Integrate with the Token module for email token substitution.

Here is a patch that changes the variable substitution used in the Advanced User module from the current method to Token module.

Almost all substitution variables had their names changed because the names used by Advanced User where different from the ones used in the Token module.

There were a few variables used by Advanced User that didn't exist in the Tokens module so I created them inside Advanced User through the Tokens module API.

I changed the default subject and email definitions to match the new variable names, i.e., I changed the definitions so the default subject and emails would remain the same.

I also changed the prefix and suffix used by Advanced User to match the ones recommended by the Token module. Previously Advanced User used % as prefix and nothing as suffix. Token module mentions that it's safer to use a prefix AND a suffix to eliminate the possibility of variables starting with the same letters being substituted wrongly. I adopted [ as the prefix and ] as the suffix.

Please review the patch and let me know if there are any modifications necessary.

Oh, joy, I don't have to do it! :D

You are welcome.

Do we really have to code it like this?

No. Not really. I did it this way only because I was uncertain that the delimiters change would be well received by you (from "% before" to "surronded by []") and this way it would be easier to roll back the delimiters change.

Is the !prefixuser!suffix what the user will put in the settings form?

No not all. The user will use [user]

As the users won't have to deal with this ultra-ugly !prefixuser!suffix syntax I believe the way I coded is ok but if you prefer it can be made prettier. Please let me know.

Here is a patch that beautifies the default subject and mail definitions. It should be applied after applying my previous patch.

There are already some discussions on the subject of hosting the Profile Tokens module (or including it in the Token module itself). You can track these discussions at #125640-73: Profile tokens.

I think your idea of the optional dependency is a good one. I believe we should just see what is settled with the Token module maintainers about the Profile Token module before doing anything.

Forgot to change the status.

How many mistakes one can make when trying to provide a patch?...

Let's see if I managed to provide a working patch this time.

This is a complete patch made with all up to the last modifications you asked for created against DRUPAL-6--3 version from a few hours back with the command you mentioned. (I'm still unsure if DRUPAL-6--3 is a branch or a tag).

This patch has the DEFAULT_ removed from the prefix and suffix constant names.

Just to further clarify the branch X tag X release cvs definitions: you say the release tag is static. So is it correct to infer that the branch tag isn't static?

I think it's a good idea.

Here is a patch.

Edit: I'm not sure about the name and path of the Profile Tokens 6 module as the page where fizk said he put it isn't showing it yet. He said it would show sometime today.

AFAIU there are two dependency issues at hand:

1. The mandatory dependency on the Token module. This is dealt with with the "dependencies[]" entry on the .info file. As per the hook_requirements API manual page "Module dependencies do not belong to these installation requirements, but should be defined in the module's .info file."
2. The optional dependency on the Token Profile module. This is the one I'm trying to deal with on hook_requirements.

Do you envision something different?

On other matter: what do you think about creating a constants file for the module?

Ok, I will include the mandatory dependency on the Token module in the 'runtime' requirements. In case of failure it will return with an error.

About the optional dependency on the Token Profile module: I believe that it would be helpful for users to get an warning on the lack of the Token Profile module in the same spirit the Upload module does in a similar situation. Here is an example of the warning the Upload module provides:

Upload progress Disabled
Your server is capable of displaying file upload progress, but does not have the required libraries. It is recommended to install the PECL uploadprogress library (preferred) or to install APC.

What you think about it?

Any ideas on the one below?

On other matter: what do you think about creating a constants file for the module?

Ok. Your module, your rules. ;)

Here is the patch without 'requirements' testing for Token Profile module.

rsevero--

Can you re-apply your patch and post it based upon the latest DEV version? Thanks.

Joe

Here is a patch against DRUPAL--6-3 version I checked out a few minutes ago.

rsevero --

Applied the patch to DRUPAL--6-3 and it appears to work through a series of tests, including simpletest. We need someone else to test this patch to make sure there are no bugs before committing to the next version.

Thanks for your quick reply!

Joe

Hi there,

I've just tested the patch on #24 and although found no major errors or issues, here's a list of what I've detected so far:

1. User profile tokens don't show on the Substitution variables list
2. "Administor" typo on Mail body default text
3. Couldn't get notifications logged in watchdog or account activity emailed to admin either for new user or updated profile info even when selecting these options in settings. (guess maybe I'm missing something here, I'll try again later)

This is my testing setup:

Drupal-6.17
Advanced User Management 6.x-3.x-dev
Profile Tokens 6.x-1.x-dev
Token 6.x-1.12
Core profile module enabled

Thanks Libriana!

I have reviewed your bugs and I think fixed them. Here is the next patch that I need reviewed by two people before we can commit it to the next version. This is to add Tokens module dependency and features to the Advanced User module (advuser).

I split the patches up into five files, one for each file to be patched. I am also submitting a tarball with the entire module to make it easier for someone to download and test. The tarball is 6.x-3.x-dev with all five patches to provide Tokens support applied.

The sooner we get some testing, the faster we can commit this feature! Thanks everyone for helping out.

My testing environment:
Drupal-6.17
advuser 6.x-1.x-dev
Token 6.x-1.12
(core) Profile module enabled

(I did not test this against Profile Tokens 6.x-1.x-dev)

All tokens appeared.
Email notifications happened.
Everything was showing up in Watchdog.

Updated version of #24 patch with requested hook_update_N.

Updated #29 patch with fix for #26 item 2 (which wasn't introduced by this patch BTW).

Item 1: user tokens are listed in http://example.org/admin/settings/advuser "Registration notification controls" and "Account update notification controls". Is there anywhere else to check? Or are there other tokens to be presented? Please provide more detailed information if you believe there is still a problem.

Item 3: I didn't test it. If this problem is really present, I bet it has nothing to do with this patch so I suggest a specific issue is opened for it.

Ok, this gotta be the last version of this patch.

Fixed the account-url passed as user administration page.

@bmango: the more up to date patch is the one from #31. Could you test it and report?

Thanks.

@bmango: could you please test this patch?

@bmango: if you are getting a Hunk #1 FAILED at 2 error you don't have the newest DRUPAL-6--3 code as the above patch applies cleanly in it.

This patch makes Advanced User use the Token module for token substitution and creates a few specific Advanced User tokens. To get profile field tokens you need the Token Profile module from http://drupal.org/project/token_profile.

The bullet point alignment issue isn't related to this patch. I bet it has something to do with the select theme.

I also applied the patch in #38 to 6.x-3.x-dev from 2010-Jul-11. Same error as bmango in #39 (since I didn't get from CVS), but otherwise appears to be working fine.

Now to figure out how to get this token applied to the registration email (#257200: Custom profile fields in registration mail)...

Patch #38: Tested & reviewed. It works correctly. It has some Warnings and mistakes, I think they can be solved through Drupal 7 port.

Re-attaching patch and working on it (to be ported).