comment.module 66.7 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
14
15
16
17
      $output .= "<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>";
      $output .= "<h3>User control of comment display</h3>";
      $output .= "<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>";
      $output .= "<ul>";
      $output .= "<li><b>Threaded</b> -- Displays the posts grouped according to conversations and subconversations, much like the subject view of an email client.</li>";
      $output .= "<li><b>Flat</b> --  Displays the posts in chronological order, in the order in which they are posted.</li>";
      $output .= "<li><b>Expanded</b> -- Displays the title and text for each post.</li>";
      $output .= "<li><b>Collapsed</b> -- Displays only the title for each post.</li>";
      $output .= "</ul>";
Dries's avatar
   
Dries committed
18
      $output .= "<p>When a user chooses <i>save settings</i>, 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 %comment-config.</p>";
Dries's avatar
   
Dries committed
19
20
21
      $output .= "<p>NOTE: When comment moderation is enabled, users will have another control panel option to control thresholds (see below).</p>";

      $output .= "<h3>Additional comment configurations</h3>";
Dries's avatar
   
Dries committed
22
23
      $output .= "<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 %site-config under <i>Submission settings</i>.</p>";
      $output .= "<p>Administrators can control access to various comment module functions through %user-permissions. 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
24
25
26
27
28
29
30
31
32
33
34
35
36
      $output .= "<p>The following permissions can be enabled for anonymous users, authenticated users, or any other user roles that the administrator chooses to define:</p>";
      $output .= "<ul>";
      $output .= "<li><b>Access comments</b> -- Allows users to view comments.</li>";
      $output .= "<li><b>Administrate comments</b> -- Allows users complete control over configuring, editing and deleting all comments on the site. Best reserved for <b>very</b> trusted users.</li>";
      $output .= "<li><b>Moderate comments</b> -- Allows users to rate comment postings (see more on moderation below).</li>";
      $output .= "<li><b>Post comments</b> -- Allows users to post comments into an administrator moderation queue. Administrators then post the comment to the site.</li>";
      $output .= "<li><b>Post comments without approval</b> -- Allows users to directly post comments. This bypasses the administrator moderation queue.</li>";
      $output .= "</ul>";

      $output .= "<h3>Notification of new comments</h3>";
      $output .= "<p>Drupal provides specific features to inform site members when new comments have been posted:</p>";
      $output .= "<ul>";
      $output .= "<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>";
Dries's avatar
   
Dries committed
37
      $output .= "<li>The <i>tracker</i> module, disabled by default, displays all the site's recent posts.  There is a link to the %tracker 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 <i>new</i> label beside the text of unread comments.</li>";
Dries's avatar
   
Dries committed
38
      $output .= "<li>Some administrators may want to %download-notify, install and configure the notify module. Users can then request that Drupal send them an email when new comments are posted (the notify module requires that cron.php be configured properly).</li>";
Dries's avatar
   
Dries committed
39
40
41
42
43
      $output .= "</ul>";

      $output .= "<h3>Comment moderation</h3>";
      $output .= "<p>On sites with active commenting from users, the administrator can turn over comment moderation to the community. </p>";
      $output .= "<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>";
Dries's avatar
   
Dries committed
44
      $output .= "<p>To enable moderation, the administrator must grant %permission permissions. Then, a number of options in %comment-moderation must be configured.</p>";
Dries's avatar
   
Dries committed
45
46

      $output .= "<h4>Moderation votes</h4>";
Dries's avatar
   
Dries committed
47
      $output .= "<p>The first step is to create moderation labels which allow users to rate a comment.  Go to %comment-votes. In the <i>vote</i> field, enter the textual labels which users will see when casting their votes. Some examples are</p>";
Dries's avatar
   
Dries committed
48
49
50
51
52
53
54
55
56
57
58
      $output .= "<ul>";
      $output .= "<li>Excellent +3</li>";
      $output .= "<li>Insightful +2</li>";
      $output .= "<li>Caught My Attention +1</li>";
      $output .= "<li>Useful +1</li>";
      $output .= "<li>Redundant -1</li>";
      $output .= "<li>Flame -3</li>";
      $output .= "</ul>";
      $output .= "<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>";
      $output .= "<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
      $output .= "<h4>Moderator vote/values matrix</h4>";
Dries's avatar
   
Dries committed
60

Dries's avatar
   
Dries committed
61
      $output .= "<p>Next go to %comment-matrix.  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
62
      $output .= "<p>NOTE: Comment ratings are calculated by averaging user votes with the initial rating.</p>";
Dries's avatar
   
Dries committed
63
64
65
66
      $output .= "<h4>Creating comment thresholds</h4>";
      $output .= "<p>In %comment-thresholds, 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>";
      $output .= "<p>When creating the thresholds, note that the <i>Minimum score</i> is asking you for the lowest rating that a comment can have in order to be displayed.</p>";
      $output .= "<p>To see a common example of how thresholds work, you might visit %slashdot 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
67

Dries's avatar
   
Dries committed
68
69
      $output .= "<h4>Initial comment scores</h4>";
      $output .= "<p>Finally, you may want to enter some <i>initial comment scores</i>. In %comment-inital 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 <b>0</b> as the default.</p>";
Dries's avatar
   
Dries committed
70
      $output = t($output, array("%comment-config" => l(t("administer") ." &raquo; ". t("configuration") ." &raquo; ". t("modules") ." &raquo; ". t("comment"), "admin/system/modules/comment"), "%site-config" => l(t("administer") ." &raquo; ". t("configuration"), "admin/system"), "%user-permissions" => l(t("administer") ." &raquo; ". t("accounts") ." &raquo; ". t("permissions"), "admin/user/permission"), "%tracker" => l(t("recent posts"), "tracker"), "%download-notify" => "<a href=\"http://drupal.org/project/releases\">". t("download") ."</a>", "%permission" => l(t("moderate comments"), "admin/user/permissions"), "%comment-moderation" => l(t("administer") ." &raquo; ". t("comments") ." &raquo; ". t("moderation"), "admin/comment/moderation"), "%comment-votes" => l(t("administer") ." &raquo; ". t("comments") ." &raquo; ". t("moderation") ." &raquo; ". t("votes"), "admin/comment/moderation/votes"), "%comment-matrix" => l(t("administer") ." &raquo; ". t("comments") ." &raquo; ". t("moderation") ." &raquo; ". t("matrix"), "admin/comment/moderation/matrix"), "%comment-thresholds" => l(t("administer") ." &raquo; ". t("comments") ." &raquo; ". t("moderation") ." &raquo; ". t("thresholds"), "admin/comment/moderation/thresholds"), "%slashdot" => "<a href=\"http://slashdot.org/\">Slashdot</a>", "%comment-inital" => l(t("administer") ." &raquo; ". t("comments") ." &raquo; ". t("initial comment scores"), "admin/comments/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':
Dries's avatar
   
Dries committed
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 %threshold 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" => l(t("administer") ." &raquo; ". t("comments") ." &raquo; ". t("moderation") ." &raquo; ". t("thresholds"), "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':
Dries's avatar
   
Dries committed
82
      $output = t("Click on %nup to see your latest comments, or %queue to approve new comments.", array("%nup" => l(t("new or updated comments"), "admin/comment/0"), "%queue" => l(t("comment approval queue"), "admin/comment/1")));
Dries's avatar
   
Dries committed
83
84
85
86
87
88
89
90
      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':
      $output = t("Below is a list of the comments posted to your site that need approval. To approve a comment click on <b>\"edit comment\"</b> and then change it's <b>moderation status</b> 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.");
      break;
    case 'admin/comments/moderation':
Dries's avatar
   
Dries committed
91
      $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. %votes sets up the names in the dropdown menu, and the order in which they appear, using weights. %matrix sets up the value of each user's vote, and %threshold sets up the levels at which a comment will be displayed.", array("%votes" => l(t("Votes"), "admin/comment/moderation/votes"), "%matrix" => l(t("Matrix"), "admin/comment/moderation/matrix"), "%threshold" => l(t("threshold"), "admin/comment/moderation/threshold")));
Dries's avatar
   
Dries committed
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
      break;
    case 'admin/comment/moderation/votes':
      $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 <b>edit</b> 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 <b>delete</b> a name/weight combiniation go to the <b>edit</b> area.</li></ul>");
      break;
    case 'admin/comment/moderation/matrix':
      $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 <b>moderate comments</b> 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 <b>lowering</b> a comments over all score.</li></ul>");
      break;
    case 'admin/comment/moderation/filters':
      $output = t("<i>Optional</i> 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 <b>delete</b> a threshold click on \"edit\".");
      break;
    case 'admin/comment/moderation/roles':
      $output = t("Here you can setup the <b>initial</b> 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");
      break;
    case ' admin/comment/search':
      $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
113
114
115
116
117
function comment_help_page() {
  print theme("header");
  print comment_help();
  print theme("footer");
}

118
function comment_settings() {
Dries's avatar
   
Dries committed
119

Dries's avatar
   
Dries committed
120
121
  $output .= 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."));
  $output .= 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."));
Dries's avatar
   
Dries committed
122
  $output .= form_textfield(t("Default comments per page"), "comment_default_per_page", variable_get("comment_default_per_page", "50"), 5, 5, t("Default number of comments for each page; more comments are distributed in several pages."));
Dries's avatar
   
Dries committed
123

Dries's avatar
   
Dries committed
124
  $result = db_query("SELECT fid, filter FROM {moderation_filters} ");
Dries's avatar
   
Dries committed
125
126
  while ($filter = db_fetch_object($result)) {
    $thresholds[$filter->fid] = ($filter->filter);
Dries's avatar
   
Dries committed
127
128
  }

Dries's avatar
   
Dries committed
129
  $output .= 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
130

Dries's avatar
   
Dries committed
131
132
133
  $output .= form_radios(t("Preview comment"), "comment_preview", variable_get("comment_preview", 1), array(t("Optional"), t("Required")), t("Must users preview comments before submitting?"));
  $output .= form_radios(t("Location of comment submission form"), "comment_form_location", variable_get("comment_form_location", 0), array(t("Display below post or comments"), t("Display on separate page")), t("The location of the comment submission form."));
  $output .= 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."));
Dries's avatar
   
Dries committed
134

Dries's avatar
   
Dries committed
135
  return $output;
Dries's avatar
   
Dries committed
136
137
}

Dries's avatar
   
Dries committed
138
139
140
function comment_user($type, $edit, &$user) {
  switch ($type) {
    case "view_public":
Dries's avatar
   
Dries committed
141
      if ($user->signature) {
Dries's avatar
   
Dries committed
142
        return form_item(t("Signature"), check_output($user->signature));
Dries's avatar
   
Dries committed
143
144
      }
      break;
Dries's avatar
   
Dries committed
145
    case "view_private":
Dries's avatar
   
Dries committed
146
      if ($user->signature) {
Dries's avatar
   
Dries committed
147
        return form_item(t("Signature"), check_output($user->signature));
Dries's avatar
   
Dries committed
148
149
      }
      break;
Dries's avatar
   
Dries committed
150
151
    case "edit_form":
      // when user tries to edit his own data
Dries's avatar
   
Dries committed
152
      return form_textarea(t("Signature"), "signature", $user->signature, 70, 3, t("Your signature will be publicly displayed at the end of your comments.") ."<br />". form_allowed_tags_text());
Dries's avatar
   
Dries committed
153
154
    case "edit_validate":
      // validate user data editing
Dries's avatar
   
Dries committed
155
      return array("signature" => $edit["signature"]);
Dries's avatar
   
Dries committed
156
157
158
  }
}

Dries's avatar
   
Dries committed
159
function comment_access($op, $comment) {
Dries's avatar
   
Dries committed
160
161
  global $user;

Dries's avatar
   
Dries committed
162
163
164
165
166
167
168
169
170
171
172
  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
173
  }
Dries's avatar
   
Dries committed
174

Dries's avatar
   
Dries committed
175
}
Dries's avatar
   
Dries committed
176
function comment_referer_save() {
Dries's avatar
   
Dries committed
177
  $_SESSION["comment_referer"] = arg(0) ."/". arg(1) ."/". arg(2);
Dries's avatar
   
Dries committed
178
179
180
181
182
183
184
185
186
}

/*
** Restores the referer from a persistent variable:
*/

function comment_referer_load() {
  return $_SESSION["comment_referer"];
}
Dries's avatar
   
Dries committed
187
188
189
190

function comment_form($edit) {
  global $user;

Dries's avatar
   
Dries committed
191
  $form .= "<a id=\"comment\"></a>\n";
Dries's avatar
   
Dries committed
192
193
194
195
196

  // name field:
  $form .= form_item(t("Your name"), format_name($user));

  // subject field:
Dries's avatar
   
Dries committed
197
  $form .= form_textfield(t("Subject"), "subject", $edit["subject"], 50, 64);
Dries's avatar
   
Dries committed
198
199

  // comment field:
Dries's avatar
   
Dries committed
200
  $form .= form_textarea(t("Comment"), "comment", $edit["comment"] ? $edit["comment"] : $user->signature, 70, 10, form_allowed_tags_text());
Dries's avatar
   
Dries committed
201
202

  // preview button:
Dries's avatar
   
Dries committed
203
  $form .= form_hidden("cid", $edit["cid"]);
Dries's avatar
   
Dries committed
204
  $form .= form_hidden("pid", $edit["pid"]);
Dries's avatar
   
Dries committed
205
  $form .= form_hidden("nid", $edit["nid"]);
Dries's avatar
   
Dries committed
206

Dries's avatar
   
Dries committed
207
  if (!$edit["comment"] && variable_get("comment_preview", 1)) {
Dries's avatar
   
Dries committed
208
209
210
211
212
213
214
    $form .= form_submit(t("Preview comment"));
  }
  else {
    $form .= form_submit(t("Preview comment"));
    $form .= form_submit(t("Post comment"));
  }

Dries's avatar
   
Dries committed
215
  return form($form, "post", url("comment/reply/". $edit["nid"]));
Dries's avatar
   
Dries committed
216
217
}

Dries's avatar
   
Dries committed
218
219
220
function comment_edit($cid) {
  global $user;

Dries's avatar
   
Dries committed
221
  $comment = db_fetch_object(db_query("SELECT c.*, u.uid, u.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
222
223
224
225
226
227
228

  if (comment_access("edit", $comment)) {
    comment_preview(object2array($comment));
  }
}

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

Dries's avatar
   
Dries committed
230

231
  if (user_access("access comments")) {
Dries's avatar
   
Dries committed
232
233
234
235
236

    /*
    ** Show comment
    */

Dries's avatar
   
Dries committed
237
    if ($pid) {
Dries's avatar
   
Dries committed
238
      $comment = db_fetch_object(db_query("SELECT c.*, u.uid, u.name, 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
239
      print theme("comment_view", $comment);
Dries's avatar
   
Dries committed
240
    }
Dries's avatar
   
Dries committed
241
    else if (user_access("access content")) {
Dries's avatar
   
Dries committed
242
      node_view(node_load(array("nid" => $nid)));
Dries's avatar
   
Dries committed
243
244
      $pid = 0;
    }
Dries's avatar
   
Dries committed
245

Dries's avatar
   
Dries committed
246
247
248
249
    /*
    ** If possible, show reply form
    */

Dries's avatar
   
Dries committed
250
    if (node_comment_mode($nid) != 2) {
Dries's avatar
   
Dries committed
251
      print theme("box", t("Reply"), t("This discussion is closed: you can't post new comments."));
Kjartan's avatar
Kjartan committed
252
    }
Dries's avatar
   
Dries committed
253
    else if (user_access("post comments")) {
Dries's avatar
   
Dries committed
254
      print theme("box", t("Reply"), comment_form(array("pid" => $pid, "nid" => $nid)));
Dries's avatar
   
Dries committed
255
256
    }
    else {
Dries's avatar
   
Dries committed
257
      print theme("box", t("Reply"), t("You are not authorized to post comments."));
Dries's avatar
   
Dries committed
258
    }
Kjartan's avatar
Kjartan committed
259
260
  }
  else {
Dries's avatar
   
Dries committed
261
    print theme("box", t("Reply"), t("You are not authorized to view comments."));
Dries's avatar
   
Dries committed
262
263
264
265
  }
}

function comment_preview($edit) {
Dries's avatar
   
Dries committed
266
  global $user;
Dries's avatar
   
Dries committed
267

Dries's avatar
   
Dries committed
268
269
270
271
  foreach ($edit as $key => $value) {
    $comment->$key = $value;
  }

Dries's avatar
   
Dries committed
272
  /*
Dries's avatar
   
Dries committed
273
  ** Attach the user and time information:
Dries's avatar
   
Dries committed
274
275
276
277
278
279
280
281
282
283
  */

  $comment->uid = $user->uid;
  $comment->name = $user->name;
  $comment->timestamp = time();

  /*
  ** Preview the comment:
  */

Dries's avatar
   
Dries committed
284
  print theme("comment_view", $comment, t("reply to this comment"));
Dries's avatar
   
Dries committed
285

Dries's avatar
   
Dries committed
286
  print theme("box", t("Reply"), comment_form($edit));
Kjartan's avatar
Kjartan committed
287
288

  if ($edit["pid"]) {
Dries's avatar
   
Dries committed
289
    $comment = db_fetch_object(db_query("SELECT c.*, u.uid, u.name, 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
290
    print theme("comment_view", $comment);
Kjartan's avatar
Kjartan committed
291
292
  }
  else {
Dries's avatar
   
Dries committed
293
    node_view(node_load(array("nid" => $edit["nid"])));
Kjartan's avatar
Kjartan committed
294
295
    $edit["pid"] = 0;
  }
Dries's avatar
   
Dries committed
296
297
298
}

function comment_post($edit) {
Dries's avatar
   
Dries committed
299
  global $user;
Dries's avatar
   
Dries committed
300

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

Dries's avatar
   
Dries committed
303
304
305
306
307
    /*
    ** Validate the comment's subject.  If not specified, extract
    ** one from the comment's body.
    */

Dries's avatar
   
Dries committed
308
    $edit["subject"] = strip_tags($edit["subject"]);
Dries's avatar
   
Dries committed
309

Dries's avatar
   
Dries committed
310
311
312
    if ($edit["subject"] == "") {
      $edit["subject"] = substr(strip_tags($edit["comment"]), 0, 29);
    }
Dries's avatar
   
Dries committed
313
314
315
316
317

    /*
    ** Validate the comment's body.
    */

Dries's avatar
   
Dries committed
318
319
320
321
    if ($edit["comment"] == "") {
      return array(t("Empty comment"), t("The comment you submitted is empty."));
    }

Dries's avatar
   
Dries committed
322
323
324
325
326
    /*
    ** Check for duplicate comments.  Note that we have to use the
    ** validated/filtered data to perform such check.
    */

Dries's avatar
   
Dries committed
327
    $duplicate = db_result(db_query("SELECT COUNT(cid) FROM {comments} WHERE pid = %d AND nid = %d AND subject = '%s' AND comment = '%s'", $edit["pid"], $edit["nid"], $edit["subject"], $edit["comment"]), 0);
Dries's avatar
   
Dries committed
328
329

    if ($duplicate != 0) {
Dries's avatar
   
Dries committed
330
      watchdog("warning", "comment: duplicate '". $edit["subject"] ."'");
Dries's avatar
   
Dries committed
331
      return array(t("Duplicate comment"), t("The comment you submitted has already been inserted."));
Dries's avatar
   
Dries committed
332
333
334
    }
    else {

Dries's avatar
   
Dries committed
335
      if ($edit["cid"]) {
Dries's avatar
   
Dries committed
336

Dries's avatar
   
Dries committed
337
338
339
340
341
342
        /*
        ** 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
343
        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
344
345
346
347
348
349

        /*
        ** Fire a hook
        */

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

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

Dries's avatar
   
Dries committed
355
        watchdog("special", "comment: updated '". $edit["subject"] ."'", l(t("view comment"), "node/view/". $edit["nid"] ."#". $edit["cid"]));
Dries's avatar
   
Dries committed
356
357
358
359
360
361
362
363
364
365
366
367
368
      }
      else {
        /*
        ** Check the user's comment submission rate.  If exceeded,
        ** throttle() will bail out.
        */

        throttle("post comment", variable_get("max_comment_rate", 60));

        /*
        ** Add the comment to database:
        */

Dries's avatar
   
Dries committed
369
370
371
372
373
        $status = user_access("post comments without approval") ? 0 : 1;
        $roles = variable_get("comment_roles", array());
        $score = $roles[$user->rid] ? $roles[$user->rid] : 0;
        $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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
        /*
        ** 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:
          $parent = db_fetch_object(db_query("SELECT * FROM {comments} WHERE cid = '%d'", $edit["pid"]));

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

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

          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) VALUES (%d, %d, %d, %d, '%s', '%s', '%s', %d, %d, %d, '%s', '%s')", $edit["cid"], $edit["nid"], $edit["pid"], $user->uid, $edit["subject"], $edit["comment"], getenv("REMOTE_ADDR"), time(), $status, $score, $users, $thread);
Dries's avatar
   
Dries committed
464
465
466
467
468
469

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

        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

Dries's avatar
   
Dries committed
475
        watchdog("special", "comment: added '". $edit["subject"] ."'", l(t("view comment"), "node/view/". $edit["nid"] ."#". $edit["cid"]));
Dries's avatar
   
Dries committed
476
      }
Dries's avatar
   
Dries committed
477
478

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

Dries's avatar
   
Dries committed
483
      cache_clear_all();
Dries's avatar
   
Dries committed
484
485
    }
  }
Dries's avatar
   
Dries committed
486
487
488
489
  else {
    watchdog("error", "comment: unauthorized comment submitted or comment submitted to a closed node '". $edit["subject"] ."'");
    return array(t("Error"), t("You are not authorized to post comments, or this node doesn't accept new comments."));
  }
Dries's avatar
   
Dries committed
490
491

  /*
Dries's avatar
   
Dries committed
492
  ** Redirect the user the node he commented on, or explain queue
Dries's avatar
   
Dries committed
493
494
  */

Dries's avatar
   
Dries committed
495
496
  if ($status == 1) {
    return array(t("Comment queued"), t("Your comment has been queued for moderation by site administrators and will be published after approval."));
Dries's avatar
   
Dries committed
497
498
499
500
  }
}

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

Dries's avatar
   
Dries committed
503
  $links = array();
Dries's avatar
   
Dries committed
504

Dries's avatar
   
Dries committed
505
506
507
508
  /*
  ** If we are viewing just this comment, we link back to the node
  */

Dries's avatar
   
Dries committed
509
  if ($return) {
Dries's avatar
   
Dries committed
510
    $links[] = l(t("parent"), comment_referer_load() ."#$comment->cid");
Dries's avatar
   
Dries committed
511
  }
Dries's avatar
   
Dries committed
512

Dries's avatar
   
Dries committed
513
514
515
516
  /*
  ** Admin link
  */

Dries's avatar
   
Dries committed
517
  if (user_access("administer comments") && user_access("access administration pages")) {
Dries's avatar
   
Dries committed
518
    $links[] = l(t("administer"), "admin/comment/edit/$comment->cid");
Dries's avatar
   
Dries committed
519
520
  }

Dries's avatar
   
Dries committed
521
  /*
Dries's avatar
   
Dries committed
522
  ** Possibly show edit and reply links
Dries's avatar
   
Dries committed
523
  */
Dries's avatar
   
Dries committed
524

Dries's avatar
   
Dries committed
525
526
527
  if (node_comment_mode($comment->nid) == 2) {
    if (user_access("post comments")) {
      if (comment_access("edit", $comment)) {
Dries's avatar
   
Dries committed
528
        $links[] = l(t("edit your comment"), "comment/edit/$comment->cid", array("title" => t("Make changes to your comment.")));
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 theme("links", $links);
Dries's avatar
   
Dries committed
542
543
}

Dries's avatar
   
Dries committed
544

Dries's avatar
   
Dries committed
545

Dries's avatar
   
Dries committed
546
function comment_render($node, $cid = 0) {
Dries's avatar
   
Dries committed
547
548
549
550
551
552
553
  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
554
555
556

  if (user_access("access comments")) {

Dries's avatar
   
Dries committed
557
558
559
560
561
562
    /*
    ** Save were we come from so we can go back after a reply
    */

    comment_referer_save();

Dries's avatar
   
Dries committed
563
564
565
566
    /*
    ** Pre-process variables:
    */

Dries's avatar
   
Dries committed
567
    $nid = $node->nid;
Dries's avatar
   
Dries committed
568
569
    if (empty($nid)) {
      $nid = 0;
Dries's avatar
   
Dries committed
570
571
572
    }

    if (empty($mode)) {
573
      $mode = $user->mode ? $user->mode : ($_SESSION["comment_mode"] ? $_SESSION["comment_mode"] : variable_get("comment_default_mode", 4));
Dries's avatar
   
Dries committed
574
575
576
    }

    if (empty($order)) {
577
      $order = $user->sort ? $user->sort : ($_SESSION["comment_sort"] ? $_SESSION["comment_sort"] : variable_get("comment_default_order", 1));
Dries's avatar
   
Dries committed
578
579
580
    }

    if (empty($threshold)) {
581
      $threshold = $user->threshold ? $user->threshold : ($_SESSION["comment_threshold"] ? $_SESSION["comment_threshold"] : variable_get("comment_default_threshold", 0));
Dries's avatar
   
Dries committed
582
    }
Dries's avatar
   
Dries committed
583
    $threshold_min = db_result(db_query("SELECT minimum FROM {moderation_filters} WHERE fid = %d", $threshold));
Dries's avatar
   
Dries committed
584

Dries's avatar
   
Dries committed
585
    if (empty($comments_per_page)) {
586
      $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
587
    }
Dries's avatar
   
Dries committed
588

Dries's avatar
   
Dries committed
589
    print "<a id=\"comment\"></a>\n";
Dries's avatar
   
Dries committed
590
591


Kjartan's avatar
Kjartan committed
592
    if ($cid) {
Dries's avatar
   
Dries committed
593
594
595
596
597

      /*
      ** Single comment view
      */

Dries's avatar
   
Dries committed
598
      print "<form method=\"post\" action=\"". url("comment") ."\"><div>\n";
Dries's avatar
   
Dries committed
599
600
      print form_hidden("nid", $nid);

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

Dries's avatar
   
Dries committed
603
      if ($comment = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
604
        print theme("comment_view",$comment, comment_links($comment));
Dries's avatar
   
Dries committed
605
      }
Dries's avatar
   
Dries committed
606

Dries's avatar
   
Dries committed
607
      if ((comment_user_can_moderate($node)) && $user->uid != $comment->uid && !(comment_already_moderated($user->uid, $comment->users))) {
Dries's avatar
   
Dries committed
608
        print "<div style=\"text-align: center;\">". form_submit(t("Moderate comment")) ."</div><br />";
Dries's avatar
   
Dries committed
609
      }
Dries's avatar
   
Dries committed
610
      print "</div></form>";
Dries's avatar
   
Dries committed
611
    }
Dries's avatar
   
Dries committed
612
    else {
Dries's avatar
   
Dries committed
613

Dries's avatar
   
Dries committed
614
615
616
617
      /*
      ** Multiple comments view
      */

Dries's avatar
   
Dries committed
618
      $query .= "SELECT c.cid as cid, c.pid, c.nid, c.subject, c.comment, c.timestamp, u.uid, u.name, 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
619
620

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

Dries's avatar
   
Dries committed
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
677
678
679
680
681
682
683
      /*
      ** 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
684
685

      if ($order == 1) {
Dries's avatar
   
Dries committed
686
687
688
689
690
691
        if ($mode == 1 || $mode == 2) {
          $query .= " ORDER BY c.timestamp DESC";
        }
        else {
          $query .= " ORDER BY c.thread DESC";
        }
Dries's avatar
   
Dries committed
692
      }
Dries's avatar
   
Dries committed
693
      else if ($order == 2) {
Dries's avatar
   
Dries committed
694
695
696
697
698
699
700
701
702
703
704
705
706
        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
707
708
709
      }

      /*
Dries's avatar
   
Dries committed
710
      ** Start a form, to use with comment control and moderation.
Dries's avatar
   
Dries committed
711
712
      */

Dries's avatar
   
Dries committed
713
      $result = pager_query($query, $comments_per_page, 0, "SELECT COUNT(*) FROM {comments} WHERE nid = '". check_query($nid) ."'");
Dries's avatar
   
Dries committed
714

715
      if (db_num_rows($result) && (variable_get("comment_controls", 0) == 0 || variable_get("comment_controls", 0) == 2)) {
Dries's avatar
   
Dries committed
716
        print "<form method=\"post\" action=\"". url("comment") ."\"><div>\n";
Dries's avatar
   
Dries committed
717
        print theme("comment_controls", $threshold, $mode, $order, $comments_per_page);
Dries's avatar
   
Dries committed
718
        print form_hidden("nid", $nid);
Dries's avatar
   
Dries committed
719
        print "</div></form>";
Dries's avatar
   
Dries committed
720
      }
Dries's avatar
   
Dries committed
721

Dries's avatar
   
Dries committed
722
      print "<form method=\"post\" action=\"". url("comment") ."\"><div>\n";
Dries's avatar
   
Dries committed
723
724
      print form_hidden("nid", $nid);

Dries's avatar
   
Dries committed
725
726
      while ($comment = db_fetch_object($result)) {
        $comment->depth = count(explode(".", $comment->thread)) - 1;
Dries's avatar
   
Dries committed
727

Dries's avatar
   
Dries committed
728
        if ($mode == 1) {
Dries's avatar
   
Dries committed
729
          print theme("comment_flat_collapsed", $comment, $threshold_min);
Dries's avatar
   
Dries committed
730
        }
Dries's avatar
   
Dries committed
731
        else if ($mode == 2) {
Dries's avatar
   
Dries committed
732
          print theme("comment_flat_expanded", $comment, $threshold_min);
Dries's avatar
   
Dries committed
733
        }
Dries's avatar
   
Dries committed
734
        else if ($mode == 3) {
Dries's avatar
   
Dries committed
735
          print theme("comment_thread_min", $comment, $threshold_min);
Dries's avatar
   
Dries committed
736
        }
Dries's avatar
   
Dries committed
737
        else if ($mode == 4) {
Dries's avatar
   
Dries committed
738
          print theme("comment_thread_max", $comment, $threshold_min);
Dries's avatar
   
Dries committed
739
740
        }
      }
Dries's avatar
   
Dries committed
741

Dries's avatar
   
Dries committed
742
743
744
745
746
747
748
      /*
      ** Use the standard pager, $pager_total is the number of returned rows,
      ** is global and defined in pager.inc
      */
      if ($pager = pager_display(NULL, $comments_per_page, 0, "default", array("comments_per_page" => $comments_per_page))) {
        print $pager;
      }
Dries's avatar
   
Dries committed
749

750
      if (db_num_rows($result) && comment_user_can_moderate($node)) {
Dries's avatar
   
Dries committed
751
        print "<div align=\"center\">". form_submit(t("Moderate comments")) ."</div><br />";
Dries's avatar
   
Dries committed
752
      }
Dries's avatar
   
Dries committed
753

Dries's avatar
   
Dries committed
754
      print "</div></form>";
Dries's avatar
   
Dries committed
755

756
      if (db_num_rows($result) && (variable_get("comment_controls", 0) == 1 || variable_get("comment_controls", 0) == 2)) {
Dries's avatar
   
Dries committed
757
        print "<form method=\"post\" action=\"". url("comment") ."\"><div>\n";
Dries's avatar
   
Dries committed
758
        print theme("comment_controls", $threshold, $mode, $order, $comments_per_page);
Dries's avatar
   
Dries committed
759
        print form_hidden("nid", $nid);
Dries's avatar
   
Dries committed
760
        print "</div></form>";
Dries's avatar
   
Dries committed
761
      }
Dries's avatar
   
Dries committed
762
763
    }

Dries's avatar
   
Dries committed
764
765
766
767
    /*
    ** If enabled, show new comment form
    */

Dries's avatar
   
Dries committed
768
    if (user_access("post comments") && node_comment_mode($nid) == 2 && variable_get("comment_form_location", 0)) {
Dries's avatar
   
Dries committed
769
      print theme("box", t("Post new comment"), comment_form(array("nid" => $nid)));
Dries's avatar
   
Dries committed
770
    }
Dries's avatar
   
Dries committed
771
772
773
  }
}

Dries's avatar
   
Dries committed
774
775
776
function comment_perm() {
  return array("access comments", "post comments", "administer comments", "moderate comments", "post comments without approval", "administer moderation");
}
Dries's avatar
   
Dries committed
777

Dries's avatar
   
Dries committed
778
function comment_link($type, $node = 0, $main = 0) {
Dries's avatar
   
Dries committed
779

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

    if ($main) {

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

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

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

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

Dries's avatar
   
Dries committed
817
818
      if ($node->comment == 2) {
        if (user_access("post comments")) {
Dries's avatar
   
Dries committed
819
          $links[] = l(t("add new comment"), "comment/reply/$node->nid#comment", array("title" => t("Share your thoughts and opinions related to this posting.")));
Kjartan's avatar
Kjartan committed
820
821
        }
        else {
822
          $links[] = theme("comment_post_forbidden");
Dries's avatar
   
Dries committed
823
        }
Dries's avatar
   
Dries committed
824
825
826
827
      }
    }
  }

Dries's avatar
   
Dries committed
828
829
830
  if ($type == "system") {
    if (user_access("administer comments")) {

Dries's avatar
   
Dries committed
831
832
833
834
835
      menu("admin/comment", t("comments"), "comment_admin", 1);
      menu("admin/comment/comments", t("overview"), NULL, 2);
      menu("admin/comment/comments/0", t("new/updated"), "comment_admin", 1);
      menu("admin/comment/comments/1", t("approval queue"), "comment_admin", 2);
      menu("admin/comment/search", t("search"), "comment_admin", 8);
Dries's avatar
   
Dries committed
836
      menu("admin/comment/help", t("help"), "comment_help_page", 9);
Dries's avatar
   
Dries committed
837
      menu("admin/comment/edit", t("edit comment"), "comment_admin", 0, 1);
Dries's avatar
   
Dries committed
838
839
840

      // comment settings:
      if (user_access("administer moderation")) {
Dries's avatar
   
Dries committed
841
842
843
844
845
        menu("admin/comment/moderation", t("moderation"), NULL, 3);
        menu("admin/comment/moderation/votes", t("votes"), "comment_admin");
        menu("admin/comment/moderation/matrix", t("matrix"), "comment_admin");
        menu("admin/comment/moderation/filters", t("thresholds"), "comment_admin");
        menu("admin/comment/moderation/roles", t("initial scores"), "comment_admin", 6);
Dries's avatar
   
Dries committed
846
      }
Dries's avatar
   
Dries committed
847
    }
Dries's avatar
   
Dries committed
848
    menu("comment", t("comments"), "comment_page", 0, 1);
Dries's avatar
   
Dries committed
849
850
  }

Dries's avatar
   
Dries committed
851
  return $links ? $links : array();
Dries's avatar
   
Dries committed
852
853
}

Dries's avatar
   
Dries committed
854
function comment_page() {
Dries's avatar
   
Dries committed
855
856
  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
857
858
859
860

  if (empty($op)) {
    $op = arg(1);
  }
Dries's avatar
   
Dries committed
861
862
863

  switch ($op) {
    case "edit":
Dries's avatar
   
Dries committed
864
      print theme("header");
Dries's avatar
   
Dries committed
865
      comment_edit(check_query(arg(2)));
Dries's avatar
   
Dries committed
866
      print theme("footer");
Dries's avatar
   
Dries committed
867
      break;
Dries's avatar
   
Dries committed
868
869
870
    case t("Moderate comments"):
    case t("Moderate comment"):
      comment_moderate($edit);
Dries's avatar
   
Dries committed
871
      drupal_goto(url(comment_referer_load()));
Dries's avatar
   
Dries committed
872
      break;
Dries's avatar
   
Dries committed
873
    case "reply":
Dries's avatar
   
Dries committed
874
      print theme("header");
Dries's avatar
   
Dries committed
875
      comment_reply(check_query(arg(3)), check_query(arg(2)));
Dries's avatar
   
Dries committed
876
      print theme("footer");
Dries's avatar
   
Dries committed
877
878
      break;
    case t("Preview comment"):
Dries's avatar
   
Dries committed
879
      print theme("header");
Dries's avatar
   
Dries committed
880
      comment_preview($edit);
Dries's avatar
   
Dries committed
881
      print theme("footer");
Dries's avatar
   
Dries committed
882
883
      break;
    case t("Post comment"):
Dries's avatar
   
Dries committed
884
885
      list($error_title, $error_body) = comment_post($edit);
      if ($error_body) {
Dries's avatar
   
Dries committed
886
        drupal_set_title($error_title);
Dries's avatar
   
Dries committed
887
        print theme("header");
Dries's avatar
   
Dries committed
888
        print $error_body;
Dries's avatar
   
Dries committed
889
        print theme("footer");
Dries's avatar
   
Dries committed
890
891
      }
      else {
Dries's avatar
   
Dries committed
892
        drupal_goto(url(comment_referer_load()));
Dries's avatar
   
Dries committed
893
      }
Dries's avatar
   
Dries committed
894
      break;
895
    case t("Save settings"):
Dries's avatar
   
Dries committed
896
897
898
899
900
      $mode = $_POST["mode"];
      $order = $_POST["order"];
      $threshold = $_POST["threshold"];
      $comments_per_page = $_POST["comments_per_page"];

901
      comment_save_settings(check_query($mode), check_query($order), check_query($threshold), check_query($comments_per_page));
Dries's avatar
   
Dries committed
902
      drupal_goto(url(comment_referer_load()));
Dries's avatar
   
Dries committed
903
904
905
906
      break;
  }
}

Dries's avatar
   
Dries committed
907
908
909
/**
*** admin functions
**/
Dries's avatar
   
Dries committed
910

Dries's avatar
   
Dries committed
911
function comment_node_link($node) {
Dries's avatar
   
Dries committed
912

Dries's avatar
   
Dries committed
913
  if (user_access("administer comments")) {
Dries's avatar
   
Dries committed
914

Dries's avatar
   
Dries committed
915
916
917
    /*
    ** Edit comments:
    */
Dries's avatar
   
Dries committed
918

Dries's avatar
   
Dries committed
919
    $result = db_query("SELECT c.cid, c.subject, u.uid, u.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
920

Dries's avatar
   
Dries committed
921
922

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

    while ($comment = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
925
      $rows[] = array(l($comment->subject, "node/view/$node->nid#$comment->cid"), format_name($comment), l(t("view comment"), "node/view/$node->nid#$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
926
927
    }

Dries's avatar
   
Dries committed
928
929
    if ($rows) {
      $output  = "<h3>". t("Edit comments") ."</h3>";
Dries's avatar
   
Dries committed
930
      $output .= theme("table", $header, $rows);
Dries's avatar
   
Dries committed
931
    }
Dries's avatar
   
Dries committed
932
933

    return $output;
Dries's avatar
   
Dries committed
934
  }
Dries's avatar
   
Dries committed
935
}
Dries's avatar
   
Dries committed
936

Dries's avatar
   
Dries committed
937
938
function comment_admin_edit($id) {

Dries's avatar
   
Dries committed
939
  $result = db_query("SELECT c.*, u.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
940
941
942
943
944
945
946
947
948
949
950
951
952
953
  $comment = db_fetch_object($result);

  // if a comment is "deleted", it's deleted
  if ($comment) {
    $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);
    $form .= form_select(t("Status"), "status", $comment->status, array("published", "not published"));
    $form .= form_hidden("cid", $id);
    $form .= form_submit(t("Submit"));
    $form .= form_submit(t("Delete"));

    return form($form);
  }
Dries's avatar
   
Dries committed
954
955
}

Dries's avatar
   
Dries committed
956
957
958
function comment_delete($edit) {

  if ($edit["confirm"]) {
Dries's avatar
   
Dries committed
959
    db_query("UPDATE {comments} SET status = 2 WHERE cid = %d", $edit["cid"]);
Dries's avatar
   
Dries committed
960
    watchdog("special", "comment: deleted comment #". $edit["cid"]);
Dries's avatar
   
Dries committed
961
    $output = "deleted comment.";
Dries's avatar
   
Dries committed
962
963
964
965
966
967
968
969
970
971
  }
  else {
    $output .= form_item(t("Confirm deletion"), "");
    $output .= form_hidden("cid", $edit["cid"]);
    $output .= form_hidden("confirm", 1);
    $output .= form_submit(t("Delete"));
    $output = form($output);
  }

  return $output;
Dries's avatar
   
Dries committed
972
973
}

Dries's avatar
   
Dries committed
974
function comment_save($id, $edit) {
Dries's avatar
   
Dries committed
975
  db_query("UPDATE {comments} SET subject = '%s', comment = '%s', status = %d WHERE cid = %d", $edit["subject"], $edit["comment"], $edit["status"], $id);
Dries's avatar
   
Dries committed
976
  watchdog("special", "comment: modified '". $edit["subject"] ."'");
Dries's avatar
   
Dries committed
977
  return "updated comment.";
Dries's avatar
   
Dries committed
978
979
}

Dries's avatar
   
Dries committed
980
function comment_admin_overview($status = 0) {
Dries's avatar
   
Dries committed
981

Dries's avatar
   
Dries committed
982
  $header = array(
Dries's avatar
Dries committed
983
984
985
    array("data" => t("subject"), "field" => "subject"),
    array("data" => t("author"), "field" => "u.name"),
    array("data" => t("status"), "field" => "status"),
Dries's avatar
Dries committed
986
    array("data" => t("time"), "field" => "c.timestamp", "sort" => "desc"),
Dries's avatar
   
Dries committed
987
988
989
    array("data" => t("operations"), "colspan" => 2)
  );

Dries's avatar
   
Dries committed
990
  $sql = "SELECT c.*, u.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
991
992
  $sql .= tablesort_sql($header);
  $result = pager_query($sql,  50);
Dries's avatar
   
Dries committed
993
994

  while ($comment = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
995
    $rows[] = array(l($comment->subject, "node/view/$comment->nid/$comment->cid#$comment->cid", array("title" => htmlspecialchars(substr($comment->comment, 0, 128)))) ." ". (node_is_new($comment->nid, $comment->timestamp) ? theme("mark") : ""), format_name($comment), ($comment->status == 0 ? t("published") : t("not published")) ."</td><td>". format_date($comment->timestamp, "small") ."</td><td>". l(t("edit comment"), "admin/comment/edit/$comment->cid"), l(t("delete comment"), "admin/comment/delete/$comment->cid"));
Dries's avatar
   
Dries committed
996
997
  }

Dries's avatar
   
Dries committed
998
999
  if ($pager = pager_display(NULL, 50, 0, "admin", tablesort_pager())) {
    $rows[] = array(array("data" => $pager, "colspan" => 6));
Dries's avatar
   
Dries committed
1000
1001
  }

Dries's avatar
   
Dries committed
1002
  return theme("table", $header, $rows);
Dries's avatar
   
Dries committed
1003
1004
1005
1006
}

function comment_mod_matrix($edit) {

Dries's avatar
   
Dries committed
1007
  $output .= "<h3>Moderation vote/value matrix</h3>";
Dries's avatar
   
Dries committed
1008

Dries's avatar
Dries committed
1009
  if ($edit) {
Dries's avatar
   
Dries committed
1010
    db_query("DELETE FROM {moderation_roles} ");
Dries's avatar
Dries committed
1011
    foreach ($edit as $role_id => $votes) {
Dries's avatar
   
Dries committed
1012
      foreach ($votes as $mid => $value) {
Dries's avatar