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

4
function forum_system($field){
Dries's avatar
   
Dries committed
5
  $system["description"] = t("Enable threaded discussions about general topics.");
6
7
8
  return $system[$field];
}

Dries's avatar
   
Dries committed
9
10
11
12
13
14
15
16
17
18
19
function forum_node($field) {
  $info["name"] = t("discussion forum");
  $info["description"] = t("A forum is a threaded discussion, enabling users to communicate about a particular topic.");

  return $info[$field];
}

function forum_access($op, $node) {
  if ($op == "view") {
    return $node->status;
  }
Dries's avatar
   
Dries committed
20
  if ($op == "create") {
Dries's avatar
   
Dries committed
21
    return user_access("create forum topics");
Dries's avatar
   
Dries committed
22
  }
Dries's avatar
   
Dries committed
23
24
}

Dries's avatar
   
Dries committed
25
function forum_perm() {
Dries's avatar
   
Dries committed
26
  return array("create forum topics");
Dries's avatar
   
Dries committed
27
}
Dries's avatar
   
Dries committed
28

29
function forum_settings() {
Dries's avatar
   
Dries committed
30

Dries's avatar
   
Dries committed
31
  if (module_exist("taxonomy")) {
Dries's avatar
   
Dries committed
32
    $vocs[0] = "<". t("none") .">";
Dries's avatar
   
Dries committed
33
34
35
36
    foreach (taxonomy_get_vocabularies("forum") as $vid => $voc) {
      $vocs[$vid] = $voc->name;
    }

Dries's avatar
   
Dries committed
37
    if ($voc) {
Dries's avatar
   
Dries committed
38
      $output .= form_textarea("Explanation or submission guidelines", "forum_help", variable_get("forum_help", ""), 55, 4, t("This text will be displayed at the top of the forum submission form.  Useful for helping or instructing your users."));
Dries's avatar
   
Dries committed
39
40
41
42
43
44
45
46
47
48
49
      $output .= form_select("Forum vocabulary", "forum_nav_vocabulary", variable_get("forum_nav_vocabulary", ""), $vocs, t("The taxonomy vocabulary that will be used as the navigation tree."));
      $output .= _taxonomy_term_select("Containers", "forum_containers", variable_get("forum_containers", array()), variable_get("forum_nav_vocabulary", ""), t("You can choose forums which will not have topics, but will be just containers for other forums."), 1, t("<none>"));

      $output .= form_textfield("Topic icons path", "forum_topic_icon_path", variable_get("forum_topic_icon_path", ""), 30, 255, "The path to the topic icons.  Leave blank to disable icons.");
      $output .= form_textfield("Folder icons path", "forum_folder_icon_path", variable_get("forum_folder_icon_path", ""), 30, 255, "The path to the <b>default</b>, <b>hot</b>, <b>new</b>, <b>hot & new</b>, and <b>closed</b> folder icons.  Leave blank to disable icons.");
      $number = array(5 => 5, 10 => 10, 15 => 15, 20 => 20, 25 => 25, 30 => 30, 35 => 35, 40 => 40, 50 => 50, 60 => 60, 80 => 80, 100 => 100, 10000=>10000);
      $output .= form_select("Hot topic threshold", "forum_hot_topic", variable_get("forum_hot_topic", 15), $number, "The number of posts a topic must have to be considered <b>hot</b>.");
      $number = array(10 => 10, 25 => 25, 50 => 50, 75 => 75, 100 => 100);
      $output .= form_select("Topics per page", "forum_per_page", variable_get("forum_per_page", 25), $number, "The default number of topics displayed per page; links to browse older messages are automatically being displayed.");
      $forder = array(1 => "Date - newest first", 2 => "Date - oldest first", 3 => "Posts - most active first", 4=> "Posts - least active first");
      $output .= form_select("Default order", "forum_order", variable_get("forum_order", 1), $forder, "The default display order for topics.");
Dries's avatar
   
Dries committed
50
      $output .= form_textfield("Number of topics in block", "forum_block_num", variable_get("forum_block_num", "5"), 5, 5, "The number of topics in the <b>Forum topics</b>-block.  To enable the block, click ". l("here", "admin/block") .".");
Dries's avatar
   
Dries committed
51
52
53
54
55
56
57
58
    }
    else {
      $output .= _forum_message_taxonomy();
    }
  }
  else {
    $output .= _forum_message_taxonomy();
  }
Dries's avatar
   
Dries committed
59

Dries's avatar
   
Dries committed
60
61
62
  return $output;
}

Dries's avatar
Dries committed
63
64
65
66
67
68
69
70
71
function forum_taxonomy($op, $type, $object) {
  if ($type == "vocabulary" && ($op == "insert" || $op == "update")) {
    if (variable_get("forum_nav_vocabulary", "") == "" && in_array("forum", $object["types"])) {
      // since none is already set, silently set this vocabulary as the navigation vocabulary
      variable_set("forum_nav_vocabulary", $object["vid"]);
    }
  }
}

Dries's avatar
   
Dries committed
72
function forum_save($op, $node) {
Dries's avatar
   
Dries committed
73
74
75
76
77
  if ($op == "approve") {
    return array("status" => 1);
  }

  if ($op == "create") {
78
    return array("body" => filter($node->body), "teaser" => filter($node->teaser), "moderate" => 0, "status" => 1, "tid", "icon_num", "shadow" => 0);
Dries's avatar
   
Dries committed
79
80
  }

Dries's avatar
   
Dries committed
81
82
  if ($op == "decline") {
    return array("status" => 0);
Dries's avatar
   
Dries committed
83
84
85
  }

  if ($op == "update") {
86
    return array("body" => filter($node->body), "teaser" => filter($node->teaser), "tid", "icon_num", "shadow");
Dries's avatar
   
Dries committed
87
88
89
  }
}

Dries's avatar
   
Dries committed
90
function forum_load($node) {
Dries's avatar
Dries committed
91
  $forum = db_fetch_object(db_query("SELECT * FROM forum WHERE nid = '%d'", $node->nid));
Dries's avatar
   
Dries committed
92
93
94
95

  return $forum;
}

96
97
98
99
100
101
function forum_block($op = "list", $delta = 0) {
  if ($op == "list") {
    $blocks[0]["info"] = t("Forum topics");
  }
  else {
    if (user_access("access content")) {
Dries's avatar
   
Dries committed
102
      $cache = cache_get("forum:block");
Dries's avatar
   
Dries committed
103

Dries's avatar
   
Dries committed
104
      if (empty($cache)) {
Dries's avatar
   
Dries committed
105
        unset($items);
Dries's avatar
Dries committed
106
        $content = node_title_list(db_query("SELECT n.nid, n.title, u.uid, u.name, GREATEST(n.created, MAX(c.timestamp)) AS sort FROM node n, forum f LEFT JOIN comments c ON c.nid = n.nid LEFT JOIN users u ON n.uid = u.uid WHERE n.type = 'forum' AND n.nid = f.nid AND n.status = 1 GROUP BY n.nid ORDER BY sort DESC LIMIT ". variable_get("forum_block_num", "5")), t("Active forum topics:"));
107
        $content .= "<br />";
Dries's avatar
   
Dries committed
108
109

        unset ($items);
Dries's avatar
   
Dries committed
110
        $content .= node_title_list(db_query("SELECT n.nid, n.title, u.uid, u.name FROM node n LEFT JOIN forum f ON n.nid = f.nid LEFT JOIN users u ON n.uid = u.uid WHERE n.type = 'forum' ORDER BY n.nid DESC LIMIT ". variable_get("forum_block_num", "5")), t("New forum topics:"));
Dries's avatar
   
Dries committed
111

112
        if ($content) {
Dries's avatar
   
Dries committed
113
          $content .= "<div id=\"forum_more\" align=\"right\">". l(t("more"), "forum") ."</div>";
114
        }
Dries's avatar
   
Dries committed
115

Dries's avatar
   
Dries committed
116
        cache_set("forum:block", $content, time() + variable_get("cache_clear", 120));
117
      }
Dries's avatar
   
Dries committed
118
119
120
      else {
        $content = $cache->data;
      }
Dries's avatar
   
Dries committed
121

122
      $blocks["subject"] = t("Forum topics");
Dries's avatar
   
Dries committed
123
      $blocks["content"] = $content;
Dries's avatar
   
Dries committed
124
125
    }
  }
Dries's avatar
   
Dries committed
126

Dries's avatar
   
Dries committed
127
128
129
  return $blocks;
}

130
function forum_link($type, $node = 0, $main = 0) {
Dries's avatar
Dries committed
131
  global $user;
Dries's avatar
   
Dries committed
132

Dries's avatar
   
Dries committed
133
  if ($type == "page" && user_access("access content")) {
Dries's avatar
   
Dries committed
134
    $links[] = l(t("forum"), "forum");
Dries's avatar
   
Dries committed
135
136
  }

137
  if (!$main && $type == "node" && $node->type == "forum") {
Dries's avatar
   
Dries committed
138
139
    // get previous and next topic

Dries's avatar
Dries committed
140
    $result = db_query("SELECT n.nid, title, body, GREATEST(n.created, MAX(c.timestamp)) AS date_sort, COUNT(c.nid) AS num_comments FROM node n, forum f LEFT JOIN comments c ON c.nid = n.nid WHERE n.nid = f.nid AND f.tid = '%d' AND n.status = 1 GROUP BY n.nid ORDER BY ". _forum_get_topic_order(isset($user->sortby) ? $user->sortby : variable_get("forum_order",1)), $node->tid);
Dries's avatar
   
Dries committed
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

    while ($topic = db_fetch_object($result)) {
      if ($stop == 1) {
        $next->nid = $topic->nid;
        $next->title = $topic->title;
        $next->body = $topic->body;
        break;
      }
      if ($topic->nid == $node->nid) {
        $stop = 1;
      }
      else {
        $prev->nid = $topic->nid;
        $prev->title = $topic->title;
        $prev->body = $topic->body;
      }
    }

    if ($prev) {
Dries's avatar
   
Dries committed
160
      $links[] = l(t("previous forum topic"), "node/view/$prev->nid", array("title" => $prev->title .": ". substr(strip_tags($prev->body), 0, 100)."..."));
Dries's avatar
   
Dries committed
161
162
163
    }

    if ($next) {
Dries's avatar
   
Dries committed
164
      $links[] = l(t("next forum topic"), "node/view/$next->nid", array("title" => $next->title .": ". substr(strip_tags($next->body), 0, 100)."..."));
Dries's avatar
   
Dries committed
165
    }
Dries's avatar
   
Dries committed
166
167
  }

Dries's avatar
   
Dries committed
168
169
170
  return $links ? $links : array();
}

Dries's avatar
   
Dries committed
171
function forum_view($node, $main = 0) {
Dries's avatar
   
Dries committed
172
  global $theme;
Dries's avatar
   
Dries committed
173
174
175
176
177
178
179
180

  $term_data = array_shift(taxonomy_node_get_terms($node->nid));
  if (!$term_data) {
    // we are previewing
    $term_data = taxonomy_get_term($node->taxonomy[0]);
  }
  $voc = taxonomy_get_vocabulary($term_data->vid);

181
  if (!$main) {
Dries's avatar
   
Dries committed
182
    $node->title = _forum_get_icon($node) ." ". l($voc->name, "forum") ." : ". l($term_data->name, "forum/$term_data->tid") ." / <b>$node->title</b>";
183
  }
Dries's avatar
   
Dries committed
184
185

  $theme->node($node, $main);
Dries's avatar
   
Dries committed
186
187
}

Dries's avatar
Dries committed
188
189
190
191
192
193
194
195
196
function forum_validate($node) {
  // we use the validate hook to remember the old taxonomy terms
  $node->taxonomy = array_keys(taxonomy_node_get_terms($node->nid));
  if (!in_array($node->tid[0], $node->taxonomy)) {
    $node->taxonomy[] = $node->tid[0];
  }
  return $node;
}

Dries's avatar
   
Dries committed
197
function forum_form(&$node, &$help, &$error) {
Dries's avatar
Dries committed
198
199
200
  if ($node->tid) {
    // editing
    $tid = $node->tid;
201
202
  }
  else {
Dries's avatar
Dries committed
203
204
    // new topic
    $tid = arg(3);
205
206
  }

Dries's avatar
   
Dries committed
207
208
209
  // outputs the compose guidelines
  $help = variable_get("forum_help", "");

Dries's avatar
Dries committed
210
211
212
213
214
215
  $output .= _taxonomy_term_select("Forum", "tid", $tid, variable_get("forum_nav_vocabulary", ""), "", 0, "", variable_get("forum_containers", array()));

  if ($node->nid) {
    // if editing, give option to leave shadows
    $output .= form_checkbox(t("Leave shadow copy"), "shadow", 1, $node->shadow, t("If you move this topic, you can leave a link in the old forum to the new forum."));
  }
Dries's avatar
   
Dries committed
216

Dries's avatar
   
Dries committed
217
  if ($icon_path = variable_get("forum_topic_icon_path", "")) {
Dries's avatar
   
Dries committed
218
219
220
221
222
223
224
    if ($node->icon) {
      // we are editing post
      if ($dir = @opendir($icon_path)) {
        $icon_num = 0;
        while($icon = readdir($dir)) {
          if ($icon == '.' || $icon == '..') {continue;}
          if ($node->icon == $icon) {$checked = "checked";} else {$checked = "";}
Dries's avatar
Dries committed
225
          $radio .= "<input type=\"radio\" name=\"edit[icon_num]\" value=\"$icon_num\" $checked /><img src=\"$icon_path$icon\" alt=\"\" /> \n";
Dries's avatar
   
Dries committed
226
227
228
229
230
231
232
233
234
235
236
          $icon_num++;
        }
        closedir($dir);
      }
    }
    else {
      if ($dir = @opendir($icon_path)) {
        $icon_num = 0;
        while($icon = readdir($dir)) {
          if ($icon == '.' || $icon == '..') {continue;}
          if ($node->icon_num == $icon_num) {$checked = "checked";} else {$checked = "";}
Dries's avatar
Dries committed
237
          $radio .= "<input type=\"radio\" name=\"edit[icon_num]\" value=\"$icon_num\" $checked /><img src=\"$icon_path$icon\" alt=\"\" /> \n";
Dries's avatar
   
Dries committed
238
239
240
241
242
243
244
          $icon_num++;
        }
        closedir($dir);
      }
    }
    $output .= form_item(t("Topic icon"), $radio);
  }
Dries's avatar
Dries committed
245
  $output .= form_textarea(t("Body"), "body", $node->body, 60, 10);
Dries's avatar
   
Dries committed
246
247
248
249

  return $output;
}

Dries's avatar
   
Dries committed
250
251
function forum_insert($node) {
  $node->icon = _forum_decode_icon($node);
Dries's avatar
Dries committed
252
  db_query("INSERT INTO forum (nid, icon, shadow, tid) VALUES ('%d', '%s', '%d', '%d')", $node->nid, $node->icon, $node->shadow, $node->tid);
Dries's avatar
   
Dries committed
253
254
255
256
}

function forum_update($node) {
  $node->icon = _forum_decode_icon($node);
Dries's avatar
Dries committed
257
  db_query("UPDATE forum SET icon = '%s', shadow = '%d', tid = '%d' WHERE nid = '%d'", $node->icon, $node->shadow, $node->tid[0], $node->nid);
Dries's avatar
   
Dries committed
258
259
260
261
}

function _forum_decode_icon($node) {
  // to prevent malicious users
Dries's avatar
   
Dries committed
262
  if ($icon_path = variable_get("forum_topic_icon_path", "")) {
Dries's avatar
   
Dries committed
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
    if ($dir = @opendir($icon_path)) {
      $icon_num = 0;
      while($icon = readdir($dir)) {
        if ($icon == '.' || $icon == '..') {continue;}
        if ($icon_num == $node->icon_num) {$myicon = $icon;}
        $icon_num++;
      }
      closedir($dir);
    }
  }
  return $myicon;
}

function forum_delete(&$node) {
  db_query("DELETE FROM forum WHERE nid = '%d'", $node->nid);
}
Dries's avatar
   
Dries committed
279

Dries's avatar
   
Dries committed
280
281
function _forum_num_comments($nid) {
  $value = db_fetch_object(db_query("SELECT COUNT(cid) AS count FROM comments WHERE nid = '%d' AND status = 0", $nid));
Dries's avatar
   
Dries committed
282
283
284
  return ($value) ? $value->count : 0;
}

Dries's avatar
   
Dries committed
285
286
function _forum_last_comment($nid) {
  $value = db_fetch_object(db_query("SELECT timestamp FROM comments WHERE nid = '%d' AND status = 0 ORDER BY timestamp DESC LIMIT 1", $nid));
Dries's avatar
   
Dries committed
287
288
289
  return ($value) ? format_date($value->timestamp, "small") : "&nbsp;";
}

Dries's avatar
   
Dries committed
290
291
292
293
294
295
296
function _forum_last_reply($nid) {
  $value = db_fetch_object(db_query("SELECT c.timestamp, u.name, u.uid FROM comments c LEFT JOIN users u ON c.uid = u.uid WHERE c.nid = '%d' AND c.status = 0 ORDER BY c.timestamp DESC LIMIT 1", $nid));
  return $value;
}

function _forum_format($topic) {
  if ($topic) {
Dries's avatar
Dries committed
297
    return "<small>". format_date($topic->timestamp, "small")."<br />".t("by")." ". format_name($topic) ."</small>";
Dries's avatar
   
Dries committed
298
299
300
301
302
303
304
305
306
307
308
309
310
  }
  else {
    return message_na();
  }
}

function forum_get_forums($tid = 0) {
  global $user;

  if (!$tid) {
    $tid = 0;
  }

Dries's avatar
   
Dries committed
311
  $cache = cache_get("forum:$tid");
Dries's avatar
   
Dries committed
312

Dries's avatar
   
Dries committed
313
  if (empty($cache)) {
314
    $forums = array();
Dries's avatar
   
Dries committed
315
    $_forums = taxonomy_get_tree(variable_get("forum_nav_vocabulary", ""), $tid);
Dries's avatar
   
Dries committed
316
317
318
319
320
321
322
323
324
325
326
327
328
329
    $n = 0;
    foreach ($_forums as $forum) {
      if (in_array($forum->tid, variable_get("forum_containers", array()))) {
        $forum->container = 1;
      }
      else {
        $forum->num_topics = _forum_num_topics($forum->tid);
        $forum->num_posts = _forum_num_replies($forum->tid) + $forum->num_topics;
        $forum->last_post = _forum_last_post($forum->tid);
      }
      $forums[$forum->tid] = $forum;
      $n++;
    }

Dries's avatar
   
Dries committed
330
    cache_set("forum:$tid", serialize($forums), time() + variable_get("cache_clear", 120));
Dries's avatar
   
Dries committed
331
  }
Dries's avatar
   
Dries committed
332
333
334
  else {
    $forums = unserialize($cache->data);
  }
Dries's avatar
   
Dries committed
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354

  if ($user->uid && $forums) {
    foreach (_forum_topics_read($user->uid) as $tid => $old) {
      if ($forums[$tid]) {
        $forums[$tid]->old_topics = $old;
      }
    }
  }
  return $forums;
}

function forum_get_parents($tid) {
  if ($tid) {
    $parents[] = taxonomy_get_term($tid);
  }
  $n = 0;
  while ($parent = taxonomy_get_parents($parents[$n]->tid)) {
    $parents = array_merge($parents, $parent);
    $n++;
  }
Dries's avatar
   
Dries committed
355

Dries's avatar
   
Dries committed
356
357
358
359
  return $parents;
}

function _forum_num_topics($term) {
Dries's avatar
Dries committed
360
  $value = db_fetch_object(db_query("SELECT COUNT(n.nid) AS count FROM node n, forum f WHERE f.tid = '%d' AND n.nid = f.nid AND n.status = 1 AND n.type = 'forum'", $term));
Dries's avatar
   
Dries committed
361
362
363
364
  return ($value) ? $value->count : 0;
}

function _forum_num_replies($term) {
Dries's avatar
Dries committed
365
  $value = db_fetch_object(db_query("SELECT COUNT(*) AS count FROM comments c, node n, forum f WHERE f.tid = '%d' AND n.nid = f.nid AND n.nid = c.nid AND n.status = 1 AND c.status = 0 AND n.type = 'forum'", $term));
Dries's avatar
   
Dries committed
366
367
368
369
  return ($value) ? $value->count : 0;
}

function _forum_topics_read($uid) {
Dries's avatar
Dries committed
370
  $result = db_query("SELECT tid, count(*) AS c FROM history h, node n, forum f WHERE f.nid = n.nid AND n.nid = h.nid AND n.type = 'forum' AND n.status = 1 AND h.uid = '%d' GROUP BY tid", $uid);
Dries's avatar
   
Dries committed
371
372
373
374
375
376
377
378
379

  while ($obj = db_fetch_object($result)) {
    $topics_read[$obj->tid] = $obj->c;
  }

  return $topics_read ? $topics_read : array();
}

function _forum_last_post($term) {
Dries's avatar
Dries committed
380
  $topic = db_fetch_object(db_query("SELECT n.nid, n.created AS timestamp, u.name AS name, u.uid AS uid FROM node n, forum f LEFT JOIN users u ON n.uid = u.uid WHERE f.tid = '%d' AND n.nid = f.nid AND n.type = 'forum' AND n.status = 1 ORDER BY timestamp DESC LIMIT 1", $term));
Dries's avatar
   
Dries committed
381

Dries's avatar
Dries committed
382
  $reply = db_fetch_object(db_query("SELECT n.nid, c.timestamp, u.name AS name, u.uid AS uid FROM forum f, node n LEFT JOIN comments c ON n.nid = c.nid LEFT JOIN users u ON c.uid = u.uid WHERE f.tid = '%d' AND n.nid = f.nid AND n.type = 'forum' AND n.status = 1 AND c.status = 0 ORDER BY c.timestamp DESC LIMIT 1", $term));
Dries's avatar
   
Dries committed
383
384
385
386
387
388

  $value = ($topic->timestamp > $reply->timestamp) ? $topic : $reply;

  return $value;
}

Dries's avatar
Dries committed
389
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
   
Dries committed
390
391
392
393
394
395
396
  global $user;

  $term = taxonomy_get_term($tid);
  $voc = taxonomy_get_vocabulary($term->vid);

  $sql_sortby = _forum_get_topic_order($sortby);

Dries's avatar
Dries committed
397
398
399
400
  // show topics with the correct tid, or in the forum but with shadow = 1
  $sql = "SELECT n.nid, title, u.name AS name, u.uid AS uid, n.created AS timestamp, GREATEST(n.created, MAX(c.timestamp)) AS date_sort, COUNT(c.nid) AS num_comments, icon, n.comment AS comment_mode, f.tid FROM node n, term_node r LEFT JOIN users u ON n.uid = u.uid LEFT JOIN comments c ON c.nid = n.nid LEFT JOIN forum f ON n.nid = f.nid WHERE n.nid = r.nid AND ( (r.tid = '".check_query($tid)."' AND f.shadow = 1) OR f.tid = '".check_query($tid)."' ) AND n.status = 1 AND n.type = 'forum' GROUP BY n.nid ORDER BY $sql_sortby";

  $sql_count = "SELECT COUNT(DISTINCT(n.nid)) FROM node n, term_node r LEFT JOIN forum f ON n.nid = f.nid WHERE n.nid = r.nid AND ( (r.tid = '".check_query($tid)."' AND f.shadow = 1) OR f.tid = '".check_query($tid)."' ) AND n.status = 1 AND n.type = 'forum'";
Dries's avatar
   
Dries committed
401

Dries's avatar
Dries committed
402
  $result = pager_query($sql, $forum_per_page, 0, $sql_count);
Dries's avatar
   
Dries committed
403
404
405
406
  $topic_num = db_num_rows($result);

  $n = 0;
  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
407
408
409
410
411
    if ($user->uid) {
      $history = _forum_user_last_visit($topic->nid);
      // folder is new if topic is new or there are new comments since last visit
      if ($topic->shadow > 0) {
        $topic->new = 0;
Dries's avatar
   
Dries committed
412
413
      }
      else {
Dries's avatar
Dries committed
414
415
        if (!$history && $user->uid) {
          $topic->new_replies = 0;
Dries's avatar
   
Dries committed
416
417
418
          $topic->new = 1;
        }
        else {
Dries's avatar
Dries committed
419
420
421
422
423
424
425
426
427
          $comments = db_result(db_query("SELECT COUNT(c.nid) FROM node n LEFT JOIN comments c ON n.nid = c.nid WHERE n.nid = '$topic->nid' AND n.status = 1 AND c.status = 0 AND timestamp > '$history' GROUP BY n.nid"));

          $topic->new_replies = $comments ? $comments : 0;
          if ($topic->new_replies) {
            $topic->new = 1;
          }
          else {
            $topic->new = 0;
          }
Dries's avatar
   
Dries committed
428
429
        }
      }
Dries's avatar
Dries committed
430
431
432
433
434
435
     }
     else {
      // you're not logged in eh?
      $topic->new_replies = 0;
      $topic->new = 0;
     }
Dries's avatar
   
Dries committed
436
437
438
439
440

    $topic->last_reply = _forum_last_reply($topic->nid);
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
441
  return $topics;
Dries's avatar
   
Dries committed
442
443
}

Dries's avatar
Dries committed
444
function _forum_new($tid) {
Dries's avatar
   
Dries committed
445
  global $user;
Dries's avatar
Dries committed
446
  $result = db_query("SELECT n.nid FROM node n, history h, forum f WHERE n.type = 'forum' AND n.status = 1 AND h.nid = n.nid AND f.nid = h.nid AND f.tid = '%d' AND h.uid = '%d'", $tid, $user->uid);
Dries's avatar
   
Dries committed
447
448
449
450
  while ($r = db_fetch_object($result)) {
    $read[] = $r->nid;
  }

Dries's avatar
Dries committed
451
  $nid = db_result(db_query("SELECT n.nid FROM node n, forum f WHERE n.type = 'forum' AND f.nid = n.nid AND n.status = 1 AND f.tid = '%d' ".($read ? "AND NOT (n.nid IN (".implode(",", $read).")) " : "") ."ORDER BY created LIMIT 1", $tid));
Dries's avatar
   
Dries committed
452
453
454
455

  return $nid ? $nid : 0;
}

Dries's avatar
   
Dries committed
456
457
458
459
function _forum_message_taxonomy() {
  return t("For the forums to work, the taxonomy module has to be installed and enabled.  When activated, a taxonomy vocubulary needs to be created, bound to the forum module.  The vocabulary's terms define the forums.");
}

Dries's avatar
   
Dries committed
460
function forum_page() {
Dries's avatar
Dries committed
461
  global $theme, $sortby, $forum_per_page, $from, $op, $user;
Dries's avatar
   
Dries committed
462
463

  if (user_access("access content")) {
Dries's avatar
   
Dries committed
464
    if (module_exist("taxonomy")) {
Dries's avatar
   
Dries committed
465
466
      $tid = arg(1);

Dries's avatar
   
Dries committed
467
      if ($op == "Update settings" && $user->uid) {
Dries's avatar
   
Dries committed
468
469
        $user = user_save($user, array("sortby" => $sortby, "forum_per_page" => $forum_per_page));
      }
Dries's avatar
   
Dries committed
470

Dries's avatar
Dries committed
471
472
473
474
475
476
      if (arg(2) == "new") {
        if ($nid = _forum_new($tid)) {
          drupal_goto(url("node/view/$nid"));
        }
      }

Dries's avatar
   
Dries committed
477
478
479
      if (empty($sortby)) {
        $sortby = isset($user->sortby) ? $user->sortby : variable_get("forum_order",1);
      }
Dries's avatar
   
Dries committed
480

Dries's avatar
   
Dries committed
481
482
483
      if (empty($forum_per_page)) {
        $forum_per_page = isset($user->forum_per_page) ? $user->forum_per_page : variable_get("forum_per_page", 25);
      }
Dries's avatar
   
Dries committed
484

Dries's avatar
Dries committed
485
      $offset = ($from / $forum_per_page) + 1;
Dries's avatar
   
Dries committed
486

Dries's avatar
   
Dries committed
487
488
489
      $forums = forum_get_forums($tid);
      $parents = forum_get_parents($tid);
      if ($tid && !in_array($tid, variable_get("forum_containers", array()))) {
Dries's avatar
Dries committed
490
        $topics = forum_get_topics($tid, $sortby, $forum_per_page);
Dries's avatar
   
Dries committed
491
      }
Dries's avatar
   
Dries committed
492

493
      theme("forum_render", $forums, $topics, $parents, $tid, $sortby, $forum_per_page, $offset);
Dries's avatar
   
Dries committed
494
495
496
497
498
499
    }
    else {
      $theme->header();
      $theme->box(t("Warning"), _forum_message_taxonomy());
      $theme->footer();
    }
Dries's avatar
   
Dries committed
500
501
502
503
504
505
506
507
  }
  else {
    $theme->header();
    $theme->box(t("Access denied"), message_access());
    $theme->footer();
  }
}

Dries's avatar
   
Dries committed
508
509
510
/*
** Render functions.
*/
Dries's avatar
   
Dries committed
511

Dries's avatar
Dries committed
512
function forum_render($forums, $topics, $parents, $tid, $sortby, $forum_per_page, $offset) {
Dries's avatar
   
Dries committed
513
514
515
  // forum list, topics list, topic browser and "add new topic" link
  global $theme;

516
  $output .= theme("forum_forum_list", $forums, $parents, $tid);
Dries's avatar
   
Dries committed
517
  if ($tid && !in_array($tid, variable_get("forum_containers", array()))) {
518
    $output .= theme("forum_topic_list", $tid, $topics, $sortby, $forum_per_page, $offset);
Dries's avatar
   
Dries committed
519
520
521
522
523
  }

  $theme->header();
  $theme->box(t("Discussion forum"), $output);
  if ($tid && !in_array($tid, variable_get("forum_containers", array()))) {
524
    $theme->box(t("Control panel"), theme("forum_topic_browser", $sortby, $forum_per_page, $offset));
Dries's avatar
   
Dries committed
525
526
527
528
529
530
531
532
533
  }
  $theme->footer();
}

function forum_forum_list($forums, $parents, $tid) {
  global $user;
  if ($parents) {
    foreach($parents as $p) {
      if ($tid != $p->tid) {
Dries's avatar
   
Dries committed
534
        $t[] = l($p->name, "forum/$p->tid");
Dries's avatar
   
Dries committed
535
536
537
538
539
540
      }
      else {
        $t[] = $p->name;
      }
    }
  }
Dries's avatar
   
Dries committed
541
  $t[] = l(t("Discussion forum"), "forum");
Dries's avatar
   
Dries committed
542

Dries's avatar
   
Dries committed
543
  $output .= "<table border=\"0\" cellpadding=\"5\" width=\"100%\">\n";
Dries's avatar
   
Dries committed
544
545
546
547
548
549
550
  $output .= " <tr><th colspan=\"3\" align=\"left\">".implode(" : ", array_reverse($t)) ."</th>";
  if ($forums) {
    $output .= "<th>". t("topics") ."</th><th>". t("posts") ."</th><th>". t("last post") ."</th></tr>";


    foreach ($forums as $forum) {
      if ($forum->container) {
Dries's avatar
   
Dries committed
551
        $output .= " <tr><td colspan=\"5\">". l($forum->name, "forum/$forum->tid") ."<br /><small>". ($forum->description ? check_output($forum->description) : "") ."</small></td></tr>";
552
553
      }
      else {
Dries's avatar
   
Dries committed
554
555
556
        if ($user->uid) $new_topics = $forum->num_topics - $forum->old_topics;
        $icon = _forum_get_folder_icon($new_topics);
        $output .= " <tr><td>&nbsp;</td><td>$icon</td>";
Dries's avatar
   
Dries committed
557
        $output .= "<td><table border=\"0\"><tr><td width=\"". ($forum->depth * 20) ."\">&nbsp;</td><td>". l($forum->name, "forum/$forum->tid") ."<div style=\"padding-top: 5px;\">". check_output($forum->description);
Dries's avatar
   
Dries committed
558
559
560

        $links = array();
        if ($forum->last_post) {
Dries's avatar
   
Dries committed
561
          $links[] = l(t("the most recent topic"), "node/view/". $forum->last_post->nid);
Dries's avatar
   
Dries committed
562
563
        }
        if ($new_topics) {
Dries's avatar
Dries committed
564
          $links[] = l(t("the first new topic"), "forum/$forum->tid/new");
Dries's avatar
   
Dries committed
565
566
567
        }

        if ($links) {
Dries's avatar
   
Dries committed
568
          $output .= "<br />". t("Jump to") .": ". implode(", ", $links);
Dries's avatar
   
Dries committed
569
570
        }

Dries's avatar
   
Dries committed
571
        $output .= "</div></td></tr></table></td>";
Dries's avatar
Dries committed
572
        $output .= "<td align=\"center\">".$forum->num_topics.($new_topics ? "<br />(".t("%a new", array("%a" => $new_topics)).")" : "")."</td><td align=\"center\">".$forum->num_posts."</td><td align=\"center\">"._forum_format($forum->last_post)."</td></tr>";
Dries's avatar
   
Dries committed
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
      }
    }
  }
  $output .= "</table>\n";

  return $output;
}

function forum_topic_browser() {
  global $tid, $sortby, $forum_per_page, $offset;

  if (empty($sortby)) {
    $sortby = variable_get("forum_order",1);
  }
  if (empty($forum_per_page)) {
    $forum_per_page = variable_get("forum_per_page", 25);
  }

  $forum_per_page_options = array(10, 25, 50, 75, 100);
  foreach ($forum_per_page_options as $value) {
    $options .= " <option value=\"$value\"". ($forum_per_page == $value ? " selected=\"selected\"" : "") .">".t("%a topics per page", array("%a" => $value))."</option>\n";
  }

  $output .= "<select name=\"forum_per_page\">$options</select>\n";

  $options = "";
  $sortby_options = array(1 => t("Date - newest first"), 2 => t("Date - oldest first"), 3 => t("Posts - most active first"), 4=> t("Posts - least active first"));
  foreach ($sortby_options as $key => $value) {
    $options .= " <option value=\"$key\"". ($sortby == $key ? " selected=\"selected\"" : "") .">$value</option>\n";
  }

  $output .= "\n<select name=\"sortby\">$options</select>\n";
  $output .= form_hidden("tid", $tid);
  $output .= form_submit(t("Update settings"));
  return form(form_item(t("Topic viewing options"), $output, t("Select your preferred way to display the topics and click 'Update settings'.")));
}

Dries's avatar
Dries committed
610
611
function forum_topic_list($tid, $topics, $sortby, $forum_per_page, $offset) {
  global $theme, $id, $status, $user, $pager_total;
Dries's avatar
   
Dries committed
612
613

  if ($topics) {
Dries's avatar
   
Dries committed
614
    $output .= "<table border=\"0\" cellpadding=\"5\" cellspacing=\"5\" width=\"100%\">\n";
Dries's avatar
   
Dries committed
615
616
617
618
    $output .= " <tr><th>&nbsp;</th><th>&nbsp;</th><th>". t("topic") ."</th><th>". t("replies") ."</th><th>". t("posted") ."</th><th>". t("last reply") ."</th></tr>";

    foreach ($topics as $topic) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
Dries committed
619
      if ($topic->tid != $tid) {
Dries's avatar
   
Dries committed
620
621
622
623
        $output .= "
          <tr>
            <td>"._forum_get_folder_icon($topic->new, $topic->num_comments, $topic->comment_mode)."</td>
            <td>"._forum_get_icon($topic)."</td>
Dries's avatar
   
Dries committed
624
            <td valign=\"top\">$topic->title</td>
Dries's avatar
Dries committed
625
            <td align=\"center\" valign=\"top\" colspan=\"3\">". l(t("This topic has been moved"), "forum/$topic->tid")."</td>
Dries's avatar
   
Dries committed
626
627
628
629
630
631
632
          </tr>";
      }
      else {
        $output .= "
          <tr>
            <td>"._forum_get_folder_icon($topic->new, $topic->num_comments, $topic->comment_mode)."</td>
            <td>"._forum_get_icon($topic)."</td>
Dries's avatar
   
Dries committed
633
            <td valign=\"top\">". l($topic->title, "node/view/$topic->nid") ."</td>
Dries's avatar
   
Dries committed
634
            <td align=\"center\" valign=\"top\" nowrap=\"nowrap\">".$topic->num_comments.($topic->new_replies ? " (".t("%a new", array("%a" => $topic->new_replies)).")" : "")."</td>
Dries's avatar
   
Dries committed
635
636
637
638
639
640
641
642
            <td align=\"center\">"._forum_format($topic)."</td>
            <td align=\"center\">"._forum_format($topic->last_reply)."</td>
          </tr>";
      }
    }

    $output .= "</table></blockquote>\n";
  }
Dries's avatar
   
Dries committed
643
  $output .= "<hr />";
Dries's avatar
   
Dries committed
644

Dries's avatar
Dries committed
645
  $output .= "<div align=\"center\">" .t("%a topics, %b topics per page, page %c of %d", array("%a" => $pager_total[0], "%b" => $forum_per_page, "%c" => $offset, "%d" => ceil($pager_total[0]/$forum_per_page))) ."</div>";
Dries's avatar
   
Dries committed
646

Dries's avatar
Dries committed
647
  $output .= (($pager = pager_display(NULL, $forum_per_page, 0, "default")) ? "$pager" : "");
Dries's avatar
   
Dries committed
648

Dries's avatar
Dries committed
649
650
  if (user_access("create forum topics")) {
    $output .= "<div align=\"center\" style=\"font-style: bold;\">". l(t("create new forum topic"), "node/add/forum/$tid") ."</div>";
Dries's avatar
   
Dries committed
651
652
653
654
655
656
657
  }

  return $output;
}


function _forum_get_icon($node) {
Dries's avatar
   
Dries committed
658
  if (variable_get("forum_topic_icon_path", "") && $node->icon) {
Dries's avatar
   
Dries committed
659
    return "<img src=\"". variable_get("forum_topic_icon_path", "") ."$node->icon\" />";
Dries's avatar
   
Dries committed
660
661
662
663
664
665
666
667
668
669
  }
  else {
    return "&nbsp;";
  }
}

function _forum_get_folder_icon($new_posts, $num_posts = 0, $comment_mode = 0) {
  // "folder" icon because it's generally rendered as a folder
  global $theme;

Dries's avatar
   
Dries committed
670
  $base_path = variable_get("forum_folder_icon_path", "");
Dries's avatar
   
Dries committed
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
  if ($base_path) {
    if ($num_posts > variable_get("forum_hot_topic", 15)) {
      $icon = $new_posts ? "hot_new" : "hot";
    }
    else {
      $icon = $new_posts ? "new" : "default";
    }

    if ($comment_mode == 1) {
      $icon = "closed";
    }

    if ($theme->bbs_icons) {
      $file = $theme->bbs_icons[$icon];
    }
    else {
      // default
      $file = $base_path."/".$icon.".gif";
    }

Dries's avatar
Dries committed
691
    return "<img src=\"$file\" alt=\"\" />";
Dries's avatar
   
Dries committed
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
  }
  else {
    return "&nbsp;";
  }
}

function _forum_user_last_visit($nid) {
  global $user;
  static $history;
  if (!$history) {
    $result = db_query("SELECT nid, timestamp FROM history WHERE uid = '%d'", $user->uid);
    while ($t = db_fetch_object($result)) {
      $history[$t->nid] = $t->timestamp;
    }
  }
  return $history[$nid] ? $history[$nid] : 0;
}

function _forum_get_topic_order($sortby) {
  switch ($sortby) {
    case 1:
      return "date_sort DESC";
      break;
    case 2:
      return "date_sort ASC";
      break;
    case 3:
      return "num_comments DESC";
      break;
    case 4:
      return "num_comments ASC";
      break;
  }
}

Dries's avatar
   
Dries committed
727
728
function forum_help() {
  ?>
Dries's avatar
   
Dries committed
729
730
731
732
  <h3>Creating a forum</h3>
  <p>Drupal lets you setup a countless number of forums by using the powerful taxonomy module. Therefore to create a forum you first have to create a taxonomy vocuabulary and add some terms to it, each term will be a forum. Creating a vocabulary is done by going the <b>taxonomy</b> page of the administration pages, then selecting the <b>add new vocabulary</b> link. Choose a name for the vocabulary (example: forum, message boards, or debates), and make sure under Types that forum is selected. Nothing else needs to be configured, so unless you have more advanced needs save the vocabulary. Now add a term to the vocabulary just added to create a forum. In the <b>add term</b> window enter the name of the forum (example: general, off topic, support), a description to make it clear to the users what the forum is about, and then save the term. You can now add a new forum by entering another term, repeat until all the forums are entered.</p>
  <p>Once a vocabulary is entered go to <b>site configuration</b> in the administration pages and set the <b>Forum vocabulary</b>, don't forget to save! There will now be forums active on the site. For users to access them the proper user permissions must be given in the <b>user management</b> pages.</p>
  <h3>Containers</h3>
Dries's avatar
Dries committed
733
734
  <p>By designating a forum as a Container, users are not allowed to post into that forum. The forum will be visible on the forum listing page, so it acts as a section delimiter if you will. This is useful if you have a lots of forums which are nested. For example,</p>
<p>  Marketing<br />
Dries's avatar
   
Dries committed
735
736
737
738
739
  -- Market research<br />
  -- Brand management<br />
  <br />
  Sales<br />
  -- Closing the deal<br />
Dries's avatar
Dries committed
740
741
  -- Avoiding ear and throat pain</p>
  <p>If you don't want people posting into the Marketing or Sales folders, you designate them as Containers.</p>
Dries's avatar
   
Dries committed
742
743
744
745
746
747
748
  <h4>Icons</h4>
  <p>To disable icons, set the icon paths as blank in Admin -> Site Configuration -> Forum</p>
  <p>All files in the icon directory are assumed to be images. Usually it is best to use GIF or JPG files as icons. You may use images of whatever size you wish, but it is customary to use 15x15 or 16x16.</p>
    <?php
}

?>