comment.module 58.6 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
/*
Dries's avatar
Dries committed
14
 * Constants to define a comment's published state
15
 */
Dries's avatar
Dries committed
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
define('COMMENT_PUBLISHED', 0);
define('COMMENT_NOT_PUBLISHED', 1);

/**
 * Constants to define the viewing modes for comment listings
 */
define('COMMENT_MODE_FLAT_COLLAPSED', 0);
define('COMMENT_MODE_FLAT_EXPANDED', 1);
define('COMMENT_MODE_THREADED_COLLAPSED', 2);
define('COMMENT_MODE_THREADED_EXPANDED', 3);

/**
 * Constants to define the viewing orders for comment listings
 */
define('COMMENT_ORDER_NEWEST_FIRST', 0);
define('COMMENT_ORDER_OLDEST_FIRST', 1);

/**
 * Constants to define the position of the comment controls
 */
define('COMMENT_CONTROLS_ABOVE', 0);
define('COMMENT_CONTROLS_BELOW', 1);
define('COMMENT_CONTROLS_ABOVE_BELOW', 2);
define('COMMENT_CONTROLS_HIDDEN', 3);

/**
 * Constants to define the anonymous poster contact handling
 */
define('COMMENT_ANONYMOUS_MAYNOT_CONTACT', 0);
define('COMMENT_ANONYMOUS_MAY_CONTACT', 1);
define('COMMENT_ANONYMOUS_MUST_CONTACT', 2);

/**
 * Constants to define the comment form location
 */
define('COMMENT_FORM_SEPARATE_PAGE', 0);
define('COMMENT_FORM_BELOW', 1);

/**
 * Constants to define a node's comment state
 */
define('COMMENT_NODE_DISABLED', 0);
define('COMMENT_NODE_READ_ONLY', 1);
define('COMMENT_NODE_READ_WRITE', 2);
60

61 62 63 64 65 66
/**
 * Constants to define if comment preview is optional or required
 */
define('COMMENT_PREVIEW_OPTIONAL', 0);
define('COMMENT_PREVIEW_REQUIRED', 1);

67 68 69
/**
 * Implementation of hook_help().
 */
70
function comment_help($section) {
Dries's avatar
 
Dries committed
71
  switch ($section) {
Dries's avatar
 
Dries committed
72
    case 'admin/help#comment':
73 74 75 76 77 78 79 80 81 82 83 84
      $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 communtiy dialogue.') .'</p>';
      $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. On sites with active commenting from users, the administrator can turn over comment moderation to the community.') .'</p>';
      $output .= t('<p>You can</p>
<ul>
<li>control access for various comment module functions through access permissions <a href="%admin-access">administer &gt;&gt; access control</a>.</li>
<li>administer comments <a href="%admin-comment-configure"> administer &gt;&gt; comments &gt;&gt; configure</a>.</li>
</ul>
', array('%admin-access' => url('admin/access'), '%admin-comment-configure' => url('admin/comment/configure')));
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="%comment">Comment page</a>.', array('%comment' => 'http://www.drupal.org/handbook/modules/comment/')) .'</p>';
      return $output;
    case 'admin/modules#description':
      return t('Allows users to comment on and discuss published content.');
Dries's avatar
 
Dries committed
85
    case 'admin/comment':
86
    case 'admin/comment/new':
87
      return t("<p>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>");
Dries's avatar
 
Dries committed
88
    case 'admin/comment/approval':
89
      return t("<p>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>");
Dries's avatar
Dries committed
90 91
    case 'admin/comment/configure':
    case 'admin/comment/configure/settings':
92
      return t("<p>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>");
93
   }
Dries's avatar
 
Dries committed
94 95
}

Dries's avatar
 
Dries committed
96 97 98
/**
 * Implementation of hook_menu().
 */
Dries's avatar
 
Dries committed
99
function comment_menu($may_cache) {
Dries's avatar
 
Dries committed
100 101
  $items = array();

Dries's avatar
 
Dries committed
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
  if ($may_cache) {
    $access = user_access('administer comments');
    $items[] = array('path' => 'admin/comment', 'title' => t('comments'),
      'callback' => 'comment_admin_overview', 'access' => $access);

    // Tabs:
    $items[] = array('path' => 'admin/comment/list', 'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
    $items[] = array('path' => 'admin/comment/configure', 'title' => t('configure'),
      'callback' => 'comment_configure', 'access' => $access, 'type' => MENU_LOCAL_TASK);

    // Subtabs:
    $items[] = array('path' => 'admin/comment/list/new', 'title' => t('new comments'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
    $items[] = array('path' => 'admin/comment/list/approval', 'title' => t('approval queue'),
      'callback' => 'comment_admin_overview', 'access' => $access,
118
      'callback arguments' => array('approval'),
Dries's avatar
 
Dries committed
119 120 121 122 123 124
      'type' => MENU_LOCAL_TASK);

    $items[] = array('path' => 'admin/comment/configure/settings', 'title' => t('settings'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);

    $access = user_access('post comments');
125 126
    $items[] = array('path' => 'comment/reply', 'title' => t('reply to comment'),
      'callback' => 'comment_save_settings', 'access' => 1, 'type' => MENU_CALLBACK);
127
    $items[] = array('path' => 'comment/edit', 'title' => t('edit comment'),
Dries's avatar
 
Dries committed
128
      'callback' => 'comment_edit', 'access' => $access, 'type' => MENU_CALLBACK);
129 130
    $items[] = array('path' => 'comment/delete', 'title' => t('delete comment'),
      'callback' => 'comment_delete', 'access' => $access, 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
131
  }
Dries's avatar
 
Dries committed
132 133
  else {
    if (arg(0) == 'comment' && arg(1) == 'reply' && is_numeric(arg(2))) {
134
      $node = node_load(arg(2));
Dries's avatar
 
Dries committed
135 136 137 138 139 140 141 142 143 144
      if ($node->nid) {
        $items[] = array('path' => 'comment/reply', 'title' => t('reply to comment'),
          'callback' => 'comment_reply', 'access' => node_access('view', $node), 'type' => MENU_CALLBACK);
      }
    }
    if ((arg(0) == 'node') && is_numeric(arg(1)) && is_numeric(arg(2))) {
      $items[] = array('path' => ('node/'. arg(1) .'/'. arg(2)), 'title' => t('view'),
        'callback' => 'node_page',
        'type' => MENU_CALLBACK);
    }
Dries's avatar
 
Dries committed
145
  }
Dries's avatar
 
Dries committed
146 147 148 149 150 151 152 153

  return $items;
}

/**
 * Implementation of hook_perm().
 */
function comment_perm() {
154
  return array('access comments', 'post comments', 'administer comments', 'post comments without approval');
Dries's avatar
 
Dries committed
155 156 157 158 159 160 161 162 163 164 165 166
}

/**
 * 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;
  }
167
  else if ($op == 'view' && user_access('access comments')) {
168
    $result = db_query_range(db_rewrite_sql('SELECT c.nid, c.* 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);
Dries's avatar
 
Dries committed
169 170
    $items = array();
    while ($comment = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
171
      $items[] = l($comment->subject, 'node/'. $comment->nid, NULL, NULL, 'comment-'. $comment->cid) .'<br />'. t('%time ago', array('%time' => format_interval(time() - $comment->timestamp)));
Dries's avatar
 
Dries committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
    }

    $block['subject'] = t('Recent comments');
    $block['content'] = theme('item_list', $items);
    return $block;
  }
}

/**
 * Implementation of hook_link().
 */
function comment_link($type, $node = 0, $main = 0) {
  $links = array();

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

    if ($main) {
      // 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) {
          $links[] = l(format_plural($all, '1 comment', '%count comments'), "node/$node->nid", array('title' => t('Jump to the first comment of this posting.')), NULL, 'comment');

          if ($new) {
            $links[] = l(format_plural($new, '1 new comment', '%count new comments'), "node/$node->nid", array('title' => t('Jump to the first new comment of this posting.')), NULL, 'new');
          }
        }
        else {
Dries's avatar
Dries committed
203
          if ($node->comment == COMMENT_NODE_READ_WRITE) {
Dries's avatar
 
Dries committed
204 205 206 207 208 209 210 211 212 213 214 215 216 217
            if (user_access('post comments')) {
              $links[] = l(t('add new comment'), "comment/reply/$node->nid", array('title' => t('Add a new comment to this page.')));
            }
            else {
              $links[] = theme('comment_post_forbidden');
            }
          }
        }
      }
    }
    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

Dries's avatar
Dries committed
218
      if ($node->comment == COMMENT_NODE_READ_WRITE && variable_get('comment_form_location', COMMENT_FORM_SEPARATE_PAGE) == COMMENT_FORM_SEPARATE_PAGE) {
Dries's avatar
 
Dries committed
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
        if (user_access('post comments')) {
          $links[] = l(t('add new comment'), "comment/reply/$node->nid", array('title' => t('Share your thoughts and opinions related to this posting.')), NULL, 'comment');
        }
        else {
          $links[] = theme('comment_post_forbidden');
        }
      }
    }
  }

  if ($type == 'comment') {
    $links = comment_links($node, $main);
  }

  return $links;
}

/**
 * Implementation of hook_nodeapi().
Dries's avatar
 
Dries committed
238
 *
Dries's avatar
 
Dries committed
239 240 241 242
 */
function comment_nodeapi(&$node, $op, $arg = 0) {
  switch ($op) {
    case 'settings':
Dries's avatar
Dries committed
243
      $form['comment_'. $node->type] = array('#type' => 'radios', '#title' => t('Default comment setting'), '#default_value' => variable_get('comment_'. $node->type, COMMENT_NODE_READ_WRITE), '#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.'));
244
      return $form;
Dries's avatar
 
Dries committed
245 246
    case 'fields':
      return array('comment');
247

248
    case 'form':
Dries's avatar
 
Dries committed
249
      if (user_access('administer comments')) {
Dries's avatar
Dries committed
250
        $selected = isset($node->comment) ? $node->comment : variable_get("comment_$node->type", COMMENT_NODE_READ_WRITE);
251 252
        $form['user_comments'] = array('#type' => 'fieldset', '#title' => t('User Comments'), '#collapsible' => TRUE, '#collapsed' => TRUE);
        $form['user_comments']['comment'] = array('#type' => 'radios', '#parents' => array('comment'), '#default_value' => $selected, '#options' => array(t('Disabled'), t('Read only'), t('Read/Write')));
253
        return $form;
Dries's avatar
 
Dries committed
254 255
      }
      break;
256

Dries's avatar
 
Dries committed
257
    case 'load':
258
      return db_fetch_array(db_query("SELECT last_comment_timestamp, last_comment_name, comment_count FROM {node_comment_statistics} WHERE nid = %d", $node->nid));
Dries's avatar
 
Dries committed
259
    case 'validate':
260
      if (!user_access('administer comments')) {
Dries's avatar
 
Dries committed
261
        // Force default for normal users:
Dries's avatar
Dries committed
262
        $node->comment = variable_get("comment_$node->type", COMMENT_NODE_READ_WRITE);
Dries's avatar
 
Dries committed
263 264
      }
      break;
265

Dries's avatar
 
Dries committed
266
    case 'insert':
267
      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);
Dries's avatar
 
Dries committed
268
      break;
269

Dries's avatar
 
Dries committed
270
    case 'delete':
Dries's avatar
 
Dries committed
271 272
      db_query('DELETE FROM {comments} WHERE nid = %d', $node->nid);
      db_query('DELETE FROM {node_comment_statistics} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
273
      break;
274

Dries's avatar
Dries committed
275 276
    case 'update index':
      $text = '';
277
      $comments = db_query('SELECT subject, comment, format FROM {comments} WHERE nid = %d AND status = %d', $node->nid, COMMENT_PUBLISHED);
Dries's avatar
Dries committed
278
      while ($comment = db_fetch_object($comments)) {
279
        $text .= '<h2>'. check_plain($comment->subject) .'</h2>'. check_markup($comment->comment, $comment->format, FALSE);
Dries's avatar
Dries committed
280 281
      }
      return $text;
282

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

Steven Wittens's avatar
- Typo  
Steven Wittens committed
287
    case 'rss item':
Steven Wittens's avatar
Steven Wittens committed
288
      return array(array('key' => 'comments', 'value' => url('node/'. $node->nid, NULL, 'comment', TRUE)));
Dries's avatar
 
Dries committed
289 290 291 292 293 294 295 296 297 298 299
  }
}

/**
 * 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
300 301
    $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['comment_settings']['signature'], '#description' => ('Your signature will be publicly displayed at the end of your comments.'));
302 303

    return $form;
Dries's avatar
 
Dries committed
304 305 306
  }
}

307
/**
Dries's avatar
 
Dries committed
308
 * Menu callback; presents the comment settings page.
309
 */
Dries's avatar
 
Dries committed
310
function comment_configure() {
311
  $form['viewing_options'] = array('#type' => 'fieldset', '#title' => t('Comment viewing options'), '#collapsible' => TRUE, '#collapsed' => TRUE, '#weight' => 0);
Dries's avatar
 
Dries committed
312

Dries's avatar
Dries committed
313 314 315 316 317 318 319
  $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(),
    '#description' => t('The default view for comments. Expanded views display the body of the comment. Threaded views keep replies together.')
  );
320

Dries's avatar
Dries committed
321 322 323 324 325 326 327
  $form['viewing_options']['comment_default_order'] = array(
    '#type' => 'radios',
    '#title' => t('Default display order'),
    '#default_value' => variable_get('Default display order', COMMENT_ORDER_NEWEST_FIRST),
    '#options' => _comment_get_orders(),
    '#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
328

329
  $form['viewing_options']['comment_default_per_page'] = array(
330 331 332 333 334
    '#type' => 'select',
    '#title' => t('Default comments per page'),
    '#default_value' => variable_get('comment_default_per_page', 50),
    '#options' => _comment_per_page(),
    '#description' => t('Default number of comments for each page: more comments are distributed in several pages.')
335 336
  );

Dries's avatar
Dries committed
337 338 339 340 341 342 343 344 345 346 347
  $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')),
    '#description' => t('Position of the comment controls box.  The comment controls let the user change the default display mode and display order of comments.')
  );
348

349
  $form['posting_settings'] = array('#type' => 'fieldset', '#title' => t('Comment posting settings'), '#collapsible' => true, '#collapsed' => true, '#weight' => 0);
350

Dries's avatar
Dries committed
351 352 353 354 355 356 357 358 359 360
  $form['posting_settings']['comment_anonymous'] = array(
    '#type' => 'radios',
    '#title' => t('Comment controls'),
    '#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')),
    '#description' => t('This feature is only useful if you allow anonymous users to post comments.  See the <a href="%url">permissions page</a>.', array('%url' => url('admin/access/permissions')))
  );
361 362

  $form['posting_settings']['comment_subject_field'] = array(
363 364 365 366 367
    '#type' => 'radios',
    '#title' => t('Comment subject field'),
    '#default_value' => variable_get('comment_subject_field', 1),
    '#options' => array(t('Disabled'), t('Enabled')),
    '#description' => t('Can users provide a unique subject for their comments?')
368 369
  );

370
  $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')));
371

Dries's avatar
Dries committed
372 373 374 375 376 377
  $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),
    '#options' => array(t('Display on separate page'), t('Display below post or comments'))
  );
378 379

  return system_settings_form('comment_settings_form', $form);
Dries's avatar
 
Dries committed
380 381
}

382 383 384 385 386 387 388 389 390 391
/**
 * 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
 * statements based on the replies their posts got. Furthermore, users
 * can't reply to their own comments and are encouraged instead to extend
 * their original comment.
 */
Dries's avatar
 
Dries committed
392
function comment_access($op, $comment) {
Dries's avatar
 
Dries committed
393 394
  global $user;

395
  if ($op == 'edit') {
396
    return ($user->uid && $user->uid == $comment->uid && comment_num_replies($comment->cid) == 0) || user_access('administer comments');
Dries's avatar
 
Dries committed
397 398
  }
}
399

Dries's avatar
 
Dries committed
400
function comment_node_url() {
Dries's avatar
Dries committed
401
  return arg(0) .'/'. arg(1);
Dries's avatar
 
Dries committed
402
}
Dries's avatar
 
Dries committed
403

Dries's avatar
 
Dries committed
404 405 406
function comment_edit($cid) {
  global $user;

407
  $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
408
  $comment = drupal_unpack($comment);
409
  $comment->name = $comment->uid ? $comment->registered_name : $comment->name;
410
  if (comment_access('edit', $comment)) {
411
    return comment_form(object2array($comment));
412 413 414
  }
  else {
    drupal_access_denied();
Dries's avatar
 
Dries committed
415 416 417
  }
}

Dries's avatar
Dries committed
418
function comment_reply($nid, $pid = NULL) {
419
  // set the breadcrumb trail
420
  $node = node_load($nid);
421
  menu_set_location(array(array('path' => "node/$nid", 'title' => $node->title), array('path' => "comment/reply/$nid")));
Dries's avatar
 
Dries committed
422

423
  $output = '';
Dries's avatar
 
Dries committed
424

Dries's avatar
Dries committed
425 426 427
  // are we posting or previewing a reply?
  if ($_POST['op'] == t('Post comment')) {
    $edit = $_POST['edit'];
428
    $edit = comment_validate($edit);
429
    drupal_set_title(t('Post comment'));
430 431 432 433 434
    if (!$cid = comment_save($edit)) {
      // comment could not be posted. show edit form with errors
      return comment_preview($edit);
    }
    else {
435
      drupal_goto("node/$nid", NULL, "comment-$cid");
436
    }
Dries's avatar
Dries committed
437 438 439
  }
  else if ($_POST['op'] == t('Preview comment')) {
    $edit = $_POST['edit'];
440
    $edit = comment_validate($edit);
441
    drupal_set_title(t('Preview comment'));
Dries's avatar
 
Dries committed
442
    return comment_preview($edit);
Dries's avatar
Dries committed
443
  }
Dries's avatar
 
Dries committed
444

Dries's avatar
Dries committed
445 446 447 448 449
  // or are we merely showing the form?
  if (user_access('access comments')) {

    // if this is a reply to another comment, show that comment first
    // else, we'll just show the user the node they're commenting on.
Dries's avatar
 
Dries committed
450
    if ($pid) {
451
      $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));
Dries's avatar
 
Dries committed
452
      $comment = drupal_unpack($comment);
453
      $comment->name = $comment->uid ? $comment->registered_name : $comment->name;
454
      $output .= theme('comment_view', $comment);
Dries's avatar
 
Dries committed
455
    }
456
    else if (user_access('access content')) {
457
      $output .= node_view($node);
Dries's avatar
 
Dries committed
458 459
      $pid = 0;
    }
Dries's avatar
 
Dries committed
460

Dries's avatar
Dries committed
461
    // should we show the reply box?
462
    if (node_comment_mode($nid) != COMMENT_NODE_READ_WRITE) {
463
      drupal_set_message(t("This discussion is closed: you can't post new comments."), 'error');
Kjartan's avatar
Kjartan committed
464
    }
465
    else if (user_access('post comments')) {
466
      $output .= comment_form(array('pid' => $pid, 'nid' => $nid), t('Reply'));
Dries's avatar
 
Dries committed
467 468
    }
    else {
469
      drupal_set_message(t('You are not authorized to post comments.'), 'error');
Dries's avatar
 
Dries committed
470
    }
Kjartan's avatar
Kjartan committed
471 472
  }
  else {
473
    drupal_set_message(t('You are not authorized to view comments.'), 'error');
Dries's avatar
 
Dries committed
474
  }
Dries's avatar
 
Dries committed
475

Dries's avatar
 
Dries committed
476
  return $output;
Dries's avatar
 
Dries committed
477 478
}

479
function comment_validate(&$edit) {
Dries's avatar
 
Dries committed
480
  global $user;
Dries's avatar
 
Dries committed
481

482 483 484
  // Invoke other validation handlers
  comment_invoke_comment($edit, 'validate');

485 486 487 488 489 490 491
  // only admins can change these fields
  if (!user_access('administer comments')) {
    $edit['uid'] = $user->uid;
    $edit['timestamp'] = time();
    $edit['status'] = user_access('post comments without approval') ? 0 : 1;
  }
  else {
492 493 494
    $date = isset($edit['date']) ? $edit['date'] : 'now';
    if (strtotime($date) != -1) {
      $edit['timestamp'] = strtotime($date);
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
    }
    else {
      form_set_error('date', t('You have to specify a valid date.'));
    }

    if ($edit['uid']) {
      // if a registered user posted the comment, we assume you only want to transfer authorship
      // to another registered user. Name changes are freely allowed on anon comments.
      if ($account = user_load(array('name' => $edit['author']))) {
        $edit['uid'] = $account->uid;
      }
      else {
        form_set_error('author', t('You have to specify a valid author.'));
      }
    }
    else {
      $edit['uid'] = 0;
      $edit['name'] = $edit['author'];
    }
  }

516 517
  // Validate the comment's subject.  If not specified, extract
  // one from the comment's body.
518 519 520 521 522
  if (trim($edit['subject']) == '') {
    // The body may be in any format, so we:
    // 1) Filter it into HTML
    // 2) Strip out all HTML tags
    // 3) Convert entities back to plain-text.
523 524
  // Note: format is checked by check_markup().
    $edit['subject'] = truncate_utf8(decode_entities(strip_tags(check_markup($edit['comment'], $edit['format']))), 29, TRUE);
525
  }
Dries's avatar
 
Dries committed
526

527
  // Validate the comment's body.
Dries's avatar
 
Dries committed
528 529 530 531
  if ($edit['comment'] == '') {
    form_set_error('comment', t('The body of your comment is empty.'));
  }

532
  // Validate filter format
533
  if (array_key_exists('format', $edit) && !filter_access($edit['format'])) {
534 535 536
    form_set_error('format', t('The supplied input format is invalid.'));
  }

537
  // Check validity of name, mail and homepage (if given)
Dries's avatar
 
Dries committed
538
  if (!$user->uid) {
Dries's avatar
Dries committed
539
    if (variable_get('comment_anonymous', COMMENT_ANONYMOUS_MAYNOT_CONTACT) > COMMENT_ANONYMOUS_MAYNOT_CONTACT) {
Dries's avatar
 
Dries committed
540
      if ($edit['name']) {
541
        $taken = db_result(db_query("SELECT COUNT(uid) FROM {users} WHERE LOWER(name) = '%s'", $edit['name']), 0);
Dries's avatar
 
Dries committed
542 543 544 545 546 547

        if ($taken != 0) {
          form_set_error('name', t('The name you used belongs to a registered user.'));
        }

      }
Dries's avatar
Dries committed
548
      else if (variable_get('comment_anonymous', COMMENT_ANONYMOUS_MAYNOT_CONTACT) == COMMENT_ANONYMOUS_MUST_CONTACT) {
Dries's avatar
 
Dries committed
549 550 551 552 553
        form_set_error('name', t('You have to leave your name.'));
      }

      if ($edit['mail']) {
        if (!valid_email_address($edit['mail'])) {
554
          form_set_error('mail', t('The e-mail address you specified is not valid.'));
Dries's avatar
 
Dries committed
555 556
        }
      }
Dries's avatar
Dries committed
557
      else if (variable_get('comment_anonymous', COMMENT_ANONYMOUS_MAYNOT_CONTACT) == COMMENT_ANONYMOUS_MUST_CONTACT) {
Dries's avatar
 
Dries committed
558 559 560 561 562 563 564 565 566 567
        form_set_error('mail', t('You have to leave an e-mail address.'));
      }

      if ($edit['homepage']) {
        if (!valid_url($edit['homepage'], TRUE)) {
          form_set_error('homepage', t('The URL of your homepage is not valid.  Remember that it must be fully qualified, i.e. of the form <code>http://example.com/directory</code>.'));
        }
      }
    }
  }
568

569
  return $edit;
Dries's avatar
 
Dries committed
570 571
}

Dries's avatar
 
Dries committed
572
function comment_preview($edit) {
Dries's avatar
 
Dries committed
573
  global $user;
Dries's avatar
 
Dries committed
574

575
  $output = '';
Dries's avatar
 
Dries committed
576

577
  $comment = array2object($edit);
Dries's avatar
 
Dries committed
578

579
  // Attach the user and time information.
580 581 582 583 584 585 586 587 588 589 590
  if ($edit['author']) {
    $account = user_load(array('name' => $edit['author']));
  }
  elseif ($user->uid) {
    $account = $user;
  }
  if ($account) {
    $comment->uid = $account->uid;
    $comment->name = check_plain($account->name);
  }
  $comment->timestamp = $edit['timestamp'] ? $edit['timestamp'] : time();
Dries's avatar
 
Dries committed
591

592 593 594 595
  // Preview the comment with security check.
  if (!form_get_errors()) {
    $output .= theme('comment_view', $comment);
  }
596
  $output .= comment_form($edit, t('Reply'));
Kjartan's avatar
Kjartan committed
597

598
  if ($edit['pid']) {
599
    $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', $edit['pid'], COMMENT_PUBLISHED));
Dries's avatar
 
Dries committed
600
    $comment = drupal_unpack($comment);
601
    $comment->name = $comment->uid ? $comment->registered_name : $comment->name;
602
    $output .= theme('comment_view', $comment);
Kjartan's avatar
Kjartan committed
603 604
  }
  else {
605
    $output .= node_view(node_load($edit['nid']));
606
    $edit['pid'] = 0;
Kjartan's avatar
Kjartan committed
607
  }
Dries's avatar
 
Dries committed
608 609

  return $output;
Dries's avatar
 
Dries committed
610 611
}

612 613 614 615 616 617 618 619 620 621 622
/**
 * Accepts a submission of new or changed comment content.
 *
 * @param $edit
 *   A comment array.
 *
 * @return
 *   If the comment is successfully saved the comment ID is returned.  If the comment
 *   is not saved, FALSE is returned.
 */
function comment_save($edit) {
Dries's avatar
 
Dries committed
623
  global $user;
624
  if (user_access('post comments') && (user_access('administer coments') || node_comment_mode($edit['nid']) == COMMENT_NODE_READ_WRITE)) {
Dries's avatar
 
Dries committed
625
    if (!form_get_errors()) {
626 627
      // Check for duplicate comments.  Note that we have to use the
      // validated/filtered data to perform such check.
628
      $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
629
      if ($duplicate != 0) {
630
        watchdog('content', t('Comment: duplicate %subject.', array('%subject' => theme('placeholder', $edit['subject']))), WATCHDOG_WARNING);
Dries's avatar
 
Dries committed
631
      }
Dries's avatar
 
Dries committed
632

633
      if ($edit['cid']) {
634
        // Update the comment in the database.
635
        db_query("UPDATE {comments} SET status = '%s', timestamp = %d, subject = '%s', comment = '%s', format = '%s', uid = %d, name = '%s' WHERE cid = %d", $edit['status'], $edit['timestamp'], $edit['subject'], $edit['comment'], $edit['format'], $edit['uid'], $edit['name'], $edit['cid']);
Dries's avatar
 
Dries committed
636

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

639
        // Allow modules to respond to the updating of a comment.
640 641
        comment_invoke_comment($edit, 'update');

Dries's avatar
 
Dries committed
642

Dries's avatar
Dries committed
643
        // Add an entry to the watchdog log.
644
        watchdog('content', t('Comment: updated %subject.', array('%subject' => theme('placeholder', $edit['subject']))), WATCHDOG_NOTICE, l(t('view'), 'node/'. $edit['nid'], NULL, NULL, 'comment-'. $edit['cid']));
Dries's avatar
 
Dries committed
645 646
      }
      else {
647
        // Add the comment to database.
648
        $status = user_access('post comments without approval') ? COMMENT_PUBLISHED : COMMENT_NOT_PUBLISHED;
649
        $roles = variable_get('comment_roles', array());
Dries's avatar
 
Dries committed
650 651 652 653 654 655
        $score = 0;

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

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

658 659
        // Here we are building the thread field.  See the comment
        // in comment_render().
660
        if ($edit['pid'] == 0) {
661 662
          // This is a comment with no parent comment (depth 0): we start
          // by retrieving the maximum thread level.
663
          $max = db_result(db_query('SELECT MAX(thread) FROM {comments} WHERE nid = %d', $edit['nid']));
Dries's avatar
 
Dries committed
664

665 666
          // Strip the "/" from the end of the thread.
          $max = rtrim($max, '/');
Dries's avatar
 
Dries committed
667

668 669 670 671 672
          // Next, we increase this value by one.  Note that we can't
          // use 1, 2, 3, ... 9, 10, 11 because we order by string and
          // 10 would be right after 1.  We use 1, 2, 3, ..., 9, 91,
          // 92, 93, ... instead.  Ugly but fast.
          $decimals = (string) substr($max, 0, strlen($max) - 1);
Dries's avatar
 
Dries committed
673 674 675 676 677 678 679 680 681
          $units = substr($max, -1, 1);
          if ($units) {
            $units++;
          }
          else {
            $units = 1;
          }

          if ($units == 10) {
682
            $units = '90';
Dries's avatar
 
Dries committed
683 684
          }

685
          // Finally, build the thread field for this new comment.
686
          $thread = $decimals . $units .'/';
Dries's avatar
 
Dries committed
687 688
        }
        else {
689 690
          // This is comment with a parent comment: we increase
          // the part of the thread value at the proper depth.
Dries's avatar
 
Dries committed
691 692

          // Get the parent comment:
693
          $parent = db_fetch_object(db_query('SELECT * FROM {comments} WHERE cid = %d', $edit['pid']));
Dries's avatar
 
Dries committed
694

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

698
          // Get the max value in _this_ thread.
Dries's avatar
 
Dries committed
699
          $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
700

701 702
          if ($max == '') {
            // First child of this parent.
703
            $thread = $parent->thread .'.1/';
Dries's avatar
 
Dries committed
704 705
          }
          else {
706 707
            // Strip the "/" at the end of the thread.
            $max = rtrim($max, '/');
Dries's avatar
 
Dries committed
708

709 710 711
            // We need to get the value at the correct depth.
            $parts = explode('.', $max);
            $parent_depth = count(explode('.', $parent->thread));
Dries's avatar
 
Dries committed
712 713
            $last = $parts[$parent_depth];

714 715 716 717
            // Next, we increase this value by one.  Note that we can't
            // use 1, 2, 3, ... 9, 10, 11 because we order by string and
            // 10 would be right after 1.  We use 1, 2, 3, ..., 9, 91,
            // 92, 93, ... instead.  Ugly but fast.
Dries's avatar
 
Dries committed
718 719 720 721
            $decimals = (string)substr($last, 0, strlen($last) - 1);
            $units = substr($last, -1, 1);
            $units++;
            if ($units == 10) {
722
              $units = '90';
Dries's avatar
 
Dries committed
723 724
            }

725
            // Finally, build the thread field for this new comment.
726
            $thread = $parent->thread .'.'. $decimals . $units .'/';
Dries's avatar
 
Dries committed
727 728 729
          }
        }

730
        $edit['cid'] = db_next_id('{comments}_cid');
Dries's avatar
 
Dries committed
731 732 733 734 735 736
        $edit['timestamp'] = time();

        if ($edit['uid'] = $user->uid) {
          $edit['name'] = $user->name;
        }

737
        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'], $edit['status'], $score, $users, $thread, $edit['name'], $edit['mail'], $edit['homepage']);
Dries's avatar
 
Dries committed
738 739

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

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

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

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

Dries's avatar
 
Dries committed
751
      // Explain the approval queue if necessary, and then
Dries's avatar
 
Dries committed
752
      // redirect the user to the node he's commenting on.
753
      if ($status == COMMENT_NOT_PUBLISHED) {
Dries's avatar
 
Dries committed
754
        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
755
      }
756
      return $edit['cid'];
Dries's avatar
 
Dries committed
757 758
    }
    else {
759
      return FALSE;
Dries's avatar
 
Dries committed
760 761
    }
  }
Dries's avatar
 
Dries committed
762
  else {
763
    $txt = t('Comment: unauthorized comment submitted or comment submitted to a closed node %subject.', array('%subject' => theme('placeholder', $edit['subject'])));
764 765 766
    watchdog('content', $txt, WATCHDOG_WARNING);
    drupal_set_message($txt, 'error');
    return FALSE;
Dries's avatar
 
Dries committed
767 768 769 770
  }
}

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

Dries's avatar
 
Dries committed
773
  $links = array();
Dries's avatar
 
Dries committed
774

775
  // If we are viewing just this comment, we link back to the node.
Dries's avatar
 
Dries committed
776
  if ($return) {
777
    $links[] = l(t('parent'), comment_node_url(), NULL, NULL, "comment-$comment->cid");
Dries's avatar
 
Dries committed
778
  }
Dries's avatar
 
Dries committed
779

780
  if (node_comment_mode($comment->nid) == COMMENT_NODE_READ_WRITE) {
781
    if (user_access('administer comments') && user_access('access administration pages')) {
782 783
      $links[] = l(t('delete'), "comment/delete/$comment->cid");
      $links[] = l(t('edit'), "comment/edit/$comment->cid");
Dries's avatar
 
Dries committed
784
      $links[] = l(t('reply'), "comment/reply/$comment->nid/$comment->cid");
785
    }
786 787
    else if (user_access('post comments')) {
      if (comment_access('edit', $comment)) {
Dries's avatar
 
Dries committed
788
        $links[] = l(t('edit'), "comment/edit/$comment->cid");
Dries's avatar
 
Dries committed
789
      }
Dries's avatar
 
Dries committed
790
      $links[] = l(t('reply'), "comment/reply/$comment->nid/$comment->cid");
Dries's avatar
 
Dries committed
791 792
    }
    else {
793
      $links[] = theme('comment_post_forbidden');
Dries's avatar
 
Dries committed
794
    }
Dries's avatar
 
Dries committed
795
  }
Dries's avatar
 
Dries committed
796

Dries's avatar
 
Dries committed
797
  return $links;
Dries's avatar
 
Dries committed
798 799
}

Dries's avatar
 
Dries committed
800
function comment_render($node, $cid = 0) {
Dries's avatar
 
Dries committed
801 802
  global $user;

803 804 805 806
  $mode = $_GET['mode'];
  $order = $_GET['order'];
  $comments_per_page = $_GET['comments_per_page'];
  $comment_page = $_GET['comment_page'];
Dries's avatar
 
Dries committed
807

808
  $output = '';
Dries's avatar
 
Dries committed
809

810 811
  if (user_access('access comments')) {
    // Pre-process variables.
Dries's avatar
 
Dries committed
812
    $nid = $node->nid;
Dries's avatar
 
Dries committed
813 814
    if (empty($nid)) {
      $nid = 0;
Dries's avatar
 
Dries committed
815 816 817
    }

    if (empty($mode)) {
Dries's avatar
Dries committed
818
      $mode = $user->mode ? $user->mode : ($_SESSION['comment_mode'] ? $_SESSION['comment_mode'] : variable_get('comment_default_mode', COMMENT_MODE_THREADED_EXPANDED));
Dries's avatar
 
Dries committed
819 820 821
    }

    if (empty($order)) {
Dries's avatar
Dries committed
822
      $order = $user->sort ? $user->sort : ($_SESSION['comment_sort'] ? $_SESSION['comment_sort'] : variable_get('comment_default_order', COMMENT_ORDER_NEWEST_FIRST));
Dries's avatar
 
Dries committed
823 824
    }

Dries's avatar
 
Dries committed
825
    if (empty($comments_per_page)) {
826
      $comments_per_page = $user->comments_per_page ? $user->comments_per_page : ($_SESSION['comment_comments_per_page'] ? $_SESSION['comment_comments_per_page'] : variable_get('comment_default_per_page', '50'));
Dries's avatar
 
Dries committed
827
    }
Dries's avatar
 
Dries committed
828

Dries's avatar
 
Dries committed
829
    $output .= "<a id=\"comment\"></a>\n";
Dries's avatar
 
Dries committed
830

Kjartan's avatar
Kjartan committed
831
    if ($cid) {
832
      // Single comment view.
833
      $result = db_query('SELECT c.cid, c.pid, c.nid, c.subject, c.comment, c.format, c.timestamp, c.name, c.mail, c.homepage, u.uid, u.name AS registered_name, u.picture, u.data, c.score, c.users FROM {comments} c INNER JOIN {users} u ON c.uid = u.uid WHERE c.cid = %d AND c.status = %d GROUP BY c.cid, c.pid, c.nid, c.subject, c.comment, c.format, c.timestamp, c.name, c.mail, u.picture, c.homepage, u.uid, u.name, u.picture, u.data, c.score, c.users', $cid, COMMENT_PUBLISHED);
Dries's avatar
 
Dries committed
834

Dries's avatar
 
Dries committed
835
      if ($comment = db_fetch_object($result)) {
836
        $comment->name = $comment->uid ? $comment->registered_name : $comment->name;
837
        $output .= theme('comment_view', $comment, module_invoke_all('link', 'comment', $comment, 1));
Dries's avatar
 
Dries committed
838
      }
Dries's avatar
 
Dries committed
839
    }
Dries's avatar
 
Dries committed
840
    else {
841
      // Multiple comment view
Dries's avatar
 
Dries committed
842

843
      $query .= "SELECT c.cid as cid, c.pid, c.nid, c.subject, c.comment, c.format, c.timestamp, c.name , c.mail, c.homepage, u.uid, u.name AS registered_name, u.picture, u.data, c.score, c.users, c.thread FROM {comments} c INNER JOIN {users} u ON c.uid = u.uid WHERE c.nid = %d AND c.status = %d";
Dries's avatar
 
Dries committed
844

845
      $query .= ' GROUP BY c.cid, c.pid, c.nid, c.subject, c.comment, c.format, c.timestamp, c.name, c.mail, u.picture, c.homepage, u.uid, u.name, u.picture, u.data, c.score, c.users, c.thread';
Dries's avatar
 
Dries committed
846

Dries's avatar
 
Dries committed
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
      /*
      ** We want to use the standard pager, but threads would need every
      ** comment to build the thread structure, so we need to store some
      ** extra info.
      **
      ** We use a "thread" field to store this extra info. The basic idea
      ** is to store a value and to order by that value. The "thread" field
      ** keeps this data in a way which is easy to update and convenient
      ** to use.
      **
      ** A "thread" value starts at "1". If we add a child (A) to this
      ** comment, we assign it a "thread" = "1.1". A child of (A) will have
      ** "1.1.1". Next brother of (A) will get "1.2". Next brother of the
      ** parent of (A) will get "2" and so on.
      **
      ** First of all note that the thread field stores the depth of the
      ** comment: depth 0 will be "X", depth 1 "X.X", depth 2 "X.X.X", etc.
      **
      ** Now to get the ordering right, consider this example:
      **
      ** 1
      ** 1.1
      ** 1.1.1
      ** 1.2
      ** 2
      **
      ** If we "ORDER BY thread ASC" we get the above result, and this is
      ** the natural order sorted by time.  However, if we "ORDER BY thread
      ** DESC" we get:
      **
      ** 2
      ** 1.2
      ** 1.1.1
      ** 1.1
      ** 1
      **
      ** Clearly, this is not a natural way to see a thread, and users
      ** will get confused. The natural order to show a thread by time
      ** desc would be:
      **
      ** 2
      ** 1
      ** 1.2
      ** 1.1
      ** 1.1.1
      **
      ** which is what we already did before the standard pager patch. To
      ** achieve this we simply add a "/" at the end of each "thread" value.
      ** This way out thread fields will look like depicted below:
      **
      ** 1/
      ** 1.1/
      ** 1.1.1/
      ** 1.2/
      ** 2/
      **
      ** we add "/" since this char is, in ASCII, higher than every number,
      ** so if now we "ORDER BY thread DESC" we get the correct order.  Try
      ** it, it works ;).  However this would spoil the "ORDER BY thread ASC"
      ** Here, we do not need to consider the trailing "/" so we use a
      ** substring only.
      */
Dries's avatar
 
Dries committed
909

Dries's avatar
Dries committed
910 911
      if ($order == COMMENT_ORDER_NEWEST_FIRST) {
        if ($mode == COMMENT_MODE_FLAT_COLLAPSED || $mode == COMMENT_MODE_FLAT_EXPANDED) {
912
          $query .= ' ORDER BY c.timestamp DESC';
Dries's avatar
 
Dries committed
913 914
        }
        else {
915
          $query .= ' ORDER BY c.thread DESC';
Dries's avatar
 
Dries committed
916
        }
Dries's avatar
 
Dries committed
917
      }
Dries's avatar
Dries committed
918 919
      else if ($order == COMMENT_ORDER_OLDEST_FIRST) {
        if ($mode == COMMENT_MODE_FLAT_COLLAPSED || $mode == COMMENT_MODE_FLAT_EXPANDED) {
920
          $query .= ' ORDER BY c.timestamp';
Dries's avatar
 
Dries committed
921 922 923 924 925 926 927 928 929
        }
        else {

          /*
          ** See comment above.  Analysis learns that this doesn't cost
          ** too much.  It scales much much better than having the whole
          ** comment structure.
          */

930
          $query .= ' ORDER BY SUBSTRING(c.thread, 1, (LENGTH(c.thread) - 1))';
Dries's avatar
 
Dries committed
931
        }
Dries's avatar
 
Dries committed
932 933
      }

934 935
      // Start a form, for use with comment control.
      $result = pager_query($query, $comments_per_page, 0, "SELECT COUNT(*) FROM {comments} WHERE nid = %d AND status = %d", $nid, COMMENT_PUBLISHED);
Dries's avatar
Dries committed
936
      if (db_num_rows($result) && (variable_get('comment_controls', COMMENT_CONTROLS_HIDDEN) == COMMENT_CONTROLS_ABOVE || variable_get('comment_controls', COMMENT_CONTROLS_HIDDEN) == COMMENT_CONTROLS_ABOVE_BELOW)) {
937
        $output .= comment_controls($mode, $order, $comments_per_page, $nid, 'top');
Dries's avatar
 
Dries committed
938
      }
Dries's avatar
 
Dries committed
939

Dries's avatar
<