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

4
5
6
7
/**
 * Implementation of hook_help().
 */
function comment_help($section) {
Dries's avatar
   
Dries committed
8
  switch ($section) {
Dries's avatar
   
Dries committed
9
    case 'admin/help#comment':
10
      return t("
Dries's avatar
   
Dries committed
11
12
13
14
      <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, collaborative book page, etc.</p>
      <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>
      <ul>
15
      <li><strong>Threaded</strong> -- Displays the posts grouped according to conversations and subconversations, much like the subject view of an e-mail client.</li>
Dries's avatar
   
Dries committed
16
17
18
19
      <li><strong>Flat</strong> --  Displays the posts in chronological order, in the order in which they are posted.</li>
      <li><strong>Expanded</strong> -- Displays the title and text for each post.</li>
      <li><strong>Collapsed</strong> -- Displays only the title for each post.</li>
      </ul>
20
      <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
21
      <p>NOTE: When comment moderation is enabled, users will have another control panel option to control thresholds (see below).</p>
Dries's avatar
   
Dries committed
22

Dries's avatar
   
Dries committed
23
      <h3>Additional comment configurations</h3>
24
      <p>Comments behave like other user submissions in Drupal. Filters, smileys and HTML that work in nodes will also work with content. To prevent a single user from spamming the web site with too many comments, administrators can set a comment throttle in <a href=\"%site-config\">administer &raquo; configuration</a> under <em>Submission settings</em>.</p>
25
      <p>Administrators can control access to various comment module functions through <a href=\"%user-permissions\">administer &raquo; users &raquo; configure &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.</p>
Dries's avatar
   
Dries committed
26
27
28
29
30
31
32
33
      <p>The following permissions can be enabled for anonymous users, authenticated users, or any other user roles that the administrator chooses to define:</p>
      <ul>
      <li><strong>Access comments</strong> -- Allows users to view comments.</li>
      <li><strong>Administrate comments</strong> -- Allows users complete control over configuring, editing and deleting all comments on the site. Best reserved for <strong>very</strong> trusted users.</li>
      <li><strong>Moderate comments</strong> -- Allows users to rate comment postings (see more on moderation below).</li>
      <li><strong>Post comments</strong> -- Allows users to post comments into an administrator moderation queue. Administrators then post the comment to the site.</li>
      <li><strong>Post comments without approval</strong> -- Allows users to directly post comments. This bypasses the administrator moderation queue.</li>
      </ul>
Dries's avatar
   
Dries committed
34

Dries's avatar
   
Dries committed
35
36
37
38
      <h3>Notification of new comments</h3>
      <p>Drupal provides specific features to inform site members when new comments have been posted:</p>
      <ul>
      <li>On the home page, 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 that they have not read.</li>
39
40
      <li>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.</li>
      <li>Some administrators may want to <a href=\"%download-notify\">download</a>, install and configure the notify module. 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).</li>
Dries's avatar
   
Dries committed
41
      </ul>
Dries's avatar
   
Dries committed
42

Dries's avatar
   
Dries committed
43
44
45
      <h3>Comment moderation</h3>
      <p>On sites with active commenting from users, the administrator can turn over comment moderation to the community. </p>
      <p>With comment moderation, each comment is automatically assigned an initial rating. As users read comments, they can apply a vote which affects the comment rating. At the same time, users have an additional option in the control panel which allows them to set a threshold for the comments they wish to view. Those comments with ratings lower than the set threshold will not be shown.</p>
46
      <p>To enable moderation, the administrator must grant <a href=\"%permission\">moderate comments</a> permissions. Then, a number of options in <a href=\"%comment-moderation\">administer &raquo; comments &raquo; configure</a> must be configured.</p>
Dries's avatar
   
Dries committed
47

Dries's avatar
   
Dries committed
48
      <h4>Moderation votes</h4>
49
      <p>The first step is to create moderation labels which allow users to rate a comment.  Go to <a href=\"%comment-votes\">administer &raquo; comments &raquo; configure &raquo; moderation votes</a>. In the <em>vote</em> field, enter the textual labels which users will see when casting their votes. Some examples are</p>
Dries's avatar
   
Dries committed
50
51
52
53
54
55
56
57
58
59
      <ul>
      <li>Excellent +3</li>
      <li>Insightful +2</li>
      <li>Caught My Attention +1</li>
      <li>Useful +1</li>
      <li>Redundant -1</li>
      <li>Flame -3</li>
      </ul>
      <p>So that users know how their votes affect the comment, these examples include the vote value as part of the label, although that is optional.</p>
      <p>Using the weight option, you can control the order in which the votes appear to users. Setting the weight heavier (positive numbers) will make the vote label appear at the bottom of the list. Lighter (a negative number) will push it to the top. To encourage positive voting, a useful order might be higher values, positive votes, at the top, with negative votes at the bottom.</p>
Dries's avatar
   
Dries committed
60

Dries's avatar
   
Dries committed
61
      <h4>Moderator vote/values matrix</h4>
Dries's avatar
   
Dries committed
62

63
      <p>Next go to <a href=\"%comment-matrix\">administer &raquo; comments &raquo; configure &raquo; moderation matrix</a>. Enter the values for the vote labels for each permission role in the vote matrix. The values entered here will be used to create the rating for each comment.</p>
Dries's avatar
   
Dries committed
64
65
      <p>NOTE: Comment ratings are calculated by averaging user votes with the initial rating.</p>
      <h4>Creating comment thresholds</h4>
66
      <p>In <a href=\"%comment-thresholds\">administer &raquo; comments &raquo; configure &raquo; moderation thresholds</a>, you'll have to create some comment thresholds to make the comment rating system useful. When comment moderation is enabled and the thresholds are created, users will find another comment control panel option for selecting their thresholds. They'll use the thresholds you enter here to filter out comments with low ratings. Consequently, you'll probably want to create more than one threshold to give users some flexibility in filtering comments.</p>
67
      <p>When creating the thresholds, note that the <em>Minimum score</em> is asking you for the lowest rating that a comment can have in order to be displayed.</p>
Dries's avatar
   
Dries committed
68
      <p>To see a common example of how thresholds work, you might visit <a href=\"%slashdot\">Slashdot</a> and view one of their comment boards associated with a story. You can reset the thresholds in their comment control panel.</p>
Dries's avatar
   
Dries committed
69

Dries's avatar
   
Dries committed
70
      <h4>Initial comment scores</h4>
71
      <p>Finally, you may want to enter some <em>initial comment scores</em>. In <a href=\"%comment-initial\">administer &raquo; comments &raquo; configure &raquo; moderation roles</a> you can assign a beginning rating for all comments posted by a particular permission role. If you do not assign any initial scores, Drupal will assign a rating of <strong>0</strong> as the default.</p>", array('%comment-config' => url('admin/comment/configure'), '%site-config' => url('admin'), '%user-permissions' => url('admin/user/configure/permission'), '%tracker' => url('tracker'), '%download-notify' => 'http://drupal.org/project/releases', '%permission' => url('admin/user/configure/permission'), '%comment-moderation' => url('admin/comment/configure'), '%comment-votes' => url('admin/comment/configure/votes'), '%comment-matrix' => url('admin/comment/configure/matrix'), '%comment-thresholds' => url('admin/comment/configure/thresholds'), '%slashdot' => ' http://slashdot.org', '%comment-initial' => url('admin/comment/configure/roles')));
Dries's avatar
   
Dries committed
72
    case 'admin/modules#description':
73
      return t('Enables user to comment on content (nodes).');
74
75
    case 'admin/comment/configure':
    case 'admin/comment/configure/settings':
76
      return t("Comments can be attached to any node. Below are the settings for comments. 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 comments 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. To set the default threshold you first have to set up thresholds in the <a href=\"%threshold\">administer &raquo; comments &raquo; configure &raquo; moderation thresholds</a> area. Preview comment forces a user to look at their comment by clicking on a \"Preview\" button before they can actually add the comment. If \"New comment form\" is enabled then at the bottom of every comment page there will be a form too add a new comment.", array('%threshold' => url('admin/comment/configure/thresholds')));
Dries's avatar
   
Dries committed
77
    case 'admin/comment':
78
    case 'admin/comment/new':
79
      return t("Below is a list of the latest comments posted your site. Click on a subject to see the comment, the author's name to edit the author's user information , \"edit comment\" to edit the comment, and \"delete comment\" to remove the comment.");
Dries's avatar
   
Dries committed
80
    case 'admin/comment/approval':
81
82
83
84
85
86
      return t("Below is a list of the comments posted to your site that need approval. To approve a comment click on \"edit comment\" and then change its \"moderation status\" to Approved.<br />Click on a subject to see the comment, the author's name to edit the author's user information, \"edit comment\" to edit the comment, and \"delete comment\" to remove the comment.");
//    case 'admin/settings/comment':
//      return t("If you get a lot of comments, you can enable comment moderation. Once moderation is enabled, users can vote on a comment based on dropdown menus. <a href=\"%votes\">Votes</a> sets up the names in the dropdown menu, and the order in which they appear, using weights. <a href=\"%matrix\">Matrix</a> sets up the value of each user's vote, and <a href=\"%threshhold\">threshhold</a> sets up the levels at which a comment will be displayed.", array('%votes' => url('admin/comment/configure/votes'), '%matrix' => url('admin/comment/configure/matrix'), '%threshhold' => url('admin/comment/configure/thresholds')));
    case 'admin/comment/configure/matrix':
      return t("Here is where you assign a value to each item in the dropdown menu. This value is added to the vote total, which is then divided by the number of users who have voted and rounded off to the nearest integer.<br />Notes:<ul><li>In order to use comment moderation, every text box on this page should be populated.</li><li>You must assign the \"moderate comments\" permission to at least one role in order to use this page.</li><li>Every box not filled in will have a value of zero, which will have the effect of lowering a comments over all score.</li></ul>");
    case 'admin/comment/configure/thresholds':
Dries's avatar
   
Dries committed
87
      return t("Here you can setup the name and minimum \"cut off\" score to help your users hide comments that they don't want too see. These thresholds appear in the Comment Control Panel. Click \"edit\" to edit the values of an already existing threshold. To delete a threshold click on \"edit\".");
88
89
90
91
    case 'admin/comment/configure/votes':
      return t('Here is where you set up the name of each type of vote. "Weight" lets you set the order of the drop down menu. Click "edit" to edit a current vote weight.<br />Notes: <ul><li>you can have more than one type with the same name. The system does not protect you from this.</li><li>To delete a name/weight combination go to the "edit" area.</li></ul>');
    case 'admin/comment/configure/roles':
      return t("Here you can setup the initial vote value of a comment posted by each user role. This value is used before any other users vote on the comment.<br />Note: Blank entries are valued at zero");
Dries's avatar
   
Dries committed
92
    case 'admin/comment/search':
93
94
      return t("Enter a simple pattern ( '*' maybe used as a wildcard match) to search for a comment.  For example, one may search for 'br' and Drupal might return 'bread brakers', 'our daily bread' and 'brenda'.");
   }
Dries's avatar
   
Dries committed
95
96
}

Dries's avatar
   
Dries committed
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
/**
 * Implementation of hook_menu().
 */
function comment_menu() {
  $items = array();
  $access = user_access('administer comments');

  $items[] = array('path' => 'admin/comment', 'title' => t('comments'),
    'callback' => 'comment_admin', 'access' => $access);
  $items[] = array('path' => 'admin/comment/edit', 'title' => t('edit comment'),
    'callback' => 'comment_admin', 'access' => $access,
    'type' => MENU_CALLBACK);
  $items[] = array('path' => 'admin/comment/delete', 'title' => t('delete comment'),
    'callback' => 'comment_admin', 'access' => $access,
    'type' => MENU_CALLBACK);

  // Tabs:
  $items[] = array('path' => 'admin/comment/configure', 'title' => t('configure'),
    'callback' => 'comment_configure', 'access' => $access,
    'type' => MENU_LOCAL_TASK);
  if (module_exist('search')) {
    $items[] = array('path' => 'admin/comment/search', 'title' => t('search'),
      'callback' => 'comment_admin', 'access' => $access,
      'type' => MENU_LOCAL_TASK);
  }

  // Subtabs:
  $items[] = array('path' => 'admin/comment/new', 'title' => t('new comments'),
    'callback' => 'comment_admin', 'access' => $access,
    'type' => MENU_LOCAL_SUBTASK);
  $items[] = array('path' => 'admin/comment/approval', 'title' => t('approval queue'),
    'callback' => 'comment_admin', 'access' => $access,
    'type' => MENU_LOCAL_SUBTASK);
  $items[] = array('path' => 'admin/comment/configure/settings', 'title' => t('settings'),
    'callback' => 'comment_configure', 'access' => $access,
    'type' => MENU_LOCAL_SUBTASK);
  $access = user_access('administer comments') && user_access('administer moderation');
  $items[] = array('path' => 'admin/comment/configure/matrix', 'title' => t('moderation matrix'),
    'callback' => 'comment_matrix_settings', 'access' => $access,
    'type' => MENU_LOCAL_SUBTASK);
  $items[] = array('path' => 'admin/comment/configure/thresholds', 'title' => t('moderation thresholds'),
    'callback' => 'comment_threshold_settings', 'access' => $access,
    'type' => MENU_LOCAL_SUBTASK);
  $items[] = array('path' => 'admin/comment/configure/votes', 'title' => t('moderation votes'),
    'callback' => 'comment_vote_settings', 'access' => $access,
    'type' => MENU_LOCAL_SUBTASK,
    'weight' => 6);
  $items[] = array('path' => 'admin/comment/configure/roles', 'title' => t('moderation roles'),
    'callback' => 'comment_role_settings', 'access' => $access,
    'type' => MENU_LOCAL_SUBTASK,
    'weight' => 6);

  $items[] = array('path' => 'comment', 'title' => t('comments'),
    'callback' => 'comment_page', 'access' => $access,
    'type' => MENU_CALLBACK);

  return $items;
}

/**
 * Implementation of hook_perm().
 */
function comment_perm() {
  return array('access comments', 'post comments', 'administer comments', 'moderate comments', 'post comments without approval', 'administer moderation');
}

/**
 * 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;
  }
  else if (user_access('access comments')) {
    $result = db_query_range('SELECT * FROM {comments} WHERE status = 0 ORDER BY timestamp DESC', 0, 10);
    $items = array();
    while ($comment = db_fetch_object($result)) {
      $items[] = l($comment->subject, "node/$comment->nid", NULL, NULL, "comment-$comment->cid") .'<br />'. format_interval(time() - $comment->timestamp) .' '. t('ago');
    }

    $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().
 */
function comment_nodeapi(&$node, $op, $arg = 0) {
  switch ($op) {
    case 'settings':
      $output[t('comment')] = form_select('', "comment_$node->type", variable_get("comment_$node->type", 2), array(t('Disabled'), t('Read only'), t('Read/Write')));
      return $output;
    case 'fields':
      return array('comment');
    case 'form admin':
      if (user_access('administer comments')) {
        $selected = isset($node->comment) ? $node->comment : variable_get("comment_$node->type", 2);
        $output = form_radios('', 'comment', $selected, array(t('Disabled'), t('Read only'), t('Read/write')));
        return form_group(t('User comments'), $output);
      }
      break;
    case 'validate':
      if (!user_access('administer nodes')) {
        // Force default for normal users:
        $node->comment = variable_get("comment_$node->type", 2);
      }
      break;
    case 'delete':
      db_query("DELETE FROM {comments} WHERE nid = '$node->nid'");
      break;
  }
}

/**
 * Implementation of hook_node_link().
 *
 * Allows users with appropriate privileges to edit comments when viewing
 * a node.
 */
function comment_node_link($node) {
  if (user_access('administer comments')) {
    $result = db_query('SELECT c.cid, c.subject, c.name, c.homepage, u.uid, u.name AS registered_name, c.name FROM {comments} c INNER JOIN {users} u ON u.uid = c.uid WHERE nid = %d AND c.status = 0 ORDER BY c.timestamp', $node->nid);

    $header = array(t('title'), t('author'), array('data' => t('operations'), 'colspan' => 3));

    while ($comment = db_fetch_object($result)) {
      $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
      $rows[] = array(l($comment->subject, "node/$node->nid", NULL, NULL, "comment-$comment->cid"), format_name($comment), l(t('view comment'), "node/$node->nid", NULL, NULL, $comment->cid), l(t('edit comment'), "admin/comment/edit/$comment->cid"), l(t('delete comment'), "admin/comment/delete/$comment->cid"));
    }

    if ($rows) {
      $output  = '<h3>'. t('Edit comments') .'</h3>';
      $output .= theme('table', $header, $rows);
    }

    return $output;
  }
}

/**
 * Implementation of hook_search().
 *
 * This search function uses search.module's built-in content index by
 * calling do_search(). The "nid" identifier in the select is used to
 * present search results in the context of their associated node.
 */
function comment_search($keys) {
  $find = do_search(array("keys" => $keys, "type" => 'comment', "select" => "select s.lno as lno, c.nid as nid, c.subject as title, c.timestamp as created, u.uid as uid, u.name as name, s.count as count FROM {search_index} s, {comments} c INNER JOIN {users} u ON c.uid = u.uid WHERE s.lno = c.cid AND s.type = 'comment' AND c.status = 0 AND s.word like '%'"));

  return array(t('Matching comments ranked in order of relevance'), $find);
}

/**
 * Implementation of hook_update_index().
 *
 * The SQL statement returned checks for the last time the index was updated
 * so as not to cause redundant work for the indexer.
 */
function comment_update_index() {
  return array('last_update' => 'comment_cron_last', 'node_type' => 'comment', 'select' => 'SELECT c.cid as lno, c.subject as text1, c.comment as text2 FROM {comments} c WHERE c.status = 0 AND timestamp > '. variable_get('comment_cron_last', 1));
}

/**
 * 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
    return array(array('title' => t('Comment settings'), 'data' => form_textarea(t('Signature'), 'signature', $user->signature, 64, 3, t('Your signature will be publicly displayed at the end of your comments.') .'<br />'. filter_tips_short()), 'weight' => 2));
  }
  if ($type == 'validate') {
    // validate user data editing
    return array('signature' => $edit['signature']);
  }
}

336
337
338
/**
 * Menu callback; prints the comment-specific help text from admin/help.
 */
Dries's avatar
   
Dries committed
339
function comment_help_page() {
340
  print theme('page', comment_help('admin/help#comment'));
Dries's avatar
   
Dries committed
341
342
}

343
/**
Dries's avatar
   
Dries committed
344
 * Menu callback; presents the comment settings page.
345
 */
Dries's avatar
   
Dries committed
346
347
348
349
350
function comment_configure() {
  if ($_POST) {
    system_settings_save();
  }

351
352
353
354
  $group  = form_radios(t('Default display mode'), 'comment_default_mode', variable_get('comment_default_mode', 4), _comment_get_modes(), t('The default view for comments. Expanded views display the body of the comment. Threaded views keep replies together.'));
  $group .= form_radios(t('Default display order'), 'comment_default_order', variable_get('comment_default_order', 1), _comment_get_orders(), 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.'));
  $group .= form_select(t('Default comments per page'), 'comment_default_per_page', variable_get('comment_default_per_page', '50'), _comment_per_page(), t('Default number of comments for each page: more comments are distributed in several pages.'));
  $group .= form_radios(t('Comment controls'), 'comment_controls', variable_get('comment_controls', 0), array(t('Display above the comments'), t('Display below the comments'), t('Display above and below the comments'), t('Do not display')), t('Position of the comment controls box.  The comment controls let the user change the default display mode and display order of comments.'));
Dries's avatar
Dries committed
355
  $output = form_group(t('Comment viewing options'), $group);
Dries's avatar
   
Dries committed
356

Dries's avatar
   
Dries committed
357
  $group  = form_radios(t('Anonymous poster settings'), 'comment_anonymous', variable_get('comment_anonymous', 0), 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')), 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('user/admin/permission')));
358
359
360
  $group .= form_radios(t('Comment subject field'), 'comment_subject_field', variable_get('comment_subject_field', 1), array(t('Disabled'), t('Enabled')), t('Must users provide a subject for their comments?'));
  $group .= form_radios(t('Preview comment'), 'comment_preview', variable_get('comment_preview', 1), array(t('Optional'), t('Required')), t('Must users preview comments before submitting?'));
  $group .= form_radios(t('Location of comment submission form'), 'comment_form_location', variable_get('comment_form_location', 0), array(t('Display on separate page'), t('Display below post or comments')), t('The location of the comment submission form.'));
Dries's avatar
   
Dries committed
361
  $output .= form_group(t('Comment posting settings'), $group);
Dries's avatar
   
Dries committed
362

363
  $result = db_query('SELECT fid, filter FROM {moderation_filters} ');
Dries's avatar
   
Dries committed
364
365
  while ($filter = db_fetch_object($result)) {
    $thresholds[$filter->fid] = ($filter->filter);
Dries's avatar
   
Dries committed
366
  }
Dries's avatar
   
Dries committed
367
  if ($thresholds) {
368
    $group = form_select(t('Default threshold'), 'comment_default_threshold', variable_get('comment_default_threshold', 0), $thresholds, t('Thresholds are values below which comments are hidden. These thresholds are useful for busy sites which want to hide poor comments from most users.'));
Dries's avatar
   
Dries committed
369
370
    $output .= form_group(t('Comment moderation settings'), $group);
  }
Dries's avatar
   
Dries committed
371

Dries's avatar
   
Dries committed
372
  print theme('page', system_settings_form($output));
Dries's avatar
   
Dries committed
373
374
}

375
376
377
378
379
380
381
382
383
384
/**
 * 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
385
function comment_access($op, $comment) {
Dries's avatar
   
Dries committed
386
387
  global $user;

388
  if ($op == 'edit') {
Dries's avatar
   
Dries committed
389
    return $user->uid && $user->uid == $comment->uid && comment_num_replies($comment->cid) == 0;
Dries's avatar
   
Dries committed
390
391
  }
}
392

Dries's avatar
   
Dries committed
393
function comment_node_url() {
394
  return arg(0) .'/'. arg(1) .'/'. arg(2);
Dries's avatar
   
Dries committed
395
}
Dries's avatar
   
Dries committed
396

Dries's avatar
   
Dries committed
397
398
399
function comment_edit($cid) {
  global $user;

Dries's avatar
   
Dries committed
400
  $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 AND c.status != 2', $cid));
Dries's avatar
   
Dries committed
401
  $comment = drupal_unpack($comment);
Dries's avatar
   
Dries committed
402
  $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
403
  if (comment_access('edit', $comment)) {
Dries's avatar
   
Dries committed
404
    return comment_preview(object2array($comment));
Dries's avatar
   
Dries committed
405
406
407
408
  }
}

function comment_reply($pid, $nid) {
Dries's avatar
   
Dries committed
409

410
  $output = '';
Dries's avatar
   
Dries committed
411

412
  if (user_access('access comments')) {
Dries's avatar
   
Dries committed
413
414
415
416
417

    /*
    ** Show comment
    */

Dries's avatar
   
Dries committed
418
    if ($pid) {
Dries's avatar
   
Dries committed
419
      $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 = 0', $pid));
Dries's avatar
   
Dries committed
420
      $comment = drupal_unpack($comment);
Dries's avatar
   
Dries committed
421
      $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
422
      $output .= theme('comment_view', $comment);
Dries's avatar
   
Dries committed
423
    }
424
425
    else if (user_access('access content')) {
      $output .= node_view(node_load(array('nid' => $nid)));
Dries's avatar
   
Dries committed
426
427
      $pid = 0;
    }
Dries's avatar
   
Dries committed
428

Dries's avatar
   
Dries committed
429
430
431
432
    /*
    ** If possible, show reply form
    */

Dries's avatar
   
Dries committed
433
    if (node_comment_mode($nid) != 2) {
434
      $output .= theme('box', t('Reply'), t("This discussion is closed: you can't post new comments."));
Kjartan's avatar
Kjartan committed
435
    }
436
437
    else if (user_access('post comments')) {
      $output .= theme('comment_form', array('pid' => $pid, 'nid' => $nid), t('Reply'));
Dries's avatar
   
Dries committed
438
439
    }
    else {
440
      $output .= theme('box', t('Reply'), t('You are not authorized to post comments.'));
Dries's avatar
   
Dries committed
441
    }
Kjartan's avatar
Kjartan committed
442
443
  }
  else {
444
    $output .= theme('box', t('Reply'), t('You are not authorized to view comments.'));
Dries's avatar
   
Dries committed
445
  }
Dries's avatar
   
Dries committed
446
447

  return $output;
Dries's avatar
   
Dries committed
448
449
}

Dries's avatar
   
Dries committed
450
451
function comment_validate_form($edit) {
  global $user;
Dries's avatar
   
Dries committed
452

Dries's avatar
   
Dries committed
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
  /*
  ** Validate the comment's body.
  */

  if ($edit['comment'] == '') {
    form_set_error('comment', t('The body of your comment is empty.'));
  }

  /*
  ** Check validity of name, mail and homepage (if given)
  */

  if (!$user->uid) {
    if (variable_get('comment_anonymous', 0) > 0) {
      if ($edit['name']) {
        $taken = db_result(db_query("SELECT COUNT(uid) FROM {users} WHERE LOWER(name) = '%s'", strip_tags($edit['name'])), 0);

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

      }
      else if (variable_get('comment_anonymous', 0) == 2) {
        form_set_error('name', t('You have to leave your name.'));
      }

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

Dries's avatar
   
Dries committed
497
function comment_preview($edit) {
Dries's avatar
   
Dries committed
498
  global $user;
Dries's avatar
   
Dries committed
499

500
  $output = '';
Dries's avatar
   
Dries committed
501

Dries's avatar
   
Dries committed
502
503
504
505
  foreach ($edit as $key => $value) {
    $comment->$key = $value;
  }

506
  // Attach the user and time information.
Dries's avatar
   
Dries committed
507
508
  $comment->uid = $user->uid;
  $comment->timestamp = time();
Dries's avatar
   
Dries committed
509
  $comment->name = $user->name ? $user->name : $comment->name;
Dries's avatar
   
Dries committed
510

511
512
513
  // Preview the comment.
  $output .= theme('comment_view', $comment, theme('links', module_invoke_all('link', 'comment', $comment, 1)));
  $output .= theme('comment_form', $edit, t('Reply'));
Kjartan's avatar
Kjartan committed
514

515
516
  if ($edit['pid']) {
    $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 = 0', $edit['pid']));
Dries's avatar
   
Dries committed
517
    $comment = drupal_unpack($comment);
Dries's avatar
   
Dries committed
518
    $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
519
    $output .= theme('comment_view', $comment);
Kjartan's avatar
Kjartan committed
520
521
  }
  else {
522
523
    $output .= node_view(node_load(array('nid' => $edit['nid'])));
    $edit['pid'] = 0;
Kjartan's avatar
Kjartan committed
524
  }
Dries's avatar
   
Dries committed
525
526

  return $output;
Dries's avatar
   
Dries committed
527
528
529
}

function comment_post($edit) {
Dries's avatar
   
Dries committed
530
  global $user;
Dries's avatar
   
Dries committed
531

532
  if (user_access('post comments') && node_comment_mode($edit['nid']) == 2) {
Dries's avatar
   
Dries committed
533

534
535
    // Validate the comment's subject.  If not specified, extract
    // one from the comment's body.
Dries's avatar
   
Dries committed
536
    $edit['subject'] = strip_tags($edit['subject']);
Dries's avatar
   
Dries committed
537

538
    if ($edit['subject'] == '') {
Dries's avatar
   
Dries committed
539
      $edit['subject'] = truncate_utf8(strip_tags($edit['comment']), 29);
Dries's avatar
   
Dries committed
540
541
    }

Dries's avatar
   
Dries committed
542
    if (!form_get_errors()) {
543
544
      // Check for duplicate comments.  Note that we have to use the
      // validated/filtered data to perform such check.
Dries's avatar
   
Dries committed
545

Dries's avatar
   
Dries committed
546
547
      $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);
      if ($duplicate != 0) {
548
        watchdog('warning', t('comment: duplicate "%comment-subject"', array('%comment-subject' => $edit["subject"])));
Dries's avatar
   
Dries committed
549
      }
Dries's avatar
   
Dries committed
550

Dries's avatar
   
Dries committed
551
      if ($edit["cid"]) {
552
553
554
        // Update the comment in the database.  Note that the update
        // query will fail if the comment isn't owned by the current
        // user.
Dries's avatar
   
Dries committed
555
        db_query("UPDATE {comments} SET subject = '%s', comment = '%s' WHERE cid = %d AND uid = '$user->uid'", $edit['subject'], $edit['comment'], $edit["cid"]);
Dries's avatar
   
Dries committed
556

557
558
        // Allow modules to respond to the updating of a comment.
        module_invoke_all('comment', 'update', $edit);
Dries's avatar
   
Dries committed
559

560
        // Add entry to the watchdog log.
Dries's avatar
   
Dries committed
561
        watchdog('special', t('comment: updated "%comment-subject"', array('%comment-subject' => $edit['subject'])), l(t('view comment'), 'node/'. $edit['nid'], NULL, NULL, 'comment-'. $edit['cid']));
Dries's avatar
   
Dries committed
562
563
      }
      else {
564
565
566
        // Add the comment to database.
        $status = user_access('post comments without approval') ? 0 : 1;
        $roles = variable_get('comment_roles', array());
Dries's avatar
   
Dries committed
567
568
569
570
571
572
        $score = 0;

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

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

Dries's avatar
   
Dries committed
575
576
577
578
579
        /*
        ** Here we are building the thread field.  See the comment
        ** in comment_render().
        */

580
        if ($edit['pid'] == 0) {
Dries's avatar
   
Dries committed
581
582
583
584
585
          /*
          ** This is a comment with no parent comment (depth 0): we start
          ** by retrieving the maximum thread level.
          */

586
          $max = db_result(db_query('SELECT MAX(thread) FROM {comments} WHERE nid = %d', $edit['nid']));
Dries's avatar
   
Dries committed
587

588
589
          // Strip the "/" from the end of the thread.
          $max = rtrim($max, '/');
Dries's avatar
   
Dries committed
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607

          /*
          ** 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);
          $units = substr($max, -1, 1);
          if ($units) {
            $units++;
          }
          else {
            $units = 1;
          }

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

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

          // 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
624
          // Strip the "/" from the end of the parent thread.
          $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.
Dries's avatar
   
Dries committed
631
632
633
            $thread = "$parent->thread.1/";
          }
          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
642
643
644
645
646
647
648
649
650
651
652
            $last = $parts[$parent_depth];

            /*
            ** 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($last, 0, strlen($last) - 1);
            $units = substr($last, -1, 1);
            $units++;
            if ($units == 10) {
653
              $units = '90';
Dries's avatar
   
Dries committed
654
655
            }

656
657
            // Finally, build the thread field for this new comment.
            $thread = "$parent->thread.". $decimals.$units .'/';
Dries's avatar
   
Dries committed
658
659
660
661
          }
        }


Dries's avatar
   
Dries committed
662
        $edit["cid"] = db_next_id("{comments}_cid");
Dries's avatar
   
Dries committed
663

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

666
667
        // Tell the other modules a new comment has been submitted.
        module_invoke_all('comment', 'insert', $edit);
Dries's avatar
   
Dries committed
668

669
        // Add an entry to the watchdog log.
Dries's avatar
   
Dries committed
670
        watchdog('special', t('comment: added "%comment-subject"', array('%comment-subject' => $edit['subject'])), l(t('view comment'), 'node/'. $edit['nid'], NULL, NULL, 'comment-'. $edit['cid']));
Dries's avatar
   
Dries committed
671
      }
Dries's avatar
   
Dries committed
672

673
      // Clear the cache so an anonymous user can see his comment being added.
Dries's avatar
   
Dries committed
674
      cache_clear_all();
Dries's avatar
   
Dries committed
675
676
677
678
679
680
681
682
683
684

      /*
      ** Redirect the user the node he commented on, or explain queue
      */

      if ($status == 1) {
        print theme('page', t('Your comment has been queued for moderation by site administrators and will be published after approval.'));
      }
      else {
        // Redirect the user to his comment:
Dries's avatar
   
Dries committed
685
        drupal_goto('node/'. $edit['nid'] .'#comment-'. $edit['cid']);
Dries's avatar
   
Dries committed
686
687
688
689
      }
    }
    else {
      print theme('page', comment_preview($edit));
Dries's avatar
   
Dries committed
690
691
    }
  }
Dries's avatar
   
Dries committed
692
  else {
693
    watchdog('error', t('comment: unauthorized comment submitted or comment submitted to a closed node "%comment-subject"', array('%comment-subject' => $edit['subject'])));
Dries's avatar
   
Dries committed
694
695
696
697
  }
}

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

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

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

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

724
  if ($moderation = theme('comment_moderation_form', $comment)) {
Dries's avatar
   
Dries committed
725
726
    $links[] = $moderation;
  }
Dries's avatar
   
Dries committed
727

Dries's avatar
   
Dries committed
728
  return $links;
Dries's avatar
   
Dries committed
729
730
}

Dries's avatar
   
Dries committed
731
function comment_render($node, $cid = 0) {
Dries's avatar
   
Dries committed
732
733
  global $user;

734
735
736
737
738
  $mode = $_GET['mode'];
  $order = $_GET['order'];
  $threshold = $_GET['threshold'];
  $comments_per_page = $_GET['comments_per_page'];
  $comment_page = $_GET['comment_page'];
Dries's avatar
   
Dries committed
739

740
  $output = '';
Dries's avatar
   
Dries committed
741

742
743
  if (user_access('access comments')) {
    // Pre-process variables.
Dries's avatar
   
Dries committed
744
    $nid = $node->nid;
Dries's avatar
   
Dries committed
745
746
    if (empty($nid)) {
      $nid = 0;
Dries's avatar
   
Dries committed
747
748
749
    }

    if (empty($mode)) {
750
      $mode = $user->mode ? $user->mode : ($_SESSION['comment_mode'] ? $_SESSION['comment_mode'] : variable_get('comment_default_mode', 4));
Dries's avatar
   
Dries committed
751
752
753
    }

    if (empty($order)) {
754
      $order = $user->sort ? $user->sort : ($_SESSION['comment_sort'] ? $_SESSION['comment_sort'] : variable_get('comment_default_order', 1));
Dries's avatar
   
Dries committed
755
756
    }
    if (empty($threshold)) {
757
      $threshold = $user->threshold ? $user->threshold : ($_SESSION['comment_threshold'] ? $_SESSION['comment_threshold'] : variable_get('comment_default_threshold', 0));
Dries's avatar
   
Dries committed
758
    }
759
    $threshold_min = db_result(db_query('SELECT minimum FROM {moderation_filters} WHERE fid = %d', $threshold));
Dries's avatar
   
Dries committed
760

Dries's avatar
   
Dries committed
761
    if (empty($comments_per_page)) {
762
      $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
763
    }
Dries's avatar
   
Dries committed
764

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

Kjartan's avatar
Kjartan committed
767
    if ($cid) {
768
      // Single comment view.
Dries's avatar
   
Dries committed
769

770
771
      $output .= '<form method="post" action="'. url('comment') ."\"><div>\n";
      $output .= form_hidden('nid', $nid);
Dries's avatar
   
Dries committed
772

Dries's avatar
   
Dries committed
773
      $result = db_query('SELECT c.cid, c.pid, c.nid, c.subject, c.comment, 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 = 0 GROUP BY c.cid, c.pid, c.nid, c.subject, c.comment, c.timestamp, u.uid, u.name, u.picture, u.data, c.score, c.users', $cid);
Dries's avatar
   
Dries committed
774

Dries's avatar
   
Dries committed
775
      if ($comment = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
776
        $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
Dries's avatar
   
Dries committed
777
        $output .= theme('comment_view', $comment, theme('links', module_invoke_all('link', 'comment', $comment, 1)));
Dries's avatar
   
Dries committed
778
      }
Dries's avatar
   
Dries committed
779

Dries's avatar
   
Dries committed
780
      if ((comment_user_can_moderate($node)) && $user->uid != $comment->uid && !(comment_already_moderated($user->uid, $comment->users))) {
781
        $output .= '<div style="text-align: center;">'. form_submit(t('Moderate comment')) .'</div><br />';
Dries's avatar
   
Dries committed
782
      }
783
      $output .= '</div></form>';
Dries's avatar
   
Dries committed
784
    }
Dries's avatar
   
Dries committed
785
    else {
786
      // Multiple comment view
Dries's avatar
   
Dries committed
787

Dries's avatar
   
Dries committed
788
      $query .= "SELECT c.cid as cid, c.pid, c.nid, c.subject, c.comment, 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 = '". check_query($nid) ."' AND c.status = 0";
Dries's avatar
   
Dries committed
789

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

Dries's avatar
   
Dries committed
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
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
      /*
      ** 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
854
855

      if ($order == 1) {
Dries's avatar
   
Dries committed
856
        if ($mode == 1 || $mode == 2) {
857
          $query .= ' ORDER BY c.timestamp DESC';
Dries's avatar
   
Dries committed
858
859
        }
        else {
860
          $query .= ' ORDER BY c.thread DESC';
Dries's avatar
   
Dries committed
861
        }
Dries's avatar
   
Dries committed
862
      }
Dries's avatar
   
Dries committed
863
      else if ($order == 2) {
Dries's avatar
   
Dries committed
864
        if ($mode == 1 || $mode == 2) {
865
          $query .= ' ORDER BY c.timestamp';
Dries's avatar
   
Dries committed
866
867
868
869
870
871
872
873
874
        }
        else {

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

875
          $query .= ' ORDER BY SUBSTRING(c.thread, 1, (LENGTH(c.thread) - 1))';
Dries's avatar
   
Dries committed
876
        }
Dries's avatar
   
Dries committed
877
878
      }

879
      // Start a form, for use with comment control and moderation.
Dries's avatar
   
Dries committed
880
      $result = pager_query($query, $comments_per_page, 0, "SELECT COUNT(*) FROM {comments} WHERE nid = '". check_query($nid) ."'");
881
882
883
884
885
      if (db_num_rows($result) && (variable_get('comment_controls', 0) == 0 || variable_get('comment_controls', 0) == 2)) {
        $output .= '<form method="post" action="'. url('comment') ."\"><div>\n";
        $output .= theme('comment_controls', $threshold, $mode, $order, $comments_per_page);
        $output .= form_hidden('nid', $nid);
        $output .= '</div></form>';
Dries's avatar
   
Dries committed
886
      }
Dries's avatar
   
Dries committed
887

888
889
      $output .= '<form method="post" action="'. url('comment') ."\"><div>\n";
      $output .= form_hidden('nid', $nid);
Dries's avatar
   
Dries committed
890

Dries's avatar
   
Dries committed
891
      while ($comment = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
892
        $comment = drupal_unpack($comment);
Dries's avatar
   
Dries committed
893
        $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
894
        $comment->depth = count(explode('.', $comment->thread)) - 1;
Dries's avatar
   
Dries committed
895

Dries's avatar
   
Dries committed
896
        if ($mode == 1) {
897
          $output .= theme('comment_flat_collapsed', $comment, $threshold_min);
Dries's avatar
   
Dries committed
898
        }
Dries's avatar
   
Dries committed
899
        else if ($mode == 2) {
900
          $output .= theme('comment_flat_expanded', $comment, $threshold_min);
Dries's avatar
   
Dries committed
901
        }
Dries's avatar
   
Dries committed
902
        else if ($mode == 3) {
903
          $output .= theme('comment_thread_min', $comment, $threshold_min);
Dries's avatar
   
Dries committed
904
        }
Dries's avatar
   
Dries committed
905
        else if ($mode == 4) {
906
          $output .= theme('comment_thread_max', $comment, $threshold_min);
Dries's avatar
   
Dries committed
907
        }
Dries's avatar
   
Dries committed
908
      }
Dries's avatar
   
Dries committed
909

Dries's avatar
   
Dries committed
910
911
912
913
914
915
916
      /*
      ** Use the standard pager; $pager_total is the number of returned rows,
      ** is global and defined in pager.inc.
      */
      if ($pager = theme('pager', NULL, $comments_per_page, 0, array('comments_per_page' => $comments_per_page))) {
        $output .= $pager;
      }
Dries's avatar
   
Dries committed
917

Dries's avatar
   
Dries committed
918
919
920
      if (db_num_rows($result) && comment_user_can_moderate($node)) {
        $output .= '<div align="center">'. form_submit(t('Moderate comments')) .'</div><br />';
      }
Dries's avatar
   
Dries committed
921

Dries's avatar
   
Dries committed
922
      $output .= '</div></form>';
Dries's avatar
   
Dries committed
923

Dries's avatar
   
Dries committed
924
925
926
927
928
929
930
931
932
933
934
935
936
937
      if (db_num_rows($result) && (variable_get('comment_controls', 0) == 1 || variable_get('comment_controls', 0) == 2)) {
        $output .= '<form method="post" action="'. url('comment') ."\"><div>\n";
        $output .= theme('comment_controls', $threshold, $mode, $order, $comments_per_page);
        $output .= form_hidden('nid', $nid);
        $output .= '</div></form>';
      }
    }

    // If enabled, show new comment form.
    if (user_access('post comments') && node_comment_mode($nid) == 2 && variable_get('comment_form_location', 0)) {
      $output .= theme('comment_form', array('nid' => $nid), t('Post new comment'));
    }
  }
  return $output;
Dries's avatar
   
Dries committed
938
939
940
941
}

/**
 * Menu callback; dispatches to the correct comment function.
942
 */
Dries's avatar
   
Dries committed
943
function comment_page() {
944
945
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries's avatar
   
Dries committed
946
947
948
949

  if (empty($op)) {
    $op = arg(1);
  }
Dries's avatar
   
Dries committed
950
951

  switch ($op) {
952
953
    case 'edit':
      print theme('page', comment_edit(check_query(arg(2))), t('Edit comment'));;
Dries's avatar
   
Dries committed
954
      break;
955
956
    case t('Moderate comments'):
    case t('Moderate comment'):
Dries's avatar
   
Dries committed
957
      comment_moderate($edit);
Dries's avatar
   
Dries committed
958
      drupal_goto('node/'. $edit['nid'] .'#comment');
Dries's avatar
   
Dries committed
959
      break;
960
961
    case 'reply':
      print theme('page', comment_reply(check_query(arg(3)), check_query(arg(2))), t('Add new comment'));
Dries's avatar
   
Dries committed
962
      break;
963
    case t('Preview comment'):
Dries's avatar
   
Dries committed
964
      comment_validate_form($edit);
965
      print theme('page', comment_preview($edit), t('Preview comment'));
Dries's avatar
   
Dries committed
966
      break;
967
    case t('Post comment'):
Dries's avatar
   
Dries committed
968
969
      comment_validate_form($edit);
      print theme('page', comment_post($edit));
Dries's avatar
   
Dries committed
970
      break;
971
972
973
974
975
    case t('Save settings'):
      $mode = $_POST['mode'];
      $order = $_POST['order'];
      $threshold = $_POST['threshold'];
      $comments_per_page = $_POST['comments_per_page'];
Dries's avatar
   
Dries committed
976

977
      comment_save_settings(check_query($mode), check_query($order), check_query($threshold), check_query($comments_per_page));
Dries's avatar
   
Dries committed
978
      drupal_goto('node/'. $edit['nid'] .'#comment');
Dries's avatar
   
Dries committed
979
980
981
982
      break;
  }
}

Dries's avatar
   
Dries committed
983
984
function comment_admin_edit($id) {

Dries's avatar
   
Dries committed
985
  $result = db_query('SELECT c.*, u.name AS registered_name, u.uid FROM {comments} c INNER JOIN {users} u ON c.uid = u.uid WHERE c.cid = %d AND c.status != 2', $id);
Dries's avatar
   
Dries committed
986
  $comment = db_fetch_object($result);
Dries's avatar
   
Dries committed
987
  $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
Dries's avatar
   
Dries committed
988
  $comment = drupal_unpack($comment);
Dries's avatar
   
Dries committed
989
990

  if ($comment) {
991
992
993
994
995
996
    $form .= form_item(t('Author'), format_name($comment));
    $form .= form_textfield(t('Subject'), 'subject', $comment->subject, 70, 128);
    $form .= form_textarea(t('Comment'), 'comment', $comment->comment, 70, 15, filter_tips_short());
    $form .= form_radios(t('Status'), 'status', $comment->status, array('published', 'not published'));
    $form .= form_hidden('cid', $id);
    $form .= form_submit(t('Submit'));
Dries's avatar
   
Dries committed
997
998
999

    return form($form);
  }
Dries's avatar
 
Dries committed
1000
1001
}

1002
function comment_delete($cid, $confirmed = 0) {
Dries's avatar
   
Dries committed
1003
1004
  $comment = db_fetch_object(db_query('SELECT c.*, u.name AS registered_name, u.uid FROM {comments} c INNER JOIN {users} u ON u.uid = c.uid WHERE c.cid = %d', $cid));
  $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
1005
1006
1007

  if ($comment->cid) {
    if ($confirmed) {
1008
      drupal_set_message(t('the comment and all its replies have been deleted.'));
1009

1010
      // Delete the comment and all of its replies.
1011
1012
      _comment_delete_thread($comment);

1013
      // Clear the cache so an anonymous user can see his comment being added.
1014
1015
1016
      cache_clear_all();
    }
    else {
1017
      drupal_set_message(t('do you want to delete this comment and all its replies?'));
Dries's avatar
   
Dries committed
1018

1019
      // Print a confirmation screen.
Dries's avatar
   
Dries committed
1020
      $output  = theme('comment', $comment);
1021
      $output .= form_submit(t('Delete comment'));
1022
1023
1024

      return form($output);
    }
Dries's avatar
   
Dries committed
1025
1026
  }
  else {
1027
    drupal_set_message(t('the comment no longer exists.'));
Dries's avatar
   
Dries committed
1028
  }
Dries's avatar
   
Dries committed
1029
1030
}

Dries's avatar
   
Dries committed
1031
function comment_save($id, $edit) {
Dries's avatar
   
Dries committed
1032
  db_query("UPDATE {comments} SET subject = '%s', comment = '%s', status = %d WHERE cid = %d", $edit['subject'], $edit['comment'], $edit['status'], $id);
1033
1034
  watchdog('special', t('comment: modified "%comment-subject"', array('%comment-subject' => $edit['subject'])));
  drupal_set_message(t('the comment has been saved.'));
Dries's avatar
   
Dries committed
1035
1036
}

Dries's avatar
   
Dries committed
1037
function comment_admin_overview() {
Dries's avatar
   
Dries committed
1038

Dries's avatar
   
Dries committed
1039
  $header = array(
1040
1041
1042
1043
1044
    array('data' => t('subject'), 'field' => 'subject'),
    array('data' => t('author'), 'field' => 'u.name'),
    array('data' => t('status'), 'field' => 'status'),
    array('data' => t('time'), 'field' => 'c.timestamp', 'sort' => 'desc'),
    array('data' => t('operations'), 'colspan' => 2)
Dries's avatar
   
Dries committed
1045
1046
  );

Dries's avatar
   
Dries committed
1047
  $status = (arg(2) == 'approval') ? 1 : 0;
Dries's avatar
   
Dries committed
1048
  $sql = 'SELECT c.subject, c.nid, c.cid, c.comment, c.timestamp, c.status, c.name, c.homepage, u.name AS registered_name, u.uid FROM {comments} c INNER JOIN {users} u ON u.uid = c.uid WHERE c.status = '. check_query($status);
Dries's avatar
   
Dries committed
1049
1050
  $sql .= tablesort_sql($header);
  $result = pager_query($sql,  50);
Dries's avatar
   
Dries committed
1051
1052

  while ($comment = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
1053
    $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
1054
    $rows[] = array(
Dries's avatar
   
Dries committed
1055
        l($comment->subject, "node/$comment->nid", array('title' => htmlspecialchars(truncate_utf8(