Feature Proposal: Report on pending Registration email confirmations or approvals.

Motivation

Tasks.Item14199 changes the pending registrations format from plain text (Data::Dumper) to binary (Storable). This is needed to support utf-8 user names, which get broken by Data::Dumper.

Because of this, a registration report would be very helpful.

Description and Documentation

• Add a new macro - PENDINGREGISTRATIONS which will report contents of the working/registration_approvals directory
• Add a System.PendingRegistrationsTemplate file to control formatting
• Add a Main.PendingRegistrations topic.

The report will only be generated for:

• Users in the AdminGroup
• Users listed in $Foswiki::cfg{Register}{Approvers}

As this is in response to a bug fix in 2.1.3, I intend to add this in a patch release.

I'm running into one area of confusion. What the heck belongs where? User registration is apparently somewhat randomly split between TopicUserMappingContrib and Foswiki core:

• All the registration templates are in core
• The registration code is in core
• The important topics like UserRegistration and BulkRegistration are provided by TopicUserMappingContrib.

So... where does this belong. I'm planning on putting this in core for now. Registration is somewhat useful for other mappers.

Examples

Impact

WhatDoesItAffect:

%WHATDOESITAFFECT%

edit

Implementation

-- Contributors: GeorgeClark - 20 Oct 2016

Discussion

I wouldn't pollute the Main web with an admin topic.

-- MichaelDaum - 21 Oct 2016

Yeah I was thinking about that. I started with putting it in System but was surprised when the Main.PendRegTemplate didn't override the System.PendRegTemplate. I was looking for an easy way to override the templates used for generating the report. Unfortunately our Template search path is

• ... (template files)
• $web.$skinSkin$nameTemplate
• System.$skinSkin$nameTemplate
• ... (template files)
• $web.$nameTemplate
• System.$nameTemplate

So by putting the Topic in System, there is no way that I can see to easily tailor just using a template override. Though I could have the instructions say to copy both the PendingRegistrations, and the PendingRegistrationsTemplate to a different web. I suppose that's not that big a deal.

I'll move it back to System and change the instructions.

-- GeorgeClark - 21 Oct 2016

This must be System.PendingRegistrationsViewTemplate, then set VIEW_TEMPLATE to PendingRegistrationView.

-- MichaelDaum - 21 Oct 2016

It's not a VIEW Template! It's a template used by the macro to extract the registration formfields into the | Table | Layout |. See https://github.com/foswiki/distro/blob/Item14201/core/lib/Foswiki/Macros/PENDINGREGISTRATIONS.pm#L75

I suppose the other way to do this would be with a format=... string on the macro. Maybe that's a better solution than the template.

-- GeorgeClark - 21 Oct 2016

Maybe not... The Template makes it easer to add the confirm / reject links, and have different formats for approvals vs. confirmations, headings, etc.

-- GeorgeClark - 21 Oct 2016

Commenting is disabled while not logged in