comment.module 57.3 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 15 16 17 18
/*
 * Constants
 */
 define('COMMENT_PUBLISHED', 0);
 define('COMMENT_NOT_PUBLISHED', 1);

19 20 21
/**
 * Implementation of hook_help().
 */
Dries's avatar
Dries committed
22
function comment_help($section = "admin/help#comment") {
Dries's avatar
 
Dries committed
23
  switch ($section) {
Dries's avatar
 
Dries committed
24
    case 'admin/help#comment':
25
      return t("
Dries's avatar
Dries committed
26 27
      <p>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. An administrator can give comment permissions to user groups, and users can (optionally) edit their last comment, assuming no others have been posted since.</p>

Dries's avatar
 
Dries committed
28 29
      <h3>User control of comment display</h3>
      <p>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. Additional settings include:</p>
Dries's avatar
Dries committed
30 31 32 33
      <ul><li><strong>Threaded</strong> &mdash; Displays the posts grouped according to conversations and subconversations.</li>
      <li><strong>Flat</strong> &mdash;  Displays the posts in chronological order, with no threading whatsoever.</li>
      <li><strong>Expanded</strong> &mdash; Displays the title and text for each post.</li>
      <li><strong>Collapsed</strong> &mdash; Displays only the title for each post.</li></ul>
34
      <p>When a user chooses <em>save settings</em>, the comments are then redisplayed using the user's new choices. Administrators can set the default settings for the comment control panel, along with other comment defaults, in <a href=\"%comment-config\">administer &raquo; comments &raquo; configure</a>.</p>
Dries's avatar
 
Dries committed
35

Dries's avatar
 
Dries committed
36
      <h3>Additional comment configurations</h3>
37
      <p>Comments behave like other user submissions in Drupal. Filters, smileys and HTML that work in nodes will also work with comments. Administrators can control access to various comment module functions through <a href=\"%permissions\">administer &raquo; access control &raquo; permissions</a>. Know that in a new Drupal installation, all comment permissions are disabled by default. The choice of which permissions to grant to which roles (groups of users) is left up to the site administrator. The following permissions:</p>
Dries's avatar
Dries committed
38 39 40 41
      <ul><li><strong>Access comments</strong> &mdash; Allows users to view comments.</li>
      <li><strong>Administrate comments</strong> &mdash; Allows users complete control over configuring, editing and deleting all comments.</li>
      <li><strong>Post comments</strong> &mdash; Allows users to post comments into an administrator moderation queue.</li>
      <li><strong>Post comments without approval</strong> &mdash; Allows users to directly post comments, bypassing the moderation queue.</li></ul>
Dries's avatar
 
Dries committed
42

Dries's avatar
 
Dries committed
43
      <h3>Notification of new comments</h3>
Dries's avatar
Dries committed
44 45
      <p>Drupal provides specific features to inform site members when new comments have been posted.</p>
      <p>Drupal displays the total number of comments attached to each node, and tracks comments read by individual site members. Members which have logged in will see a notice accompanying nodes which contain comments they have not read. Some administrators may want to <a href=\"%download-notify\">download, install and configure the notify module</a>. Users can then request that Drupal send them an e-mail when new comments are posted (the notify module requires that cron.php be configured properly).</p>
46
      <p>The <em>tracker</em> module, disabled by default, displays all the site's recent posts.  There is a link to the <a href=\"%tracker\">recent posts</a> page in the navigation block.  This page is a useful way to browse new or updated nodes and comments. Content which the user has not yet read is tagged with a red star (this graphic depends on the current theme). Visit the comment board for any node, and Drupal will display a red <em>\"new\"</em> label beside the text of unread comments.</p>", array('%comment-config' => url('admin/comment/configure'), '%permissions' => url('admin/access/permissions'), '%tracker' => url('tracker'), '%download-notify' => 'http://drupal.org/project/releases', '%comment-initial' => url('admin/comment/configure/roles')));
Dries's avatar
 
Dries committed
47
    case 'admin/comment':
48
    case 'admin/comment/new':
49
      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
50
    case 'admin/comment/approval':
51
      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
52 53
    case 'admin/comment/configure':
    case 'admin/comment/configure/settings':
54
      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>");
Dries's avatar
Dries committed
55
    case 'admin/modules#description':
56
      return t('Allows users to comment on and discuss published content.');
57
   }
Dries's avatar
 
Dries committed
58 59
}

Dries's avatar
 
Dries committed
60 61 62
/**
 * Implementation of hook_menu().
 */
Dries's avatar
 
Dries committed
63
function comment_menu($may_cache) {
Dries's avatar
 
Dries committed
64 65
  $items = array();

Dries's avatar
 
Dries committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
  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,
82
      'callback arguments' => array('approval'),
Dries's avatar
 
Dries committed
83 84 85 86 87 88
      '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');
89 90
    $items[] = array('path' => 'comment/reply', 'title' => t('reply to comment'),
      'callback' => 'comment_save_settings', 'access' => 1, 'type' => MENU_CALLBACK);
91
    $items[] = array('path' => 'comment/edit', 'title' => t('edit comment'),
Dries's avatar
 
Dries committed
92
      'callback' => 'comment_edit', 'access' => $access, 'type' => MENU_CALLBACK);
93 94
    $items[] = array('path' => 'comment/delete', 'title' => t('delete comment'),
      'callback' => 'comment_delete', 'access' => $access, 'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
95
  }
Dries's avatar
 
Dries committed
96 97
  else {
    if (arg(0) == 'comment' && arg(1) == 'reply' && is_numeric(arg(2))) {
98
      $node = node_load(arg(2));
Dries's avatar
 
Dries committed
99 100 101 102 103 104 105 106 107 108
      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
109
  }
Dries's avatar
 
Dries committed
110 111 112 113 114 115 116 117

  return $items;
}

/**
 * Implementation of hook_perm().
 */
function comment_perm() {
118
  return array('access comments', 'post comments', 'administer comments', 'post comments without approval');
Dries's avatar
 
Dries committed
119 120 121 122 123 124 125 126 127 128 129 130
}

/**
 * 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;
  }
131
  else if ($op == 'view' && user_access('access comments')) {
132
    $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
133 134
    $items = array();
    while ($comment = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
135
      $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
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 170 171 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
    }

    $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 {
          if ($node->comment == 2) {
            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

      if ($node->comment == 2 && variable_get('comment_form_location', 0) == 0) {
        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
202
 *
Dries's avatar
 
Dries committed
203 204 205 206
 */
function comment_nodeapi(&$node, $op, $arg = 0) {
  switch ($op) {
    case 'settings':
207 208
      $form['comment_'. $node->type] = array(type => 'radios', title => t('Default comment setting'), default_value => variable_get('comment_'. $node->type, 2), 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.'));
      return $form;
Dries's avatar
 
Dries committed
209 210
    case 'fields':
      return array('comment');
211

212
    case 'form':
Dries's avatar
 
Dries committed
213 214
      if (user_access('administer comments')) {
        $selected = isset($node->comment) ? $node->comment : variable_get("comment_$node->type", 2);
215 216 217
        $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')));
        return $form;
Dries's avatar
 
Dries committed
218 219
      }
      break;
220

Dries's avatar
 
Dries committed
221
    case 'load':
222
      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
223
    case 'validate':
224
      if (!user_access('administer comments')) {
Dries's avatar
 
Dries committed
225 226 227 228
        // Force default for normal users:
        $node->comment = variable_get("comment_$node->type", 2);
      }
      break;
229

Dries's avatar
 
Dries committed
230
    case 'insert':
231
      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
232
      break;
233

Dries's avatar
 
Dries committed
234
    case 'delete':
Dries's avatar
 
Dries committed
235 236
      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
237
      break;
238

Dries's avatar
Dries committed
239 240
    case 'update index':
      $text = '';
241
      $comments = db_query('SELECT subject, comment, format FROM {comments} WHERE nid = %d AND status = %d', $node->nid, COMMENT_PUBLISHED);
Dries's avatar
Dries committed
242
      while ($comment = db_fetch_object($comments)) {
243
        $text .= '<h2>'. check_plain($comment->subject) .'</h2>'. check_markup($comment->comment, $comment->format, FALSE);
Dries's avatar
Dries committed
244 245
      }
      return $text;
246

Dries's avatar
Dries committed
247 248 249
    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');
250

251 252
    case 'rss item':
      return array(array('key' => 'comments', 'value' => url('node/'.$node->nid, NULL, 'comment', TRUE)));
Dries's avatar
 
Dries committed
253 254 255 256 257 258 259 260 261 262 263
  }
}

/**
 * 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
264 265 266 267
    $form['comment_settings'] = array(type => 'fieldset', title => t('Comment settings'), collapsible => TRUE, collapsed => FALSE, weight => 4);
    $form['comment_settings']['signature'] = array(type => 'textarea', title => t('Signature'), default_value => $edit['comment_settings']['signature'], cols => 60, rows => 5, description => ('Your signature will be publicly displayed at the end of your comments.'));

    return $form;
Dries's avatar
 
Dries committed
268 269 270
  }
}

271
/**
Dries's avatar
 
Dries committed
272
 * Menu callback; presents the comment settings page.
273
 */
Dries's avatar
 
Dries committed
274
function comment_configure() {
275
  $form['viewing_options'] = array(type => 'fieldset', title => t('Comment viewing options'), collapsible => TRUE, collapsed => TRUE, weight => 0);
Dries's avatar
 
Dries committed
276

277 278 279
  $form['viewing_options']['comment_default_mode'] = array(type => 'radios', title => t('Default display mode'), default_value => variable_get('comment_default_mode', 4), options => _comment_get_modes(), description => t('The default view for comments. Expanded views display the body of the comment. Threaded views keep replies together.'));

  $form['viewing_options']['comment_default_order'] = array(type => 'radios', title => t('Default display order'), default_value => variable_get('Default display order', 1), 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
280

281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
  $form['viewing_options']['comment_default_per_page'] = array(
    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.')
  );

  $form['viewing_options']['comment_controls'] = array(type => 'radios', title => t('Comment controls'), default_value => variable_get('comment_controls', 3), 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.'));

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

  $form['posting_settings']['comment_anonymous'] = array(type => 'radios', title => t('Comment controls'), default_value => variable_get('comment_anonymous', 1), options => array(t('Anonymous posters may not enter their contact information'), t('Anonymous posters may leave their contact information'), 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'))));

  $form['posting_settings']['comment_subject_field'] = array(
    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?')
  );

  $form['posting_settings']['comment_preview'] = array(type => 'radios', title => t('Preview comment'), default_value => variable_get('comment_preview', 1), options => array(t('Optional'), t('Required')));

  $form['posting_settings']['comment_form_location'] = array(type => 'radios', title => t('Location of comment submission form'), default_value => variable_get('comment_form_location', 0), options => array(t('Display on separate page'), t('Display below post or comments')));

  return system_settings_form('comment_settings_form', $form);
Dries's avatar
 
Dries committed
308 309
}

310 311 312 313 314 315 316 317 318 319
/**
 * 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
320
function comment_access($op, $comment) {
Dries's avatar
 
Dries committed
321 322
  global $user;

323
  if ($op == 'edit') {
324
    return ($user->uid && $user->uid == $comment->uid && comment_num_replies($comment->cid) == 0) || user_access('administer comments');
Dries's avatar
 
Dries committed
325 326
  }
}
327

Dries's avatar
 
Dries committed
328
function comment_node_url() {
Dries's avatar
Dries committed
329
  return arg(0) .'/'. arg(1);
Dries's avatar
 
Dries committed
330
}
Dries's avatar
 
Dries committed
331

Dries's avatar
 
Dries committed
332 333 334
function comment_edit($cid) {
  global $user;

335
  $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
336
  $comment = drupal_unpack($comment);
337
  $comment->name = $comment->uid ? $comment->registered_name : $comment->name;
338
  if (comment_access('edit', $comment)) {
339
    return comment_form(object2array($comment));
340 341 342
  }
  else {
    drupal_access_denied();
Dries's avatar
 
Dries committed
343 344 345
  }
}

Dries's avatar
Dries committed
346
function comment_reply($nid, $pid = NULL) {
347
  // set the breadcrumb trail
348
  $node = node_load($nid);
349
  menu_set_location(array(array('path' => "node/$nid", 'title' => $node->title), array('path' => "comment/reply/$nid")));
Dries's avatar
 
Dries committed
350

351
  $output = '';
Dries's avatar
 
Dries committed
352

Dries's avatar
Dries committed
353 354 355
  // are we posting or previewing a reply?
  if ($_POST['op'] == t('Post comment')) {
    $edit = $_POST['edit'];
356
    $edit = comment_validate($edit);
357
    drupal_set_title(t('Post comment'));
358 359 360 361 362 363 364
    if (!$cid = comment_save($edit)) {
      // comment could not be posted. show edit form with errors
      return comment_preview($edit);
    }
    else {
      drupal_goto("node/$nid#comment-$cid");
    }
Dries's avatar
Dries committed
365 366 367
  }
  else if ($_POST['op'] == t('Preview comment')) {
    $edit = $_POST['edit'];
368
    $edit = comment_validate($edit);
369
    drupal_set_title(t('Preview comment'));
Dries's avatar
 
Dries committed
370
    return comment_preview($edit);
Dries's avatar
Dries committed
371
  }
Dries's avatar
 
Dries committed
372

Dries's avatar
Dries committed
373 374 375 376 377
  // 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
378
    if ($pid) {
379
      $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
380
      $comment = drupal_unpack($comment);
381
      $comment->name = $comment->uid ? $comment->registered_name : $comment->name;
382
      $output .= theme('comment_view', $comment);
Dries's avatar
 
Dries committed
383
    }
384
    else if (user_access('access content')) {
385
      $output .= node_view($node);
Dries's avatar
 
Dries committed
386 387
      $pid = 0;
    }
Dries's avatar
 
Dries committed
388

Dries's avatar
Dries committed
389
    // should we show the reply box?
Dries's avatar
 
Dries committed
390
    if (node_comment_mode($nid) != 2) {
391
      drupal_set_message(t("This discussion is closed: you can't post new comments."), 'error');
Kjartan's avatar
Kjartan committed
392
    }
393
    else if (user_access('post comments')) {
394
      $output .= comment_form(array('pid' => $pid, 'nid' => $nid), t('Reply'));
Dries's avatar
 
Dries committed
395 396
    }
    else {
397
      drupal_set_message(t('You are not authorized to post comments.'), 'error');
Dries's avatar
 
Dries committed
398
    }
Kjartan's avatar
Kjartan committed
399 400
  }
  else {
401
    drupal_set_message(t('You are not authorized to view comments.'), 'error');
Dries's avatar
 
Dries committed
402
  }
Dries's avatar
 
Dries committed
403

Dries's avatar
 
Dries committed
404
  return $output;
Dries's avatar
 
Dries committed
405 406
}

407
function comment_validate(&$edit) {
Dries's avatar
 
Dries committed
408
  global $user;
Dries's avatar
 
Dries committed
409

410 411 412
  // Invoke other validation handlers
  comment_invoke_comment($edit, 'validate');

413 414 415 416 417 418 419
  // 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 {
420 421 422
    $date = isset($edit['date']) ? $edit['date'] : 'now';
    if (strtotime($date) != -1) {
      $edit['timestamp'] = strtotime($date);
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
    }
    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'];
    }
  }

444 445
  // Validate the comment's subject.  If not specified, extract
  // one from the comment's body.
446 447 448 449 450
  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.
451 452
  // Note: format is checked by check_markup().
    $edit['subject'] = truncate_utf8(decode_entities(strip_tags(check_markup($edit['comment'], $edit['format']))), 29, TRUE);
453
  }
Dries's avatar
 
Dries committed
454

455
  // Validate the comment's body.
Dries's avatar
 
Dries committed
456 457 458 459
  if ($edit['comment'] == '') {
    form_set_error('comment', t('The body of your comment is empty.'));
  }

460
  // Validate filter format
461
  if (array_key_exists('format', $edit) && !filter_access($edit['format'])) {
462 463 464
    form_set_error('format', t('The supplied input format is invalid.'));
  }

465
  // Check validity of name, mail and homepage (if given)
Dries's avatar
 
Dries committed
466
  if (!$user->uid) {
467
    if (variable_get('comment_anonymous', 1) > 1) {
Dries's avatar
 
Dries committed
468
      if ($edit['name']) {
469
        $taken = db_result(db_query("SELECT COUNT(uid) FROM {users} WHERE LOWER(name) = '%s'", $edit['name']), 0);
Dries's avatar
 
Dries committed
470 471 472 473 474 475

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

      }
476
      else if (variable_get('comment_anonymous', 1) == 3) {
Dries's avatar
 
Dries committed
477 478 479 480 481
        form_set_error('name', t('You have to leave your name.'));
      }

      if ($edit['mail']) {
        if (!valid_email_address($edit['mail'])) {
482
          form_set_error('mail', t('The e-mail address you specified is not valid.'));
Dries's avatar
 
Dries committed
483 484
        }
      }
485
      else if (variable_get('comment_anonymous', 1) == 3) {
Dries's avatar
 
Dries committed
486 487 488 489 490 491 492 493 494 495
        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>.'));
        }
      }
    }
  }
496

497
  return $edit;
Dries's avatar
 
Dries committed
498 499
}

Dries's avatar
 
Dries committed
500
function comment_preview($edit) {
Dries's avatar
 
Dries committed
501
  global $user;
Dries's avatar
 
Dries committed
502

503
  $output = '';
Dries's avatar
 
Dries committed
504

505
  $comment = array2object($edit);
Dries's avatar
 
Dries committed
506

507
  // Attach the user and time information.
508 509 510 511 512 513 514 515 516 517 518
  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
519

520 521 522 523
  // Preview the comment with security check.
  if (!form_get_errors()) {
    $output .= theme('comment_view', $comment);
  }
524
  $output .= comment_form($edit, t('Reply'));
Kjartan's avatar
Kjartan committed
525

526
  if ($edit['pid']) {
527
    $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
528
    $comment = drupal_unpack($comment);
529
    $comment->name = $comment->uid ? $comment->registered_name : $comment->name;
530
    $output .= theme('comment_view', $comment);
Kjartan's avatar
Kjartan committed
531 532
  }
  else {
533
    $output .= node_view(node_load($edit['nid']));
534
    $edit['pid'] = 0;
Kjartan's avatar
Kjartan committed
535
  }
Dries's avatar
 
Dries committed
536 537

  return $output;
Dries's avatar
 
Dries committed
538 539
}

540 541 542 543 544 545 546 547 548 549 550
/**
 * 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
551
  global $user;
552
  if (user_access('post comments') && (user_access('administer coments') || node_comment_mode($edit['nid']) == 2)) {
Dries's avatar
 
Dries committed
553
    if (!form_get_errors()) {
554 555
      // Check for duplicate comments.  Note that we have to use the
      // validated/filtered data to perform such check.
556
      $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
557
      if ($duplicate != 0) {
558
        watchdog('content', t('Comment: duplicate %subject.', array('%subject' => theme('placeholder', $edit['subject']))), WATCHDOG_WARNING);
Dries's avatar
 
Dries committed
559
      }
Dries's avatar
 
Dries committed
560

561
      if ($edit['cid']) {
562 563
        // Update the comment in the database.
        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
564

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

567
        // Allow modules to respond to the updating of a comment.
568 569
        comment_invoke_comment($edit, 'update');

Dries's avatar
 
Dries committed
570

Dries's avatar
Dries committed
571
        // Add an entry to the watchdog log.
572
        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
573 574
      }
      else {
575
        // Add the comment to database.
576
        $status = user_access('post comments without approval') ? COMMENT_PUBLISHED : COMMENT_NOT_PUBLISHED;
577
        $roles = variable_get('comment_roles', array());
Dries's avatar
 
Dries committed
578 579 580 581 582 583
        $score = 0;

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

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

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

593 594
          // Strip the "/" from the end of the thread.
          $max = rtrim($max, '/');
Dries's avatar
 
Dries committed
595

596 597 598 599 600
          // 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
601 602 603 604 605 606 607 608 609
          $units = substr($max, -1, 1);
          if ($units) {
            $units++;
          }
          else {
            $units = 1;
          }

          if ($units == 10) {
610
            $units = '90';
Dries's avatar
 
Dries committed
611 612
          }

613
          // Finally, build the thread field for this new comment.
614
          $thread = $decimals . $units .'/';
Dries's avatar
 
Dries committed
615 616
        }
        else {
617 618
          // This is comment with a parent comment: we increase
          // the part of the thread value at the proper depth.
Dries's avatar
 
Dries committed
619 620

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

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

626
          // Get the max value in _this_ thread.
Dries's avatar
 
Dries committed
627
          $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
628

629 630
          if ($max == '') {
            // First child of this parent.
631
            $thread = $parent->thread .'.1/';
Dries's avatar
 
Dries committed
632 633
          }
          else {
634 635
            // Strip the "/" at the end of the thread.
            $max = rtrim($max, '/');
Dries's avatar
 
Dries committed
636

637 638 639
            // We need to get the value at the correct depth.
            $parts = explode('.', $max);
            $parent_depth = count(explode('.', $parent->thread));
Dries's avatar
 
Dries committed
640 641
            $last = $parts[$parent_depth];

642 643 644 645
            // 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
646 647 648 649
            $decimals = (string)substr($last, 0, strlen($last) - 1);
            $units = substr($last, -1, 1);
            $units++;
            if ($units == 10) {
650
              $units = '90';
Dries's avatar
 
Dries committed
651 652
            }

653
            // Finally, build the thread field for this new comment.
654
            $thread = $parent->thread .'.'. $decimals . $units .'/';
Dries's avatar
 
Dries committed
655 656 657
          }
        }

658
        $edit['cid'] = db_next_id('{comments}_cid');
Dries's avatar
 
Dries committed
659 660 661 662 663 664
        $edit['timestamp'] = time();

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

665
        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
666 667

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

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

672
        // Add an entry to the watchdog log.
673
        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
674
      }
Dries's avatar
 
Dries committed
675

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

Dries's avatar
 
Dries committed
679
      // Explain the approval queue if necessary, and then
Dries's avatar
 
Dries committed
680
      // redirect the user to the node he's commenting on.
681
      if ($status == COMMENT_NOT_PUBLISHED) {
Dries's avatar
 
Dries committed
682
        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
683
      }
684
      return $edit['cid'];
Dries's avatar
 
Dries committed
685 686
    }
    else {
687
      return FALSE;
Dries's avatar
 
Dries committed
688 689
    }
  }
Dries's avatar
 
Dries committed
690
  else {
691
    $txt = t('Comment: unauthorized comment submitted or comment submitted to a closed node %subject.', array('%subject' => theme('placeholder', $edit['subject'])));
692 693 694
    watchdog('content', $txt, WATCHDOG_WARNING);
    drupal_set_message($txt, 'error');
    return FALSE;
Dries's avatar
 
Dries committed
695 696 697 698
  }
}

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

Dries's avatar
 
Dries committed
701
  $links = array();
Dries's avatar
 
Dries committed
702

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

Dries's avatar
 
Dries committed
708
  if (node_comment_mode($comment->nid) == 2) {
709
    if (user_access('administer comments') && user_access('access administration pages')) {
710 711
      $links[] = l(t('delete'), "comment/delete/$comment->cid");
      $links[] = l(t('edit'), "comment/edit/$comment->cid");
Dries's avatar
 
Dries committed
712
      $links[] = l(t('reply'), "comment/reply/$comment->nid/$comment->cid");
713
    }
714 715
    else if (user_access('post comments')) {
      if (comment_access('edit', $comment)) {
Dries's avatar
 
Dries committed
716
        $links[] = l(t('edit'), "comment/edit/$comment->cid");
Dries's avatar
 
Dries committed
717
      }
Dries's avatar
 
Dries committed
718
      $links[] = l(t('reply'), "comment/reply/$comment->nid/$comment->cid");
Dries's avatar
 
Dries committed
719 720
    }
    else {
721
      $links[] = theme('comment_post_forbidden');
Dries's avatar
 
Dries committed
722
    }
Dries's avatar
 
Dries committed
723
  }
Dries's avatar
 
Dries committed
724

Dries's avatar
 
Dries committed
725
  return $links;
Dries's avatar
 
Dries committed
726 727
}

Dries's avatar
 
Dries committed
728
function comment_render($node, $cid = 0) {
Dries's avatar
 
Dries committed
729 730
  global $user;

731 732 733 734
  $mode = $_GET['mode'];
  $order = $_GET['order'];
  $comments_per_page = $_GET['comments_per_page'];
  $comment_page = $_GET['comment_page'];
Dries's avatar
 
Dries committed
735

736
  $output = '';
Dries's avatar
 
Dries committed
737

738 739
  if (user_access('access comments')) {
    // Pre-process variables.
Dries's avatar
 
Dries committed
740
    $nid = $node->nid;
Dries's avatar
 
Dries committed
741 742
    if (empty($nid)) {
      $nid = 0;
Dries's avatar
 
Dries committed
743 744 745
    }

    if (empty($mode)) {
746
      $mode = $user->mode ? $user->mode : ($_SESSION['comment_mode'] ? $_SESSION['comment_mode'] : variable_get('comment_default_mode', 4));
Dries's avatar
 
Dries committed
747 748 749
    }

    if (empty($order)) {
750
      $order = $user->sort ? $user->sort : ($_SESSION['comment_sort'] ? $_SESSION['comment_sort'] : variable_get('comment_default_order', 1));
Dries's avatar
 
Dries committed
751 752
    }

Dries's avatar
 
Dries committed
753
    if (empty($comments_per_page)) {
754
      $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
755
    }
Dries's avatar
 
Dries committed
756

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

Kjartan's avatar
Kjartan committed
759
    if ($cid) {
760
      // Single comment view.
761
      $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
762

Dries's avatar
 
Dries committed
763
      if ($comment = db_fetch_object($result)) {
764
        $comment->name = $comment->uid ? $comment->registered_name : $comment->name;
Dries's avatar
 
Dries committed
765
        $output .= theme('comment_view', $comment, theme('links', module_invoke_all('link', 'comment', $comment, 1)));
Dries's avatar
 
Dries committed
766
      }
Dries's avatar
 
Dries committed
767
    }
Dries's avatar
 
Dries committed
768
    else {
769
      // Multiple comment view
Dries's avatar
 
Dries committed
770

771
      $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
772

773
      $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
774

Dries's avatar
 
Dries committed
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
      /*
      ** 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
837 838

      if ($order == 1) {
Dries's avatar
 
Dries committed
839
        if ($mode == 1 || $mode == 2) {
840
          $query .= ' ORDER BY c.timestamp DESC';
Dries's avatar
 
Dries committed
841 842
        }
        else {
843
          $query .= ' ORDER BY c.thread DESC';
Dries's avatar
 
Dries committed
844
        }
Dries's avatar
 
Dries committed
845
      }
Dries's avatar
 
Dries committed
846
      else if ($order == 2) {
Dries's avatar
 
Dries committed
847
        if ($mode == 1 || $mode == 2) {
848
          $query .= ' ORDER BY c.timestamp';
Dries's avatar
 
Dries committed
849 850 851 852 853 854 855 856 857
        }
        else {

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

858
          $query .= ' ORDER BY SUBSTRING(c.thread, 1, (LENGTH(c.thread) - 1))';
Dries's avatar
 
Dries committed
859
        }
Dries's avatar
 
Dries committed
860 861
      }

862 863
      // 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
864
      if (db_num_rows($result) && (variable_get('comment_controls', 3) == 0 || variable_get('comment_controls', 3) == 2)) {
865
        $output .= comment_controls($mode, $order, $comments_per_page, $nid, 'top');
Dries's avatar
 
Dries committed
866
      }
Dries's avatar
 
Dries committed
867

Dries's avatar
 
Dries committed
868
      while ($comment = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
869
        $comment = drupal_unpack($comment);
870
        $comment->name = $comment->uid ? $comment->registered_name : $comment->name;
871
        $comment->depth = count(explode('.', $comment->thread)) - 1;
Dries's avatar
 
Dries committed
872

Dries's avatar
 
Dries committed
873
        if ($mode == 1) {
874
          $output .= theme('comment_flat_collapsed', $comment);
Dries's avatar
 
Dries committed
875
        }
Dries's avatar
 
Dries committed
876
        else if ($mode == 2) {
877
          $output .= theme('comment_flat_expanded', $comment);
Dries's avatar
 
Dries committed
878
        }
Dries's avatar
 
Dries committed
879
        else if ($mode == 3) {
880
          $output .= theme('comment_thread_min', $comment);
Dries's avatar
 
Dries committed
881
        }
Dries's avatar
 
Dries committed
882
        else if ($mode == 4) {
883
          $output .= theme('comment_thread_max', $comment);
Dries's avatar
 
Dries committed
884
        }
Dries's avatar
 
Dries committed
885
      }
Dries's avatar
 
Dries committed
886

887 888
      // Use the standard pager; $pager_total is the number of returned rows,
      // is global and defined in pager.inc.
889
      $output .= theme('pager', NULL, $comments_per_page, 0, array('comments_per_page' => $comments_per_page));
Dries's avatar
 
Dries committed
890

891 892
      if (db_num_rows($result) && (variable_get('comment_controls', 3) == 1 || variable_get('comment_controls', 3) == 3)) {
        $output .= comment_controls($mode, $order, $comments_per_page, $nid, 'bottom');
Dries's avatar
 
Dries committed
893 894 895 896
      }
    }

    // If enabled, show new comment form.
897 898
    if (user_access('post comments') && node_comment_mode($nid) == 2 && (variable_get('comment_form_location', 0) == 1)) {
      $output .= comment_form(array('nid' => $nid), t('Post new comment'));
Dries's avatar
 
Dries committed
899 900 901
    }
  }
  return $output;
Dries's avatar
 
Dries committed
902 903
}

Dries's avatar