comment_notify.module 14.5 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 40 41 42

/**
 * Implementation of hook_help().
 */
function comment_notify_help($section) {
  switch ($section) {
    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 50 51
 * Insert our checkbox, and populate fields.
 * set validation hook.
 */
52
function comment_notify_form_alter($form_id, &$form) {
53 54
  global $user;

55 56 57
  if ($form_id != 'comment_form') {
    return;
  }
58 59 60 61

  $op = isset($_POST['op']) ? $_POST['op'] : '';

  if ($op == t('Preview comment')) {
62
    drupal_set_message(t('ATTENTION: Your comment is NOT YET posted - please click the post button to confirm your post'));
63 64 65 66

    //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(
67 68 69 70 71
        '#type' => 'fieldset',
        '#title' => t('Comment is not posted yet - please click post button to confirm your post'),
        '#weight' => -99,
        '#collapsible' => FALSE
      );
72

73 74 75 76 77
      $form['submitextra']['submit'] = array(
        '#type' => 'submit',
        '#value' => t('Post comment'),
        '#weight' => -20
      );
78 79 80
    }
  }

81
  if (($user->uid == 0) || (variable_get('comment_notify_regged_checkbox', TRUE))) {
82 83
    $form['notify'] = array(
      '#type' => 'checkbox',
84 85 86 87 88
      '#title' => t('Notify me of follow-up comments posted here.'),
      '#default_value' => ($user->uid != 0) ? $user->comment_notify_mailalert : variable_get('comment_notify_default_anon_mailalert', TRUE)
    );
  }
  else {
89
    $form['notify'] = array(
90 91 92
      '#type' => 'hidden',
      '#title' => t('Mail me updates to this comment.'),
      '#default_value' => $user->comment_notify_mailalert
93 94 95
    );
  }

96 97 98 99
  if ($form['cid']['#value'] != '') {
    $form['notify']['#default_value'] = $form['#parameters'][1]['notify'];
  }
}
100

101 102 103 104 105 106
/**
 * Implementation of hook_perm
 */
function comment_notify_perm() {
  return array('Administer comment notify');
}
107 108 109 110 111 112 113 114 115

/**
 * Implementation of hook_menu().
 */
function comment_notify_menu($may_cache) {
  $items = array();
  global $user;

  if ($may_cache) {
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
    $items[] = array(
      'path' => 'admin/settings/comment_notify', 
      'title' => t('Comment Notify'), 
      'description' => t('Configure settings for e-mails about new comments.'), 
      'callback' => 'drupal_get_form', 
      'callback arguments' => array('comment_notify_settings'), 
      'access' => user_access('Administer comment notify'),   
    ); 
    $items[] = array(
      'path' => 'admin/settings/comment_notify/settings',
      'title' => t('Settings'),
      'callback' => 'drupal_get_form',
      'description' => t('Configure settings for e-mails about new comments.'),
      'callback arguments' => array('comment_notify_settings'),
      'access' => user_access('Administer comment notify'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
    );
    $items[] = array(
      'path' => 'admin/settings/comment_notify/unsubscribe',
      'title' => t('Unsubscribe'),
      'weight' => 2,
      'callback' => 'drupal_get_form',
      'description' => t('Unsubscribe an email from all notifications.'),
      'callback arguments' => array('comment_notify_unsubscribe'),
      'access' => user_access('Administer comment notify'),
      'type' => MENU_LOCAL_TASK,
    );
143 144
  }
  else {
145 146 147 148 149 150 151
    $items[] = array(
      'path' => 'comment_notify',
      'title' => t('comment notify') ,
      'callback' => 'comment_notify_page',
      'access' => 1,
      'type' => MENU_CALLBACK
    );
152 153 154 155 156 157 158 159
  }
  return $items;
}

function comment_notify_page() {
  global $user;

  $breadcrumb = NULL;
160 161
  $op = $_POST['op'];
  $edit = $_POST['edit'];
162

163
  $page_content = ' ';
164 165 166 167 168 169 170
  if (empty($op)) {
    $op = arg(1);
  }
  $arg = arg(2);

  switch ($op) {
    case 'disable':
171 172 173 174 175 176 177 178 179 180
      $key = $arg;
      db_query("UPDATE {comments} c, {users} u
          SET c.notify = 0
        WHERE u.uid = c.uid
          AND md5(concat(c.mail, ifnull(u.mail, u.init), c.uid, c.name, c.nid)) = '%s'",
        $arg
      );

      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.');
181 182 183 184 185
      break;
    default;
      $title = t('Comment Notify');
      break;
  }
186

187 188
  drupal_set_title($title);
  drupal_set_breadcrumb($breadcrumb);
189
  print theme('page', $page_content);
190 191
}

192
/**
193 194
 * save our data.
 */
195
function comment_notify_validate($form_id, $form_values) {
196 197 198 199 200

  if ($form_values['optin']) {
    foreach (array('optin') as $field) {
      $_SESSION['comment_notify'][$field] = $form_values[$field];
    }
201 202
  }
  else {
203 204 205 206 207 208
    foreach (array('optin') as $field) {
      unset($_SESSION['comment_notify'][$field]);
    }
  }
}

209 210
/**
 * implement hook_comment and check the publish status
211 212 213 214
 */
function comment_notify_comment($comment, $op) {
  global $user;

215
  switch ($op) {
216
    case 'publish':
217 218 219 220 221 222
      _comment_notify_mailalert($comment);
      break;
    case 'update':
    case 'insert':
      $sql = 'UPDATE {comments} set notify = %d where cid = %d';
      db_query($sql, $comment['notify'], $comment['cid']);
223 224 225 226 227 228 229 230 231 232
      break;
  }
}

/**
 * Implementation of hook_user().
 */
function comment_notify_user($type, &$edit, &$user, $category = NULL) {
  switch ($type) {
    case 'form':
233
      if ($category == 'account') {
234 235
        $form = array();
        $form['comment_notify_settings'] = array(
236 237 238 239 240 241
          '#type' => 'fieldset',
          '#title' => t('Comment follow-up notification settings'),
          '#weight' => 4,
          '#collapsible' => TRUE
        );

242
        $form['comment_notify_settings']['comment_notify_mailalert'] = array(
243 244 245 246 247
          '#type' => 'checkbox',
          '#title' => t('Receive comment follow-up notification e-mails'),
          '#default_value' => isset($edit['comment_notify_mailalert']) ? $edit['comment_notify_mailalert'] : 1,
          '#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.')
        );
248 249 250

        return $form;
      }
251

252 253 254 255
      break;
  }
}

256 257
function _comment_notify_mailalert($comment) {
  $comment = (object) $comment;
258 259 260 261
  global $locale;
  global $base_url;

  $initial_locale = $locale;
262

263 264 265 266 267
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }

268 269 270 271 272 273 274 275 276 277 278 279 280
  $nid = $comment->nid;
  $cid = $comment->cid;
  $commname = $comment->name;
  $commtext = $comment->comment;
  $commsubj = $comment->subject;
  $node = node_load($nid);
  if (!isset($comment->mail)) {
    $comment_account = user_load(array('name' => $commname));
    $comment_mail = $comment_account->mail;
  }
  else {
    $comment_mail = $comment->mail;
  }
281

282
  $from = variable_get('site_mail', ini_get('sendmail_from'));
283

284 285 286 287 288 289 290 291
  $result = db_query('SELECT DISTINCT c.cid, u.init, c.uid, c.name, c.nid, IF(length(c.mail) < 1, ifnull(u.mail, u.init), c.mail) mail, c.uid, c.name, max(cid) cid, md5(concat(c.mail, ifnull(u.mail, u.init), c.uid, c.name, c.nid)) mymd5
    FROM {comments} c LEFT OUTER JOIN {users} u ON u.uid = c.uid
    WHERE nid = %d  AND notify = 1 AND c.status = 0
      AND LENGTH(IF(LENGTH(c.mail) < 1, ifnull(u.mail, u.init), c.mail)) > 1
      AND IF(LENGTH(c.mail) < 1, ifnull(u.mail, u.init), c.mail) like \'%@%.%\'
    GROUP BY IF(LENGTH(c.mail) < 1, ifnull(u.mail, u.init), c.mail), c.name',
    $nid
  );
292

293 294
  $count = 0;
  $sent_to = array();
295

296 297 298 299 300 301
  while ($alert = db_fetch_object($result)) {
    if ($alert->mail != $comment_mail && !in_array($alert->mail, $sent_to) && $alert->uid != $comment->uid) {

      if (function_exists('locale') && $languages[$user->language]) {
        $locale = $user->language;
      }
302

303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
      $subject = t('!site :: new comment for your post.', array('!site' => variable_get('site_name', 'drupal')));
      $message = t(
        variable_get('comment_notify_default_mailtext', DEFAULT_MAILTEXT),
        array(
          '!commname' => $commname,
          '!commtext' => $commtext,
          '!commsubj' => $commsubj,
          '!comment_url' => url('node/'. $nid, NULL, NULL, 1) .'#comment-'. $cid,
          '!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,
          '!uri_brief' => substr($base_url, strlen('http://')),
          '!date' => format_date(time()),
          '!login_uri' => url('user', NULL, NULL, 1),
          '!edit_uri' => url('user/'. $alert->uid .'/edit', NULL, NULL, 1),
          '!link1' => url('comment_notify/disable/'. $alert->mymd5, NULL, NULL, 1)
        )
      );

      drupal_mail('comment_notify_mail', $alert->mail, $subject, $message, $from, array());
      $count++;
      $sent_to[] = $alert->mail;
329

330 331 332
      if ($alert->uid != 0) {
        $watchdog_message = t('Notified: <a href="!url">@user_mail</a>', 
          array('!url' => url('user/'. $alert->uid .'/edit'), '@user_mail' => $alert->mail)) ;
333

334 335 336 337
      }
      else {
        $watchdog_message = t('Notified @user_mail', array('@user_mail' => $alert->mail));
      }
338

339 340 341
      // Add an entry to the watchdog log.
      watchdog('comment_notify', $watchdog_message,
        WATCHDOG_NOTICE, l(t('source comment'), 'node/'. $nid, NULL, NULL, 'comment-'. $alert->cid));
342

343 344
      // revert to previous (site default) locale
      $locale = $initial_locale;
345 346 347 348
    }
  }
}

349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
/**
 * Callback for a form to unsubscribe users.
 */
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;
}
364

365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
/** 
 * Actual unsubscribe of users. 
 */
function comment_notify_unsubscribe_submit($form_id, $form_values) {
  $email = trim($form_values['email_to_unsubscribe']);
  // If they have a uid, use that, otherwise update comments directly
  $result = db_result(db_query_range("SELECT uid FROM {users} WHERE mail = '%s'", $email, 0, 1)); 
  if ($result > 0) {
    $comments = db_result(db_query("SELECT COUNT(1) FROM {comments} WHERE uid = %d AND notify = 1", $result));
    db_query("UPDATE {comments} SET notify = 0 WHERE uid = %d", $result);
  }
  else {
    $comments = db_result(db_query("SELECT COUNT(1) FROM {comments} WHERE mail = '%s' AND notify = 1", $email));
    db_query("UPDATE {comments} SET notify = 0 WHERE mail = '%s'", $email);
  }
  // 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."));
  }
}
389 390


391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
function comment_notify_settings() {
  $form['comment_notify_settings'] = array();
  $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:
414
      <ul>
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
      <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);
440
}