comment.module 70.9 KB
Newer Older
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

Dries's avatar
Dries committed
4 5
/**
 * @file
Dries's avatar
 
Dries committed
6
 * Enables users to comment on published content.
Dries's avatar
Dries committed
7 8 9 10 11 12
 *
 * When enabled, the Drupal comment module creates a discussion
 * board for each Drupal node. Users can post comments to discuss
 * a forum topic, weblog post, story, collaborative book page, etc.
 */

13 14
/**
 * Comment is published.
15
 */
Dries's avatar
Dries committed
16
define('COMMENT_PUBLISHED', 0);
17 18 19 20

/**
 * Comment is awaiting approval.
 */
Dries's avatar
Dries committed
21 22 23
define('COMMENT_NOT_PUBLISHED', 1);

/**
24
 * Comments are displayed in a flat list - collapsed.
Dries's avatar
Dries committed
25
 */
26
define('COMMENT_MODE_FLAT_COLLAPSED', 1);
27 28 29 30

/**
 * Comments are displayed in a flat list - expanded.
 */
31
define('COMMENT_MODE_FLAT_EXPANDED', 2);
32 33 34 35

/**
 * Comments are displayed as a threaded list - collapsed.
 */
36
define('COMMENT_MODE_THREADED_COLLAPSED', 3);
37 38 39 40

/**
 * Comments are displayed as a threaded list - expanded.
 */
41
define('COMMENT_MODE_THREADED_EXPANDED', 4);
Dries's avatar
Dries committed
42 43

/**
44
 * Comments are ordered by date - newest first.
Dries's avatar
Dries committed
45
 */
46
define('COMMENT_ORDER_NEWEST_FIRST', 1);
47 48 49 50

/**
 * Comments are ordered by date - oldest first.
 */
51
define('COMMENT_ORDER_OLDEST_FIRST', 2);
Dries's avatar
Dries committed
52 53

/**
54
 * Comment controls should be shown above the comment list.
Dries's avatar
Dries committed
55 56
 */
define('COMMENT_CONTROLS_ABOVE', 0);
57 58 59 60

/**
 * Comment controls should be shown below the comment list.
 */
Dries's avatar
Dries committed
61
define('COMMENT_CONTROLS_BELOW', 1);
62 63 64 65

/**
 * Comment controls should be shown both above and below the comment list.
 */
Dries's avatar
Dries committed
66
define('COMMENT_CONTROLS_ABOVE_BELOW', 2);
67 68 69 70

/**
 * Comment controls are hidden.
 */
Dries's avatar
Dries committed
71 72 73
define('COMMENT_CONTROLS_HIDDEN', 3);

/**
74
 * Anonymous posters may not enter their contact information.
Dries's avatar
Dries committed
75 76
 */
define('COMMENT_ANONYMOUS_MAYNOT_CONTACT', 0);
77 78 79 80

/**
 * Anonymous posters may leave their contact information.
 */
Dries's avatar
Dries committed
81
define('COMMENT_ANONYMOUS_MAY_CONTACT', 1);
82 83 84 85

/**
 * Anonymous posters must leave their contact information.
 */
Dries's avatar
Dries committed
86 87 88
define('COMMENT_ANONYMOUS_MUST_CONTACT', 2);

/**
89
 * Comment form should be displayed on a separate page.
Dries's avatar
Dries committed
90 91
 */
define('COMMENT_FORM_SEPARATE_PAGE', 0);
92 93 94 95

/**
 * Comment form should be shown below post or list of comments.
 */
Dries's avatar
Dries committed
96 97 98
define('COMMENT_FORM_BELOW', 1);

/**
99
 * Comments for this node are disabled.
Dries's avatar
Dries committed
100 101
 */
define('COMMENT_NODE_DISABLED', 0);
102 103 104 105

/**
 * Comments for this node are locked.
 */
Dries's avatar
Dries committed
106
define('COMMENT_NODE_READ_ONLY', 1);
107 108 109 110

/**
 * Comments are enabled on this node.
 */
Dries's avatar
Dries committed
111
define('COMMENT_NODE_READ_WRITE', 2);
112

113
/**
114
 * Comment preview is optional.
115 116
 */
define('COMMENT_PREVIEW_OPTIONAL', 0);
117 118 119 120

/**
 * Comment preview is required.
 */
121 122
define('COMMENT_PREVIEW_REQUIRED', 1);

123 124 125
/**
 * Implementation of hook_help().
 */
126
function comment_help($section) {
Dries's avatar
 
Dries committed
127
  switch ($section) {
Dries's avatar
 
Dries committed
128
    case 'admin/help#comment':
129
      $output = '<p>'. t('The comment module creates a discussion board for each post. Users can post comments to discuss a forum topic, weblog post, story, collaborative book page, etc. The ability to comment is an important part of involving members in a community dialogue.') .'</p>';
130
      $output .= '<p>'. t('An administrator can give comment permissions to user groups, and users can (optionally) edit their last comment, assuming no others have been posted since. Attached to each comment board is a control panel for customizing the way that comments are displayed. Users can control the chronological ordering of posts (newest or oldest first) and the number of posts to display on each page. Comments behave like other user submissions. Filters, smileys and HTML that work in nodes will also work with comments. The comment module provides specific features to inform site members when new comments have been posted.') .'</p>';
131
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="@comment">Comment page</a>.', array('@comment' => 'http://drupal.org/handbook/modules/comment/')) .'</p>';
132
      return $output;
133 134
    case 'admin/content/comment':
    case 'admin/content/comment/new':
135
      return '<p>'. t("Below is a list of the latest comments posted to your site. Click on a subject to see the comment, the author's name to edit the author's user information , 'edit' to modify the text, and 'delete' to remove their submission.") .'</p>';
136
    case 'admin/content/comment/approval':
137
      return '<p>'. t("Below is a list of the comments posted to your site that need approval. To approve a comment, click on 'edit' and then change its 'moderation status' to Approved. Click on a subject to see the comment, the author's name to edit the author's user information, 'edit' to modify the text, and 'delete' to remove their submission.") .'</p>';
138
    case 'admin/content/comment/settings':
139
      return '<p>'. t("Comments can be attached to any node, and their settings are below. The display comes in two types: a 'flat list' where everything is flush to the left side, and comments come in chronological order, and a 'threaded list' where replies to other comments are placed immediately below and slightly indented, forming an outline. They also come in two styles: 'expanded', where you see both the title and the contents, and 'collapsed' where you only see the title. Preview comment forces a user to look at their comment by clicking on a 'Preview' button before they can actually add the comment.") .'</p>';
140
   }
Dries's avatar
 
Dries committed
141 142
}

Dries's avatar
 
Dries committed
143 144 145
/**
 * Implementation of hook_menu().
 */
Dries's avatar
 
Dries committed
146
function comment_menu($may_cache) {
Dries's avatar
 
Dries committed
147 148
  $items = array();

Dries's avatar
 
Dries committed
149 150
  if ($may_cache) {
    $access = user_access('administer comments');
151 152
    $items[] = array(
      'path' => 'admin/content/comment',
153
      'title' => t('Comments'),
154
      'description' => t('List and edit site comments and the comment moderation queue.'),
155
      'callback' => 'comment_admin',
156 157
      'access' => $access
    );
Dries's avatar
 
Dries committed
158 159

    // Tabs:
160
    $items[] = array('path' => 'admin/content/comment/list', 'title' => t('List'),
Dries's avatar
 
Dries committed
161 162 163
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);

    // Subtabs:
164
    $items[] = array('path' => 'admin/content/comment/list/new', 'title' => t('Published comments'),
Dries's avatar
 
Dries committed
165
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
166
    $items[] = array('path' => 'admin/content/comment/list/approval', 'title' => t('Approval queue'),
167 168
      'callback' => 'comment_admin',
      'callback arguments' => array('approval'),
169
      'access' => $access,
Dries's avatar
 
Dries committed
170 171
      'type' => MENU_LOCAL_TASK);

Dries's avatar
Dries committed
172
    $items[] = array(
173
      'path' => 'admin/content/comment/settings',
174
      'title' => t('Settings'),
175 176
      'callback' => 'drupal_get_form',
      'callback arguments' => array('comment_admin_settings'),
Dries's avatar
Dries committed
177
      'access' => $access,
178 179
      'weight' => 10,
      'type' => MENU_LOCAL_TASK);
180

181
    $items[] = array('path' => 'comment/delete', 'title' => t('Delete comment'),
182
      'callback' => 'comment_delete', 'access' => $access, 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
183 184

    $access = user_access('post comments');
185
    $items[] = array('path' => 'comment/edit', 'title' => t('Edit comment'),
186 187
      'callback' => 'comment_edit',
      'access' => $access, 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
188
  }
Dries's avatar
 
Dries committed
189 190
  else {
    if (arg(0) == 'comment' && arg(1) == 'reply' && is_numeric(arg(2))) {
191
      $node = node_load(arg(2));
Dries's avatar
 
Dries committed
192
      if ($node->nid) {
193
        $items[] = array('path' => 'comment/reply', 'title' => t('Reply to comment'),
Dries's avatar
 
Dries committed
194 195 196 197
          'callback' => 'comment_reply', 'access' => node_access('view', $node), 'type' => MENU_CALLBACK);
      }
    }
    if ((arg(0) == 'node') && is_numeric(arg(1)) && is_numeric(arg(2))) {
198 199 200 201 202 203 204
      $items[] = array(
        'path' => ('node/'. arg(1) .'/'. arg(2)),
        'title' => t('View'),
        'callback' => 'node_page_view',
        'callback arguments' => array(node_load(arg(1)), arg(2)),
        'type' => MENU_CALLBACK,
      );
Dries's avatar
 
Dries committed
205
    }
Dries's avatar
 
Dries committed
206
  }
Dries's avatar
 
Dries committed
207 208 209 210 211 212 213 214

  return $items;
}

/**
 * Implementation of hook_perm().
 */
function comment_perm() {
215
  return array('access comments', 'post comments', 'administer comments', 'post comments without approval');
Dries's avatar
 
Dries committed
216 217 218 219 220 221 222 223 224 225 226 227
}

/**
 * Implementation of hook_block().
 *
 * Generates a block with the most recent comments.
 */
function comment_block($op = 'list', $delta = 0) {
  if ($op == 'list') {
    $blocks[0]['info'] = t('Recent comments');
    return $blocks;
  }
228
  else if ($op == 'view' && user_access('access comments')) {
Dries's avatar
 
Dries committed
229
    $block['subject'] = t('Recent comments');
230
    $block['content'] = theme('comment_block');
Dries's avatar
 
Dries committed
231 232 233 234
    return $block;
  }
}

235
function theme_comment_block() {
236
  $result = db_query_range(db_rewrite_sql('SELECT c.nid, c.subject, c.cid, c.timestamp FROM {comments} c INNER JOIN {node} n ON n.nid = c.nid WHERE n.status = 1 AND c.status = %d ORDER BY c.timestamp DESC', 'c'), COMMENT_PUBLISHED, 0, 10);
237 238
  $items = array();
  while ($comment = db_fetch_object($result)) {
239
    $items[] = l($comment->subject, 'node/'. $comment->nid, NULL, NULL, 'comment-'. $comment->cid) .'<br />'. t('@time ago', array('@time' => format_interval(time() - $comment->timestamp)));
240
  }
241 242 243
  if ($items) {
    return theme('item_list', $items);
  }
244 245
}

Dries's avatar
 
Dries committed
246 247 248
/**
 * Implementation of hook_link().
 */
249
function comment_link($type, $node = NULL, $teaser = FALSE) {
Dries's avatar
 
Dries committed
250 251 252 253
  $links = array();

  if ($type == 'node' && $node->comment) {

254
    if ($teaser) {
Dries's avatar
 
Dries committed
255 256 257 258 259 260 261
      // Main page: display the number of comments that have been posted.

      if (user_access('access comments')) {
        $all = comment_num_all($node->nid);
        $new = comment_num_new($node->nid);

        if ($all) {
262
          $links['comment_comments'] = array(
263
            'title' => format_plural($all, '1 comment', '@count comments'),
264 265
            'href' => "node/$node->nid",
            'attributes' => array('title' => t('Jump to the first comment of this posting.')),
266
            'fragment' => 'comments'
267
          );
Dries's avatar
 
Dries committed
268 269

          if ($new) {
270
            $links['comment_new_comments'] = array(
271
              'title' => format_plural($new, '1 new comment', '@count new comments'),
272 273 274
              'href' => "node/$node->nid",
              'attributes' => array('title' => t('Jump to the first new comment of this posting.')),
              'fragment' => 'new'
275
            );
Dries's avatar
 
Dries committed
276 277 278
          }
        }
        else {
Dries's avatar
Dries committed
279
          if ($node->comment == COMMENT_NODE_READ_WRITE) {
Dries's avatar
 
Dries committed
280
            if (user_access('post comments')) {
281
              $links['comment_add'] = array(
282
                'title' => t('Add new comment'),
283 284 285
                'href' => "comment/reply/$node->nid",
                'attributes' => array('title' => t('Add a new comment to this page.')),
                'fragment' => 'comment_form'
286
              );
Dries's avatar
 
Dries committed
287 288
            }
            else {
289
              $links['comment_forbidden']['title'] = theme('comment_post_forbidden', $node->nid);
Dries's avatar
 
Dries committed
290 291 292 293 294 295 296 297 298
            }
          }
        }
      }
    }
    else {
      // Node page: add a "post comment" link if the user is allowed to
      // post comments, if this node is not read-only, and if the comment form isn't already shown

299
      if ($node->comment == COMMENT_NODE_READ_WRITE) {
Dries's avatar
 
Dries committed
300
        if (user_access('post comments')) {
301
          if (variable_get('comment_form_location', COMMENT_FORM_SEPARATE_PAGE) == COMMENT_FORM_SEPARATE_PAGE) {
302
            $links['comment_add'] = array(
303
              'title' => t('Add new comment'),
304 305 306
              'href' => "comment/reply/$node->nid",
              'attributes' => array('title' => t('Share your thoughts and opinions related to this posting.')),
              'fragment' => 'comment_form'
307
            );
308
          }
Dries's avatar
 
Dries committed
309 310
        }
        else {
311
          $links['comment_forbidden']['title'] = theme('comment_post_forbidden', $node->nid);
Dries's avatar
 
Dries committed
312 313 314 315 316 317
        }
      }
    }
  }

  if ($type == 'comment') {
318
    $links = comment_links($node, $teaser);
Dries's avatar
 
Dries committed
319
  }
320 321 322
  if (isset($links['comment_forbidden'])) {
    $links['comment_forbidden']['html'] = TRUE;
  }
Dries's avatar
 
Dries committed
323 324 325 326

  return $links;
}

327
function comment_form_alter($form_id, &$form) {
328 329 330 331
  if ($form_id == 'node_type_form' && isset($form['identity']['type'])) {
    $form['workflow']['comment'] = array(
      '#type' => 'radios',
      '#title' => t('Default comment setting'),
332
      '#default_value' => variable_get('comment_'. $form['#node_type']->type, COMMENT_NODE_READ_WRITE),
333 334 335 336 337
      '#options' => array(t('Disabled'), t('Read only'), t('Read/Write')),
      '#description' => t('Users with the <em>administer comments</em> permission will be able to override this setting.'),
    );
  }
  elseif (isset($form['type'])) {
338
    if ($form['type']['#value'] .'_node_form' == $form_id) {
339
      $node = $form['#node'];
340 341 342 343 344 345 346 347 348 349 350 351 352 353
      $form['comment_settings'] = array(
        '#type' => 'fieldset',
        '#access' => user_access('administer comments'),
        '#title' => t('Comment settings'),
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
        '#weight' => 30,
      );
      $form['comment_settings']['comment'] = array(
        '#type' => 'radios',
        '#parents' => array('comment'),
        '#default_value' => $node->comment,
        '#options' => array(t('Disabled'), t('Read only'), t('Read/Write')),
      );
354
    }
355 356 357
  }
}

Dries's avatar
 
Dries committed
358 359
/**
 * Implementation of hook_nodeapi().
Dries's avatar
 
Dries committed
360
 *
Dries's avatar
 
Dries committed
361 362 363
 */
function comment_nodeapi(&$node, $op, $arg = 0) {
  switch ($op) {
Dries's avatar
 
Dries committed
364
    case 'load':
365
      return db_fetch_array(db_query("SELECT last_comment_timestamp, last_comment_name, comment_count FROM {node_comment_statistics} WHERE nid = %d", $node->nid));
366 367 368 369
      break;

    case 'prepare':
      if (!isset($node->comment)) {
Dries's avatar
Dries committed
370
        $node->comment = variable_get("comment_$node->type", COMMENT_NODE_READ_WRITE);
Dries's avatar
 
Dries committed
371 372
      }
      break;
373

374 375 376 377 378 379 380 381 382
    case 'insert':
      db_query('INSERT INTO {node_comment_statistics} (nid, last_comment_timestamp, last_comment_name, last_comment_uid, comment_count) VALUES (%d, %d, NULL, %d, 0)', $node->nid, $node->created, $node->uid);
      break;

    case 'delete':
      db_query('DELETE FROM {comments} WHERE nid = %d', $node->nid);
      db_query('DELETE FROM {node_comment_statistics} WHERE nid = %d', $node->nid);
      break;

Dries's avatar
Dries committed
383 384
    case 'update index':
      $text = '';
385
      $comments = db_query('SELECT subject, comment, format FROM {comments} WHERE nid = %d AND status = %d', $node->nid, COMMENT_PUBLISHED);
Dries's avatar
Dries committed
386
      while ($comment = db_fetch_object($comments)) {
387
        $text .= '<h2>'. check_plain($comment->subject) .'</h2>'. check_markup($comment->comment, $comment->format, FALSE);
Dries's avatar
Dries committed
388 389
      }
      return $text;
390

Dries's avatar
Dries committed
391 392
    case 'search result':
      $comments = db_result(db_query('SELECT comment_count FROM {node_comment_statistics} WHERE nid = %d', $node->nid));
393
      return format_plural($comments, '1 comment', '@count comments');
394

Steven Wittens's avatar
- Typo  
Steven Wittens committed
395
    case 'rss item':
396
      if ($node->comment != COMMENT_NODE_DISABLED) {
397
        return array(array('key' => 'comments', 'value' => url('node/'. $node->nid, NULL, 'comments', TRUE)));
398 399 400 401
      }
      else {
        return array();
      }
Dries's avatar
 
Dries committed
402 403 404 405 406 407 408 409 410 411 412
  }
}

/**
 * Implementation of hook_user().
 *
 * Provides signature customization for the user's comments.
 */
function comment_user($type, $edit, &$user, $category = NULL) {
  if ($type == 'form' && $category == 'account') {
    // when user tries to edit his own data
413 414 415 416 417 418 419 420 421 422
    $form['comment_settings'] = array(
      '#type' => 'fieldset',
      '#title' => t('Comment settings'),
      '#collapsible' => TRUE,
      '#weight' => 4);
    $form['comment_settings']['signature'] = array(
      '#type' => 'textarea',
      '#title' => t('Signature'),
      '#default_value' => $edit['signature'],
      '#description' => t('Your signature will be publicly displayed at the end of your comments.'));
423 424

    return $form;
Dries's avatar
 
Dries committed
425
  }
426 427 428 429
  elseif ($type == 'delete') {
    db_query('UPDATE {comments} SET uid = 0 WHERE uid = %d', $user->uid);
    db_query('UPDATE {node_comment_statistics} SET last_comment_uid = 0 WHERE last_comment_uid = %d', $user->uid);
  }
Dries's avatar
 
Dries committed
430 431
}

432
/**
Dries's avatar
 
Dries committed
433
 * Menu callback; presents the comment settings page.
434
 */
Dries's avatar
Dries committed
435
function comment_admin_settings() {
436 437
  $form['viewing_options'] = array(
    '#type' => 'fieldset',
438
    '#title' => t('Viewing options'),
439 440
    '#collapsible' => TRUE,
  );
Dries's avatar
 
Dries committed
441

Dries's avatar
Dries committed
442 443 444 445 446
  $form['viewing_options']['comment_default_mode'] = array(
    '#type' => 'radios',
    '#title' => t('Default display mode'),
    '#default_value' => variable_get('comment_default_mode', COMMENT_MODE_THREADED_EXPANDED),
    '#options' => _comment_get_modes(),
447
    '#description' => t('The default view for comments. Expanded views display the body of the comment. Threaded views keep replies together.'),
Dries's avatar
Dries committed
448
  );
449

Dries's avatar
Dries committed
450 451 452
  $form['viewing_options']['comment_default_order'] = array(
    '#type' => 'radios',
    '#title' => t('Default display order'),
453
    '#default_value' => variable_get('comment_default_order', COMMENT_ORDER_NEWEST_FIRST),
Dries's avatar
Dries committed
454
    '#options' => _comment_get_orders(),
455
    '#description' => t('The default sorting for new users and anonymous users while viewing comments. These users may change their view using the comment control panel. For registered users, this change is remembered as a persistent user preference.'),
Dries's avatar
Dries committed
456
  );
Dries's avatar
 
Dries committed
457

458
  $form['viewing_options']['comment_default_per_page'] = array(
459 460 461 462
    '#type' => 'select',
    '#title' => t('Default comments per page'),
    '#default_value' => variable_get('comment_default_per_page', 50),
    '#options' => _comment_per_page(),
463
    '#description' => t('Default number of comments for each page: more comments are distributed in several pages.'),
464 465
  );

Dries's avatar
Dries committed
466 467 468 469 470 471 472 473 474
  $form['viewing_options']['comment_controls'] = array(
    '#type' => 'radios',
    '#title' => t('Comment controls'),
    '#default_value' => variable_get('comment_controls', COMMENT_CONTROLS_HIDDEN),
    '#options' => array(
      t('Display above the comments'),
      t('Display below the comments'),
      t('Display above and below the comments'),
      t('Do not display')),
475
    '#description' => t('Position of the comment controls box. The comment controls let the user change the default display mode and display order of comments.'),
Dries's avatar
Dries committed
476
  );
477

478 479
  $form['posting_settings'] = array(
    '#type' => 'fieldset',
480
    '#title' => t('Posting settings'),
481 482
    '#collapsible' => TRUE,
  );
483

Dries's avatar
Dries committed
484 485
  $form['posting_settings']['comment_anonymous'] = array(
    '#type' => 'radios',
486
    '#title' => t('Anonymous commenting'),
Dries's avatar
Dries committed
487 488 489 490 491
    '#default_value' => variable_get('comment_anonymous', COMMENT_ANONYMOUS_MAYNOT_CONTACT),
    '#options' => array(
      COMMENT_ANONYMOUS_MAYNOT_CONTACT => t('Anonymous posters may not enter their contact information'),
      COMMENT_ANONYMOUS_MAY_CONTACT => t('Anonymous posters may leave their contact information'),
      COMMENT_ANONYMOUS_MUST_CONTACT => t('Anonymous posters must leave their contact information')),
492
    '#description' => t('This option is enabled when anonymous users have permission to post comments on the <a href="@url">permissions page</a>.', array('@url' => url('admin/user/access', NULL, 'module-comment'))),
Dries's avatar
Dries committed
493
  );
494
  if (!user_access('post comments', user_load(array('uid' => 0)))) {
495
    $form['posting_settings']['comment_anonymous']['#disabled'] = TRUE;
496
  }
497 498

  $form['posting_settings']['comment_subject_field'] = array(
499 500 501 502
    '#type' => 'radios',
    '#title' => t('Comment subject field'),
    '#default_value' => variable_get('comment_subject_field', 1),
    '#options' => array(t('Disabled'), t('Enabled')),
503
    '#description' => t('Can users provide a unique subject for their comments?'),
504 505
  );

506 507 508 509 510 511
  $form['posting_settings']['comment_preview'] = array(
    '#type' => 'radios',
    '#title' => t('Preview comment'),
    '#default_value' => variable_get('comment_preview', COMMENT_PREVIEW_REQUIRED),
    '#options' => array(t('Optional'), t('Required')),
  );
512

Dries's avatar
Dries committed
513 514 515 516
  $form['posting_settings']['comment_form_location'] = array(
    '#type' => 'radios',
    '#title' => t('Location of comment submission form'),
    '#default_value' => variable_get('comment_form_location', COMMENT_FORM_SEPARATE_PAGE),
517
    '#options' => array(t('Display on separate page'), t('Display below post or comments')),
Dries's avatar
Dries committed
518
  );
519

520
  return system_settings_form($form);
Dries's avatar
 
Dries committed
521 522
}

523 524 525 526 527 528
/**
 * This is *not* a hook_access() implementation. This function is called
 * to determine whether the current user has access to a particular comment.
 *
 * Authenticated users can edit their comments as long they have not been
 * replied to. This prevents people from changing or revising their
529
 * statements based on the replies to their posts.
530
 */
Dries's avatar
 
Dries committed
531
function comment_access($op, $comment) {
Dries's avatar
 
Dries committed
532 533
  global $user;

534
  if ($op == 'edit') {
535
    return ($user->uid && $user->uid == $comment->uid && comment_num_replies($comment->cid) == 0) || user_access('administer comments');
Dries's avatar
 
Dries committed
536 537
  }
}
538

Dries's avatar
 
Dries committed
539
function comment_node_url() {
Dries's avatar
Dries committed
540
  return arg(0) .'/'. arg(1);
Dries's avatar
 
Dries committed
541
}
Dries's avatar
 
Dries committed
542

Dries's avatar
 
Dries committed
543 544 545
function comment_edit($cid) {
  global $user;

546
  $comment = db_fetch_object(db_query('SELECT c.*, u.uid, u.name AS registered_name, u.data FROM {comments} c INNER JOIN {users} u ON c.uid = u.uid WHERE c.cid = %d', $cid));
Dries's avatar
 
Dries committed
547
  $comment = drupal_unpack($comment);
548
  $comment->name = $comment->uid ? $comment->registered_name : $comment->name;
549
  if (comment_access('edit', $comment)) {
550
    return comment_form_box((array)$comment);
551 552 553
  }
  else {
    drupal_access_denied();
Dries's avatar
 
Dries committed
554 555 556
  }
}

557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
/**
 * This function is responsible for generating a comment reply form.
 * There are several cases that have to be handled, including:
 *   - replies to comments
 *   - replies to nodes
 *   - attempts to reply to nodes that can no longer accept comments
 *   - respecting access permissions ('access comments', 'post comments', etc.)
 *
 * The node or comment that is being replied to must appear above the comment
 * form to provide the user context while authoring the comment.
 *
 * @param $nid
 *   Every comment belongs to a node. This is that node's id.
 * @param $pid
 *   Some comments are replies to other comments. In those cases, $pid is the parent
 *   comment's cid.
 *
 * @return $output
 *   The rendered parent node or comment plus the new comment form.
 */
Dries's avatar
Dries committed
577
function comment_reply($nid, $pid = NULL) {
578
  // Load the parent node.
579
  $node = node_load($nid);
580 581

  // Set the breadcrumb trail.
582
  menu_set_location(array(array('path' => "node/$nid", 'title' => $node->title), array('path' => "comment/reply/$nid")));
Dries's avatar
 
Dries committed
583

584
  $op = isset($_POST['op']) ? $_POST['op'] : '';
Dries's avatar
 
Dries committed
585

586
  $output = '';
Dries's avatar
 
Dries committed
587

Dries's avatar
Dries committed
588
  if (user_access('access comments')) {
589
    // The user is previewing a comment prior to submitting it.
590 591
    if ($op == t('Preview comment')) {
      if (user_access('post comments')) {
592
        $output .= comment_form_box(array('pid' => $pid, 'nid' => $nid), NULL);
593 594 595
      }
      else {
        drupal_set_message(t('You are not authorized to post comments.'), 'error');
596
        drupal_goto("node/$nid");
597
      }
Dries's avatar
 
Dries committed
598 599
    }
    else {
600
      // $pid indicates that this is a reply to a comment.
601
      if ($pid) {
602
        // load the comment whose cid = $pid
603
        if ($comment = db_fetch_object(db_query('SELECT c.*, u.uid, u.name AS registered_name, u.picture, u.data FROM {comments} c INNER JOIN {users} u ON c.uid = u.uid WHERE c.cid = %d AND c.status = %d', $pid, COMMENT_PUBLISHED))) {
604 605
          // If that comment exists, make sure that the current comment and the parent comment both
          // belong to the same parent node.
606 607 608 609 610
          if ($comment->nid != $nid) {
            // Attempting to reply to a comment not belonging to the current nid.
            drupal_set_message(t('The comment you are replying to does not exist.'), 'error');
            drupal_goto("node/$nid");
          }
611
          // Display the parent comment
612 613 614 615 616 617 618 619
          $comment = drupal_unpack($comment);
          $comment->name = $comment->uid ? $comment->registered_name : $comment->name;
          $output .= theme('comment_view', $comment);
        }
        else {
          drupal_set_message(t('The comment you are replying to does not exist.'), 'error');
          drupal_goto("node/$nid");
        }
620
      }
621
      // This is the case where the comment is in response to a node. Display the node.
622 623 624 625
      else if (user_access('access content')) {
        $output .= node_view($node);
      }

626
      // Should we show the reply box?
627 628
      if (node_comment_mode($nid) != COMMENT_NODE_READ_WRITE) {
        drupal_set_message(t("This discussion is closed: you can't post new comments."), 'error');
629
        drupal_goto("node/$nid");
630 631
      }
      else if (user_access('post comments')) {
632
        $output .= comment_form_box(array('pid' => $pid, 'nid' => $nid), t('Reply'));
633 634 635
      }
      else {
        drupal_set_message(t('You are not authorized to post comments.'), 'error');
636
        drupal_goto("node/$nid");
637
      }
Dries's avatar
 
Dries committed
638
    }
Kjartan's avatar
Kjartan committed
639 640
  }
  else {
641
    drupal_set_message(t('You are not authorized to view comments.'), 'error');
642
    drupal_goto("node/$nid");
Dries's avatar
 
Dries committed
643
  }
Dries's avatar
 
Dries committed
644

Dries's avatar
 
Dries committed
645
  return $output;
Dries's avatar
 
Dries committed
646 647
}

648 649 650 651 652 653 654
/**
 * Accepts a submission of new or changed comment content.
 *
 * @param $edit
 *   A comment array.
 *
 * @return
655
 *   If the comment is successfully saved the comment ID is returned. If the comment
656 657 658
 *   is not saved, FALSE is returned.
 */
function comment_save($edit) {
Dries's avatar
 
Dries committed
659
  global $user;
660
  if (user_access('post comments') && (user_access('administer comments') || node_comment_mode($edit['nid']) == COMMENT_NODE_READ_WRITE)) {
Dries's avatar
 
Dries committed
661
    if (!form_get_errors()) {
662
      // Check for duplicate comments. Note that we have to use the
663
      // validated/filtered data to perform such check.
664
      $duplicate = db_result(db_query("SELECT COUNT(cid) FROM {comments} WHERE pid = %d AND nid = %d AND subject = '%s' AND comment = '%s'", $edit['pid'], $edit['nid'], $edit['subject'], $edit['comment']), 0);
Dries's avatar
 
Dries committed
665
      if ($duplicate != 0) {
666
        watchdog('content', t('Comment: duplicate %subject.', array('%subject' => $edit['subject'])), WATCHDOG_WARNING);
Dries's avatar
 
Dries committed
667
      }
Dries's avatar
 
Dries committed
668

669
      if ($edit['cid']) {
670
        // Update the comment in the database.
671
        db_query("UPDATE {comments} SET status = %d, timestamp = %d, subject = '%s', comment = '%s', format = %d, uid = %d, name = '%s', mail = '%s', homepage = '%s' WHERE cid = %d", $edit['status'], $edit['timestamp'], $edit['subject'], $edit['comment'], $edit['format'], $edit['uid'], $edit['name'], $edit['mail'], $edit['homepage'], $edit['cid']);
Dries's avatar
 
Dries committed
672

Dries's avatar
 
Dries committed
673 674
        _comment_update_node_statistics($edit['nid']);

675
        // Allow modules to respond to the updating of a comment.
676 677
        comment_invoke_comment($edit, 'update');

Dries's avatar
 
Dries committed
678

Dries's avatar
Dries committed
679
        // Add an entry to the watchdog log.
680
        watchdog('content', t('Comment: updated %subject.', array('%subject' => $edit['subject'])), WATCHDOG_NOTICE, l(t('view'), 'node/'. $edit['nid'], NULL, NULL, 'comment-'. $edit['cid']));
Dries's avatar
 
Dries committed
681 682
      }
      else {
683
        // Add the comment to database.
684
        $status = user_access('post comments without approval') ? COMMENT_PUBLISHED : COMMENT_NOT_PUBLISHED;
685
        $roles = variable_get('comment_roles', array());
Dries's avatar
 
Dries committed
686 687 688 689 690 691
        $score = 0;

        foreach (array_intersect(array_keys($roles), array_keys($user->roles)) as $rid) {
          $score = max($roles[$rid], $score);
        }

Dries's avatar
 
Dries committed
692 693
        $users = serialize(array(0 => $score));

694 695
        // Here we are building the thread field. See the documentation for
        // comment_render().
696
        if ($edit['pid'] == 0) {
697 698
          // This is a comment with no parent comment (depth 0): we start
          // by retrieving the maximum thread level.
699
          $max = db_result(db_query('SELECT MAX(thread) FROM {comments} WHERE nid = %d', $edit['nid']));
Dries's avatar
 
Dries committed
700

701 702
          // Strip the "/" from the end of the thread.
          $max = rtrim($max, '/');
Dries's avatar
 
Dries committed
703

704
          // Finally, build the thread field for this new comment.
705
          $thread = int2vancode(vancode2int($max) + 1) .'/';
Dries's avatar
 
Dries committed
706 707
        }
        else {
708 709
          // This is comment with a parent comment: we increase
          // the part of the thread value at the proper depth.
Dries's avatar
 
Dries committed
710 711

          // Get the parent comment:
712
          $parent = _comment_load($edit['pid']);
Dries's avatar
 
Dries committed
713

714
          // Strip the "/" from the end of the parent thread.
715
          $parent->thread = (string) rtrim((string) $parent->thread, '/');
Dries's avatar
 
Dries committed
716

717
          // Get the max value in _this_ thread.
Dries's avatar
 
Dries committed
718
          $max = db_result(db_query("SELECT MAX(thread) FROM {comments} WHERE thread LIKE '%s.%%' AND nid = %d", $parent->thread, $edit['nid']));
Dries's avatar
 
Dries committed
719

720 721
          if ($max == '') {
            // First child of this parent.
722
            $thread = $parent->thread .'.'. int2vancode(0) .'/';
Dries's avatar
 
Dries committed
723 724
          }
          else {
725 726
            // Strip the "/" at the end of the thread.
            $max = rtrim($max, '/');
Dries's avatar
 
Dries committed
727

728 729 730
            // We need to get the value at the correct depth.
            $parts = explode('.', $max);
            $parent_depth = count(explode('.', $parent->thread));
Dries's avatar
 
Dries committed
731 732
            $last = $parts[$parent_depth];

733
            // Finally, build the thread field for this new comment.
734
            $thread = $parent->thread .'.'. int2vancode(vancode2int($last) + 1) .'/';
Dries's avatar
 
Dries committed
735 736 737
          }
        }

738
        $edit['cid'] = db_next_id('{comments}_cid');
Dries's avatar
 
Dries committed
739 740
        $edit['timestamp'] = time();

741
        if ($edit['uid'] === $user->uid) { // '===' because we want to modify anonymous users too
Dries's avatar
 
Dries committed
742 743 744
          $edit['name'] = $user->name;
        }

745
        db_query("INSERT INTO {comments} (cid, nid, pid, uid, subject, comment, format, hostname, timestamp, status, score, users, thread, name, mail, homepage) VALUES (%d, %d, %d, %d, '%s', '%s', %d, '%s', %d, %d, %d, '%s', '%s', '%s', '%s', '%s')", $edit['cid'], $edit['nid'], $edit['pid'], $edit['uid'], $edit['subject'], $edit['comment'], $edit['format'], $_SERVER['REMOTE_ADDR'], $edit['timestamp'], $status, $score, $users, $thread, $edit['name'], $edit['mail'], $edit['homepage']);
Dries's avatar
 
Dries committed
746 747

        _comment_update_node_statistics($edit['nid']);
Dries's avatar
 
Dries committed
748

749
        // Tell the other modules a new comment has been submitted.
750
        comment_invoke_comment($edit, 'insert');
Dries's avatar
 
Dries committed
751

752
        // Add an entry to the watchdog log.
753
        watchdog('content', t('Comment: added %subject.', array('%subject' => $edit['subject'])), WATCHDOG_NOTICE, l(t('view'), 'node/'. $edit['nid'], NULL, NULL, 'comment-'. $edit['cid']));
Dries's avatar
 
Dries committed
754
      }
Dries's avatar
 
Dries committed
755

756
      // Clear the cache so an anonymous user can see his comment being added.
Dries's avatar
 
Dries committed
757
      cache_clear_all();
Dries's avatar
 
Dries committed
758

Dries's avatar
 
Dries committed
759
      // Explain the approval queue if necessary, and then
Dries's avatar
 
Dries committed
760
      // redirect the user to the node he's commenting on.
761
      if ($status == COMMENT_NOT_PUBLISHED) {
Dries's avatar
 
Dries committed
762
        drupal_set_message(t('Your comment has been queued for moderation by site administrators and will be published after approval.'));
Dries's avatar
 
Dries committed
763
      }
764
      return $edit['cid'];
Dries's avatar
 
Dries committed
765 766
    }
    else {
767
      return FALSE;
Dries's avatar
 
Dries committed
768 769
    }
  }
Dries's avatar
 
Dries committed
770
  else {
771
    $txt = t('Comment: unauthorized comment submitted or comment submitted to a closed node %subject.', array('%subject' => $edit['subject']));
772 773 774
    watchdog('content', $txt, WATCHDOG_WARNING);
    drupal_set_message($txt, 'error');
    return FALSE;
Dries's avatar
 
Dries committed
775 776 777 778
  }
}

function comment_links($comment, $return = 1) {
Dries's avatar
 
Dries committed
779
  global $user;
Dries's avatar
 
Dries committed
780

Dries's avatar
 
Dries committed
781
  $links = array();
Dries's avatar
 
Dries committed
782

783
  // If we are viewing just this comment, we link back to the node.
Dries's avatar
 
Dries committed
784
  if ($return) {