comment_notify.module 18.9 KB
Newer Older
1 2 3 4 5
<?php
// $Id$

/**
 * @file
6 7
 *
 * This module provides comment follow-up e-mail notification for anonymous and registered users.
8 9
 */

10 11
define('DEFAULT_MAILTEXT',
'Hi !name,
12

13
!commname has commented on: "!node_title"
14 15 16

The post is about
----
17
!node_teaser
18 19 20
----

You can view the comment at the following url
21
!comment_url
22

23 24
You can stop receiving emails when someone replies to this blog post,
by going to !link1
25 26 27

If you have auto-blog-following enabled in your account, you will receive emails like this for all replies to a blog post you commented on. You can disable this by logging in and going to your account settings or unchecking the flag at the time you post the comment.

28 29
You can set up blog-following feature for all future posts
by creating your own user with a few clicks here !uri/user/register
30 31 32

Thanks for your feedback,

33 34 35
Webmaster of !site
!mission
!uri');
36 37 38 39

/**
 * Implementation of hook_help().
 */
40 41
function comment_notify_help($path, $arg) {
  switch ($path) {
42
    case 'admin/modules#description':
43
      return t('Comment follow-up e-mail notification for anonymous and registered users.');
44 45 46 47
      break;
  }
}

48
/**
49
 * Insert our checkbox, add a submit button, and populate fields.
50
 */
51
function comment_notify_form_alter(&$form, &$form_state, $form_id) {
52 53
  global $user;

54 55
  // Only do alter the form if it's a comment form and the user has the permission to subscribe
  if ($form_id != 'comment_form' || !user_access('Subscribe to comments')) {
56 57
    return;
  }
58

59 60
  // Only add the checkbox if this is an enabled content type
  $node = node_load($form['nid']['#value']);
61 62
  $enabled_types = variable_get('comment_notify_node_types', array($node->type => TRUE));
  if (empty($enabled_types[$node->type])) {
63
    return;
64
  }
65

66
  // If this is a POST then it is a preview and we remind people that there post isn't done yet.
67 68 69
  $op = isset($_POST['op']) ? $_POST['op'] : '';

  if ($op == t('Preview comment')) {
70
    drupal_set_message(t('ATTENTION: Your comment is NOT YET posted - please click the post button to confirm your post'));
71 72 73 74

    //extra submit button on top
    if (!form_get_errors() && ((variable_get('comment_preview', COMMENT_PREVIEW_REQUIRED) == COMMENT_PREVIEW_OPTIONAL) || ($op == t('Preview comment')) || ($op == t('Post comment')))) {
      $form['submitextra'] = array(
75 76 77 78 79
        '#type' => 'fieldset',
        '#title' => t('Comment is not posted yet - please click post button to confirm your post'),
        '#weight' => -99,
        '#collapsible' => FALSE
      );
80

81 82 83 84 85
      $form['submitextra']['submit'] = array(
        '#type' => 'submit',
        '#value' => t('Post comment'),
        '#weight' => -20
      );
86 87 88
    }
  }

89
  // Add the checkbox for anonymous users and set the default based on admin settings.
90
  if ($user->uid == 0) {
91 92 93 94
    // If anonymous user's can't enter their e-mail don't tempt them with the checkbox
    if (empty($form['mail'])) {
      return;
    }
95 96
    $form['notify'] = array(
      '#type' => 'checkbox',
97
      '#title' => t('Notify me of follow-up comments posted here.'),
98 99 100
      '#default_value' => ($user->uid != 0) ? $user->comment_notify_mailalert : variable_get('comment_notify_default_anon_mailalert', TRUE),
    );
  }
101
  // For registered users and the admin wants them to see the checkbox.
102
  elseif (variable_get('comment_notify_regged_checkbox', TRUE)) {
103
    $user_setting = empty($user->comment_notify_mailalert) ? FALSE : $user->comment_notify_mailalert;
104 105 106
    $form['notify'] = array(
      '#type' => 'checkbox',
      '#title' => t('Notify me of follow-up comments posted here.'),
107
      '#default_value' => ($user->uid != 0) ? $user_setting : variable_get('comment_notify_default_anon_mailalert', TRUE),
108
      '#description' => t('You can change the default for this field in "Comment follow-up notification settings" on <a href="!uri">your account edit page</a>', array('!uri' => url('user/'. $user->uid .'/edit'))),
109 110
    );
  }
111
  // For the registered users where the admin wants the checkbox hidden.
112
  else {
113
    $form['notify'] = array(
114 115
      '#type' => 'hidden',
      '#title' => t('Mail me updates to this comment.'),
116
      '#default_value' => $user->comment_notify_mailalert,
117 118
    );
  }
119
  // If this is an existing comment we set the default value based on their selection last time.
120
  if ($form['cid']['#value'] != '') {
121 122
    $notify = db_result(db_query("SELECT notify FROM {comment_notify} WHERE cid = %d", $form['cid']['#value']));
    $form['notify']['#default_value'] = $notify;
123 124
  }
}
125

126
/**
127
 * Implementation of hook_perm().
128 129
 */
function comment_notify_perm() {
130
  return array('Administer comment notify', 'Subscribe to comments');
131
}
132 133 134 135

/**
 * Implementation of hook_menu().
 */
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
function comment_notify_menu() {

  $items['admin/settings/comment_notify'] = array(
    'title' => 'Comment Notify',
    'description' => 'Configure settings for e-mails about new comments.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('comment_notify_settings'),
    'access arguments' => array('Administer comment notify'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  /*  $items['admin/settings/comment_notify/settings'] = array(
    'title' => 'Settings',
    'description' => 'Configure settings for e-mails about new comments.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('comment_notify_settings'),
    'access arguments' => array('Administer comment notify'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  */
  $items['admin/settings/comment_notify/unsubscribe'] = array(
    'title' => 'Unsubscribe',
    'description' => 'Unsubscribe an email from all notifications.',
    'weight' => 2,
    'page callback' => 'drupal_get_form',
    'page arguments' => array('comment_notify_unsubscribe'),
    'access arguments' => array('Administer comment notify'),
    'type' => MENU_LOCAL_TASK,
  );
  $items['comment_notify'] = array(
    'title' => 'comment notify',
    'page callback' => 'comment_notify_page',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK
  );
170 171 172 173

  return $items;
}

174 175 176
/**
 * Page callback to allow users to unsubscribe simply by visiting the page.
 */
177 178 179
function comment_notify_page() {
  global $user;

180 181
  $op = $_POST['op'];
  $edit = $_POST['edit'];
182

183
  $page_content = ' ';
184 185 186 187 188 189 190
  if (empty($op)) {
    $op = arg(1);
  }
  $arg = arg(2);

  switch ($op) {
    case 'disable':
191
      $key = $arg;
192
      db_query("UPDATE {comment_notify} c SET c.notify = 0 WHERE notify_hash = '%s'", $arg);
193 194 195

      drupal_set_message(t('Your comment follow-up notification for this post was disabled. Thanks.'));
      $title = t('Disabled comment follow-up notification feature for this post.');
196 197 198 199 200
      break;
    default;
      $title = t('Comment Notify');
      break;
  }
201

202
  drupal_set_title($title);
203
  return $page_content;
204 205
}

206
/**
207
 * Implementation of hook_comment().
208 209 210 211
 */
function comment_notify_comment($comment, $op) {
  global $user;

212
  switch ($op) {
213
    case 'validate':
214 215
       // We assume that if they are non-anonymous then they have a valid mail.
       // For anonymous users, though, we verify that they entered a mail and let comment.module validate it is real.
216 217 218 219
      if (!$user->uid && $comment['notify'] && empty($comment['mail'])) {
        form_set_error('mail', t('If you want to subscribe to comments you must supply a valid e-mail address.'));
      }
      break;
220
    case 'publish':
221
      // The real meat of the module.
222 223 224
      _comment_notify_mailalert($comment);
      break;
    case 'update':
225
      // In case they have changed their status, save it in the database.
226
      $sql = 'UPDATE {comment_notify} SET notify = %d WHERE cid = %d';
227
      db_query($sql, $comment['notify'], $comment['cid']);
228
      break;
229
    case 'insert':
230
      // For new comments, we first build up a string to be used s the md5 identifier for the alert
231 232
      $mail = empty($comment['mail']) ? $user->mail : $comment['mail'];
      $md5_string = $mail . $user->uid . $comment['name'] . $comment['nid'];
233 234
      // And then save the data.
      db_query("INSERT INTO {comment_notify} (cid, notify, notify_hash) values (%d, %d, '%s')", $comment['cid'], $comment['notify'], md5($md5_string));
235
      break;
236 237 238
    case 'delete':
      db_query("DELETE FROM {comment_notify} WHERE cid = %d", $comment->cid);
      break;
239 240 241 242 243 244 245 246 247
  }
}

/**
 * Implementation of hook_user().
 */
function comment_notify_user($type, &$edit, &$user, $category = NULL) {
  switch ($type) {
    case 'form':
248
      if ($category == 'account' && user_access('Subscribe to comments', $user)) {
249 250
        $form = array();
        $form['comment_notify_settings'] = array(
251 252 253 254 255 256
          '#type' => 'fieldset',
          '#title' => t('Comment follow-up notification settings'),
          '#weight' => 4,
          '#collapsible' => TRUE
        );

257
        $form['comment_notify_settings']['comment_notify_mailalert'] = array(
258 259
          '#type' => 'checkbox',
          '#title' => t('Receive comment follow-up notification e-mails'),
260
          '#default_value' => isset($edit['comment_notify_mailalert']) ? $edit['comment_notify_mailalert'] : 0,
261
          '#description' => t("Check this box to receive e-mail notification for follow-up comments to comments you posted. You can later disable this on a post-by-post basis... so if you leave this to YES, you can still disable follow-up notifications for comments you don't want follow-up mails anymore - i.e. for very popular posts.")
262
        );
263 264
        return $form;
      }
265

266 267 268 269
      break;
  }
}

270 271
/**
 * Private function to send the notifications.
greggles's avatar
greggles committed
272
 *
273 274 275
 * @param $comment
 *   The comment array as found in hook_comment $op = publish.
 */
276 277
function _comment_notify_mailalert($comment) {
  $comment = (object) $comment;
278
  global $language;
279 280
  global $base_url;

281
  $initial_language = $language;
282

283
  if (function_exists('locale')) {
284
    $languages = locale_language_list();
285 286 287
    $languages = $languages['name'];
  }

288 289 290 291
  $nid = $comment->nid;
  $cid = $comment->cid;
  $node = node_load($nid);
  if (!isset($comment->mail)) {
292
    $comment_account = user_load(array('name' => $comment->name));
293 294 295 296 297
    $comment_mail = $comment_account->mail;
  }
  else {
    $comment_mail = $comment->mail;
  }
298

299
  $result = db_query("SELECT DISTINCT c.cid, u.init, c.uid, c.name, c.nid, c.mail cmail, u.mail umail, u.init uinit, c.uid, c.name, cn.notify_hash mymd5
300
    FROM {comments} c INNER JOIN {comment_notify} cn on c.cid = cn.cid LEFT OUTER JOIN {users} u ON c.uid = u.uid
301
    WHERE nid = %d  AND cn.notify = 1 AND c.status = 0 AND (u.status = 1 or u.status = '')", $nid
302
  );
303
  // TODO? the original big query had stuff making sure the mail was populated and contained .+@.+ Perhaps check for that here and set notify = 0 if that is the case for this cid
304

305 306
  $count = 0;
  $sent_to = array();
307

308
  while ($alert = db_fetch_object($result)) {
309 310 311 312
    $umail = empty($alert->umail) ? $alert->uinit : $alert->umail;
    $mail = empty($alert->cmail) ? $umail : $alert->cmail;

    if ($mail != $comment_mail && !in_array($mail, $sent_to) && $alert->uid != $comment->uid) {
313 314
      $message = array();
      if (!empty($alert->uid)) {
greggles's avatar
greggles committed
315
        $recipient_user = user_load(array('uid' => $alert->uid));
316 317 318 319
        $language = user_preferred_language($recipient_user);
      }
      else {
        $language = language_default();
320
      }
321

322
      $message['subject'] = t('!site :: new comment for your post.', array('!site' => variable_get('site_name', 'drupal')));
323
      $message['body'] = t(
324 325
        variable_get('comment_notify_default_mailtext', DEFAULT_MAILTEXT),
        array(
326 327 328
          '!commname' => $comment->name,
          '!commtext' => $comment->comment,
          '!commsubj' => $comment->subject,
329
          '!comment_url' => url('node/'. $nid, array('absolute' => TRUE)) .'#comment-'. $cid,
330 331 332 333 334 335 336
          '!node_title' =>  $node->title,
          '!node_teaser' => $node->teaser,
          '!mission' => variable_get('site_mission', ''),
          '!node_body' =>  $node->body,
          '!name' => $alert->name,
          '!site' => variable_get('site_name', 'drupal'),
          '!uri' => $base_url,
greggles's avatar
greggles committed
337
          '!uri_brief' => drupal_substr($base_url, drupal_strlen('http://')),
338
          '!date' => format_date(time()),
339 340 341
          '!login_uri' => url('user', array('absolute' => TRUE)),
          '!edit_uri' => url('user/'. $alert->uid .'/edit', array('absolute' => TRUE)),
          '!link1' => url('comment_notify/disable/'. $alert->mymd5, array('absolute' => TRUE))
342
        )
343
      );
344
      drupal_mail('comment_notify', 'comment_notify_mail', $mail, $language, $message);
345
      $count++;
346
      $sent_to[] = $mail;
347

348
      if ($alert->uid != 0) {
349
        $watchdog_message = 'Notified: <a href="!url">@user_mail</a>';
350 351
      }
      else {
352
        $watchdog_message = 'Notified @user_mail';
353
      }
354

355
      watchdog('comment_notify', $watchdog_message, array('!url' => url('user/'. $alert->uid .'/edit'), '@user_mail' => $mail),
356
        WATCHDOG_NOTICE, l(t('source comment'), 'node/'. $nid, array('fragment' => 'comment-'. $alert->cid)));
357

358 359
      // Add an entry to the watchdog log.

360
      // revert to previous (site default) locale
361
      $language = $initial_language;
362 363 364 365
    }
  }
}

366 367
function comment_notify_mail($key, &$message, $params) {
  $message['subject'] = $params['subject'];
368
  $message['body'][] = $params['body'];
369 370 371
}


372
/**
373
 * Callback for an administrative form to unsubscribe users by e-mail address.
374 375 376 377 378 379 380 381 382 383 384 385 386
 */
function comment_notify_unsubscribe() {
  $form['comment_notify_unsubscribe'] = array();
  $form['comment_notify_unsubscribe']['email_to_unsubscribe'] = array(
    '#type' => 'textfield',
    '#title' => t('Email to unsubscribe'),
  );
  $form['comment_notify_unsubscribe']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Unsubscribe this e-mail'),
  );
  return $form;
}
387

388
/**
389
 * Based on admin submit, do the actual unsubscribe from notifications.
390
 */
391 392
function comment_notify_unsubscribe_submit($form, &$form_state) {
  $email = trim($form_state['values']['email_to_unsubscribe']);
393
  // If they have a uid, use that, otherwise update comments directly
394
  $result = db_result(db_query_range("SELECT uid FROM {users} WHERE mail = '%s'", $email, 0, 1));
395
  if ($result > 0) {
396 397
    $comments = db_result(db_query("SELECT COUNT(1) FROM {comments} c INNER JOIN {comment_notify} cn ON c.cid = cn.cid WHERE c.uid = %d AND cn.notify = 1", $result));
    db_query("UPDATE {comment_notify} cn INNER JOIN {comments} c ON cn.cid = c.cid SET cn.notify = 0 WHERE c.uid = %d", $result);
398 399
  }
  else {
400 401
    $comments = db_result(db_query("SELECT COUNT(1) FROM {comments} c INNER JOIN {comment_notify} cn ON c.cid = cn.cid WHERE c.mail = '%s' AND cn.notify = 1", $email));
    db_query("UPDATE {comment_notify} cn INNER JOIN {comments} c ON cn.cid = c.cid SET cn.notify = 0 WHERE c.mail = '%s'", $email);
402 403 404 405 406 407 408 409 410 411
  }
  // Update the admin about the state of this comment notification subscription.
  if ($comments == 0) {
    drupal_set_message(t("There were no active comment notifications for that email."));
  }
  else {
    drupal_set_message(format_plural($comments, "Email unsubscribed from 1 comment notification.",
      "Email unsubscribed from @count comment notifications."));
  }
}
412

413 414 415
/*
 * Page callback for administrative settings form.
 */
416 417
function comment_notify_settings() {
  $form['comment_notify_settings'] = array();
418 419

  // Only perform comment_notify for certain node types (default, all)
420
  $anonymous_problems = '';
421 422 423
  foreach (node_get_types('names') as $type => $name) {
    $checkboxes[$type] = check_plain($name);
    $default[] = $type;
424 425 426 427 428 429 430 431 432

    // If they don't have the ability to leave contact info, then we make a report
    if (variable_get('comment_anonymous_'. $type, COMMENT_ANONYMOUS_MAYNOT_CONTACT) == COMMENT_ANONYMOUS_MAYNOT_CONTACT) {
      $account = user_load(array('uid' => 0));
      if (user_access('Subscribe to comments', $account)) {
        $anonymous_problems[] = l(t('@content-type', array('@content-type' => $name)), 'admin/content/node-type/'. $type);
      }
    }
  }
greggles's avatar
greggles committed
433

434 435
  if (!empty($anonymous_problems)) {
    drupal_set_message(t('Anonymous commenters have the permission to subscribe to comments but cannot leave their contact infromation on the following content types: !types.  You should either disable subscriptions on those types here, revoke the permission for anonymous users, or enable anonymous users to leave their contact information in the comment settings.', array('!types' => implode(', ', $anonymous_problems))));
436 437 438 439 440 441 442 443 444 445
  }

  $form['comment_notify_settings']['comment_notify_node_types'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Content Types To Enable for Comment Notify'),
    '#default_value' => variable_get('comment_notify_node_types', $default),
    '#options' => $checkboxes,
    '#description' => t('Comments on content types enabled here will have the option of comment notification.'),
  );

446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
  $form['comment_notify_settings']['comment_notify_regged_checkbox'] = array(
    '#type' => 'checkbox',
    '#title' => t('Let registered users select notification on a node basis'),
    '#return_value' => 1,
    '#default_value' => variable_get('comment_notify_regged_checkbox', TRUE),
    '#description' => t('letting registered users select/unselect if they want to be notified. If this is disabled, this setting is propagated from their user profile, hence reducing and clutter and confusion')
  );

  $form['comment_notify_settings']['comment_notify_default_anon_mailalert'] = array(
    '#type' => 'checkbox',
    '#title' => t('Fill checkbox for follow-up with YES by default for anonymous users, so they will get an email alert for follow-up comments if they do not uncheck it then'),
    '#return_value' => 1,
    '#default_value' => variable_get('comment_notify_default_anon_mailalert', TRUE),
    '#description' => t('This flag presets the flag for the follow-up notification on the form that anon users will see when posting a comment')
  );

  $form['comment_notify_settings']['comment_notify_default_mailtext'] = array(
    '#type' => 'textarea',
    '#title' => t('Default mail text for sending out the notifications.'),
    '#description' => t(
      'You can use the following variables to be replaced:
467
      <ul>
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
      <li>!commname = the username who posted the comment
      <li>!commtext = the text of the posted comment
      <li>!commsubj = the subject of the posted comment
      <li>!comment_url = the full url of the post and comment - note: if you have paging enabled, this does not work correct - set your max comments per page so that all fit on one page or reverse order them
      <li>!node_title = the title of the node that was commented on
      <li>!node_teaser = the teaser of the node that was commented on
      <li>!node_body = the body of the node that was commented on
      <li>!mission = site_mission text
      <li>!name = username receiving the alert
      <li>!site = your site
      <li>!uri = base_url of site
      <li>!uri_brief = base_url of site w/o http
      <li>!date = the current time
      <li>!login_uri  uri to login the user
      <li>!edit_uri = uri to edit user profile
      <li>!link1 the QUICKLINK to disable future follow-up otifications for the user
      </ul>'
    ),
    '#default_value' => variable_get('comment_notify_default_mailtext', t(DEFAULT_MAILTEXT)),
    '#return_value' => 1,
    '#cols' => 80,
    '#rows' => 15
  );

  return system_settings_form($form);
493
}