CRM-17038 Custom Tokens in greetings not replaced

That change looks right, but you've changed the structure of $greetingTokens from a flat to a multidimensional array, which surely will affect some of the assumptions made by the code that follows. Can you verify that change doesn't break any existing functionality?
Also I'm curious to know why that change still does not allow custom contact tokens. Seems like they ought to be there?

Well, for any custom token a call to CRM_Utils_Token::replaceHookTokens() is needed. CRM_Utils_Token::replaceContactTokens() is called twice before the lines I cited and the second time it escapes the curly braces around any custom contact token because it's parameter $returnBlankToken is set to false. Thus we'll never get to the only call to CRM_Utils_Token::replaceHookTokens(), Maybe we can call it earlier, I'll have a look.

I read the code that follows my changes as if it assumes a multidimensional array.

$props = array_flip(CRM_Utils_Array::value($key, $greetingTokens));

CRM_Utils_Array::value() will always return a scalar value if applied to a flat array and some lines deeper $categories = array_keys($greetingTokens); seems to prove my assumption?!

Or am I too tired to see the obvious?

Thanks, yours!

Said that the fix should include changing lines 1451ff from

        $tokenString = CRM_Utils_Token::replaceContactTokens($tokenString,
          $greetingDetails,
          TRUE,
          $greetingTokens,
          FALSE,
          $escapeSmarty
        );

to

        $tokenString = CRM_Utils_Token::replaceContactTokens($tokenString,
          $greetingDetails,
          TRUE,
          $greetingTokens,
          TRUE,
          $escapeSmarty
        );

This allows the usage of custom contact tokens.

I created a patch with diff -u. Don't know about git

Maybe someone could test this. Seems it works.

Niels, thanks, this worked on my site. Too bad it wasn't included in 4.6.7 as I had to patch it twice. This patch fixed a couple of problems I was having. In addition to getting the token error, my scheduled reminders now works again using a cron job. Until your patch I had to run it manually everyday to make sure that it was successful. Thanks so much.

Glad it worked for you too!

Converted patch to PR: https://github.com/civicrm/civicrm-core/pull/6600

hi guys,

Do the tokens actually get populated for you? On a 4.6.10 site we're working on the patch fixes the issue with cron, but the tokens don't get populated for scheduled reminders.

Jon-man

I think there is still a bug with this patch. Can we escalate it to paid issue queue?

You're right! Call to replaceHookTokens in line 1484 replaces the activity tokens in $tokenString with spaces.

We are talking about a method named replaceGreetingTokens. Why is this called outside of greeting context?

how can we get this fixed quickly please? PIQ ?

Jon-man Cheung I'm not clear on how to replicate this bug. Please add details of the steps to replicate here. Then file a Paid Issue Queue request via: https://civicrm.org/paid-issue-queue

hi Dave,

When we use tokens in scheduled reminders (and apply the patch) the tokens show up blank. Even the 'out-the-box' ones.

Jon-man

Do you want me to replicate it on a site of your choice?

Jon-man Cheung Please provide a screenshot of the content from the message section of your scheduled reminder screen showing the token(s) that aren't working. And confirm the exact version of Civi you're using (e.g. CiviCRM 4.6.10 + PR-6600).

And file Paid Issue Queue request.

The tokens appear blank
https://www.gmcvodatabases.org.uk/sites/default/files/ght-screenshot.png

Civi version: CiviCRM 4.6.10 + PR-6600

I've changed the funding source to Paid Issue Queue. How do I file??

https://civicrm.org/paid-issue-queue

Ah yes, I just need to log in to the site first. Thanks

Thanks Jon-man. We'll review and get back to you w/ estimate.

Jon-man Cheung We will need some more information from your team. There is no token for

that's not working.

hi Dave,

ALL tokens are blank in the scheduled reminders, even the normal ones. We do have some modules which Circle wrote to add the custom tokens but disabling them, didn't fix the problem.

Jon-man

Where do you want me to put the modules?

I think I missed the meaning of replaceGreetingTokens. I thought it's meant to replace tokens in greetings like in Utils.php. But as it is called in other contexts like ActionSchedule.php and MessageTemplate.php and as it doesn't handle a »greeting«-category of tokens (and never did), I wonder what the method name should tell me.

If it's not possible to use other methods in those contexts, can't we move every call to replaceGreetingTokens at the respective end of token handling? This is suggested in a fix inspired by this patch and linked above (https://github.com/civicrm/civicrm-core/commit/e66cb98f6d91f491b8b6831f87a4430dcc1e0cf8).

hi Niels,

Should this patch fix my issue also?

Jon-man

Hey Jon-man,

no, I don't think so.

Without this patch some of your tokens may work because the token handling in replaceGreetingTokens was limited to the contact token category/key. Your contact.email_greeting would fail because it will be escaped and your activity.* tokens may work,

The problem is that replaceGreetingTokens calls replaceHookTokens and this replaces all unevaluated tokens with a space.

If I were you I'd try to comment out the call to replaceGreetingTokens in Line 484 of ActionSchedule.php. But this is just an educated guess, I really don't know why this is called here and haven't checked.

Yours // nielo

This may be related to https://issues.civicrm.org/jira/browse/CRM-11153 - BUT, some Jon-man Cheung reports NO tokens are working, Brian Shaughnessy reports only custom tokens not working, and in my tests on 4.6.10 the core tokens seem to be working (I did not test custom tokens).

Custom tokens didn't work for me in schedule reminder even after CRM-11153 fix. I've submitted a PR in an extension to #7535 changes at https://github.com/civicrm/civicrm-core/pull/7817.

Core tokens worked fine for me.