Sending mail and displaying a message in a trigger doesn't honor tokens

Looks like a straight port of the actions.module patch. Looks good.

This patch needs to be committed for D6 and D7, preferrably on the next security iteration of D6...

As far as I can tell, without this patch, workflow can't send emails or post messages with %node_title or %author. I'd prefer to not hack my D6 core by applying this patch, but I might have to.

Josh

I reviewed in D6, and it solves the problem that this bug caused for workflow emails. Great work :)

Drupal 6.8 dosen't repair this bug !

The patch works whit D6.8

But i have * beford and after token in the mail !

Exampel :

Bonjour, un nouvel article a été crée par *admin* sur le site web du xxxx :
*titre de test* 

Was this reviewed and tested on the 7.x branch?

i patched and it nearly worked ... All the fields work and it now emails the author using %author. BUT if I use %author in the email body I get literally "%author" and the text isn't replaced with the authors name. Yet %teaser, %body, %node_url all work fine - I'm really confused. Anyone else had the same prob?

Thanks for the patch though at least I can now email from workflow - great :)

sorry - appears I was being a little thick - you can't use %author in the body you have to use %username - doh! :)

As said in #4, this issue (as well as other bug reports in Drupal 6) first needs to be fixed in the Drupal 7 branch and will then be backported to Drupal 6. Only if the change is too different in Drupal 6 and 7 should we have two separate issues, otherwise Drupal 7 should get the fix first.

What's the status of this for D6? In my opinion, this is critical as it makes workflow useless.

Can someone paste the necessary changes here as I don't use patch..... Thanks.

Okay, I implemented the hook_mail_alter() in my own module to work around the current issue on hand. No hacking to the core codes. This is for D6 and I restrict it to be used with Workflow only.

/*
 * implementation of hook_mail_alter to address an email token bug
 * issue thread: http://drupal.org/node/339591
 */
function YOUR_MODULE_NAME_mail_alter(&$message) {
  if ($message['params']['context']['hook']=='workflow') {
    $node = $message['params']['context']['node'];
    $account = $message['params']['account'];
    
    $author_account = user_load(array('uid' => $node->uid));
    $variables = array(
      '%site_name' => variable_get('site_name', 'Drupal'),
      '%username' => $account->name,      
      '%uid' => $node->uid,
      '%node_url' => url('node/'. $node->nid, array('absolute' => TRUE)),
      '%node_type' => node_get_types('name', $node),
      '%title' => $node->title,
      '%teaser' => $node->teaser,
      '%body' => $node->body,
      '%author' => $author_account->mail,
      '%authorname' => $node->name,    
    );

    if ($message['to'] == '%author') {
      $message['to'] = $author_account->mail;
    }    
    $message['subject'] = strtr($message['subject'],$variables);
    $message['body'][0] = strtr($message['params']['context']['message'],$variables);
  } 
}

This will be the first time I've ever tried manually copying and pasting a patch into a Drupal module, so please forgive me if these questions are rather basic.

1. In the line "function YOUR_MODULE_NAME_mail_alter..." do I need to replace "YOUR_MODULE_NAME" with something more specific, or do I paste exactly as written?

2. Just to be clear: precisely WHICH file am I to copy this code into? I assume it is trigger.module, but I didn't want to find out the hard way that it should go somewhere else.

3. Does it matter WHERE in the file I copy this text? At the very end? In the middle?

Thanks very much for any help.

No, you don't touch the core code. You put it in a separate module and enable it to override the function.

Anyway, I have attached the zip file. Simply uncompress it and copy the folder to your site folder (e.g. /sites/all/modules/) and enable it in the admin panel.

When core Drupal fixes up this bug, you can simply disable and remove the module.

This module adds a new token named '%authorname' to display the author's user id and is currently restricted to use with Workflow action only.

Thanks, arnoldc. I installed your fix as a module and enabled it, and then tried moving some content through different Workflow status, but the results were the same: tokens in the resulting system-generated emails were still showing as %node_type, %title, and so on.

Not sure why. Try removing the IF statement to check for "workflow" in the codes to see if it helps. Or try to set the weight of this module in the System table to a big number like 10 instead of the default 0 using a database tool like phpMyAdmin. If that still doesn't work, try add an echo statement right at the top of the function to see if this function is actually invoked during email notification.

My PHP skills are admittedly rather feeble, but I still wasn't able to get results with this. Thanks for your help, though--much appreciated.

I tried apply the patch with some changes to workflow module and apparently it runs. (at the end of workflow.module)

/**
 * Implementation of hook_mail()
 */
function workflow_mail_alter($message){
	if ($message['params']['context']['hook'] == 'workflow'){
		$params = $message['params'];
		$context = $params['context'];
  	if (isset($context['node'])){
  		$node = $context['node'];
  		// Esta función se utiliza para obtener el estado del workflow (variable %status)
  		$status = workflow_get_state($node->workflow);
  		$variables = array(
	      '%uid' => $node->uid,
	      '%node_url' => url('node/'. $node->nid, array('absolute' => TRUE)),
	      '%node_type' => node_get_types('name', $node),
	      '%title' => $node->title,
	      '%teaser' => $node->teaser,
	      '%body' => $node->body,
	  		'%status' => $status['state'],
    	);
  	}
  	$subject = strtr($message['subject'], $variables);
  	$body = strtr($message['body'][0], $variables);
  	$message['subject'] .= str_replace(array("\r", "\n"), '', $subject);
  	$message['body'][0] = drupal_html_to_text($body);
	}
} 

What do you think?

Sorry, i'm newbie in this forum, It was not my intention to make the change.

cheers.

I pasted Ernesto's version onto the end of workflow.module, and it fixes the problems. But it duplicates the subject line in the system-generated email. For example...

What the subject line should be: Email subject line
What the subject line is with Ernesto's code: Email subject lineEmail subject line

...and upon further testing, it appears that the Ernesto's fix only works on certain workflow states. Example...

I have three Workflow states: draft, submit for review, published

When content is created by a reporter and saved as "submit for review," the correct actions are now triggered (along with the aforementioned "double email subject line").

But when the editor accesses the content and moves it to Workflow state "published" the correct workflow actions are not triggered.

Also, when the editor moves content from "submit for review" back to "draft" for more work by the reporter, the workflow actions are again not triggered.

I'll keep working on it.

I think meba's right. Unfortunately, all I can do is offer testing support and feedback.

Hello, first of all thank you for the feedback.

Indeed, it was an error in the code in the message creation.

$message['subject'] .= str_replace(array("\r", "\n"), '', $subject);     // wrong line

You can see that the message it's been adding and not replacing.

$message['subject'] = str_replace(array("\r", "\n"), '', $subject);      // right line

I try to reproduce the bug in #26 but for me it runs well y any cases.

ProfStein, can you give me more information to try to reproduce the error?

If i can do something more to correct the bug i'll try to dedicate more time.

cheers.

Again, the modified code:

/**
* Implementation of hook_mail()
*/
function workflow_mail_alter($message){
  if ($message['params']['context']['hook'] == 'workflow'){
	  $params = $message['params'];
	  $context = $params['context'];
	  
	  if (isset($context['node'])){
	    $node = $context['node'];
	    // This function is used to obtain the workflow status (%status variable)
	    $status = workflow_get_state($node->workflow);
	    $variables = array(
	        '%uid' => $node->uid,
	        '%node_url' => url('node/'. $node->nid, array('absolute' => TRUE)),
	        '%node_type' => node_get_types('name', $node),
	        '%title' => $node->title,
	        '%teaser' => $node->teaser,
	        '%body' => $node->body,
	    '%status' => $status['state'],
      );
    }
    
    $subject = strtr($message['subject'], $variables);
    $body = strtr($message['body'][0], $variables);
    $message['subject'] = str_replace(array("\r", "\n"), '', $subject);
    $message['body'][0] = drupal_html_to_text($body);
  }
} 

Okay I've done more testing of Ernesto's code from #29. It fixes the "double email subject line" bug.

Also, I think I've isolated the other problem I described in my earlier posts. It seems that %author is not being picked up from the Recipient line in the "Configure an advanced action" menu (that's in Home-->Administer-->Site configuration-->Actions). The instructions beneath the Recipient field state: "The email address to which the message should be sent OR enter %author if you would like to send an e-mail to the author of the original post." But the %author hook doesn't get picked up--it only works if an actual email address is entered in the Recipient field. When I enter an actual email address instead of %author, the actions all are triggered and carried out as they should be.

EDIT: Ernesto, it seems that %author isn't included in your "$variables = array" so it makes sense that it wouldn't be called. I tried to include an %author line, but as I mentioned earlier, I'm just not familiar enough with Drupal coding (yet) to make it work.

SECOND EDIT: I think I fixed the %author issue. Here's the code now, using Ernesto's work and a couple pieces of arnoldc's work.

/**
* Implementation of hook_mail()
*/
function workflow_mail_alter($message){
  if ($message['params']['context']['hook'] == 'workflow'){
  $params = $message['params'];
  $context = $params['context'];
 
  if (isset($context['node'])){
    $node = $context['node'];
    $author_account = user_load(array('uid' => $node->uid));
    // This function is used to obtain the workflow status (%status variable)
    $status = workflow_get_state($node->workflow);
    $variables = array(
        '%uid' => $node->uid,
        '%node_url' => url('node/'. $node->nid, array('absolute' => TRUE)),
        '%node_type' => node_get_types('name', $node),
        '%title' => $node->title,
        '%teaser' => $node->teaser,
        '%body' => $node->body,
    '%status' => $status['state'],
      );
      
      if ($message['to'] == '%author') {
      	$message['to'] = $author_account->mail;
      	} 
    }
   
    $subject = strtr($message['subject'], $variables);
    $body = strtr($message['body'][0], $variables);
    $message['subject'] = str_replace(array("\r", "\n"), '', $subject);
    $message['body'][0] = drupal_html_to_text($body);
  }
} 

Subscribing.

There doesn't seem to be a hook_message_alter. Is a temporary fix for displayed messages possible, or will that only come with the core patch?

I've entered ProfStein's code and it seems to work, although the email message is being re-written on one line (HTML breaks are ignored). I'm a PHP newbie. If there something in the above code that would cause this?

Any news on when the core module will be fixed?

Agreeing with meba with this addendum: As long as the core ain't fixed, I am very happy with a temporary solution.
Although the solution for the messages would be very welcome.

Subscribing

Subscribing

I'm in the same boat as mclsm--I would love to implement this patch but I got lost in all the code talk.

Could someone possibly post an updated fixed module possibly for us uneducated folks to use?

Thanks and great work--look forward to this getting added to core.

This is what I did. You should test it out before doing it on a production Drupal site:

1. Go to the directory of your installed workflow module.
2. Copy the file workflow.module to something like workflow.module.backup.
3. Open workflow.module in a text editor and scroll to the end of the file.
4. Copy the box of code from comment #30 and paste it at the end of that file.
5. Save this modified version of workflow.module.

This appeared to fix the mail issue for me (in D6), but I notice the problem remains with the "Display a message to user..." system action. So I guess the issue is more systemic.

In response to a couple of you who were looking for a less technical explanation of what to do with the code from #30, I want to make sure you saw Likeless's explanation in #39. He's got it right. I'll emphasize that you do NOT have to replace any of the code in the existing module; just paste #30's code onto the end of what's already there.

It's been pointed out (here and in a couple other threads) that this isn't really a complete fix yet, and that's true. But depending on what your needs are, #30 will get you through until the root problem is (hopefully) fixed in core in Drupal 7.

EDIT: Here's the other thread that has dealt with this issue a lot, if you want to read more about it: http://drupal.org/node/253711

Thanks to all who added to this thread -- we now have workflow notifications functioning on our site thanks to the patch by ProfStein in #30 and the great instructions by Likeless in #39 (sorry for the mis-type previously!)

Just an observation on the patch:
The action shown in our recent log entries still states only "action 10/12/2009 - 4:15pm Sent email to %author". The email is sent to the correct email, but that email is not displayed in the same way as other system action notifications display (emails sent by triggers not related to workflow display the email of the author, workflow triggered actions display only %author). You can, of course, find out who the author is that has been emailed by visiting the node listed in the details of the log entry, so this is really a "minor" issue but it threw me for a moment when I went to check whether all was working as it should be.

Again -- we're very happy that this patch worked for us and appreciate all the effort you each have put into finding a temporary solution for the issue!

Interesting feedback, ggevalt. Do you mind indicating precisely where you're seeing that action log entry? Is it in "Reports-->Recent log entries"? I'm guessing it is, but I don't want to hunt around for stuff in there in case you're seeing it somewhere else.

Yes,
I was referring to the logs located at admin/reports/dblog (Reports -->Recent log entries).

Also, after further investigation I've noticed that when the emails are sent, %username in the text of the generated message is replaced with MY username and does not fill in the appropriate user's username. In other words, the system should be sending an email to Sarah using Sarah's username: "Sarah, congratulations! Your entry has been ...." Instead, the message Sarah receives is as follows: "ggevalt, congratulations! Your entry has been....." The %author variable does find the correct email and Sarah does receive the notification, but I'm unsure of why she receives my name in her email instead of her own. Should I be using a variable other than %username?

The text under the Message field states "The message that should be sent. You may include the following variables: %site_name, %username, %node_url, %node_type, %title, %teaser, %body. Not all variables will be available in all contexts." -- is this altered by using the patch above?

I've temporarily fixed this by deleting the %username -- all other variables in the Message are functioning properly.

(Also, emails generated outside of workflow do fill in the appropriate name, so it appears that it is a workflow related issue...I think?)

Even with these hiccups, our users are receiving notifications for the first time in a few months and we are quite happy with the temporary fix. Thank you!

Okay, I see what you're saying. I believe the %username is the name of the person sending the email (i.e., you), not the username of the recipient. I'll see if I can come up with something that would pull the name of the recipient (probably a variable to be called %recipient).

I'm looking at the %author issue. I've replicated the problem you describe, so hopefully I can track that down soon.

If you are like me and do not like to modify core or any of the contributed modules, you can enable the module "Token Actions" module which is part of Token module. This adds a few more actions to the actions drop down like "Send Tokenized Email". The tokens in these new actions are working for me.

Subcribing

The instructions in #39 worked for me in 6.x once I figured out that I needed to use the "Send e-mail" action and not the "Send tokenized email" action.

When I added the patch from #30 to the workflow module in 6.x and got the following error:

Fatal error: Cannot use string offset as an array in .../sites/all/modules/workflow/workflow.module on line 1640