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

Dries's avatar
   
Dries committed
4
function comment_help($section = "admin/help#comment") {
Dries's avatar
   
Dries committed
5
6
7
  $output = "";

  switch ($section) {
Dries's avatar
   
Dries committed
8
    case 'admin/help#comment':
Dries's avatar
   
Dries committed
9
10
11
12
13
      $output = t("
      <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>
14
      <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
15
16
17
18
      <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>
19
      <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; configuration &raquo; modules &raquo; comment</a>.</p>
Dries's avatar
   
Dries committed
20
      <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
21

Dries's avatar
   
Dries committed
22
      <h3>Additional comment configurations</h3>
23
      <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>
Dries's avatar
   
Dries committed
24
25
26
27
28
29
30
31
32
      <p>Administrators can control access to various comment module functions through <a href=\"%user-permissions\">administer &raquo; accounts &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>
      <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
33

Dries's avatar
   
Dries committed
34
35
36
37
      <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>
38
39
      <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
40
      </ul>
Dries's avatar
   
Dries committed
41

Dries's avatar
   
Dries committed
42
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>
      <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; moderation</a> must be configured.</p>
Dries's avatar
   
Dries committed
46

Dries's avatar
   
Dries committed
47
      <h4>Moderation votes</h4>
48
      <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; moderation &raquo; 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
49
50
51
52
53
54
55
56
57
58
      <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
59

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

Dries's avatar
   
Dries committed
62
63
64
65
      <p>Next go to <a href=\"%comment-matrix\">administer &raquo; comments &raquo; moderation &raquo; 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>
      <p>NOTE: Comment ratings are calculated by averaging user votes with the initial rating.</p>
      <h4>Creating comment thresholds</h4>
      <p>In <a href=\"%comment-thresholds\">administer &raquo; comments &raquo; moderation &raquo; 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>
66
      <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
67
      <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
68

Dries's avatar
   
Dries committed
69
      <h4>Initial comment scores</h4>
70
      <p>Finally, you may want to enter some <em>initial comment scores</em>. In <a href=\"%comment-initial\">administer &raquo; comments &raquo; initial comment scores</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/system/modules/comment"), "%site-config" => url("admin/system"), "%user-permissions" => url("admin/user/permission"), "%tracker" => url("tracker"), "%download-notify" => "http://drupal.org/project/releases", "%permission" => url("admin/user/permission"), "%comment-moderation" => url("admin/comment/moderation"), "%comment-votes" => url("admin/comment/moderation/votes"), "%comment-matrix" => url("admin/comment/moderation/matrix"), "%comment-thresholds" => url("admin/comment/moderation/filters"), "%slashdot" => " http://slashdot.org", "%comment-initial" => url("admin/comment/moderation/roles")));
Dries's avatar
   
Dries committed
71
      break;
Dries's avatar
   
Dries committed
72
    case 'admin/system/modules#description':
Dries's avatar
   
Dries committed
73
74
75
      $output = t("Enables user to comment on content (nodes).");
      break;
    case 'admin/system/modules/comment':
76
      $output = 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 cronological 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; moderation &raquo; 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/moderation/filters")));
Dries's avatar
   
Dries committed
77
78
79
80
81
      break;
    case 'admin/comment':
      $output = t("Comments let users give feedback to content authors.  Here you may review/approve/deny recent comments, and configure moderation if desired.");
      break;
    case 'admin/comment/comments':
82
      $output = t("Click on <a href=\"%nup\">new or updated comments</a> to see your latest comments, or <a href=\"%queue\">comment approval queue</a> to approve new comments.", array("%nup" => url("admin/comment/comments/0"), "%queue" => url("admin/comment/comments/1")));
Dries's avatar
   
Dries committed
83
84
85
86
87
      break;
    case 'admin/comment/comments/0':
      $output = 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.");
      break;
    case 'admin/comment/comments/1':
88
      $output = t("Below is a list of the comments posted to your site that need approval. To approve a comment click on <strong>\"edit comment\"</strong> and then change its <strong>moderation status</strong> 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.");
Dries's avatar
   
Dries committed
89
      break;
Dries's avatar
   
Dries committed
90
91
    case 'admin/comment/moderation':
      $output = t("If you have a 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/moderation/votes"), "%matrix" => url("admin/comment/moderation/matrix"), "%threshhold" => url("admin/comment/moderation/filters")));
Dries's avatar
   
Dries committed
92
93
      break;
    case 'admin/comment/moderation/votes':
94
      $output = t("Here is where you setup the names of each type of vote. Weight lets you set the order of the drop down menu. Click <strong>edit</strong> 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 <strong>delete</strong> a name/weight combiniation go to the <strong>edit</strong> area.</li></ul>");
Dries's avatar
   
Dries committed
95
96
      break;
    case 'admin/comment/moderation/matrix':
97
      $output = 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 <strong>moderate comments</strong> 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 <strong>lowering</strong> a comments over all score.</li></ul>");
Dries's avatar
   
Dries committed
98
99
      break;
    case 'admin/comment/moderation/filters':
100
      $output = t("<em>Optional</em> 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 exsisting threashold. To <strong>delete</strong> a threshold click on \"edit\".");
Dries's avatar
   
Dries committed
101
102
      break;
    case 'admin/comment/moderation/roles':
103
      $output = t("Here you can setup the <strong>initial</strong> 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
104
      break;
Dries's avatar
   
Dries committed
105
    case 'admin/comment/search':
Dries's avatar
   
Dries committed
106
107
      $output = 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'.");
      break;
Dries's avatar
   
Dries committed
108
  }
Dries's avatar
   
Dries committed
109
  return $output;
Dries's avatar
   
Dries committed
110
111
}

Dries's avatar
   
Dries committed
112
function comment_help_page() {
Dries's avatar
   
Dries committed
113
  print theme('page', comment_help());
Dries's avatar
   
Dries committed
114
115
}

116
function comment_settings() {
Dries's avatar
   
Dries committed
117
118
119
120
  $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
121
  $output = form_group(t('Comment viewing options'), $group);
Dries's avatar
   
Dries committed
122

Dries's avatar
   
Dries committed
123
124
  $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')));
  $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?'));
Dries's avatar
   
Dries committed
125
  $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?"));
Dries's avatar
   
Dries committed
126
127
  $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."));
  $output .= form_group(t('Comment posting settings'), $group);
Dries's avatar
   
Dries committed
128

Dries's avatar
   
Dries committed
129
  $result = db_query("SELECT fid, filter FROM {moderation_filters} ");
Dries's avatar
   
Dries committed
130
131
  while ($filter = db_fetch_object($result)) {
    $thresholds[$filter->fid] = ($filter->filter);
Dries's avatar
   
Dries committed
132
  }
Dries's avatar
   
Dries committed
133
134
135
136
  if ($thresholds) {
    $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."));
    $output .= form_group(t('Comment moderation settings'), $group);
  }
Dries's avatar
   
Dries committed
137

Dries's avatar
   
Dries committed
138
  return $output;
Dries's avatar
   
Dries committed
139
140
}

Dries's avatar
   
Dries committed
141
142
function comment_user($type, $edit, &$user) {
  switch ($type) {
143
    case 'edit':
Dries's avatar
   
Dries committed
144
      // when user tries to edit his own data
145
      return array(t('Personal information') => 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()));
146
    case 'validate':
Dries's avatar
   
Dries committed
147
      // validate user data editing
Dries's avatar
   
Dries committed
148
      return array("signature" => $edit["signature"]);
Dries's avatar
   
Dries committed
149
150
151
  }
}

Dries's avatar
   
Dries committed
152
function comment_access($op, $comment) {
Dries's avatar
   
Dries committed
153
154
  global $user;

Dries's avatar
   
Dries committed
155
156
157
158
159
160
161
162
163
164
165
  if ($op == "edit") {

    /*
    ** Authenticated users can edit their comments as long they have
    ** not been replied to.  This, in order to avoid people changing
    ** or revising their statements based on the replies their posts
    ** got. Furthermore, users can't reply to their own comments and
    ** are encouraged to extend their original comment.
    */

    return $user->uid && $user->uid == $comment->uid && comment_num_replies($comment->cid) == 0;
Dries's avatar
   
Dries committed
166
  }
Dries's avatar
   
Dries committed
167

Dries's avatar
   
Dries committed
168
}
Dries's avatar
   
Dries committed
169
170
function comment_node_url() {
  return arg(0) ."/". arg(1) ."/". arg(2);
Dries's avatar
   
Dries committed
171
}
Dries's avatar
   
Dries committed
172

Dries's avatar
   
Dries committed
173
174
175
function comment_edit($cid) {
  global $user;

Dries's avatar
   
Dries committed
176
  $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
177
  $comment = drupal_unpack($comment);
Dries's avatar
   
Dries committed
178
  $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
Dries's avatar
   
Dries committed
179
  if (comment_access("edit", $comment)) {
Dries's avatar
   
Dries committed
180
    return comment_preview(object2array($comment));
Dries's avatar
   
Dries committed
181
182
183
184
  }
}

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

Dries's avatar
   
Dries committed
186
  $output = "";
Dries's avatar
   
Dries committed
187

188
  if (user_access("access comments")) {
Dries's avatar
   
Dries committed
189
190
191
192
193

    /*
    ** Show comment
    */

Dries's avatar
   
Dries committed
194
    if ($pid) {
Dries's avatar
   
Dries committed
195
      $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
196
      $comment = drupal_unpack($comment);
Dries's avatar
   
Dries committed
197
      $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
Dries's avatar
   
Dries committed
198
      $output .= theme("comment_view", $comment);
Dries's avatar
   
Dries committed
199
    }
Dries's avatar
   
Dries committed
200
    else if (user_access("access content")) {
Dries's avatar
   
Dries committed
201
      $output .= node_view(node_load(array("nid" => $nid)));
Dries's avatar
   
Dries committed
202
203
      $pid = 0;
    }
Dries's avatar
   
Dries committed
204

Dries's avatar
   
Dries committed
205
206
207
208
    /*
    ** If possible, show reply form
    */

Dries's avatar
   
Dries committed
209
    if (node_comment_mode($nid) != 2) {
Dries's avatar
   
Dries committed
210
      $output .= theme('box', t("Reply"), t("This discussion is closed: you can't post new comments."));
Kjartan's avatar
Kjartan committed
211
    }
Dries's avatar
   
Dries committed
212
    else if (user_access("post comments")) {
Dries's avatar
   
Dries committed
213
      $output .= theme("comment_form", array("pid" => $pid, "nid" => $nid), t("Reply"));
Dries's avatar
   
Dries committed
214
215
    }
    else {
Dries's avatar
   
Dries committed
216
      $output .= theme('box', t("Reply"), t("You are not authorized to post comments."));
Dries's avatar
   
Dries committed
217
    }
Kjartan's avatar
Kjartan committed
218
219
  }
  else {
Dries's avatar
   
Dries committed
220
    $output .= theme('box', t("Reply"), t("You are not authorized to view comments."));
Dries's avatar
   
Dries committed
221
  }
Dries's avatar
   
Dries committed
222
223

  return $output;
Dries's avatar
   
Dries committed
224
225
}

Dries's avatar
   
Dries committed
226
227
function comment_validate_form($edit) {
  global $user;
Dries's avatar
   
Dries committed
228

Dries's avatar
   
Dries committed
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
  /*
  ** 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'])) {
          form_set_error('mail', t('The e-mail address you specifed is not valid.'));
        }
      }
      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
273
function comment_preview($edit) {
Dries's avatar
   
Dries committed
274
  global $user;
Dries's avatar
   
Dries committed
275

Dries's avatar
   
Dries committed
276
277
  $output = "";

Dries's avatar
   
Dries committed
278
279
280
281
  foreach ($edit as $key => $value) {
    $comment->$key = $value;
  }

Dries's avatar
   
Dries committed
282
  /*
Dries's avatar
   
Dries committed
283
  ** Attach the user and time information:
Dries's avatar
   
Dries committed
284
285
286
287
  */

  $comment->uid = $user->uid;
  $comment->timestamp = time();
Dries's avatar
   
Dries committed
288
  $comment->name = $user->name ? $user->name : $comment->name;
Dries's avatar
   
Dries committed
289
290
291
292
293

  /*
  ** Preview the comment:
  */

Dries's avatar
   
Dries committed
294
  $output .= theme("comment_view", $comment, theme('links', module_invoke_all('link', 'comment', $comment, 1)));
Dries's avatar
   
Dries committed
295
  $output .= theme("comment_form", $edit, t("Reply"));
Kjartan's avatar
Kjartan committed
296
297

  if ($edit["pid"]) {
Dries's avatar
   
Dries committed
298
    $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
299
    $comment = drupal_unpack($comment);
Dries's avatar
   
Dries committed
300
    $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
Dries's avatar
   
Dries committed
301
    $output .= theme("comment_view", $comment);
Kjartan's avatar
Kjartan committed
302
303
  }
  else {
Dries's avatar
   
Dries committed
304
    $output .= node_view(node_load(array("nid" => $edit["nid"])));
Kjartan's avatar
Kjartan committed
305
306
    $edit["pid"] = 0;
  }
Dries's avatar
   
Dries committed
307
308

  return $output;
Dries's avatar
   
Dries committed
309
310
311
}

function comment_post($edit) {
Dries's avatar
   
Dries committed
312
  global $user;
Dries's avatar
   
Dries committed
313

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

Dries's avatar
   
Dries committed
316
317
318
319
320
    /*
    ** Validate the comment's subject.  If not specified, extract
    ** one from the comment's body.
    */

Dries's avatar
   
Dries committed
321
    $edit['subject'] = strip_tags($edit['subject']);
Dries's avatar
   
Dries committed
322

Dries's avatar
   
Dries committed
323
324
    if ($edit['subject'] == "") {
      $edit['subject'] = truncate_utf8(strip_tags($edit['comment']), 29);
Dries's avatar
   
Dries committed
325
326
    }

Dries's avatar
   
Dries committed
327
328
329
330
331
    if (!form_has_errors()) {
      /*
      ** Check for duplicate comments.  Note that we have to use the
      ** validated/filtered data to perform such check.
      */
Dries's avatar
   
Dries committed
332

Dries's avatar
   
Dries committed
333
334
      $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) {
335
        watchdog('warning', t('comment: duplicate "%comment-subject"', array('%comment-subject' => $edit["subject"])));
Dries's avatar
   
Dries committed
336
      }
Dries's avatar
   
Dries committed
337

Dries's avatar
   
Dries committed
338
339
340
341
342
343
344
      if ($edit["cid"]) {
        /*
        ** 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
345
        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
346
347
348
349
350

        /*
        ** Fire a hook
        */

Dries's avatar
   
Dries committed
351
        module_invoke_all('comment', "update", $edit);
Dries's avatar
   
Dries committed
352
353
354
355
356

        /*
        ** Add entry to the watchdog log:
        */

357
        watchdog('special', t('comment: updated "%comment-subject"', array('%comment-subject' => $edit["subject"])), l(t("view comment"), "node/view/". $edit["nid"], NULL, NULL, "comment-". $edit["cid"]));
Dries's avatar
   
Dries committed
358
359
360
361
362
363
      }
      else {
        /*
        ** Add the comment to database:
        */

Dries's avatar
   
Dries committed
364
365
        $status = user_access("post comments without approval") ? 0 : 1;
        $roles = variable_get("comment_roles", array());
Dries's avatar
   
Dries committed
366
367
368
369
370
371
        $score = 0;

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

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

Dries's avatar
   
Dries committed
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
        /*
        ** Here we are building the thread field.  See the comment
        ** in comment_render().
        */

        if ($edit["pid"] == 0) {
          /*
          ** This is a comment with no parent comment (depth 0): we start
          ** by retrieving the maximum thread level.
          */

          $max = db_result(db_query("SELECT MAX(thread) FROM {comments} WHERE nid = %d", $edit["nid"]));

          // Strip the "/" from the end of the thread
          $max = rtrim($max, "/");

          /*
          ** 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) {
            $units = "90";
          }

          // Finally build the thread field for this new comment
          $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:
Dries's avatar
   
Dries committed
420
          $parent = db_fetch_object(db_query("SELECT * FROM {comments} WHERE cid = %d", $edit['pid']));
Dries's avatar
   
Dries committed
421
422
423
424
425

          // Strip the "/" from the end of the parent thread:
          $parent->thread = (string)rtrim((string)$parent->thread, "/");

          // Get the max value in _this_ thread:
Dries's avatar
   
Dries committed
426
          $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
427
428
429
430
431
432
433
434
435
436
437

          if ($max == "") {
            // First child of this parent
            $thread = "$parent->thread.1/";
          }
          else {
            // Strip the "/" at the end of the thread:
            $max = rtrim($max, "/");

            // We need to get the value at the correct depth:
            $parts = explode(".", $max);
Dries's avatar
   
Dries committed
438
            $parent_depth = count(explode(".", $parent->thread));
Dries's avatar
   
Dries committed
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
            $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) {
              $units = "90";
            }

            // Finally build the thread field for this new comment:
Dries's avatar
   
Dries committed
456
            $thread = "$parent->thread.". $decimals.$units ."/";
Dries's avatar
   
Dries committed
457
458
459
460
          }
        }


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

Dries's avatar
   
Dries committed
463
        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
464
465
466
467
468

        /*
        ** Tell the other modules a new comment has been submitted:
        */

Dries's avatar
   
Dries committed
469
        module_invoke_all('comment', "insert", $edit);
Dries's avatar
   
Dries committed
470
471
472
473

        /*
        ** Add entry to the watchdog log:
        */
Dries's avatar
   
Dries committed
474

475
        watchdog('special', t('comment: added "%comment-subject"', array('%comment-subject' => $edit["subject"])), l(t("view comment"), "node/view/". $edit["nid"], NULL, NULL, "comment-". $edit["cid"]));
Dries's avatar
   
Dries committed
476

Dries's avatar
   
Dries committed
477
      }
Dries's avatar
   
Dries committed
478
479

      /*
Dries's avatar
   
Dries committed
480
481
      ** Clear the cache so an anonymous user can see his comment being
      ** added.
Dries's avatar
   
Dries committed
482
      */
Dries's avatar
   
Dries committed
483

Dries's avatar
   
Dries committed
484
      cache_clear_all();
Dries's avatar
   
Dries committed
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499

      /*
      ** 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:
        drupal_goto('node/view/'. $edit['nid'] .'#comment-'. $edit['cid']);
      }
    }
    else {
      print theme('page', comment_preview($edit));
Dries's avatar
   
Dries committed
500
501
    }
  }
Dries's avatar
   
Dries committed
502
  else {
503
    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
504
505
506
507
  }
}

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

Dries's avatar
   
Dries committed
510
  $links = array();
Dries's avatar
   
Dries committed
511

Dries's avatar
   
Dries committed
512
513
514
515
  /*
  ** If we are viewing just this comment, we link back to the node
  */

Dries's avatar
   
Dries committed
516
  if ($return) {
Dries's avatar
   
Dries committed
517
    $links[] = l(t("parent"), comment_node_url(), NULL, NULL, "comment-$comment->cid");
Dries's avatar
   
Dries committed
518
  }
Dries's avatar
   
Dries committed
519

Dries's avatar
   
Dries committed
520
  if (node_comment_mode($comment->nid) == 2) {
521
522
523
524
525
526
    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");
    }
    else if (user_access("post comments")) {
Dries's avatar
   
Dries committed
527
      if (comment_access("edit", $comment)) {
528
        $links[] = l(t("edit your comment"), "comment/edit/$comment->cid");
Dries's avatar
   
Dries committed
529
      }
Dries's avatar
   
Dries committed
530
      $links[] = l(t("reply to this comment"), "comment/reply/$comment->nid/$comment->cid");
Dries's avatar
   
Dries committed
531
532
    }
    else {
533
      $links[] = theme("comment_post_forbidden");
Dries's avatar
   
Dries committed
534
    }
Dries's avatar
   
Dries committed
535
  }
Dries's avatar
   
Dries committed
536

Dries's avatar
   
Dries committed
537
  if ($moderation = theme("comment_moderation_form", $comment)) {
Dries's avatar
   
Dries committed
538
539
    $links[] = $moderation;
  }
Dries's avatar
   
Dries committed
540

Dries's avatar
   
Dries committed
541
  return $links;
Dries's avatar
   
Dries committed
542
543
}

Dries's avatar
   
Dries committed
544
function comment_render($node, $cid = 0) {
Dries's avatar
   
Dries committed
545
546
547
548
549
550
551
  global $user;

  $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
552

Dries's avatar
   
Dries committed
553
554
  $output = "";

Dries's avatar
   
Dries committed
555
556
557
558
559
  if (user_access("access comments")) {
    /*
    ** Pre-process variables:
    */

Dries's avatar
   
Dries committed
560
    $nid = $node->nid;
Dries's avatar
   
Dries committed
561
562
    if (empty($nid)) {
      $nid = 0;
Dries's avatar
   
Dries committed
563
564
565
    }

    if (empty($mode)) {
566
      $mode = $user->mode ? $user->mode : ($_SESSION["comment_mode"] ? $_SESSION["comment_mode"] : variable_get("comment_default_mode", 4));
Dries's avatar
   
Dries committed
567
568
569
    }

    if (empty($order)) {
570
      $order = $user->sort ? $user->sort : ($_SESSION["comment_sort"] ? $_SESSION["comment_sort"] : variable_get("comment_default_order", 1));
Dries's avatar
   
Dries committed
571
572
    }
    if (empty($threshold)) {
573
      $threshold = $user->threshold ? $user->threshold : ($_SESSION["comment_threshold"] ? $_SESSION["comment_threshold"] : variable_get("comment_default_threshold", 0));
Dries's avatar
   
Dries committed
574
    }
Dries's avatar
   
Dries committed
575
    $threshold_min = db_result(db_query("SELECT minimum FROM {moderation_filters} WHERE fid = %d", $threshold));
Dries's avatar
   
Dries committed
576

Dries's avatar
   
Dries committed
577
    if (empty($comments_per_page)) {
578
      $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
579
    }
Dries's avatar
   
Dries committed
580

Dries's avatar
   
Dries committed
581
    $output .= "<a id=\"comment\"></a>\n";
Dries's avatar
   
Dries committed
582
583


Kjartan's avatar
Kjartan committed
584
    if ($cid) {
Dries's avatar
   
Dries committed
585
586
587
588
589

      /*
      ** Single comment view
      */

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

Dries's avatar
   
Dries committed
593
      $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
594

Dries's avatar
   
Dries committed
595
      if ($comment = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
596
        $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
Dries's avatar
   
Dries committed
597
        $output .= theme("comment_view", $comment, theme('links', module_invoke_all('link', 'comment', $comment, 1)));
Dries's avatar
   
Dries committed
598
      }
Dries's avatar
   
Dries committed
599

Dries's avatar
   
Dries committed
600
      if ((comment_user_can_moderate($node)) && $user->uid != $comment->uid && !(comment_already_moderated($user->uid, $comment->users))) {
Dries's avatar
   
Dries committed
601
        $output .= "<div style=\"text-align: center;\">". form_submit(t("Moderate comment")) ."</div><br />";
Dries's avatar
   
Dries committed
602
      }
Dries's avatar
   
Dries committed
603
      $output .= "</div></form>";
Dries's avatar
   
Dries committed
604
    }
Dries's avatar
   
Dries committed
605
    else {
Dries's avatar
   
Dries committed
606

Dries's avatar
   
Dries committed
607
608
609
610
      /*
      ** Multiple comments view
      */

Dries's avatar
   
Dries committed
611
      $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
612

Dries's avatar
   
Dries committed
613
      $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
614

Dries's avatar
   
Dries committed
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
      /*
      ** 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
677
678

      if ($order == 1) {
Dries's avatar
   
Dries committed
679
680
681
682
683
684
        if ($mode == 1 || $mode == 2) {
          $query .= " ORDER BY c.timestamp DESC";
        }
        else {
          $query .= " ORDER BY c.thread DESC";
        }
Dries's avatar
   
Dries committed
685
      }
Dries's avatar
   
Dries committed
686
      else if ($order == 2) {
Dries's avatar
   
Dries committed
687
688
689
690
691
692
693
694
695
696
697
698
699
        if ($mode == 1 || $mode == 2) {
          $query .= " ORDER BY c.timestamp";
        }
        else {

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

          $query .= " ORDER BY SUBSTRING(c.thread, 1, (LENGTH(c.thread) - 1))";
        }
Dries's avatar
   
Dries committed
700
701
702
      }

      /*
Dries's avatar
   
Dries committed
703
      ** Start a form, to use with comment control and moderation.
Dries's avatar
   
Dries committed
704
705
      */

Dries's avatar
   
Dries committed
706
      $result = pager_query($query, $comments_per_page, 0, "SELECT COUNT(*) FROM {comments} WHERE nid = '". check_query($nid) ."'");
707
      if (db_num_rows($result) && (variable_get("comment_controls", 0) == 0 || variable_get("comment_controls", 0) == 2)) {
Dries's avatar
   
Dries committed
708
        $output .= "<form method=\"post\" action=\"". url('comment') ."\"><div>\n";
Dries's avatar
   
Dries committed
709
710
711
        $output .= theme("comment_controls", $threshold, $mode, $order, $comments_per_page);
        $output .= form_hidden("nid", $nid);
        $output .= "</div></form>";
Dries's avatar
   
Dries committed
712
      }
Dries's avatar
   
Dries committed
713

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

Dries's avatar
   
Dries committed
717
      while ($comment = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
718
        $comment = drupal_unpack($comment);
Dries's avatar
   
Dries committed
719
        $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
Dries's avatar
   
Dries committed
720
        $comment->depth = count(explode(".", $comment->thread)) - 1;
Dries's avatar
   
Dries committed
721

Dries's avatar
   
Dries committed
722
        if ($mode == 1) {
Dries's avatar
   
Dries committed
723
          $output .= theme("comment_flat_collapsed", $comment, $threshold_min);
Dries's avatar
   
Dries committed
724
        }
Dries's avatar
   
Dries committed
725
        else if ($mode == 2) {
Dries's avatar
   
Dries committed
726
          $output .= theme("comment_flat_expanded", $comment, $threshold_min);
Dries's avatar
   
Dries committed
727
        }
Dries's avatar
   
Dries committed
728
        else if ($mode == 3) {
Dries's avatar
   
Dries committed
729
          $output .= theme("comment_thread_min", $comment, $threshold_min);
Dries's avatar
   
Dries committed
730
        }
Dries's avatar
   
Dries committed
731
        else if ($mode == 4) {
Dries's avatar
   
Dries committed
732
          $output .= theme("comment_thread_max", $comment, $threshold_min);
Dries's avatar
   
Dries committed
733
734
        }
      }
Dries's avatar
   
Dries committed
735

Dries's avatar
   
Dries committed
736
737
738
739
      /*
      ** Use the standard pager, $pager_total is the number of returned rows,
      ** is global and defined in pager.inc
      */
Dries's avatar
Dries committed
740
      if ($pager = theme("pager", NULL, $comments_per_page, 0, array("comments_per_page" => $comments_per_page))) {
Dries's avatar
   
Dries committed
741
        $output .= $pager;
Dries's avatar
   
Dries committed
742
      }
Dries's avatar
   
Dries committed
743

744
      if (db_num_rows($result) && comment_user_can_moderate($node)) {
Dries's avatar
   
Dries committed
745
        $output .= "<div align=\"center\">". form_submit(t("Moderate comments")) ."</div><br />";
Dries's avatar
   
Dries committed
746
      }
Dries's avatar
   
Dries committed
747

Dries's avatar
   
Dries committed
748
      $output .= "</div></form>";
Dries's avatar
   
Dries committed
749

750
      if (db_num_rows($result) && (variable_get("comment_controls", 0) == 1 || variable_get("comment_controls", 0) == 2)) {
Dries's avatar
   
Dries committed
751
        $output .= "<form method=\"post\" action=\"". url('comment') ."\"><div>\n";
Dries's avatar
   
Dries committed
752
753
754
        $output .= theme("comment_controls", $threshold, $mode, $order, $comments_per_page);
        $output .= form_hidden("nid", $nid);
        $output .= "</div></form>";
Dries's avatar
   
Dries committed
755
      }
Dries's avatar
   
Dries committed
756
757
    }

Dries's avatar
   
Dries committed
758
759
760
761
    /*
    ** If enabled, show new comment form
    */

Dries's avatar
   
Dries committed
762
    if (user_access("post comments") && node_comment_mode($nid) == 2 && variable_get("comment_form_location", 0)) {
Dries's avatar
   
Dries committed
763
      $output .= theme("comment_form", array("nid" => $nid), t("Post new comment"));
Dries's avatar
   
Dries committed
764
    }
Dries's avatar
   
Dries committed
765
  }
Dries's avatar
   
Dries committed
766
  return $output;
Dries's avatar
   
Dries committed
767
768
}

Dries's avatar
   
Dries committed
769
770
771
function comment_perm() {
  return array("access comments", "post comments", "administer comments", "moderate comments", "post comments without approval", "administer moderation");
}
Dries's avatar
   
Dries committed
772

Dries's avatar
   
Dries committed
773
774
775
/**
 * Implementation of hook_link().
 */
Dries's avatar
   
Dries committed
776
function comment_link($type, $node = 0, $main = 0) {
Dries's avatar
   
Dries committed
777
  $links = array();
Dries's avatar
   
Dries committed
778

Dries's avatar
   
Dries committed
779
  if ($type == 'node' && $node->comment) {
Dries's avatar
   
Dries committed
780
781
782
783
784
785
786

    if ($main) {

      /*
      ** Main page: display the number of comments that have been posted.
      */

Dries's avatar
   
Dries committed
787
      if (user_access('access comments')) {
Dries's avatar
   
Dries committed
788
        $all = comment_num_all($node->nid);
Dries's avatar
   
Dries committed
789
        $new = comment_num_new($node->nid);
Dries's avatar
   
Dries committed
790

Dries's avatar
   
Dries committed
791
        if ($all) {
Dries's avatar
   
Dries committed
792
          $links[] = l(format_plural($all, '1 comment', '%count comments'), "node/view/$node->nid", array('title' => t('Jump to the first comment of this posting.')), NULL, 'comment');
Dries's avatar
   
Dries committed
793

Dries's avatar
   
Dries committed
794
          if ($new) {
Dries's avatar
   
Dries committed
795
            $links[] = l(format_plural($new, '1 new comment', '%count new comments'), "node/view/$node->nid", array('title' => t('Jump to the first new comment of this posting.')), NULL, 'new');
Dries's avatar
   
Dries committed
796
797
798
          }
        }
        else {
Dries's avatar
   
Dries committed
799
          if ($node->comment == 2) {
Dries's avatar
   
Dries committed
800
801
            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.')));
Dries's avatar
   
Dries committed
802
803
            }
            else {
Dries's avatar
   
Dries committed
804
              $links[] = theme('comment_post_forbidden');
Dries's avatar
   
Dries committed
805
            }
Dries's avatar
   
Dries committed
806
807
          }
        }
Dries's avatar
   
Dries committed
808
809
810
811
812
      }
    }
    else {
      /*
      ** Node page: add a "post comment" link if the user is allowed to
Dries's avatar
   
Dries committed
813
      ** post comments and if this node is not read-only
Dries's avatar
   
Dries committed
814
815
      */

Dries's avatar
   
Dries committed
816
      if ($node->comment == 2) {
Dries's avatar
   
Dries committed
817
818
        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');
Kjartan's avatar
Kjartan committed
819
820
        }
        else {
Dries's avatar
   
Dries committed
821
          $links[] = theme('comment_post_forbidden');
Dries's avatar
   
Dries committed
822
        }
Dries's avatar
   
Dries committed
823
824
825
826
      }
    }
  }

Dries's avatar
   
Dries committed
827
  if ($type == 'comment') {
Dries's avatar
   
Dries committed
828
829
830
    $links = comment_links($node, $main);
  }

Dries's avatar
   
Dries committed
831
832
833
834
835
836
837
838
839
840
841
  if ($type == 'system') {
    $access = user_access('administer comments');
    menu('admin/comment', t('comments'), $access ? 'comment_admin' : MENU_DENIED, 1);
    menu('admin/comment/comments', t('overview'), $access ? 'comment_admin' : MENU_DENIED, 2);
    menu('admin/comment/comments/0', t('new/updated'), $access ? 'comment_admin' : MENU_DENIED, 1);
    menu('admin/comment/comments/1', t('approval queue'), $access ? 'comment_admin' : MENU_DENIED, 2);
    menu('admin/comment/help', t('help'), $access ? 'comment_help_page' : MENU_DENIED, 9);
    menu('admin/comment/edit', t('edit comment'), $access ? 'comment_admin' : MENU_DENIED, 0, MENU_HIDE, MENU_LOCKED);
    menu('admin/comment/delete', t('delete comment'), $access ? 'comment_admin' : MENU_DENIED, 0, MENU_HIDE, MENU_LOCKED);
    if (module_exist('search')) {
      menu('admin/comment/search', t('search'), $access ? 'comment_admin' : MENU_DENIED, 8);
Dries's avatar
   
Dries committed
842
    }
Dries's avatar
   
Dries committed
843
844
845
846
847
848
849
850
851
852

    // comment settings:
    $access = user_access('administer comments') && user_access('administer moderation');
    menu('admin/comment/moderation', t('moderation'), $access ? 'comment_admin' : MENU_DENIED, 3);
    menu('admin/comment/moderation/votes', t('votes'), $access ? 'comment_admin' : MENU_DENIED);
    menu('admin/comment/moderation/matrix', t('matrix'), $access ? 'comment_admin' : MENU_DENIED);
    menu('admin/comment/moderation/filters', t('thresholds'), $access ? 'comment_admin' : MENU_DENIED);
    menu('admin/comment/moderation/roles', t('initial scores'), $access ? 'comment_admin' : MENU_DENIED, 6);

    menu('comment', t('comments'), 'comment_page', 0, MENU_HIDE, MENU_LOCKED);
Dries's avatar
   
Dries committed
853
854
  }

Dries's avatar
   
Dries committed
855
  return $links;
Dries's avatar
   
Dries committed
856
857
}

Dries's avatar
   
Dries committed
858
function comment_page() {
Dries's avatar
   
Dries committed
859
860
  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
861
862
863
864

  if (empty($op)) {
    $op = arg(1);
  }
Dries's avatar
   
Dries committed
865
866
867

  switch ($op) {
    case "edit":
Dries's avatar
   
Dries committed
868
      print theme('page', comment_edit(check_query(arg(2))), t("Edit comment"));;
Dries's avatar
   
Dries committed
869
      break;
Dries's avatar
   
Dries committed
870
871
872
    case t("Moderate comments"):
    case t("Moderate comment"):
      comment_moderate($edit);
Dries's avatar
   
Dries committed
873
      drupal_goto(comment_node_url());
Dries's avatar
   
Dries committed
874
      break;
Dries's avatar
   
Dries committed
875
    case "reply":
Dries's avatar
   
Dries committed
876
      print theme('page', comment_reply(check_query(arg(3)), check_query(arg(2))), t("Add new comment"));
Dries's avatar
   
Dries committed
877
878
      break;
    case t("Preview comment"):
Dries's avatar
   
Dries committed
879
880
      comment_validate_form($edit);
      print theme('page', comment_preview($edit), t("Preview comment"));
Dries's avatar
   
Dries committed
881
882
      break;
    case t("Post comment"):
Dries's avatar
   
Dries committed
883
884
      comment_validate_form($edit);
      print theme('page', comment_post($edit));
Dries's avatar
   
Dries committed
885
      break;
886
    case t("Save settings"):
Dries's avatar
   
Dries committed
887
888
889
890
891
      $mode = $_POST["mode"];
      $order = $_POST["order"];
      $threshold = $_POST["threshold"];
      $comments_per_page = $_POST["comments_per_page"];

892
      comment_save_settings(check_query($mode), check_query($order), check_query($threshold), check_query($comments_per_page));
Dries's avatar
   
Dries committed
893
      drupal_goto(comment_node_url());
Dries's avatar
   
Dries committed
894
895
896
897
      break;
  }
}

Dries's avatar
   
Dries committed
898
899
900
/**
*** admin functions
**/
Dries's avatar
   
Dries committed
901

Dries's avatar
   
Dries committed
902
function comment_node_link($node) {
Dries's avatar
 
Dries committed
903

Dries's avatar
   
Dries committed
904
  if (user_access("administer comments")) {
Dries's avatar
 
Dries committed
905

Dries's avatar
   
Dries committed
906
907
908
    /*
    ** Edit comments:
    */
Dries's avatar
 
Dries committed
909

Dries's avatar
   
Dries committed
910
    $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);
Dries's avatar
   
Dries committed
911

Dries's avatar
   
Dries committed
912
    $header = array(t("title"), t('author'), array("data" => t("operations"), "colspan" => 3));
Dries's avatar
   
Dries committed
913
914

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

Dries's avatar
   
Dries committed
919
920
    if ($rows) {
      $output  = "<h3>". t("Edit comments") ."</h3>";
Dries's avatar
   
Dries committed
921
      $output .= theme("table", $header, $rows);
Dries's avatar
   
Dries committed
922
    }
Dries's avatar
   
Dries committed
923
924

    return $output;
Dries's avatar
 
Dries committed
925
  }
Dries's avatar
   
Dries committed
926
}
Dries's avatar
   
Dries committed
927

Dries's avatar
   
Dries committed
928
929
function comment_admin_edit($id) {

Dries's avatar
   
Dries committed
930
  $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
931
  $comment = db_fetch_object($result);
Dries's avatar
   
Dries committed
932
  $comment->name = $comment->registered_name ? $comment->registered_name : $comment->name;
Dries's avatar
   
Dries committed
933
  $comment = drupal_unpack($comment);
Dries's avatar
   
Dries committed
934
935
936

  if ($comment) {
    $form .= form_item(t("Author"), format_name($comment));
Dries's avatar
   
Dries committed
937
938
939
    $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"));
Dries's avatar
   
Dries committed
940
941
942
943
944
    $form .= form_hidden("cid", $id);
    $form .= form_submit(t("Submit"));

    return form($form);
  }
Dries's avatar
 
Dries committed
945
946
}

947
948
949
function _comment_delete_thread($comment) {
  // Delete the comment:
  db_query("DELETE FROM {comments} WHERE cid = %d", $comment->cid);
950
  watchdog('special', t('comment: deleted "%comment-subject"', array('%comment-subject' => $comment->subject)));
951
952
953
954

  // Delete the comment's replies:
  $result = db_query("SELECT cid, subject FROM {comments} WHERE pid = %d", $comment->cid);
  while ($comment = db_fetch_object($result)) {
955
    _comment_delete_thread($comment);
956
957
958
959
  }
}

function comment_delete($cid, $confirmed = 0) {
Dries's avatar
   
Dries committed
960
961
  $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;
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985

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

      /*
      ** Delete the comment and all of its replies:
      */

      _comment_delete_thread($comment);

      /*
      ** Clear the cache so an anonymous user can see his comment being
      ** added.
      */

      cache_clear_all();
    }
    else {
      drupal_set_message(t("do you want to delete this comment and all its replies?"));

      /*
      ** Print a confirmation screen:
      */
Dries's avatar
   
Dries committed
986

Dries's avatar
   
Dries committed
987
      $output  = theme('comment', $comment);
988
989
990
991
      $output .= form_submit(t("Delete comment"));

      return form($output);
    }
Dries's avatar
   
Dries committed
992
993
  }
  else {
994
    drupal_set_message(t("the comment no longer exists."));
Dries's avatar
   
Dries committed
995
  }
Dries's avatar
   
Dries committed
996
997
}

Dries's avatar
   
Dries committed
998
function comment_save($id, $edit) {