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

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

  switch ($section) {
Dries Buytaert's avatar
   
Dries Buytaert committed
8
    case 'admin/help#comment':
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
17
      $output .= "</ul>";
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
45
46

      $output .= "<h4>Moderation votes</h4>";
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
59
      $output .= "<h4>Moderator vote/values matrix</h4>";
Dries Buytaert's avatar
   
Dries Buytaert committed
60

Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
62
      $output .= "<p>NOTE: Comment ratings are calculated by averaging user votes with the initial rating.</p>";
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
67

Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
71
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
72
    case 'admin/system/modules#description':
Dries Buytaert's avatar
   
Dries Buytaert committed
73
74
75
      $output = t("Enables user to comment on content (nodes).");
      break;
    case 'admin/system/modules/comment':
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
89
90
      break;
    case 'admin/comments/moderation':
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
108
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
109
  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
110
111
}

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

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

Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
121

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

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

Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
132

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

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

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

Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
171
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
172

Dries Buytaert's avatar
   
Dries Buytaert committed
173
}
Dries Buytaert's avatar
   
Dries Buytaert committed
174
function comment_referer_save() {
Dries Buytaert's avatar
   
Dries Buytaert committed
175
  $_SESSION["comment_referer"] = arg(0) ."/". arg(1) ."/". arg(2);
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
185

Dries Buytaert's avatar
   
Dries Buytaert committed
186
187
188
function comment_edit($cid) {
  global $user;

Dries Buytaert's avatar
   
Dries Buytaert committed
189
  $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 Buytaert's avatar
   
Dries Buytaert committed
190
191

  if (comment_access("edit", $comment)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
192
    return comment_preview(object2array($comment));
Dries Buytaert's avatar
   
Dries Buytaert committed
193
194
195
196
  }
}

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

Dries Buytaert's avatar
   
Dries Buytaert committed
198
  $output = "";
Dries Buytaert's avatar
   
Dries Buytaert committed
199

200
  if (user_access("access comments")) {
Dries Buytaert's avatar
   
Dries Buytaert committed
201
202
203
204
205

    /*
    ** Show comment
    */

Dries Buytaert's avatar
   
Dries Buytaert committed
206
    if ($pid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
207
      $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 Buytaert's avatar
   
Dries Buytaert committed
208
      $output .= theme("comment_view", $comment);
Dries Buytaert's avatar
   
Dries Buytaert committed
209
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
210
    else if (user_access("access content")) {
Dries Buytaert's avatar
   
Dries Buytaert committed
211
      $output .= node_view(node_load(array("nid" => $nid)));
Dries Buytaert's avatar
   
Dries Buytaert committed
212
213
      $pid = 0;
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
214

Dries Buytaert's avatar
   
Dries Buytaert committed
215
216
217
218
    /*
    ** If possible, show reply form
    */

Dries Buytaert's avatar
   
Dries Buytaert committed
219
    if (node_comment_mode($nid) != 2) {
Dries Buytaert's avatar
   
Dries Buytaert committed
220
      $output .= theme("box", t("Reply"), t("This discussion is closed: you can't post new comments."));
Kjartan Mannes's avatar
Kjartan Mannes committed
221
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
222
    else if (user_access("post comments")) {
Dries Buytaert's avatar
   
Dries Buytaert committed
223
      $output .= theme("comment_form", array("pid" => $pid, "nid" => $nid), t("Reply"));
Dries Buytaert's avatar
   
Dries Buytaert committed
224
225
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
226
      $output .= theme("box", t("Reply"), t("You are not authorized to post comments."));
Dries Buytaert's avatar
   
Dries Buytaert committed
227
    }
Kjartan Mannes's avatar
Kjartan Mannes committed
228
229
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
230
    $output .= theme("box", t("Reply"), t("You are not authorized to view comments."));
Dries Buytaert's avatar
   
Dries Buytaert committed
231
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
232
233

  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
234
235
236
}

function comment_preview($edit) {
Dries Buytaert's avatar
   
Dries Buytaert committed
237
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
238

Dries Buytaert's avatar
   
Dries Buytaert committed
239
240
  $output = "";

Dries Buytaert's avatar
   
Dries Buytaert committed
241
242
243
244
  foreach ($edit as $key => $value) {
    $comment->$key = $value;
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
245
  /*
Dries Buytaert's avatar
   
Dries Buytaert committed
246
  ** Attach the user and time information:
Dries Buytaert's avatar
   
Dries Buytaert committed
247
248
249
250
251
252
253
254
255
256
  */

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

  /*
  ** Preview the comment:
  */

Dries Buytaert's avatar
   
Dries Buytaert committed
257
  $output .= theme("comment_view", $comment, comment_links($comment));
Dries Buytaert's avatar
   
Dries Buytaert committed
258
  $output .= theme("comment_form", $edit, t("Reply"));
Kjartan Mannes's avatar
Kjartan Mannes committed
259
260

  if ($edit["pid"]) {
Dries Buytaert's avatar
   
Dries Buytaert committed
261
    $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 Buytaert's avatar
   
Dries Buytaert committed
262
    $output .= theme("comment_view", $comment);
Kjartan Mannes's avatar
Kjartan Mannes committed
263
264
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
265
    $output .= node_view(node_load(array("nid" => $edit["nid"])));
Kjartan Mannes's avatar
Kjartan Mannes committed
266
267
    $edit["pid"] = 0;
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
268
269

  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
270
271
272
}

function comment_post($edit) {
Dries Buytaert's avatar
   
Dries Buytaert committed
273
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
274

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

Dries Buytaert's avatar
   
Dries Buytaert committed
277
278
279
280
281
    /*
    ** Validate the comment's subject.  If not specified, extract
    ** one from the comment's body.
    */

Dries Buytaert's avatar
   
Dries Buytaert committed
282
    $edit["subject"] = strip_tags($edit["subject"]);
Dries Buytaert's avatar
   
Dries Buytaert committed
283

Dries Buytaert's avatar
   
Dries Buytaert committed
284
285
286
    if ($edit["subject"] == "") {
      $edit["subject"] = substr(strip_tags($edit["comment"]), 0, 29);
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
287
288
289
290
291

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

Dries Buytaert's avatar
   
Dries Buytaert committed
292
293
294
295
    if ($edit["comment"] == "") {
      return array(t("Empty comment"), t("The comment you submitted is empty."));
    }

Dries Buytaert's avatar
   
Dries Buytaert committed
296
297
298
299
300
    /*
    ** Check for duplicate comments.  Note that we have to use the
    ** validated/filtered data to perform such check.
    */

Dries Buytaert's avatar
   
Dries Buytaert committed
301
    $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 Buytaert's avatar
   
Dries Buytaert committed
302
303

    if ($duplicate != 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
304
      watchdog("warning", "comment: duplicate '". $edit["subject"] ."'");
Dries Buytaert's avatar
   
Dries Buytaert committed
305
      return array(t("Duplicate comment"), t("The comment you submitted has already been inserted."));
Dries Buytaert's avatar
   
Dries Buytaert committed
306
307
308
    }
    else {

Dries Buytaert's avatar
   
Dries Buytaert committed
309
      if ($edit["cid"]) {
Dries Buytaert's avatar
   
Dries Buytaert committed
310

Dries Buytaert's avatar
   
Dries Buytaert committed
311
312
313
314
315
316
        /*
        ** Update the comment in the database.  Note that the update
        ** query will fail if the comment isn't owned by the current
        ** user.
        */

Dries Buytaert's avatar
   
Dries Buytaert committed
317
        db_query("UPDATE {comments} SET subject = '%s', comment = '%s' WHERE cid = %d AND uid = '$user->uid'", $edit["subject"], $edit["comment"], $edit["cid"]);
Dries Buytaert's avatar
   
Dries Buytaert committed
318
319
320
321
322
323

        /*
        ** Fire a hook
        */

        module_invoke_all("comment", "update", $edit);
Dries Buytaert's avatar
   
Dries Buytaert committed
324
325
326
327
328

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

Dries Buytaert's avatar
   
Dries Buytaert committed
329
        watchdog("special", "comment: updated '". $edit["subject"] ."'", l(t("view comment"), "node/view/". $edit["nid"], NULL, NULL, $edit["cid"]));
Dries Buytaert's avatar
   
Dries Buytaert committed
330
331
332
333
334
335
336
337
338
339
340
341
342
      }
      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 Buytaert's avatar
   
Dries Buytaert committed
343
344
345
346
347
        $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 Buytaert's avatar
   
Dries Buytaert committed
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
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
        /*
        ** 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 Buytaert's avatar
   
Dries Buytaert committed
412
            $parent_depth = count(explode(".", $parent->thread));
Dries Buytaert's avatar
   
Dries Buytaert committed
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
            $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 Buytaert's avatar
   
Dries Buytaert committed
430
            $thread = "$parent->thread.". $decimals.$units ."/";
Dries Buytaert's avatar
   
Dries Buytaert committed
431
432
433
434
          }
        }


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

Dries Buytaert's avatar
   
Dries Buytaert committed
437
        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 Buytaert's avatar
   
Dries Buytaert committed
438
439
440
441
442
443

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

        module_invoke_all("comment", "insert", $edit);
Dries Buytaert's avatar
   
Dries Buytaert committed
444
445
446
447

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

Dries Buytaert's avatar
   
Dries Buytaert committed
449
        watchdog("special", "comment: added '". $edit["subject"] ."'", l(t("view comment"), "node/view/". $edit["nid"], NULL, NULL, $edit["cid"]));
Dries Buytaert's avatar
   
Dries Buytaert committed
450
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
451
452

      /*
Dries Buytaert's avatar
   
Dries Buytaert committed
453
454
      ** Clear the cache so an anonymous user can see his comment being
      ** added.
Dries Buytaert's avatar
   
Dries Buytaert committed
455
      */
Dries Buytaert's avatar
   
Dries Buytaert committed
456

Dries Buytaert's avatar
   
Dries Buytaert committed
457
      cache_clear_all();
Dries Buytaert's avatar
   
Dries Buytaert committed
458
459
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
460
461
462
463
  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 Buytaert's avatar
   
Dries Buytaert committed
464
465

  /*
Dries Buytaert's avatar
   
Dries Buytaert committed
466
  ** Redirect the user the node he commented on, or explain queue
Dries Buytaert's avatar
   
Dries Buytaert committed
467
468
  */

Dries Buytaert's avatar
   
Dries Buytaert committed
469
470
  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 Buytaert's avatar
   
Dries Buytaert committed
471
472
473
474
  }
}

function comment_links($comment, $return = 1) {
Dries Buytaert's avatar
   
Dries Buytaert committed
475
  global $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
476

Dries Buytaert's avatar
   
Dries Buytaert committed
477
  $links = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
478

Dries Buytaert's avatar
   
Dries Buytaert committed
479
480
481
482
  /*
  ** If we are viewing just this comment, we link back to the node
  */

Dries Buytaert's avatar
   
Dries Buytaert committed
483
  if ($return) {
Dries Buytaert's avatar
   
Dries Buytaert committed
484
    $links[] = l(t("parent"), comment_referer_load(), NULL, NULL, $comment->cid);
Dries Buytaert's avatar
   
Dries Buytaert committed
485
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
486

Dries Buytaert's avatar
   
Dries Buytaert committed
487
  if (node_comment_mode($comment->nid) == 2) {
488
489
490
491
492
493
    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 Buytaert's avatar
   
Dries Buytaert committed
494
      if (comment_access("edit", $comment)) {
495
        $links[] = l(t("edit your comment"), "comment/edit/$comment->cid");
Dries Buytaert's avatar
   
Dries Buytaert committed
496
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
497
      $links[] = l(t("reply to this comment"), "comment/reply/$comment->nid/$comment->cid");
Dries Buytaert's avatar
   
Dries Buytaert committed
498
499
    }
    else {
500
      $links[] = theme("comment_post_forbidden");
Dries Buytaert's avatar
   
Dries Buytaert committed
501
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
502
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
503

Dries Buytaert's avatar
   
Dries Buytaert committed
504
  if ($moderation = theme("comment_moderation_form", $comment)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
505
506
    $links[] = $moderation;
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
507

Dries Buytaert's avatar
   
Dries Buytaert committed
508
  return theme("links", $links);
Dries Buytaert's avatar
   
Dries Buytaert committed
509
510
}

Dries Buytaert's avatar
   
Dries Buytaert committed
511
function comment_render($node, $cid = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
512
513
514
515
516
517
518
  global $user;

  $mode = $_GET["mode"];
  $order = $_GET["order"];
  $threshold = $_GET["threshold"];
  $comments_per_page = $_GET["comments_per_page"];
  $comment_page = $_GET["comment_page"];
Dries Buytaert's avatar
   
Dries Buytaert committed
519

Dries Buytaert's avatar
   
Dries Buytaert committed
520
521
  $output = "";

Dries Buytaert's avatar
   
Dries Buytaert committed
522
523
  if (user_access("access comments")) {

Dries Buytaert's avatar
   
Dries Buytaert committed
524
525
526
527
528
529
    /*
    ** Save were we come from so we can go back after a reply
    */

    comment_referer_save();

Dries Buytaert's avatar
   
Dries Buytaert committed
530
531
532
533
    /*
    ** Pre-process variables:
    */

Dries Buytaert's avatar
   
Dries Buytaert committed
534
    $nid = $node->nid;
Dries Buytaert's avatar
   
Dries Buytaert committed
535
536
    if (empty($nid)) {
      $nid = 0;
Dries Buytaert's avatar
   
Dries Buytaert committed
537
538
539
    }

    if (empty($mode)) {
540
      $mode = $user->mode ? $user->mode : ($_SESSION["comment_mode"] ? $_SESSION["comment_mode"] : variable_get("comment_default_mode", 4));
Dries Buytaert's avatar
   
Dries Buytaert committed
541
542
543
    }

    if (empty($order)) {
544
      $order = $user->sort ? $user->sort : ($_SESSION["comment_sort"] ? $_SESSION["comment_sort"] : variable_get("comment_default_order", 1));
Dries Buytaert's avatar
   
Dries Buytaert committed
545
546
547
    }

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

Dries Buytaert's avatar
   
Dries Buytaert committed
552
    if (empty($comments_per_page)) {
553
      $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 Buytaert's avatar
   
Dries Buytaert committed
554
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
555

Dries Buytaert's avatar
   
Dries Buytaert committed
556
    $output .= "<a id=\"comment\"></a>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
557
558


Kjartan Mannes's avatar
Kjartan Mannes committed
559
    if ($cid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
560
561
562
563
564

      /*
      ** Single comment view
      */

Dries Buytaert's avatar
   
Dries Buytaert committed
565
566
      $output .= "<form method=\"post\" action=\"". url("comment") ."\"><div>\n";
      $output .= form_hidden("nid", $nid);
Dries Buytaert's avatar
   
Dries Buytaert committed
567

Dries Buytaert's avatar
   
Dries Buytaert committed
568
      $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 Buytaert's avatar
   
Dries Buytaert committed
569

Dries Buytaert's avatar
   
Dries Buytaert committed
570
      if ($comment = db_fetch_object($result)) {
571
        $output .= theme("comment_view", $comment, comment_links($comment));
Dries Buytaert's avatar
   
Dries Buytaert committed
572
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
573

Dries Buytaert's avatar
   
Dries Buytaert committed
574
      if ((comment_user_can_moderate($node)) && $user->uid != $comment->uid && !(comment_already_moderated($user->uid, $comment->users))) {
Dries Buytaert's avatar
   
Dries Buytaert committed
575
        $output .= "<div style=\"text-align: center;\">". form_submit(t("Moderate comment")) ."</div><br />";
Dries Buytaert's avatar
   
Dries Buytaert committed
576
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
577
      $output .= "</div></form>";
Dries Buytaert's avatar
   
Dries Buytaert committed
578
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
579
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
580

Dries Buytaert's avatar
   
Dries Buytaert committed
581
582
583
584
      /*
      ** Multiple comments view
      */

Dries Buytaert's avatar
   
Dries Buytaert committed
585
      $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 Buytaert's avatar
   
Dries Buytaert committed
586
587

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

Dries Buytaert's avatar
   
Dries Buytaert committed
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
      /*
      ** 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 Buytaert's avatar
   
Dries Buytaert committed
651
652

      if ($order == 1) {
Dries Buytaert's avatar
   
Dries Buytaert committed
653
654
655
656
657
658
        if ($mode == 1 || $mode == 2) {
          $query .= " ORDER BY c.timestamp DESC";
        }
        else {
          $query .= " ORDER BY c.thread DESC";
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
659
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
660
      else if ($order == 2) {
Dries Buytaert's avatar
   
Dries Buytaert committed
661
662
663
664
665
666
667
668
669
670
671
672
673
        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 Buytaert's avatar
   
Dries Buytaert committed
674
675
676
      }

      /*
Dries Buytaert's avatar
   
Dries Buytaert committed
677
      ** Start a form, to use with comment control and moderation.
Dries Buytaert's avatar
   
Dries Buytaert committed
678
679
      */

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

682
      if (db_num_rows($result) && (variable_get("comment_controls", 0) == 0 || variable_get("comment_controls", 0) == 2)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
683
684
685
686
        $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 Buytaert's avatar
   
Dries Buytaert committed
687
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
688

Dries Buytaert's avatar
   
Dries Buytaert committed
689
690
      $output .= "<form method=\"post\" action=\"". url("comment") ."\"><div>\n";
      $output .= form_hidden("nid", $nid);
Dries Buytaert's avatar
   
Dries Buytaert committed
691

Dries Buytaert's avatar
   
Dries Buytaert committed
692
693
      while ($comment = db_fetch_object($result)) {
        $comment->depth = count(explode(".", $comment->thread)) - 1;
Dries Buytaert's avatar
   
Dries Buytaert committed
694

Dries Buytaert's avatar
   
Dries Buytaert committed
695
        if ($mode == 1) {
Dries Buytaert's avatar
   
Dries Buytaert committed
696
          $output .= theme("comment_flat_collapsed", $comment, $threshold_min);
Dries Buytaert's avatar
   
Dries Buytaert committed
697
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
698
        else if ($mode == 2) {
Dries Buytaert's avatar
   
Dries Buytaert committed
699
          $output .= theme("comment_flat_expanded", $comment, $threshold_min);
Dries Buytaert's avatar
   
Dries Buytaert committed
700
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
701
        else if ($mode == 3) {
Dries Buytaert's avatar
   
Dries Buytaert committed
702
          $output .= theme("comment_thread_min", $comment, $threshold_min);
Dries Buytaert's avatar
   
Dries Buytaert committed
703
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
704
        else if ($mode == 4) {
Dries Buytaert's avatar
   
Dries Buytaert committed
705
          $output .= theme("comment_thread_max", $comment, $threshold_min);
Dries Buytaert's avatar
   
Dries Buytaert committed
706
707
        }
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
708

Dries Buytaert's avatar
   
Dries Buytaert committed
709
710
711
712
      /*
      ** Use the standard pager, $pager_total is the number of returned rows,
      ** is global and defined in pager.inc
      */
Dries Buytaert's avatar
Dries Buytaert committed
713
      if ($pager = theme("pager", NULL, $comments_per_page, 0, array("comments_per_page" => $comments_per_page))) {
Dries Buytaert's avatar
   
Dries Buytaert committed
714
        $output .= $pager;
Dries Buytaert's avatar
   
Dries Buytaert committed
715
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
716

717
      if (db_num_rows($result) && comment_user_can_moderate($node)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
718
        $output .= "<div align=\"center\">". form_submit(t("Moderate comments")) ."</div><br />";
Dries Buytaert's avatar
   
Dries Buytaert committed
719
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
720

Dries Buytaert's avatar
   
Dries Buytaert committed
721
      $output .= "</div></form>";
Dries Buytaert's avatar
   
Dries Buytaert committed
722

723
      if (db_num_rows($result) && (variable_get("comment_controls", 0) == 1 || variable_get("comment_controls", 0) == 2)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
724
725
726
727
        $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 Buytaert's avatar
   
Dries Buytaert committed
728
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
729
730
    }

Dries Buytaert's avatar
   
Dries Buytaert committed
731
732
733
734
    /*
    ** If enabled, show new comment form
    */

Dries Buytaert's avatar
   
Dries Buytaert committed
735
    if (user_access("post comments") && node_comment_mode($nid) == 2 && variable_get("comment_form_location", 0)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
736
      $output .= theme("comment_form", array("nid" => $nid), t("Post new comment"));
Dries Buytaert's avatar
   
Dries Buytaert committed
737
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
738
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
739
  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
740
741
}

Dries Buytaert's avatar
   
Dries Buytaert committed
742
743
744
function comment_perm() {
  return array("access comments", "post comments", "administer comments", "moderate comments", "post comments without approval", "administer moderation");
}
Dries Buytaert's avatar
   
Dries Buytaert committed
745

Dries Buytaert's avatar
   
Dries Buytaert committed
746
function comment_link($type, $node = 0, $main = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
747
  $links = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
748

Dries Buytaert's avatar
   
Dries Buytaert committed
749
  if ($type == "node" && $node->comment) {
Dries Buytaert's avatar
   
Dries Buytaert committed
750
751
752
753
754
755
756
757

    if ($main) {

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

      if (user_access("access comments")) {
Dries Buytaert's avatar
   
Dries Buytaert committed
758
        $all = comment_num_all($node->nid);
Dries Buytaert's avatar
   
Dries Buytaert committed
759
        $new = comment_num_new($node->nid);
Dries Buytaert's avatar
   
Dries Buytaert committed
760

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

Dries Buytaert's avatar
   
Dries Buytaert committed
764
          if ($new) {
Dries Buytaert's avatar
   
Dries Buytaert committed
765
            $links[] = l(format_plural($new, "1 new comment", "%count new comments"), "node/view/$node->nid", array("title" => t("Jump to the first new comment of this posting.")), NULL, "new");
Dries Buytaert's avatar
   
Dries Buytaert committed
766
767
768
          }
        }
        else {
Dries Buytaert's avatar
   
Dries Buytaert committed
769
770
771
772
773
774
775
          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 Buytaert's avatar
   
Dries Buytaert committed
776
777
          }
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
778
779
780
781
782
      }
    }
    else {
      /*
      ** Node page: add a "post comment" link if the user is allowed to
Dries Buytaert's avatar
   
Dries Buytaert committed
783
      ** post comments and if this node is not read-only
Dries Buytaert's avatar
   
Dries Buytaert committed
784
785
      */

Dries Buytaert's avatar
   
Dries Buytaert committed
786
787
      if ($node->comment == 2) {
        if (user_access("post comments")) {
Dries Buytaert's avatar
   
Dries Buytaert committed
788
          $links[] = l(t("add new comment"), "comment/reply/$node->nid", array("title" => t("Share your thoughts and opinions related to this posting.")), NULL, "comment");
Kjartan Mannes's avatar
Kjartan Mannes committed
789
790
        }
        else {
791
          $links[] = theme("comment_post_forbidden");
Dries Buytaert's avatar
   
Dries Buytaert committed
792
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
793
794
795
796
      }
    }
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
797
798
799
  if ($type == "system") {
    if (user_access("administer comments")) {

Dries Buytaert's avatar
   
Dries Buytaert committed
800
801
802
803
804
      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 Buytaert's avatar
   
Dries Buytaert committed
805
      menu("admin/comment/help", t("help"), "comment_help_page", 9);
Dries Buytaert's avatar
   
Dries Buytaert committed
806
      menu("admin/comment/edit", t("edit comment"), "comment_admin", 0, MENU_HIDE);
807
      menu("admin/comment/delete", t("delete comment"), "comment_admin", 0, MENU_HIDE);
Dries Buytaert's avatar
   
Dries Buytaert committed
808
809
810

      // comment settings:
      if (user_access("administer moderation")) {
Dries Buytaert's avatar
   
Dries Buytaert committed
811
812
813
814
815
        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 Buytaert's avatar
   
Dries Buytaert committed
816
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
817
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
818
    menu("comment", t("comments"), "comment_page", 0, MENU_HIDE);
Dries Buytaert's avatar
   
Dries Buytaert committed
819
820
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
821
  return $links;
Dries Buytaert's avatar
   
Dries Buytaert committed
822
823
}

Dries Buytaert's avatar
   
Dries Buytaert committed
824
function comment_page() {
Dries Buytaert's avatar
   
Dries Buytaert committed
825
826
  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries Buytaert's avatar
   
Dries Buytaert committed
827
828
829
830

  if (empty($op)) {
    $op = arg(1);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
831
832
833

  switch ($op) {
    case "edit":
Dries Buytaert's avatar
   
Dries Buytaert committed
834
      print theme("page", comment_edit(check_query(arg(2))), t("Edit comment"));;
Dries Buytaert's avatar
   
Dries Buytaert committed
835
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
836
837
838
    case t("Moderate comments"):
    case t("Moderate comment"):
      comment_moderate($edit);
Dries Buytaert's avatar
   
Dries Buytaert committed
839
      drupal_goto(url(comment_referer_load()));
Dries Buytaert's avatar
   
Dries Buytaert committed
840
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
841
    case "reply":
Dries Buytaert's avatar
   
Dries Buytaert committed
842
      print theme("page", comment_reply(check_query(arg(3)), check_query(arg(2))), t("Add new comment"));
Dries Buytaert's avatar
   
Dries Buytaert committed
843
844
      break;
    case t("Preview comment"):
Dries Buytaert's avatar
   
Dries Buytaert committed
845
      print theme("page", comment_preview($edit), t("Preview comment"));
Dries Buytaert's avatar
   
Dries Buytaert committed
846
847
      break;
    case t("Post comment"):
Dries Buytaert's avatar
   
Dries Buytaert committed
848
849
      list($error_title, $error_body) = comment_post($edit);
      if ($error_body) {
Dries Buytaert's avatar
   
Dries Buytaert committed
850
        print theme("page", $error_body, $error_title);
Dries Buytaert's avatar
   
Dries Buytaert committed
851
852
      }
      else {
Dries Buytaert's avatar
   
Dries Buytaert committed
853
        drupal_goto(url(comment_referer_load()));
Dries Buytaert's avatar
   
Dries Buytaert committed
854
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
855
      break;
856
    case t("Save settings"):
Dries Buytaert's avatar
   
Dries Buytaert committed
857
858
859
860
861
      $mode = $_POST["mode"];
      $order = $_POST["order"];
      $threshold = $_POST["threshold"];
      $comments_per_page = $_POST["comments_per_page"];

862
      comment_save_settings(check_query($mode), check_query($order), check_query($threshold), check_query($comments_per_page));
Dries Buytaert's avatar
   
Dries Buytaert committed
863
      drupal_goto(url(comment_referer_load()));
Dries Buytaert's avatar
   
Dries Buytaert committed
864
865
866
867
      break;
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
868
869
870
/**
*** admin functions
**/
Dries Buytaert's avatar
   
Dries Buytaert committed
871

Dries Buytaert's avatar
   
Dries Buytaert committed
872
function comment_node_link($node) {
Dries Buytaert's avatar
 
Dries Buytaert committed
873

Dries Buytaert's avatar
   
Dries Buytaert committed
874
  if (user_access("administer comments")) {
Dries Buytaert's avatar
 
Dries Buytaert committed
875

Dries Buytaert's avatar
   
Dries Buytaert committed
876
877
878
    /*
    ** Edit comments:
    */
Dries Buytaert's avatar
 
Dries Buytaert committed
879

Dries Buytaert's avatar
   
Dries Buytaert committed
880
    $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 Buytaert's avatar
   
Dries Buytaert committed
881

Dries Buytaert's avatar
   
Dries Buytaert committed
882
883

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

    while ($comment = db_fetch_object($result)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
886
      $rows[] = array(l($comment->subject, "node/view/$node->nid", NULL, NULL, $comment->cid), format_name($comment), l(t("view comment"), "node/view/$node->nid", NULL, NULL, $comment->cid), l(t("edit comment"), "admin/comment/edit/$comment->cid"), l(t("delete comment"), "admin/comment/delete/$comment->cid"));
Dries Buytaert's avatar
   
Dries Buytaert committed
887
888
    }

Dries Buytaert's avatar
   
Dries Buytaert committed
889
890
    if ($rows) {
      $output  = "<h3>". t("Edit comments") ."</h3>";
Dries Buytaert's avatar
   
Dries Buytaert committed
891
      $output .= theme("table", $header, $rows);
Dries Buytaert's avatar
   
Dries Buytaert committed
892
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
893
894

    return $output;
Dries Buytaert's avatar
 
Dries Buytaert committed
895
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
896
}
Dries Buytaert's avatar
   
Dries Buytaert committed
897

Dries Buytaert's avatar
   
Dries Buytaert committed
898
899
function comment_admin_edit($id) {

Dries Buytaert's avatar
   
Dries Buytaert committed
900
  $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 Buytaert's avatar
   
Dries Buytaert committed
901
902
903
904
905
906
  $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);
907
    $form .= form_radios(t("Status"), "status", $comment->status, array("published", "not published"));
Dries Buytaert's avatar
   
Dries Buytaert committed
908
909
910
911
912
    $form .= form_hidden("cid", $id);
    $form .= form_submit(t("Submit"));

    return form($form);
  }
Dries Buytaert's avatar
 
Dries Buytaert committed
913
914
}

915
916
917
918
919
920
921
922
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)) {
923
    _comment_delete_thread($comment);
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
  }
}

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 Buytaert's avatar
   
Dries Buytaert committed
953

954
955
956
957
958
      $output  = theme("comment", $comment);
      $output .= form_submit(t("Delete comment"));

      return form($output);
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
959
960
  }
  else {
961
    drupal_set_message(t("the comment no longer exists."));
Dries Buytaert's avatar
   
Dries Buytaert committed
962
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
963
964
}

Dries Buytaert's avatar
   
Dries Buytaert committed
965
function comment_save($id, $edit) {
Dries Buytaert's avatar
   
Dries Buytaert committed
966
  db_query("UPDATE {comments} SET subject = '%s', comment = '%s', status = %d WHERE cid = %d", $edit["subject"], $edit["comment"], $edit["status"], $id);
Dries Buytaert's avatar
   
Dries Buytaert committed
967
  watchdog("special", "comment: modified '". $edit["subject"] ."'");
968
  drupal_set_message(t("the comment has been saved."));
Dries Buytaert's avatar
   
Dries Buytaert committed
969
970
}

Dries Buytaert's avatar
   
Dries Buytaert committed
971
function comment_admin_overview($status = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
972

Dries Buytaert's avatar
   
Dries Buytaert committed
973
  $header = array(
974
975
976
    array("data" => t("subject"), "field" => "subject"),
    array("data" => t("author"), "field" => "u.name"),
    array("data" => t("status"), "field" => "status"),
Dries Buytaert's avatar
Dries Buytaert committed
977
    array("data" => t("time"), "field" => "c.timestamp", "sort" => "desc"),
Dries Buytaert's avatar
   
Dries Buytaert committed
978
979
980
    array("data" => t("operations"), "colspan" => 2)
  );

Dries Buytaert's avatar
   
Dries Buytaert committed
981
  $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 Buytaert's avatar
   
Dries Buytaert committed
982
983
  $sql .= tablesort_sql($header);
  $result = pager_query($sql,  50);
Dries Buytaert's avatar
   
Dries Buytaert committed
984
985

  while ($comment = db_fetch_object($result)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
986
    $rows[] = array(l($comment->subject, "node/view/$comment->nid/$comment->cid", array("title" => htmlspecialchars(substr($comment->comment, 0, 128))), NULL, $comment->cid) ." ". (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 Buytaert's avatar
   
Dries Buytaert committed
987
988
  }

Dries Buytaert's avatar
Dries Buytaert committed
989
  if ($pager = theme("pager", NULL, 50, 0, tablesort_pager())) {
Dries Buytaert's avatar
   
Dries Buytaert committed
990
    $rows[] = array(array("data" => $pager, "colspan" => 6));
Dries Buytaert's avatar
   
Dries Buytaert committed
991
992
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
993
  return theme("table", $header, $rows