comment.module 67.4 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
      $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>";
13
14
15
16
      $output .= "<li><strong>Threaded</strong> -- Displays the posts grouped according to conversations and subconversations, much like the subject view of an email client.</li>";
      $output .= "<li><strong>Flat</strong> --  Displays the posts in chronological order, in the order in which they are posted.</li>";
      $output .= "<li><strong>Expanded</strong> -- Displays the title and text for each post.</li>";
      $output .= "<li><strong>Collapsed</strong> -- Displays only the title for each post.</li>";
Dries's avatar
   
Dries committed
17
      $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
      $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>";
26
27
28
29
30
      $output .= "<li><strong>Access comments</strong> -- Allows users to view comments.</li>";
      $output .= "<li><strong>Administrate comments</strong> -- Allows users complete control over configuring, editing and deleting all comments on the site. Best reserved for <strong>very</strong> trusted users.</li>";
      $output .= "<li><strong>Moderate comments</strong> -- Allows users to rate comment postings (see more on moderation below).</li>";
      $output .= "<li><strong>Post comments</strong> -- Allows users to post comments into an administrator moderation queue. Administrators then post the comment to the site.</li>";
      $output .= "<li><strong>Post comments without approval</strong> -- Allows users to directly post comments. This bypasses the administrator moderation queue.</li>";
Dries's avatar
   
Dries committed
31
32
33
34
35
36
      $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
      $output .= "<h4>Initial comment scores</h4>";
69
      $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 <strong>0</strong> 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
      break;
    case 'admin/comment/comments/0':
      $output = t("Below is a list of the latest comments posted your site. Click on a subject to see the comment, the author's name to edit the author's user information , \"edit comment\" to edit the comment, and \"delete comment\" to remove the comment.");
      break;
    case 'admin/comment/comments/1':
88
      $output = t("Below is a list of the comments posted to your site that need approval. To approve a comment click on <strong>\"edit comment\"</strong> and then change it's <strong>moderation status</strong> to Approved.<br />Click on a subject to see the comment, the author's name to edit the author's user information, \"edit comment\" to edit the comment, and \"delete comment\" to remove the comment.");
Dries's avatar
   
Dries committed
89
90
      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
      break;
    case 'admin/comment/moderation/votes':
94
      $output = t("Here is where you setup the names of each type of vote. Weight lets you set the order of the drop down menu. Click <strong>edit</strong> to edit a current vote weight.<br />Notes: <ul><li>you can have more than one type with the same name. The system does not protect you from this.</li><li>To <strong>delete</strong> a name/weight combiniation go to the <strong>edit</strong> area.</li></ul>");
Dries's avatar
   
Dries committed
95
96
      break;
    case 'admin/comment/moderation/matrix':
97
      $output = t("Here is where you assign a value to each item in the dropdown menu. This value is added to the vote total, which is then divided by the number of users who have voted and rounded off to the nearest integer.<br />Notes:<ul><li>In order to use comment moderation, every text box on this page should be populated.</li><li>You must assign the <strong>moderate comments</strong> permission to at least one role in order to use this page.</li><li>Every box not filled in will have a value of zero, which will have the effect of <strong>lowering</strong> a comments over all score.</li></ul>");
Dries's avatar
   
Dries committed
98
99
      break;
    case 'admin/comment/moderation/filters':
100
      $output = t("<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 <strong>delete</strong> a threshold click on \"edit\".");
Dries's avatar
   
Dries committed
101
102
      break;
    case 'admin/comment/moderation/roles':
103
      $output = t("Here you can setup the <strong>initial</strong> vote value of a comment posted by each user role. This value is used before any other users vote on the comment.<br />Note: Blank entries are valued at zero");
Dries's avatar
   
Dries committed
104
105
106
107
      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
function comment_help_page() {
Dries's avatar
   
Dries committed
113
  print theme("page", comment_help());
Dries's avatar
   
Dries committed
114
115
}

116
function comment_settings() {
Dries's avatar
   
Dries committed
117

Dries's avatar
   
Dries committed
118
119
  $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
120
  $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
121

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

Dries's avatar
   
Dries committed
127
  $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
128

Dries's avatar
   
Dries committed
129
  $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?"));
Dries's avatar
   
Dries committed
130
  $output .= form_radios(t("Location of comment submission form"), "comment_form_location", variable_get("comment_form_location", 0), array(t("Display on separate page"), t("Display below post or comments")), t("The location of the comment submission form."));
Dries's avatar
   
Dries committed
131
  $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
132

Dries's avatar
   
Dries committed
133
  return $output;
Dries's avatar
   
Dries committed
134
135
}

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

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

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

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

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

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

function comment_form($edit) {
  global $user;

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

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

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

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

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

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

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

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

Dries's avatar
   
Dries committed
219
  $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
220
221

  if (comment_access("edit", $comment)) {
Dries's avatar
   
Dries committed
222
    return comment_preview(object2array($comment));
Dries's avatar
   
Dries committed
223
224
225
226
  }
}

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

Dries's avatar
   
Dries committed
228
  $output = "";
Dries's avatar
   
Dries committed
229

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

    /*
    ** Show comment
    */

Dries's avatar
   
Dries committed
236
    if ($pid) {
Dries's avatar
   
Dries committed
237
      $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
238
      $output .= theme("comment_view", $comment);
Dries's avatar
   
Dries committed
239
    }
Dries's avatar
   
Dries committed
240
    else if (user_access("access content")) {
Dries's avatar
   
Dries committed
241
      $output .= node_view(node_load(array("nid" => $nid)));
Dries's avatar
   
Dries committed
242
243
      $pid = 0;
    }
Dries's avatar
   
Dries committed
244

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

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

  return $output;
Dries's avatar
   
Dries committed
264
265
266
}

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

Dries's avatar
   
Dries committed
269
270
  $output = "";

Dries's avatar
   
Dries committed
271
272
273
274
  foreach ($edit as $key => $value) {
    $comment->$key = $value;
  }

Dries's avatar
   
Dries committed
275
  /*
Dries's avatar
   
Dries committed
276
  ** Attach the user and time information:
Dries's avatar
   
Dries committed
277
278
279
280
281
282
283
284
285
286
  */

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

  /*
  ** Preview the comment:
  */

Dries's avatar
   
Dries committed
287
288
  $output .= theme("comment_view", $comment, comment_links($comment));
  $output .= theme("box", t("Reply"), comment_form($edit));
Kjartan's avatar
Kjartan committed
289
290

  if ($edit["pid"]) {
Dries's avatar
   
Dries committed
291
    $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
292
    $output .= theme("comment_view", $comment);
Kjartan's avatar
Kjartan committed
293
294
  }
  else {
Dries's avatar
   
Dries committed
295
    $output .= node_view(node_load(array("nid" => $edit["nid"])));
Kjartan's avatar
Kjartan committed
296
297
    $edit["pid"] = 0;
  }
Dries's avatar
   
Dries committed
298
299

  return $output;
Dries's avatar
   
Dries committed
300
301
302
}

function comment_post($edit) {
Dries's avatar
   
Dries committed
303
  global $user;
Dries's avatar
   
Dries committed
304

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

Dries's avatar
   
Dries committed
307
308
309
310
311
    /*
    ** Validate the comment's subject.  If not specified, extract
    ** one from the comment's body.
    */

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

Dries's avatar
   
Dries committed
314
315
316
    if ($edit["subject"] == "") {
      $edit["subject"] = substr(strip_tags($edit["comment"]), 0, 29);
    }
Dries's avatar
   
Dries committed
317
318
319
320
321

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

Dries's avatar
   
Dries committed
322
323
324
325
    if ($edit["comment"] == "") {
      return array(t("Empty comment"), t("The comment you submitted is empty."));
    }

Dries's avatar
   
Dries committed
326
327
328
329
330
    /*
    ** Check for duplicate comments.  Note that we have to use the
    ** validated/filtered data to perform such check.
    */

Dries's avatar
   
Dries committed
331
    $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
332
333

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

Dries's avatar
   
Dries committed
339
      if ($edit["cid"]) {
Dries's avatar
   
Dries committed
340

Dries's avatar
   
Dries committed
341
342
343
344
345
346
        /*
        ** 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
347
        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
348
349
350
351
352
353

        /*
        ** Fire a hook
        */

        module_invoke_all("comment", "update", $edit);
Dries's avatar
   
Dries committed
354
355
356
357
358

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

Dries's avatar
   
Dries committed
359
        watchdog("special", "comment: updated '". $edit["subject"] ."'", l(t("view comment"), "node/view/". $edit["nid"] ."#". $edit["cid"]));
Dries's avatar
   
Dries committed
360
361
362
363
364
365
366
367
368
369
370
371
372
      }
      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
373
374
375
376
377
        $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
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
438
439
440
441
        /*
        ** 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
442
            $parent_depth = count(explode(".", $parent->thread));
Dries's avatar
   
Dries committed
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
            $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
460
            $thread = "$parent->thread.". $decimals.$units ."/";
Dries's avatar
   
Dries committed
461
462
463
464
          }
        }


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

Dries's avatar
   
Dries committed
467
        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
468
469
470
471
472
473

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

        module_invoke_all("comment", "insert", $edit);
Dries's avatar
   
Dries committed
474
475
476
477

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

Dries's avatar
   
Dries committed
479
        watchdog("special", "comment: added '". $edit["subject"] ."'", l(t("view comment"), "node/view/". $edit["nid"] ."#". $edit["cid"]));
Dries's avatar
   
Dries committed
480
      }
Dries's avatar
   
Dries committed
481
482

      /*
Dries's avatar
   
Dries committed
483
484
      ** Clear the cache so an anonymous user can see his comment being
      ** added.
Dries's avatar
   
Dries committed
485
      */
Dries's avatar
   
Dries committed
486

Dries's avatar
   
Dries committed
487
      cache_clear_all();
Dries's avatar
   
Dries committed
488
489
    }
  }
Dries's avatar
   
Dries committed
490
491
492
493
  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
494
495

  /*
Dries's avatar
   
Dries committed
496
  ** Redirect the user the node he commented on, or explain queue
Dries's avatar
   
Dries committed
497
498
  */

Dries's avatar
   
Dries committed
499
500
  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
501
502
503
504
  }
}

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

Dries's avatar
   
Dries committed
507
  $links = array();
Dries's avatar
   
Dries committed
508

Dries's avatar
   
Dries committed
509
510
511
512
  /*
  ** If we are viewing just this comment, we link back to the node
  */

Dries's avatar
   
Dries committed
513
  if ($return) {
Dries's avatar
   
Dries committed
514
    $links[] = l(t("parent"), comment_referer_load() ."#$comment->cid");
Dries's avatar
   
Dries committed
515
  }
Dries's avatar
   
Dries committed
516

Dries's avatar
   
Dries committed
517
  if (node_comment_mode($comment->nid) == 2) {
518
519
520
521
522
523
    if (user_access("administer comments") && user_access("access administration pages")) {
      $links[] = l(t("delete comment"), "admin/comment/delete/$comment->cid");
      $links[] = l(t("edit comment"), "admin/comment/edit/$comment->cid");
      $links[] = l(t("reply to this comment"), "comment/reply/$comment->nid/$comment->cid");
    }
    else if (user_access("post comments")) {
Dries's avatar
   
Dries committed
524
      if (comment_access("edit", $comment)) {
525
        $links[] = l(t("edit your comment"), "comment/edit/$comment->cid");
Dries's avatar
   
Dries committed
526
      }
Dries's avatar
   
Dries committed
527
      $links[] = l(t("reply to this comment"), "comment/reply/$comment->nid/$comment->cid");
Dries's avatar
   
Dries committed
528
529
    }
    else {
530
      $links[] = theme("comment_post_forbidden");
Dries's avatar
   
Dries committed
531
    }
Dries's avatar
   
Dries committed
532
  }
Dries's avatar
   
Dries committed
533

Dries's avatar
   
Dries committed
534
  if ($moderation = theme("comment_moderation_form", $comment)) {
Dries's avatar
   
Dries committed
535
536
    $links[] = $moderation;
  }
Dries's avatar
   
Dries committed
537

Dries's avatar
   
Dries committed
538
  return theme("links", $links);
Dries's avatar
   
Dries committed
539
540
}

Dries's avatar
   
Dries committed
541
function comment_render($node, $cid = 0) {
Dries's avatar
   
Dries committed
542
543
544
545
546
547
548
  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
549

Dries's avatar
   
Dries committed
550
551
  $output = "";

Dries's avatar
   
Dries committed
552
553
  if (user_access("access comments")) {

Dries's avatar
   
Dries committed
554
555
556
557
558
559
    /*
    ** Save were we come from so we can go back after a reply
    */

    comment_referer_save();

Dries's avatar
   
Dries committed
560
561
562
563
    /*
    ** Pre-process variables:
    */

Dries's avatar
   
Dries committed
564
    $nid = $node->nid;
Dries's avatar
   
Dries committed
565
566
    if (empty($nid)) {
      $nid = 0;
Dries's avatar
   
Dries committed
567
568
569
    }

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

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

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

Dries's avatar
   
Dries committed
582
    if (empty($comments_per_page)) {
583
      $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
584
    }
Dries's avatar
   
Dries committed
585

Dries's avatar
   
Dries committed
586
    $output .= "<a id=\"comment\"></a>\n";
Dries's avatar
   
Dries committed
587
588


Kjartan's avatar
Kjartan committed
589
    if ($cid) {
Dries's avatar
   
Dries committed
590
591
592
593
594

      /*
      ** Single comment view
      */

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

Dries's avatar
   
Dries committed
598
      $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
599

Dries's avatar
   
Dries committed
600
      if ($comment = db_fetch_object($result)) {
601
        $output .= theme("comment_view", $comment, comment_links($comment));
Dries's avatar
   
Dries committed
602
      }
Dries's avatar
   
Dries committed
603

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

Dries's avatar
   
Dries committed
611
612
613
614
      /*
      ** Multiple comments view
      */

Dries's avatar
   
Dries committed
615
      $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
616
617

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

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

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

      /*
Dries's avatar
   
Dries committed
707
      ** Start a form, to use with comment control and moderation.
Dries's avatar
   
Dries committed
708
709
      */

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

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

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

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

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

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

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

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

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

Dries's avatar
   
Dries committed
761
762
763
764
    /*
    ** If enabled, show new comment form
    */

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

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

Dries's avatar
   
Dries committed
776
function comment_link($type, $node = 0, $main = 0) {
Dries's avatar
   
Dries committed
777
  $links = array();
Dries's avatar
   
Dries committed
778

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

    if ($main) {

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

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

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

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

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

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

Dries's avatar
   
Dries committed
830
831
832
833
834
      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
835
      menu("admin/comment/help", t("help"), "comment_help_page", 9);
Dries's avatar
   
Dries committed
836
      menu("admin/comment/edit", t("edit comment"), "comment_admin", 0, MENU_HIDE);
837
      menu("admin/comment/delete", t("delete comment"), "comment_admin", 0, MENU_HIDE);
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, MENU_HIDE);
Dries's avatar
   
Dries committed
849
850
  }

Dries's avatar
   
Dries committed
851
  return $links;
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("page", comment_edit(check_query(arg(2))), t("Edit comment"));;
Dries's avatar
   
Dries committed
865
      break;
Dries's avatar
   
Dries committed
866
867
868
    case t("Moderate comments"):
    case t("Moderate comment"):
      comment_moderate($edit);
Dries's avatar
   
Dries committed
869
      drupal_goto(url(comment_referer_load()));
Dries's avatar
   
Dries committed
870
      break;
Dries's avatar
   
Dries committed
871
    case "reply":
Dries's avatar
   
Dries committed
872
      print theme("page", comment_reply(check_query(arg(3)), check_query(arg(2))), t("Add new comment"));
Dries's avatar
   
Dries committed
873
874
      break;
    case t("Preview comment"):
Dries's avatar
   
Dries committed
875
      print theme("page", comment_preview($edit), t("Preview comment"));
Dries's avatar
   
Dries committed
876
877
      break;
    case t("Post comment"):
Dries's avatar
   
Dries committed
878
879
      list($error_title, $error_body) = comment_post($edit);
      if ($error_body) {
Dries's avatar
   
Dries committed
880
        print theme("page", $error_body, $error_title);
Dries's avatar
   
Dries committed
881
882
      }
      else {
Dries's avatar
   
Dries committed
883
        drupal_goto(url(comment_referer_load()));
Dries's avatar
   
Dries committed
884
      }
Dries's avatar
   
Dries committed
885
      break;
886
    case t("Save settings"):
Dries's avatar
   
Dries committed
887
888
889
890
891
      $mode = $_POST["mode"];
      $order = $_POST["order"];
      $threshold = $_POST["threshold"];
      $comments_per_page = $_POST["comments_per_page"];

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

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

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

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

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

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

Dries's avatar
   
Dries committed
912
913

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

    while ($comment = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
916
      $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
917
918
    }

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

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

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

Dries's avatar
   
Dries committed
930
  $result = db_query("SELECT c.*, u.name, u.uid FROM {comments} c INNER JOIN {users} u ON c.uid = u.uid WHERE c.cid = %d AND c.status != 2", $id);
Dries's avatar
   
Dries committed
931
932
933
934
935
936
  $comment = db_fetch_object($result);

  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);
937
    $form .= form_radios(t("Status"), "status", $comment->status, array("published", "not published"));
Dries's avatar
   
Dries committed
938
939
940
941
942
    $form .= form_hidden("cid", $id);
    $form .= form_submit(t("Submit"));

    return form($form);
  }
Dries's avatar
   
Dries committed
943
944
}

945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
function _comment_delete_thread($comment) {
  // Delete the comment:
  db_query("DELETE FROM {comments} WHERE cid = %d", $comment->cid);
  watchdog("special", "comment: deleted '$comment->subject'");

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

function comment_delete($cid, $confirmed = 0) {
  $comment = db_fetch_object(db_query("SELECT c.*, u.name, u.uid FROM {comments} c INNER JOIN {users} u ON u.uid = c.uid WHERE c.cid = %d", $cid));

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

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

      _comment_delete_thread($comment);

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

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

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

984
985
986
987
988
      $output  = theme("comment", $comment);
      $output .= form_submit(t("Delete comment"));

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

Dries's avatar
   
Dries committed
995
function comment_save($id, $edit) {
Dries's avatar
   
Dries committed
996
  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
997
  watchdog("special", "comment: modified '". $edit["subject"] ."'");
998
  drupal_set_message(t("the comment has been saved."));
Dries's avatar
   
Dries committed
999
1000
}

Dries's avatar
   
Dries committed
1001
function comment_admin_overview($status = 0) {
Dries's avatar
   
Dries committed
1002

Dries's avatar
   
Dries committed
1003
  $header = array(
Dries's avatar
Dries committed
1004
1005
1006
    array("data" => t("subject"), "field" => "subject"),
    array("data" => t("author"), "field" => "u.name"),
    array("data" => t("status"), "field" => "status"),
Dries's avatar
Dries committed
1007
    array("data" => t("time"), "field" => "c.timestamp", "sort" => "desc"),
Dries's avatar
   
Dries committed
1008
1009
1010
    array("data" => t("operations"), "colspan" => 2)
  );

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