Fix wrong documentation for hook_privatemsg_block_message()

Hey Berdir,

yikes - I checked this out really wanting to help but having trouble. I noticed the 6.x-1.x version has $recipient where as 6.x-2.x has $recipients. Does this mean in 6.x-1.x you are only able to send a message to one user at a time? I see in the above instructions that the code needs to be backported, and that the return value $blocked needs to be changed?

function hook_privatemsg_block_message($author, $recipient)
function hook_privatemsg_block_message($author, $recipients)

Thanks

I hope I am heading in the right direction with this =/

I removed the following lines as from my understanding of your explanation above, 6.x-1.x doesn't support checking for roles. Not sure if this is the correct thing to change.

// Ensure we have a recipient user object which includes roles.
if (!isset($recipients[$uid]->roles)) {
}

After your next advice/review when you have time, I will make more changes or create the changes as a patch (I have re-read instructions on creating patches and have tried it several times before).

<?php
/**
 * Check if the author can send a message to the recipients.
 *
 * This can be used to limit who can write whom based on other modules and/or
 * settings.
 *
 * @param $author
 *   Author of the message to be sent
 * @param $recipients
 *   Recipients of the message
 * @return
 *   An indexed array of arrays with the keys uid and
 *   message (The reason why the recipient has been blocked).
 */
function hook_privatemsg_block_message($author, $recipients) {
  $blocked = array();
  // Loop through each recipient and ensure there is no rule blocking this
  // author from sending them private messages. Use a reference, so when
  // user_load() is needed here the array is updated, negating the need for
  // further calls to user_load() later in the code.
  foreach (array_keys($recipients) as $uid) {
    $recipients[$uid] = user_load($uid);
    // Note: this is checked whether the author may send the message (see third
    // parameter). Further below is a check whether the recipient may block it.
    if (_pm_block_user_rule_exists($author, $recipients[$uid], PM_BLOCK_USER_DISALLOW_SENDING)) {
      $blocked[] = array(
        'uid' => $uid,
        'message' => t('Sorry, private messaging rules forbid sending messages to !name.', array('!name' => $recipients[$uid]->name)),
      );
    }
  }

  $args = array_merge(array($author->uid), array_keys($recipients));
  $result = db_query('SELECT recipient FROM {pm_block_user} WHERE author = %d AND recipient IN ('. db_placeholders($recipients) .') GROUP BY recipient', $args);
  while ($row = db_fetch_array($result)) {
    $recipient = $recipients[$row['recipient']];
    // If there's a rule disallowing blocking of this message, send it anyway.
    if (_pm_block_user_rule_exists($author, $recipient, PM_BLOCK_USER_DISALLOW_BLOCKING)) {
      continue;
    }
    $blocked[] = array(
      'uid' => $row['recipient'],
      'message' => t('%name has chosen to not recieve any more messages from you.', array('%name' => $recipients[$row['recipient']]->name))
    );
  }
  return $blocked;
}
?>

Just to see if there is a better way of patching from what I am doing:
1) I created a duplicate of privatemsg.api.php, made changes and saved as privatemsg.api2.php in the privatemsg folder
2) with terminal opened the privatemsg folder
3) created patch with diff -up privatemsg.api.php privatemsg.api2.php > 877598.patch
4) opened 877598.patch and changed name privatemsg.api2.php to privatemsg.api.php at the top

--- privatemsg.api.php	2009-11-06 22:06:26.000000000 +0900
+++ privatemsg.api2.php	2010-08-13 21:02:30.000000000 +0900

to

--- privatemsg.api.php	2009-11-06 22:06:26.000000000 +0900
+++ privatemsg.api.php	2010-08-13 21:02:30.000000000 +0900

Thanks!

oh wow, Dreditor is cool. I hope to learn how to use it more in the coming days/weeks

I'm not sure what happened with the below part getting into the patch:

@@ -371,18 +371,55 @@ function hook_privatemsg_message_insert(
  */
 
 /**

The files I used in creating the patch with command diff -up privatemsg.api.php privatemsg.api2.php > 877598.patch are attached in a zip. I wasn't able to find any spaces around the area above =/

I am going to look into the CVS method =) Thanks!

Hey Berdir,

Sorry for the big delay on this. I did run into walls getting CVS installed on my ancient MacBook but as i was about to start tackling how to use CVS i had to travel the past several weeks for work. I fly back into Tokyo (home) on Friday and promise to have this done this weekend.

If you have any tutorial guides on what to do once CVS is installed I'll read it on my iPhone to prep for the major learning I'll be doing this weekend =) I'm excited to learn the basics of how it all works to contribute in other areas in the future. Thanks

oh man, this stuff is hard x_x

I don't have my macbook with me for the next week so I started over and attempted to use Git on my Windows. Please let me know if the attach file is better than my first attempt =)

After making changes to the privatemsg.api.php file, I used the command git diff --no-prefix --relative > name.patch to create the patch. I saw this on a drupal.org page when searching how to create a patch with Git but not sure if there is a better way.

Awesome =)

I used Dreditor to review the patch and see a red highlight. Is this not good / should this be removed?
http://www.screencast.com/users/trupal218/folders/Jing/media/dad8122f-59...

The way I worked on the latest Privatemsg with Git was by downloading it from http://drupal.org/project/privatemsg, putting the folder into the git folder on my local drive, committing the whole folder, then made edits and created the patch. Is this the only way? Or is there an easier way I can link up to the latest Privatemsg module by a url link and update it with a command?

I installed the two programs below and made C:\testgit\ my git repository
1) Git-1.7.0.2-preview20100309.exe from http://code.google.com/p/msysgit/downloads/list
2) TortoiseGit-1.5.2.0-32bit.msi from http://code.google.com/p/tortoisegit/downloads/list

I'm going to continue to read up on Git this week =)

Thanks for the good info! I have lots to read up this week.

I think the text editor I use (Notepad++) added the indentation with spaces. I removed them and will check with Dreditor again once uploaded (I wish there was a way to use Dreditor before uploading, or maybe I need a better text editor). Also, I used 6.x-1.x-dev for the patches for this task.

Thanks again

Thanks, I really appreciate your instructions and advice as I get to know the ins-and-outs of the process.
I hope to help out with the README which BenK has been writing.