Newer
Older
<?php
// $Id$
/**
* @file
Greg Knaddison
committed
*
* This module provides comment follow-up e-mail notification for anonymous and registered users.
Greg Knaddison
committed
define('DEFAULT_MAILTEXT',
'Hi !name,
Greg Knaddison
committed
!commname has commented on: "!node_title"
The post is about
----
Greg Knaddison
committed
!node_teaser
----
You can view the comment at the following url
Greg Knaddison
committed
!comment_url
Greg Knaddison
committed
You can stop receiving emails when someone replies to this blog post,
by going to !link1
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.
Greg Knaddison
committed
You can set up blog-following feature for all future posts
by creating your own user with a few clicks here !uri/user/register
Thanks for your feedback,
Greg Knaddison
committed
Webmaster of !site
!mission
!uri');
/**
* Implementation of hook_help().
*/
Greg Knaddison
committed
function comment_notify_help($path, $arg) {
switch ($path) {
case 'admin/modules#description':
Greg Knaddison
committed
return t('Comment follow-up e-mail notification for anonymous and registered users.');
break;
}
}
Greg Knaddison
committed
/**
Greg Knaddison
committed
* Insert our checkbox, add a submit button, and populate fields.
Greg Knaddison
committed
function comment_notify_form_alter(&$form, &$form_state, $form_id) {
global $user;
// 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')) {
Greg Knaddison
committed
return;
}
// Only add the checkbox if this is an enabled content type
$node = node_load($form['nid']['#value']);
Greg Knaddison
committed
$enabled_types = variable_get('comment_notify_node_types', array($node->type => TRUE));
if (empty($enabled_types[$node->type])) {
return;
Greg Knaddison
committed
}
Greg Knaddison
committed
// If this is a POST then it is a preview and we remind people that there post isn't done yet.
$op = isset($_POST['op']) ? $_POST['op'] : '';
if ($op == t('Preview comment')) {
Greg Knaddison
committed
drupal_set_message(t('ATTENTION: Your comment is NOT YET posted - please click the post button to confirm your post'));
//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(
Greg Knaddison
committed
'#type' => 'fieldset',
'#title' => t('Comment is not posted yet - please click post button to confirm your post'),
'#weight' => -99,
'#collapsible' => FALSE
);
Greg Knaddison
committed
$form['submitextra']['submit'] = array(
'#type' => 'submit',
'#value' => t('Post comment'),
'#weight' => -20
);
Greg Knaddison
committed
// Add the checkbox for anonymous users and set the default based on admin settings.
Greg Knaddison
committed
if ($user->uid == 0) {
Greg Knaddison
committed
// If anonymous user's can't enter their e-mail don't tempt them with the checkbox
if (empty($form['mail'])) {
return;
}
$form['notify'] = array(
'#type' => 'checkbox',
Greg Knaddison
committed
'#title' => t('Notify me of follow-up comments posted here.'),
Greg Knaddison
committed
'#default_value' => ($user->uid != 0) ? $user->comment_notify_mailalert : variable_get('comment_notify_default_anon_mailalert', TRUE),
);
}
Greg Knaddison
committed
// For registered users and the admin wants them to see the checkbox.
Greg Knaddison
committed
elseif (variable_get('comment_notify_regged_checkbox', TRUE)) {
Greg Knaddison
committed
$user_setting = empty($user->comment_notify_mailalert) ? FALSE : $user->comment_notify_mailalert;
Greg Knaddison
committed
$form['notify'] = array(
'#type' => 'checkbox',
'#title' => t('Notify me of follow-up comments posted here.'),
Greg Knaddison
committed
'#default_value' => ($user->uid != 0) ? $user_setting : variable_get('comment_notify_default_anon_mailalert', TRUE),
Greg Knaddison
committed
'#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'))),
Greg Knaddison
committed
);
}
Greg Knaddison
committed
// For the registered users where the admin wants the checkbox hidden.
Greg Knaddison
committed
else {
$form['notify'] = array(
Greg Knaddison
committed
'#type' => 'hidden',
'#title' => t('Mail me updates to this comment.'),
Greg Knaddison
committed
'#default_value' => $user->comment_notify_mailalert,
Greg Knaddison
committed
// If this is an existing comment we set the default value based on their selection last time.
Greg Knaddison
committed
if ($form['cid']['#value'] != '') {
Greg Knaddison
committed
$notify = db_result(db_query("SELECT notify FROM {comment_notify} WHERE cid = %d", $form['cid']['#value']));
$form['notify']['#default_value'] = $notify;
Greg Knaddison
committed
}
}
Greg Knaddison
committed
/**
Greg Knaddison
committed
* Implementation of hook_perm().
Greg Knaddison
committed
*/
function comment_notify_perm() {
return array('Administer comment notify', 'Subscribe to comments');
Greg Knaddison
committed
}
/**
* Implementation of hook_menu().
*/
Greg Knaddison
committed
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
);
return $items;
}
Greg Knaddison
committed
/**
* Page callback to allow users to unsubscribe simply by visiting the page.
*/
function comment_notify_page() {
global $user;
Greg Knaddison
committed
$op = $_POST['op'];
$edit = $_POST['edit'];
Greg Knaddison
committed
$page_content = ' ';
if (empty($op)) {
$op = arg(1);
}
$arg = arg(2);
switch ($op) {
case 'disable':
Greg Knaddison
committed
$key = $arg;
Greg Knaddison
committed
db_query("UPDATE {comment_notify} c SET c.notify = 0 WHERE notify_hash = '%s'", $arg);
Greg Knaddison
committed
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.');
break;
default;
$title = t('Comment Notify');
break;
}
Greg Knaddison
committed
drupal_set_title($title);
Greg Knaddison
committed
return $page_content;
Greg Knaddison
committed
/**
Greg Knaddison
committed
* Implementation of hook_comment().
*/
function comment_notify_comment($comment, $op) {
global $user;
Greg Knaddison
committed
switch ($op) {
Greg Knaddison
committed
case 'validate':
Greg Knaddison
committed
// 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.
Greg Knaddison
committed
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;
case 'publish':
Greg Knaddison
committed
// The real meat of the module.
Greg Knaddison
committed
_comment_notify_mailalert($comment);
break;
case 'update':
Greg Knaddison
committed
// In case they have changed their status, save it in the database.
Greg Knaddison
committed
$sql = 'UPDATE {comment_notify} SET notify = %d WHERE cid = %d';
Greg Knaddison
committed
db_query($sql, $comment['notify'], $comment['cid']);
Greg Knaddison
committed
case 'insert':
Greg Knaddison
committed
// For new comments, we first build up a string to be used s the md5 identifier for the alert
Greg Knaddison
committed
$mail = empty($comment['mail']) ? $user->mail : $comment['mail'];
$md5_string = $mail . $user->uid . $comment['name'] . $comment['nid'];
Greg Knaddison
committed
// 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));
Greg Knaddison
committed
break;
Greg Knaddison
committed
case 'delete':
db_query("DELETE FROM {comment_notify} WHERE cid = %d", $comment->cid);
break;
}
}
/**
* Implementation of hook_user().
*/
function comment_notify_user($type, &$edit, &$user, $category = NULL) {
switch ($type) {
case 'form':
Greg Knaddison
committed
if ($category == 'account' && user_access('Subscribe to comments', $user)) {
$form = array();
$form['comment_notify_settings'] = array(
Greg Knaddison
committed
'#type' => 'fieldset',
'#title' => t('Comment follow-up notification settings'),
'#weight' => 4,
'#collapsible' => TRUE
);
$form['comment_notify_settings']['comment_notify_mailalert'] = array(
Greg Knaddison
committed
'#type' => 'checkbox',
'#title' => t('Receive comment follow-up notification e-mails'),
Greg Knaddison
committed
'#default_value' => isset($edit['comment_notify_mailalert']) ? $edit['comment_notify_mailalert'] : 0,
Greg Knaddison
committed
'#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.")
Greg Knaddison
committed
);
return $form;
}
Greg Knaddison
committed
break;
}
}
Greg Knaddison
committed
/**
* Private function to send the notifications.
Greg Knaddison
committed
* @param $comment
* The comment array as found in hook_comment $op = publish.
*/
Greg Knaddison
committed
function _comment_notify_mailalert($comment) {
$comment = (object) $comment;
Greg Knaddison
committed
global $language;
global $base_url;
Greg Knaddison
committed
$initial_language = $language;
Greg Knaddison
committed
if (function_exists('locale')) {
Greg Knaddison
committed
$languages = locale_language_list();
$languages = $languages['name'];
}
Greg Knaddison
committed
$nid = $comment->nid;
$cid = $comment->cid;
$node = node_load($nid);
if (!isset($comment->mail)) {
Greg Knaddison
committed
$comment_account = user_load(array('name' => $comment->name));
Greg Knaddison
committed
$comment_mail = $comment_account->mail;
}
else {
$comment_mail = $comment->mail;
}
Greg Knaddison
committed
$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
Greg Knaddison
committed
FROM {comments} c INNER JOIN {comment_notify} cn on c.cid = cn.cid LEFT OUTER JOIN {users} u ON c.uid = u.uid
Greg Knaddison
committed
WHERE nid = %d AND cn.notify = 1 AND c.status = 0 AND (u.status = 1 or u.status = '')", $nid
Greg Knaddison
committed
);
Greg Knaddison
committed
// 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
Greg Knaddison
committed
$count = 0;
$sent_to = array();
Greg Knaddison
committed
while ($alert = db_fetch_object($result)) {
Greg Knaddison
committed
$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) {
Greg Knaddison
committed
$message = array();
if (!empty($alert->uid)) {
$recipient_user = user_load(array('uid' => $alert->uid));
Greg Knaddison
committed
$language = user_preferred_language($recipient_user);
}
else {
$language = language_default();
Greg Knaddison
committed
}
Greg Knaddison
committed
$message['subject'] = t('!site :: new comment for your post.', array('!site' => variable_get('site_name', 'drupal')));
$message['body'][] = drupal_html_to_text(t(
Greg Knaddison
committed
variable_get('comment_notify_default_mailtext', DEFAULT_MAILTEXT),
array(
Greg Knaddison
committed
'!commname' => $comment->name,
'!commtext' => $comment->comment,
'!commsubj' => $comment->subject,
Greg Knaddison
committed
'!comment_url' => url('node/'. $nid, array('absolute' => TRUE)) .'#comment-'. $cid,
Greg Knaddison
committed
'!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' => drupal_substr($base_url, drupal_strlen('http://')),
Greg Knaddison
committed
'!date' => format_date(time()),
Greg Knaddison
committed
'!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))
Greg Knaddison
committed
)
Greg Knaddison
committed
));
drupal_mail('comment_notify', 'comment_notify_mail', $mail, $language, $message);
Greg Knaddison
committed
$count++;
Greg Knaddison
committed
$sent_to[] = $mail;
Greg Knaddison
committed
if ($alert->uid != 0) {
$watchdog_message = 'Notified: <a href="!url">@user_mail</a>';
Greg Knaddison
committed
}
else {
$watchdog_message = 'Notified @user_mail';
Greg Knaddison
committed
}
watchdog('comment_notify', $watchdog_message, array('!url' => url('user/'. $alert->uid .'/edit'), '@user_mail' => $mail),
Greg Knaddison
committed
WATCHDOG_NOTICE, l(t('source comment'), 'node/'. $nid, array('fragment' => 'comment-'. $alert->cid)));
// Add an entry to the watchdog log.
Greg Knaddison
committed
// revert to previous (site default) locale
Greg Knaddison
committed
$language = $initial_language;
}
}
}
Greg Knaddison
committed
function comment_notify_mail($key, &$message, $params) {
$message['subject'] = $params['subject'];
$message['body'][] = $params['body'][0];
}
Greg Knaddison
committed
/**
Greg Knaddison
committed
* Callback for an administrative form to unsubscribe users by e-mail address.
Greg Knaddison
committed
*/
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;
}
Greg Knaddison
committed
/**
Greg Knaddison
committed
* Based on admin submit, do the actual unsubscribe from notifications.
Greg Knaddison
committed
*/
Greg Knaddison
committed
function comment_notify_unsubscribe_submit($form, &$form_state) {
$email = trim($form_state['values']['email_to_unsubscribe']);
Greg Knaddison
committed
// If they have a uid, use that, otherwise update comments directly
Greg Knaddison
committed
$result = db_result(db_query_range("SELECT uid FROM {users} WHERE mail = '%s'", $email, 0, 1));
Greg Knaddison
committed
if ($result > 0) {
Greg Knaddison
committed
$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);
Greg Knaddison
committed
}
else {
Greg Knaddison
committed
$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);
Greg Knaddison
committed
}
// 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."));
}
}
Greg Knaddison
committed
/*
* Page callback for administrative settings form.
*/
Greg Knaddison
committed
function comment_notify_settings() {
$form['comment_notify_settings'] = array();
// Only perform comment_notify for certain node types (default, all)
Greg Knaddison
committed
$anonymous_problems = '';
foreach (node_get_types('names') as $type => $name) {
$checkboxes[$type] = check_plain($name);
$default[] = $type;
Greg Knaddison
committed
// 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);
}
}
}
Greg Knaddison
committed
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))));
}
$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.'),
);
Greg Knaddison
committed
$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:
Greg Knaddison
committed
<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);