comment.module 65.9 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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
      $output = t("Enables user to comment on content (nodes).");
      break;
    case 'admin/system/modules/comment':
      $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("comment management &raquo; comment moderation &raquo; thresholds"), "admin/comment/moderation/filters")));
      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':
      $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")));
      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
}

112
function comment_settings() {
Dries's avatar
   
Dries committed
113

Dries's avatar
   
Dries committed
114
115
  $output .= form_select(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_select(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
116
  $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
117

Dries's avatar
   
Dries committed
118
  $result = db_query("SELECT fid, filter FROM {moderation_filters} ");
Dries's avatar
   
Dries committed
119
120
  while ($filter = db_fetch_object($result)) {
    $thresholds[$filter->fid] = ($filter->filter);
Dries's avatar
   
Dries committed
121
122
  }

Dries's avatar
   
Dries committed
123
  $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
124

Dries's avatar
   
Dries committed
125
126
127
  $output .= form_select(t("Preview comment"), "comment_preview", variable_get("comment_preview", 1), array(t("Optional"), t("Required")), t("Must users preview comments before submitting?"));
  $output .= form_select(t("New comment form"), "comment_new_form", variable_get("comment_new_form", 0), array(t("Disabled"), t("Enabled")), t("New comment form in the node page?"));
  $output .= form_select(t("Comment controls"), "comment_controls", variable_get("comment_controls", 0), array(t("Above comments"), t("Below comments"), t("Above and below")), t("Position of the comment controls box."));
Dries's avatar
   
Dries committed
128

Dries's avatar
   
Dries committed
129
  return $output;
Dries's avatar
   
Dries committed
130
131
}

Dries's avatar
   
Dries committed
132
133
134
function comment_user($type, $edit, &$user) {
  switch ($type) {
    case "view_public":
Dries's avatar
   
Dries committed
135
      if ($user->signature) {
Dries's avatar
   
Dries committed
136
        return form_item(t("Signature"), check_output($user->signature));
Dries's avatar
   
Dries committed
137
138
      }
      break;
Dries's avatar
   
Dries committed
139
    case "view_private":
Dries's avatar
   
Dries committed
140
      if ($user->signature) {
Dries's avatar
   
Dries committed
141
        return form_item(t("Signature"), check_output($user->signature));
Dries's avatar
   
Dries committed
142
143
      }
      break;
Dries's avatar
   
Dries committed
144
145
    case "edit_form":
      // when user tries to edit his own data
Dries's avatar
   
Dries committed
146
      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
147
148
    case "edit_validate":
      // validate user data editing
Dries's avatar
   
Dries committed
149
      return array("signature" => $edit["signature"]);
Dries's avatar
   
Dries committed
150
151
152
  }
}

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

Dries's avatar
   
Dries committed
156
157
158
159
160
161
162
163
164
165
166
  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
167
  }
Dries's avatar
   
Dries committed
168

Dries's avatar
   
Dries committed
169
}
Dries's avatar
   
Dries committed
170
function comment_referer_save() {
Dries's avatar
   
Dries committed
171
  $_SESSION["comment_referer"] = arg(0) ."/". arg(1) ."/". arg(2);
Dries's avatar
   
Dries committed
172
173
174
175
176
177
178
179
180
}

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

function comment_referer_load() {
  return $_SESSION["comment_referer"];
}
Dries's avatar
   
Dries committed
181
182
183
184

function comment_form($edit) {
  global $user;

Dries's avatar
   
Dries committed
185
  $form .= "<a id=\"comment\"></a>\n";
Dries's avatar
   
Dries committed
186
187
188
189
190

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

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

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

  // preview button:
Dries's avatar
   
Dries committed
197
  $form .= form_hidden("cid", $edit["cid"]);
Dries's avatar
   
Dries committed
198
  $form .= form_hidden("pid", $edit["pid"]);
Dries's avatar
   
Dries committed
199
  $form .= form_hidden("nid", $edit["nid"]);
Dries's avatar
   
Dries committed
200

Dries's avatar
   
Dries committed
201
  if (!$edit["comment"] && variable_get("comment_preview", 1)) {
Dries's avatar
   
Dries committed
202
203
204
205
206
207
208
    $form .= form_submit(t("Preview comment"));
  }
  else {
    $form .= form_submit(t("Preview comment"));
    $form .= form_submit(t("Post comment"));
  }

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

Dries's avatar
   
Dries committed
212
213
214
function comment_edit($cid) {
  global $user;

Dries's avatar
   
Dries committed
215
  $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
216
217
218
219
220
221
222

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

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

Dries's avatar
   
Dries committed
224

225
  if (user_access("access comments")) {
Dries's avatar
   
Dries committed
226
227
228
229
230

    /*
    ** Show comment
    */

Dries's avatar
   
Dries committed
231
    if ($pid) {
Dries's avatar
   
Dries committed
232
      $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
233
      comment_view($comment);
Dries's avatar
   
Dries committed
234
    }
Dries's avatar
   
Dries committed
235
    else if (user_access("access content")) {
Dries's avatar
   
Dries committed
236
      node_view(node_load(array("nid" => $nid)));
Dries's avatar
   
Dries committed
237
238
      $pid = 0;
    }
Dries's avatar
   
Dries committed
239

Dries's avatar
   
Dries committed
240
241
242
243
    /*
    ** If possible, show reply form
    */

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

function comment_preview($edit) {
Dries's avatar
   
Dries committed
260
  global $user;
Dries's avatar
   
Dries committed
261

Dries's avatar
   
Dries committed
262
263
264
265
  foreach ($edit as $key => $value) {
    $comment->$key = $value;
  }

Dries's avatar
   
Dries committed
266
  /*
Dries's avatar
   
Dries committed
267
  ** Attach the user and time information:
Dries's avatar
   
Dries committed
268
269
270
271
272
273
274
275
276
277
  */

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

  /*
  ** Preview the comment:
  */

Dries's avatar
   
Dries committed
278
  comment_view($comment, t("reply to this comment"));
Dries's avatar
   
Dries committed
279

Dries's avatar
   
Dries committed
280
  theme("box", t("Reply"), comment_form($edit));
Kjartan's avatar
Kjartan committed
281
282

  if ($edit["pid"]) {
Dries's avatar
   
Dries committed
283
    $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
284
    comment_view($comment);
Kjartan's avatar
Kjartan committed
285
286
  }
  else {
Dries's avatar
   
Dries committed
287
    node_view(node_load(array("nid" => $edit["nid"])));
Kjartan's avatar
Kjartan committed
288
289
    $edit["pid"] = 0;
  }
Dries's avatar
   
Dries committed
290
291
292
}

function comment_post($edit) {
Dries's avatar
   
Dries committed
293
  global $user;
Dries's avatar
   
Dries committed
294

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

Dries's avatar
   
Dries committed
297
298
299
300
301
    /*
    ** Validate the comment's subject.  If not specified, extract
    ** one from the comment's body.
    */

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

Dries's avatar
   
Dries committed
304
305
306
    if ($edit["subject"] == "") {
      $edit["subject"] = substr(strip_tags($edit["comment"]), 0, 29);
    }
Dries's avatar
   
Dries committed
307
308
309
310
311

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

Dries's avatar
   
Dries committed
312
313
314
315
    if ($edit["comment"] == "") {
      return array(t("Empty comment"), t("The comment you submitted is empty."));
    }

Dries's avatar
   
Dries committed
316
317
318
319
320
    /*
    ** Check for duplicate comments.  Note that we have to use the
    ** validated/filtered data to perform such check.
    */

Dries's avatar
   
Dries committed
321
    $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
322
323

    if ($duplicate != 0) {
Dries's avatar
   
Dries committed
324
      watchdog("warning", "comment: duplicate '". $edit["subject"] ."'");
Dries's avatar
   
Dries committed
325
      return array(t("Duplicate comment"), t("The comment you submitted has already been inserted."));
Dries's avatar
   
Dries committed
326
327
328
    }
    else {

Dries's avatar
   
Dries committed
329
      if ($edit["cid"]) {
Dries's avatar
   
Dries committed
330

Dries's avatar
   
Dries committed
331
332
333
334
335
336
        /*
        ** 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
337
        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
338
339
340
341
342
343

        /*
        ** Fire a hook
        */

        module_invoke_all("comment", "update", $edit);
Dries's avatar
   
Dries committed
344
345
346
347
348

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

Dries's avatar
   
Dries committed
349
        watchdog("special", "comment: updated '". $edit["subject"] ."'", l(t("view comment"), "node/view/". $edit["nid"] ."#". $edit["cid"]));
Dries's avatar
   
Dries committed
350
351
352
353
354
355
356
357
358
359
360
361
362
      }
      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
363
364
365
366
367
        $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
368
369
370
371
372
373
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
        /*
        ** 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
432
            $parent_depth = count(explode(".", $parent->thread));
Dries's avatar
   
Dries committed
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
            $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
450
            $thread = "$parent->thread.". $decimals.$units ."/";
Dries's avatar
   
Dries committed
451
452
453
454
          }
        }


Dries's avatar
   
Dries committed
455
        $edit["cid"] = db_next_id("comments_cid");
Dries's avatar
   
Dries committed
456

Dries's avatar
   
Dries committed
457
        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
458
459
460
461
462
463

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

        module_invoke_all("comment", "insert", $edit);
Dries's avatar
   
Dries committed
464
465
466
467

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

Dries's avatar
   
Dries committed
469
        watchdog("special", "comment: added '". $edit["subject"] ."'", l(t("view comment"), "node/view/". $edit["nid"] ."#". $edit["cid"]));
Dries's avatar
   
Dries committed
470
      }
Dries's avatar
   
Dries committed
471
472

      /*
Dries's avatar
   
Dries committed
473
474
      ** Clear the cache so an anonymous user can see his comment being
      ** added.
Dries's avatar
   
Dries committed
475
      */
Dries's avatar
   
Dries committed
476

Dries's avatar
   
Dries committed
477
      cache_clear_all();
Dries's avatar
   
Dries committed
478
479
    }
  }
Dries's avatar
   
Dries committed
480
481
482
483
  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
484
485

  /*
Dries's avatar
   
Dries committed
486
  ** Redirect the user the node he commented on, or explain queue
Dries's avatar
   
Dries committed
487
488
  */

Dries's avatar
   
Dries committed
489
490
  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
491
492
493
494
  }
}

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

Dries's avatar
   
Dries committed
497
  $links = array();
Dries's avatar
   
Dries committed
498

Dries's avatar
   
Dries committed
499
500
501
502
  /*
  ** If we are viewing just this comment, we link back to the node
  */

Dries's avatar
   
Dries committed
503
  if ($return) {
Dries's avatar
   
Dries committed
504
    $links[] = l(t("parent"), comment_referer_load() ."#$comment->cid");
Dries's avatar
   
Dries committed
505
  }
Dries's avatar
   
Dries committed
506

Dries's avatar
   
Dries committed
507
508
509
510
  /*
  ** Admin link
  */

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

Dries's avatar
   
Dries committed
515
  /*
Dries's avatar
   
Dries committed
516
  ** Possibly show edit and reply links
Dries's avatar
   
Dries committed
517
  */
Dries's avatar
   
Dries committed
518

Dries's avatar
   
Dries committed
519
520
521
  if (node_comment_mode($comment->nid) == 2) {
    if (user_access("post comments")) {
      if (comment_access("edit", $comment)) {
Dries's avatar
   
Dries committed
522
        $links[] = l(t("edit your comment"), "comment/edit/$comment->cid", array("title" => t("Make changes to your comment.")));
Dries's avatar
   
Dries committed
523
      }
Dries's avatar
   
Dries committed
524
      $links[] = l(t("reply to this comment"), "comment/reply/$comment->nid/$comment->cid");
Dries's avatar
   
Dries committed
525
526
    }
    else {
527
      $links[] = theme("comment_post_forbidden");
Dries's avatar
   
Dries committed
528
    }
Dries's avatar
   
Dries committed
529
  }
Dries's avatar
   
Dries committed
530
531
532
533

  if ($moderation = comment_moderation_form($comment)) {
    $links[] = $moderation;
  }
Dries's avatar
   
Dries committed
534

Dries's avatar
   
Dries committed
535
  return theme("links", $links);
Dries's avatar
   
Dries committed
536
537
}

Dries's avatar
   
Dries committed
538
539
540
541
542
function comment_view($comment, $links = "", $visible = 1) {

  /*
  ** Switch to folded/unfolded view of the comment
  */
Dries's avatar
   
Dries committed
543

Dries's avatar
   
Dries committed
544
  if (node_is_new($comment->nid, $comment->timestamp)) {
Dries's avatar
   
Dries committed
545
    $comment->new = 1;
Dries's avatar
   
Dries committed
546
    print "<a id=\"new\"></a>\n";
Dries's avatar
   
Dries committed
547
  }
Dries's avatar
   
Dries committed
548

Dries's avatar
   
Dries committed
549
  print "<a id=\"$comment->cid\"></a>\n";
Dries's avatar
   
Dries committed
550
551

  if ($visible) {
Dries's avatar
   
Dries committed
552
    $comment->comment = check_output($comment->comment);
553
    theme("comment", $comment, $links);
Dries's avatar
   
Dries committed
554
555
  }
  else {
556
    theme("comment_folded", $comment);
Dries's avatar
   
Dries committed
557
558
559
  }
}

Dries's avatar
   
Dries committed
560
function comment_render($node, $cid = 0) {
Dries's avatar
   
Dries committed
561
562
563
564
565
566
567
  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
568
569
570
571
572
573
574

  if (user_access("access comments")) {

    /*
    ** Pre-process variables:
    */

Dries's avatar
   
Dries committed
575
    $nid = $node->nid;
Dries's avatar
   
Dries committed
576
577
    if (empty($nid)) {
      $nid = 0;
Dries's avatar
   
Dries committed
578
579
580
    }

    if (empty($mode)) {
581
      $mode = $user->mode ? $user->mode : ($_SESSION["comment_mode"] ? $_SESSION["comment_mode"] : variable_get("comment_default_mode", 4));
Dries's avatar
   
Dries committed
582
583
584
    }

    if (empty($order)) {
585
      $order = $user->sort ? $user->sort : ($_SESSION["comment_sort"] ? $_SESSION["comment_sort"] : variable_get("comment_default_order", 1));
Dries's avatar
   
Dries committed
586
587
588
    }

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

Dries's avatar
   
Dries committed
593
    if (empty($comments_per_page)) {
594
      $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
595
    }
Dries's avatar
   
Dries committed
596

Dries's avatar
   
Dries committed
597
    print "<a id=\"comment\"></a>\n";
Dries's avatar
   
Dries committed
598
599


Kjartan's avatar
Kjartan committed
600
    if ($cid) {
Dries's avatar
   
Dries committed
601
602
603
604
605

      /*
      ** Single comment view
      */

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

Dries's avatar
   
Dries committed
609
      $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
610

Dries's avatar
   
Dries committed
611
612
613
      if ($comment = db_fetch_object($result)) {
        comment_view($comment, comment_links($comment));
      }
Dries's avatar
   
Dries committed
614

Dries's avatar
   
Dries committed
615
      if ((comment_user_can_moderate($node)) && $user->uid != $comment->uid && !(comment_already_moderated($user->uid, $comment->users))) {
Dries's avatar
   
Dries committed
616
        print "<div style=\"text-align: center;\">". form_submit(t("Moderate comment")) ."</div><br />";
Dries's avatar
   
Dries committed
617
      }
Dries's avatar
   
Dries committed
618
      print "</div></form>";
Dries's avatar
   
Dries committed
619
    }
Dries's avatar
   
Dries committed
620
    else {
Dries's avatar
   
Dries committed
621

Dries's avatar
   
Dries committed
622
623
624
625
      /*
      ** Multiple comments view
      */

Dries's avatar
   
Dries committed
626
      $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
627
628

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

Dries's avatar
   
Dries committed
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
684
685
686
687
688
689
690
691
      /*
      ** 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
692
693

      if ($order == 1) {
Dries's avatar
   
Dries committed
694
695
696
697
698
699
        if ($mode == 1 || $mode == 2) {
          $query .= " ORDER BY c.timestamp DESC";
        }
        else {
          $query .= " ORDER BY c.thread DESC";
        }
Dries's avatar
   
Dries committed
700
      }
Dries's avatar
   
Dries committed
701
      else if ($order == 2) {
Dries's avatar
   
Dries committed
702
703
704
705
706
707
708
709
710
711
712
713
714
        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
715
716
717
      }

      /*
Dries's avatar
   
Dries committed
718
      ** Start a form, to use with comment control and moderation.
Dries's avatar
   
Dries committed
719
720
      */

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

723
      if (db_num_rows($result) && (variable_get("comment_controls", 0) == 0 || variable_get("comment_controls", 0) == 2)) {
Dries's avatar
   
Dries committed
724
        print "<form method=\"post\" action=\"". url("comment") ."\"><div>\n";
Dries's avatar
   
Dries committed
725
        theme("comment_controls", $threshold, $mode, $order, $comments_per_page);
Dries's avatar
   
Dries committed
726
        print form_hidden("nid", $nid);
Dries's avatar
   
Dries committed
727
        print "</div></form>";
Dries's avatar
   
Dries committed
728
      }
Dries's avatar
   
Dries committed
729

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

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

Dries's avatar
   
Dries committed
736
737
        if ($mode == 1) {
          theme("comment_flat_collapsed", $comment, $threshold_min);
Dries's avatar
   
Dries committed
738
        }
Dries's avatar
   
Dries committed
739
        else if ($mode == 2) {
Dries's avatar
   
Dries committed
740
          theme("comment_flat_expanded", $comment, $threshold_min);
Dries's avatar
   
Dries committed
741
        }
Dries's avatar
   
Dries committed
742
        else if ($mode == 3) {
Dries's avatar
   
Dries committed
743
          theme("comment_thread_min", $comment, $threshold_min);
Dries's avatar
   
Dries committed
744
        }
Dries's avatar
   
Dries committed
745
746
747
748
        else if ($mode == 4) {
          theme("comment_thread_max", $comment, $threshold_min);
        }
      }
Dries's avatar
   
Dries committed
749

Dries's avatar
   
Dries committed
750
751
752
753
754
755
756
      /*
      ** 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
757

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

Dries's avatar
   
Dries committed
762
      print "</div></form>";
Dries's avatar
   
Dries committed
763

764
      if (db_num_rows($result) && (variable_get("comment_controls", 0) == 1 || variable_get("comment_controls", 0) == 2)) {
Dries's avatar
   
Dries committed
765
        print "<form method=\"post\" action=\"". url("comment") ."\"><div>\n";
Dries's avatar
   
Dries committed
766
        theme("comment_controls", $threshold, $mode, $order, $comments_per_page);
Dries's avatar
   
Dries committed
767
        print form_hidden("nid", $nid);
Dries's avatar
   
Dries committed
768
        print "</div></form>";
Dries's avatar
   
Dries committed
769
      }
Dries's avatar
   
Dries committed
770
771
    }

Dries's avatar
   
Dries committed
772
773
774
775
776
    /*
    ** If enabled, show new comment form
    */

    if (user_access("post comments") && node_comment_mode($nid) == 2 && variable_get("comment_new_form", 0)) {
Dries's avatar
   
Dries committed
777
      theme("box", t("Post new comment"), comment_form(array("nid" => $nid)));
Dries's avatar
   
Dries committed
778
    }
Dries's avatar
   
Dries committed
779

Dries's avatar
   
Dries committed
780
781
782
783
784
    /*
    ** Save were we come from so we can go back after a reply
    */

    comment_referer_save();
Dries's avatar
   
Dries committed
785
786
787
  }
}

Dries's avatar
   
Dries committed
788
789
790
function comment_perm() {
  return array("access comments", "post comments", "administer comments", "moderate comments", "post comments without approval", "administer moderation");
}
Dries's avatar
   
Dries committed
791

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

Dries's avatar
   
Dries committed
794
  if ($type == "node" && $node->comment) {
Dries's avatar
   
Dries committed
795
796
797
798
799
800
801
802

    if ($main) {

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

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

Dries's avatar
   
Dries committed
806
        if ($all) {
Dries's avatar
   
Dries committed
807
          $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
808

Dries's avatar
   
Dries committed
809
          if ($new) {
Dries's avatar
   
Dries committed
810
            $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
811
812
813
          }
        }
        else {
Dries's avatar
   
Dries committed
814
815
816
817
818
819
820
          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
821
822
          }
        }
Dries's avatar
   
Dries committed
823
824
825
826
827
      }
    }
    else {
      /*
      ** Node page: add a "post comment" link if the user is allowed to
Dries's avatar
   
Dries committed
828
      ** post comments and if this node is not read-only
Dries's avatar
   
Dries committed
829
830
      */

Dries's avatar
   
Dries committed
831
832
      if ($node->comment == 2) {
        if (user_access("post comments")) {
Dries's avatar
   
Dries committed
833
          $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
834
835
        }
        else {
836
          $links[] = theme("comment_post_forbidden");
Dries's avatar
   
Dries committed
837
        }
Dries's avatar
   
Dries committed
838
839
840
841
      }
    }
  }

Dries's avatar
   
Dries committed
842
843
844
  if ($type == "system") {
    if (user_access("administer comments")) {

Dries's avatar
   
Dries committed
845
846
847
848
849
850
851
      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);
      menu("admin/comment/help", t("help"), "comment_help", 9);
      menu("admin/comment/edit", t("edit comment"), "comment_admin", 0, 1);
Dries's avatar
   
Dries committed
852
853
854

      // comment settings:
      if (user_access("administer moderation")) {
Dries's avatar
   
Dries committed
855
856
857
858
859
        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
860
      }
Dries's avatar
   
Dries committed
861
862
863
    }
  }

Dries's avatar
   
Dries committed
864
  return $links ? $links : array();
Dries's avatar
   
Dries committed
865
866
}

Dries's avatar
   
Dries committed
867
function comment_page() {
Dries's avatar
   
Dries committed
868
869
  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
870
871
872
873

  if (empty($op)) {
    $op = arg(1);
  }
Dries's avatar
   
Dries committed
874
875
876

  switch ($op) {
    case "edit":
Dries's avatar
   
Dries committed
877
      theme("header");
Dries's avatar
   
Dries committed
878
      comment_edit(check_query(arg(2)));
Dries's avatar
   
Dries committed
879
      theme("footer");
Dries's avatar
   
Dries committed
880
      break;
Dries's avatar
   
Dries committed
881
882
883
    case t("Moderate comments"):
    case t("Moderate comment"):
      comment_moderate($edit);
Dries's avatar
   
Dries committed
884
      drupal_goto(url(comment_referer_load()));
Dries's avatar
   
Dries committed
885
      break;
Dries's avatar
   
Dries committed
886
    case "reply":
Dries's avatar
   
Dries committed
887
      theme("header");
Dries's avatar
   
Dries committed
888
      comment_reply(check_query(arg(3)), check_query(arg(2)));
Dries's avatar
   
Dries committed
889
      theme("footer");
Dries's avatar
   
Dries committed
890
891
      break;
    case t("Preview comment"):
Dries's avatar
   
Dries committed
892
      theme("header");
Dries's avatar
   
Dries committed
893
      comment_preview($edit);
Dries's avatar
   
Dries committed
894
      theme("footer");
Dries's avatar
   
Dries committed
895
896
      break;
    case t("Post comment"):
Dries's avatar
   
Dries committed
897
898
      list($error_title, $error_body) = comment_post($edit);
      if ($error_body) {
Dries's avatar
   
Dries committed
899
900
901
        theme("header");
        theme("box", $error_title, $error_body);
        theme("footer");
Dries's avatar
   
Dries committed
902
903
      }
      else {
Dries's avatar
   
Dries committed
904
        drupal_goto(url(comment_referer_load()));
Dries's avatar
   
Dries committed
905
      }
Dries's avatar
   
Dries committed
906
      break;
907
    case t("Save settings"):
Dries's avatar
   
Dries committed
908
909
910
911
912
      $mode = $_POST["mode"];
      $order = $_POST["order"];
      $threshold = $_POST["threshold"];
      $comments_per_page = $_POST["comments_per_page"];

913
      comment_save_settings(check_query($mode), check_query($order), check_query($threshold), check_query($comments_per_page));
Dries's avatar
   
Dries committed
914
915
      //drupal_goto(url(comment_referer_load(), "mode=$mode&order=$order&threshold=$threshold&comments_per_page=$comments_per_page"));
      drupal_goto(url(comment_referer_load()));
Dries's avatar
   
Dries committed
916
917
918
919
      break;
  }
}

Dries's avatar
   
Dries committed
920
921
922
/**
*** admin functions
**/
Dries's avatar
   
Dries committed
923

Dries's avatar
   
Dries committed
924
function comment_node_link($node) {
Dries's avatar
   
Dries committed
925

Dries's avatar
   
Dries committed
926
  if (user_access("administer comments")) {
Dries's avatar
   
Dries committed
927

Dries's avatar
   
Dries committed
928
929
930
    /*
    ** Edit comments:
    */
Dries's avatar
   
Dries committed
931

Dries's avatar
   
Dries committed
932
    $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
933

Dries's avatar
   
Dries committed
934
935

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

    while ($comment = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
938
      $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
939
940
    }

Dries's avatar
   
Dries committed
941
942
943
944
    if ($rows) {
      $output  = "<h3>". t("Edit comments") ."</h3>";
      $output .= table($header, $rows);
    }
Dries's avatar
   
Dries committed
945
946

    return $output;
Dries's avatar
   
Dries committed
947
  }
Dries's avatar
   
Dries committed
948
}
Dries's avatar
   
Dries committed
949

Dries's avatar
   
Dries committed
950
951
function comment_admin_edit($id) {

Dries's avatar
   
Dries committed
952
  $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
953
954
955
956
957
958
959
960
961
962
963
964
965
966
  $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
967
968
}

Dries's avatar
   
Dries committed
969
970
971
function comment_delete($edit) {

  if ($edit["confirm"]) {
Dries's avatar
   
Dries committed
972
    db_query("UPDATE {comments} SET status = 2 WHERE cid = %d", $edit["cid"]);
Dries's avatar
   
Dries committed
973
    watchdog("special", "comment: deleted comment #". $edit["cid"]);
Dries's avatar
   
Dries committed
974
    $output = "deleted comment.";
Dries's avatar
   
Dries committed
975
976
977
978
979
980
981
982
983
984
  }
  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
985
986
}

Dries's avatar
   
Dries committed
987
function comment_save($id, $edit) {
Dries's avatar
   
Dries committed
988
  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
989
  watchdog("special", "comment: modified '". $edit["subject"] ."'");
Dries's avatar
   
Dries committed
990
  return "updated comment.";
Dries's avatar
   
Dries committed
991
992
}

Dries's avatar
   
Dries committed
993
function comment_admin_overview($status = 0) {
Dries's avatar
   
Dries committed
994

Dries's avatar
   
Dries committed
995
  $header = array(
Dries's avatar
Dries committed
996
997
998
999
    array("data" => t("subject"), "field" => "subject"),
    array("data" => t("author"), "field" => "u.name"),
    array("data" => t("status"), "field" => "status"),
    array("data" => t("time"), "field" => "timestamp", "sort" => "desc"),
Dries's avatar
   
Dries committed
1000
1001
1002
    array("data" => t("operations"), "colspan" => 2)
  );

Dries's avatar
   
Dries committed
1003
  $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
1004
1005
  $sql .= tablesort_sql($header);
  $result = pager_query($sql,  50);
Dries's avatar
   
Dries committed
1006
1007

  while ($comment = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
1008
    $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
1009
1010
  }

Dries's avatar
   
Dries committed
1011
1012
  if ($pager = pager_display(NULL, 50, 0, "admin", tablesort_pager())) {
    $rows[] = array(array("data" => $pager, "colspan" => 6));
Dries's avatar
   
Dries committed
1013
1014
  }

Dries's avatar
   
Dries committed
1015
  return table($header, $rows);
Dries's avatar
   
Dries committed
1016
1017
1018
1019
}

function comment_mod_matrix($edit) {

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

Dries's avatar
Dries committed
1022
  if ($edit) {
Dries's avatar
   
Dries committed
1023
    db_query("DELETE FROM {moderation_roles} ");
Dries's avatar
Dries committed
1024
    foreach ($edit as $role_id => $votes) {
Dries's avatar
   
Dries committed
1025
      foreach ($votes as $mid => $value) {
Dries's avatar
   
Dries committed
1026
        $sql[] = "('$mid', '$role_id', '". ($value ? $value : 0) ."')";
Dries's avatar
   
Dries committed
1027
1028
      }
    }
Dries's avatar
   
Dries committed
1029
    db_query("INSERT INTO {moderation_roles} (mid, rid, value) VALUES ". implode(", ", $sql));
Dries's avatar
   
Dries committed
1030
    $output = status("Vote values saved");
Dries's avatar
   
Dries committed
1031
1032
  }

Dries's avatar
   
Dries committed
1033
  $result = db_query("SELECT r.rid, r.name FROM {role} r, {permission} p WHERE r.rid = p.rid AND p.perm LIKE '%moderate comments%'");
Dries's avatar
   
Dries committed
1034
1035
1036
1037
1038
  $role_names = array();
  while ($role = db_fetch_object($result)) {
    $role_names[$role->rid] = $role->name;
  }

Dries's avatar
   
Dries committed
1039
  $result = db_query("SELECT rid, mid, value FROM {moderation_roles} ");
Dries's avatar
   
Dries committed
1040
1041
1042
1043
  while ($role = db_fetch_object($result)) {
    $mod_roles[$role->rid][$role->mid] = $role->value;
  }

Dries's avatar
Dries committed
1044
  $header = array_merge(array(t("votes")), array_values($role_names));
Dries's avatar
   
Dries committed
1045

Dries's avatar
   
Dries committed
1046
  $result = db_query("SELECT mid, vote FROM {moderation_votes} ORDER BY weight");
Dries's avatar
   
Dries committed
1047
  while ($vote = db_fetch_object($result)) {
Dries's avatar
Dries committed
1048
    $row = array($vote->vote);
Dries's avatar
   
Dries committed
1049
    foreach (array_keys($role_names) as $rid) {
Dries's avatar
Dries committed
1050
      $row[] = array("data" => form_textfield(NULL, "$rid][$vote->mid", $mod_roles[$rid][$vote->mid], 4, 3), "align" => "center");
Dries's avatar
   
Dries committed
1051
    }
Dries's avatar
Dries committed
1052
    $rows[] = $row;
Dries's avatar
   
Dries committed
1053
  }
Dries's avatar
Dries committed
1054
  $output .= table($header, $rows);
Dries's avatar
   
Dries committed
1055
1056
1057
1058
1059
1060
1061
1062