forum.module 30 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

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

Dries's avatar
 
Dries committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
  if (module_exist("taxonomy")) {
    foreach (taxonomy_get_vocabularies("forum") as $vid => $voc) {
      $vocs[$vid] = $voc->name;
    }

    if ($vocs) {
      $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.");
      $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 ". la("here", array("mod" => "block")) .".");
    }
    else {
      $output .= _forum_message_taxonomy();
    }
  }
  else {
    $output .= _forum_message_taxonomy();
  }
Dries's avatar
 
Dries committed
57

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

function forum_save($op, $node) {
Dries's avatar
 
Dries committed
62 63 64 65 66
  if ($op == "approve") {
    return array("status" => 1);
  }

  if ($op == "create") {
Dries's avatar
 
Dries committed
67
    $moderation = array("body" => filter($node->body), "moderate" => 0, "status" => 1);
Dries's avatar
 
Dries committed
68
    return array_merge($moderation, array("tid", "icon_num", "shadow"));
Dries's avatar
 
Dries committed
69 70
  }

Dries's avatar
 
Dries committed
71 72
  if ($op == "decline") {
    return array("status" => 0);
Dries's avatar
 
Dries committed
73 74 75
  }

  if ($op == "update") {
Dries's avatar
 
Dries committed
76 77 78 79 80 81 82 83 84
    // if she changed the term, we could have to leave a shadow
    $old_terms = explode(",", $node->old_container);
    foreach ($node->taxonomy as $term) {
      if ($term && (!in_array($term, $old_terms)) && $node->shadow) {
        $shadow = $term;
        break;
      }
    }
    return array("body" => filter($node->body), "tid", "icon_num", "shadow" => $shadow, "old_container");
Dries's avatar
 
Dries committed
85 86 87
  }
}

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

  return $forum;
}

94 95 96 97 98 99
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
100
      $cache = cache_get("forum:block");
Dries's avatar
 
Dries committed
101

Dries's avatar
 
Dries committed
102
      if (empty($cache)) {
Dries's avatar
 
Dries committed
103
        unset($items);
Dries's avatar
 
Dries committed
104
        $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 f.shadow = 0 AND n.status = 1 GROUP BY n.nid ORDER BY sort DESC LIMIT ". variable_get("forum_block_num", "5")), t("Active forum topics:"));
105
        $content .= "<br />";
Dries's avatar
 
Dries committed
106 107

        unset ($items);
Dries's avatar
 
Dries committed
108
        $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
109

110
        if ($content) {
Dries's avatar
 
Dries committed
111
          $content .= "<div id=\"forum_more\" align=\"right\">". lm(t("more"), array("mod" => "forum")) ."</div>";
112
        }
Dries's avatar
 
Dries committed
113

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

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

Dries's avatar
 
Dries committed
125 126 127
  return $blocks;
}

128
function forum_link($type, $node = 0, $main = 0) {
Dries's avatar
 
Dries committed
129

Dries's avatar
 
Dries committed
130
  if ($type == "page" && user_access("access content")) {
Dries's avatar
 
Dries committed
131
    $links[] = lm(t("forum"), array("mod" => "forum"));
Dries's avatar
 
Dries committed
132 133
  }

134
  if (!$main && $type == "node" && $node->type == "forum") {
Dries's avatar
 
Dries committed
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
    // get previous and next topic

    $sql = "SELECT n.nid, title, body, GREATEST(n.created, MAX(c.timestamp)) AS date_sort, COUNT(c.nid) AS num_comments FROM node n, term_node t, forum f LEFT JOIN comments c ON c.nid = n.nid WHERE n.nid = t.nid AND n.nid = f.nid AND t.tid = '%d' AND f.shadow = 0 AND n.status = 1 GROUP BY n.nid ORDER BY ". _forum_get_topic_order(isset($user->sortby) ? $user->sortby : variable_get("forum_order",1));

    $terms = array_keys(taxonomy_node_get_terms_by_vocabulary($node->nid, variable_get("forum_nav_vocabulary", "")));
    $result = db_query($sql, $terms[0]);

    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"), array("id" => $prev->nid), "node", "", 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"), array("id" => $next->nid), "node", "", 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
  /* TODO: find out what this code was ment to do and either use it or not.
Dries's avatar
 
Dries committed
182

Dries's avatar
 
Dries committed
183 184 185
  $output .= "<p>"._forum_get_icon($node)." ".lm(check_output($voc->name), array("mod" => "forum"))." : ".lm(check_output($term_data->name), array("mod" => "forum", "tid" => $term_data->tid));

  $output .= " / <b>". check_output($node->title) ."</b><br>".t("%a by %b", array("%a" => format_date($node->created), "%b" => format_name($node)))."</p><p>". check_output($node->body, 1) ."</p>";
Dries's avatar
 
Dries committed
186 187
  $output .= "<p>". $theme->links(link_node($node, $main)) ."</p>";

Dries's avatar
 
Dries committed
188
  #$theme->box(t("Discussion forum"), $output);
189
  */
Dries's avatar
 
Dries committed
190

191 192 193
  if (!$main) {
    $node->title = _forum_get_icon($node)." ".lm(check_output($voc->name), array("mod" => "forum"))." : ".lm(check_output($term_data->name), array("mod" => "forum", "tid" => $term_data->tid)) . " / <b>". check_output($node->title) ."</b>";
  }
Dries's avatar
 
Dries committed
194 195

  $theme->node($node, $main);
Dries's avatar
 
Dries committed
196 197 198
}

function forum_form(&$node, &$help, &$error) {
Dries's avatar
 
Dries committed
199 200 201 202
  global $tid;
  if ($node->nid) {
    if ($node->taxonomy) {
      $tid = $node->taxonomy;
203 204
    }
    else {
Dries's avatar
 
Dries committed
205 206 207 208 209
      // editing: load category from taxonomy
      $tid = implode(",", array_keys(taxonomy_node_get_terms($node->nid)));
    }
    //$output .= implode("<p>", taxonomy_node_form("forum", $node));
    $output .= "<input type=\"hidden\" name=\"edit[old_container]\" value=\"".implode(",", array_keys(taxonomy_node_get_terms($node->nid)))."\">";
Dries's avatar
 
Dries committed
210
    $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."));
211 212
  }
  else {
Dries's avatar
 
Dries committed
213 214 215
    if ($node->taxonomy) {
      $tid = $node->taxonomy;
    }
216 217
  }

Dries's avatar
 
Dries committed
218 219
  $output .= _taxonomy_term_select("Forum", "taxonomy", $tid, variable_get("forum_nav_vocabulary", ""), "", 0, "", variable_get("forum_containers", array()));

Dries's avatar
 
Dries committed
220
  if ($icon_path = variable_get("forum_topic_icon_path", "")) {
Dries's avatar
 
Dries committed
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
    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 = "";}
          $radio .= "<input type=\"radio\" name=\"edit[icon_num]\" value=\"$icon_num\" $checked><img src=\"$icon_path$icon\"> \n";
          $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 = "";}
          $radio .= "<input type=\"radio\" name=\"edit[icon_num]\" value=\"$icon_num\" $checked><img src=\"$icon_path$icon\"> \n";
          $icon_num++;
        }
        closedir($dir);
      }
    }
    $output .= form_item(t("Topic icon"), $radio);
  }
  $output .= form_textarea("Body", "body", $node->body, 60, 10);
Dries's avatar
 
Dries committed
249 250 251 252

  return $output;
}

Dries's avatar
 
Dries committed
253 254 255 256
function forum_insert($node) {
  $node->icon = _forum_decode_icon($node);
  if (!$node->shadow) {
    db_query("INSERT INTO forum (nid, icon) VALUES ('%d', '%s')", $node->nid, $node->icon);
257 258
  }
  else {
Dries's avatar
 
Dries committed
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
    // we created a shadow, a link to a moved topic in a new forum
    db_query("INSERT INTO forum (nid, icon, shadow) VALUES ('%d', '%s', '%d')", $node->nid, $node->icon, $node->shadow);
  }
}

function forum_update($node) {
  $node->icon = _forum_decode_icon($node);
  db_query("UPDATE forum SET icon = '%s' WHERE nid = '%d'", $node->icon, $node->nid);
  if ($node->shadow) {
    // insert in old forum a new topic, with link to new forum
    $node->nid = "";
    $node->type = "forum";
    $node->status = 1;
    $node->taxonomy = array($node->old_container);
    node_submit($node);
  }
}

function _forum_decode_icon($node) {
  // to prevent malicious users
Dries's avatar
 
Dries committed
279
  if ($icon_path = variable_get("forum_topic_icon_path", "")) {
Dries's avatar
 
Dries committed
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
    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
296

Dries's avatar
 
Dries committed
297 298
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
299 300 301
  return ($value) ? $value->count : 0;
}

Dries's avatar
 
Dries committed
302 303
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
304 305 306
  return ($value) ? format_date($value->timestamp, "small") : "&nbsp;";
}

Dries's avatar
 
Dries committed
307 308 309 310 311 312 313
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
314
    return "<small>". format_date($topic->timestamp, "small")."<br>".t("by")." ". format_name($topic) ."</small>";
Dries's avatar
 
Dries committed
315 316 317 318 319 320 321 322 323 324 325 326 327
  }
  else {
    return message_na();
  }
}

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

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

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

Dries's avatar
 
Dries committed
330
  if (empty($cache)) {
331
    $forums = array();
Dries's avatar
 
Dries committed
332
    $_forums = taxonomy_get_tree(variable_get("forum_nav_vocabulary", ""), $tid);
Dries's avatar
 
Dries committed
333 334 335 336 337 338 339 340 341 342 343 344 345 346
    $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
347
    cache_set("forum:$tid", serialize($forums), time() + variable_get("cache_clear", 120));
Dries's avatar
 
Dries committed
348
  }
Dries's avatar
 
Dries committed
349 350 351
  else {
    $forums = unserialize($cache->data);
  }
Dries's avatar
 
Dries committed
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372

  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
373

Dries's avatar
 
Dries committed
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
  return $parents;
}

function _forum_num_topics($term) {
  $value = db_fetch_object(db_query("SELECT COUNT(n.nid) AS count FROM node n, term_node r, forum f WHERE r.tid = '%d' AND n.nid = r.nid AND n.nid = f.nid AND n.status = 1 AND n.type = 'forum' AND f.shadow = 0", $term));
  return ($value) ? $value->count : 0;
}

function _forum_num_replies($term) {
  $value = db_fetch_object(db_query("SELECT COUNT(*) AS count FROM comments c, term_node r, node n WHERE r.tid = '%d' AND n.nid = r.nid AND n.nid = c.nid AND n.status = 1 AND c.status = 0 AND n.type = 'forum'", $term));
  return ($value) ? $value->count : 0;
}

function _forum_topics_read($uid) {
  $result = db_query("SELECT tid, count(*) AS c FROM history h, term_node r, node n WHERE r.nid = h.nid AND n.nid = h.nid AND n.type = 'forum' AND n.status = 1 AND h.uid = '%d' GROUP BY tid", $uid);

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

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

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

Dries's avatar
 
Dries committed
400
  $reply = db_fetch_object(db_query("SELECT n.nid, c.timestamp, u.name AS name, u.uid AS uid FROM term_node r, node n LEFT JOIN comments c ON n.nid = c.nid LEFT JOIN users u ON c.uid = u.uid WHERE r.tid = '%d' AND n.nid = r.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
401 402 403 404 405 406 407 408 409 410 411 412 413 414

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

  return $value;
}

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

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

  $sql_sortby = _forum_get_topic_order($sortby);

415
  $sql = "SELECT n.nid, title, users.name AS name, users.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, shadow FROM node n, term_node r LEFT JOIN users ON n.uid = users.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 = '%d' AND n.status = 1 AND n.type = 'forum' GROUP BY n.nid ORDER BY $sql_sortby";
Dries's avatar
 
Dries committed
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437

  $result = db_query($sql, $tid);
  $topic_num = db_num_rows($result);

  $n = 0;
  while ($topic = db_fetch_object($result)) {
    if ($n < $offset) {
      $n++;
      continue;
    }

    $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;
    }
    else {
      if (!$history && $user->uid) {
        $topic->new_replies = 0;
        $topic->new = 1;
      }
      else {
438
        $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"));
Dries's avatar
 
Dries committed
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475

        $topic->new_replies = $comments ? $comments : 0;
        if ($topic->new_replies) {
          $topic->new = 1;
        }
        else {
          $topic->new = 0;
        }
      }
    }

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

    $n++;
    if ($n == ($forum_per_page + $offset)) {
      break;
    }
  }

  return array($topics, $topic_num);
}

function _forum_first_new($tid) {
  global $user;
  $result = db_query("SELECT r.nid FROM node n, history h, term_node r WHERE n.type = 'forum' AND n.status = 1 AND h.nid = n.nid AND r.nid = h.nid AND r.tid = '%d' AND h.uid = '%d'   ", $tid, $user->uid);
  while ($r = db_fetch_object($result)) {
    $read[] = $r->nid;
  }

  if ($read) {
    $nid = db_result(db_query("SELECT r.nid AS c FROM node n LEFT JOIN term_node r ON r.nid = n.nid WHERE n.type = 'forum' AND n.status = 1 AND r.tid = '%d' AND NOT (r.nid IN (".implode(",", $read).")) ORDER BY created LIMIT 1", $tid));
  }

  return $nid ? $nid : 0;
}

Dries's avatar
 
Dries committed
476 477 478 479
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
480
function forum_page() {
Dries's avatar
 
Dries committed
481
  global $theme, $tid, $sortby, $forum_per_page, $offset, $op, $user;
Dries's avatar
 
Dries committed
482 483

  if (user_access("access content")) {
Dries's avatar
 
Dries committed
484 485 486 487
    if (module_exist("taxonomy")) {
      if ($op == "Update settings") {
        $user = user_save($user, array("sortby" => $sortby, "forum_per_page" => $forum_per_page));
      }
Dries's avatar
 
Dries committed
488

Dries's avatar
 
Dries committed
489 490 491 492
      if ($op == "first_new") {
        if ($nid = _forum_first_new($tid)) {
          drupal_goto(drupal_url(array("id" => $nid), "node"));
        }
Dries's avatar
 
Dries committed
493
      }
Dries's avatar
 
Dries committed
494

Dries's avatar
 
Dries committed
495 496 497
      if (empty($sortby)) {
        $sortby = isset($user->sortby) ? $user->sortby : variable_get("forum_order",1);
      }
Dries's avatar
 
Dries committed
498

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

Dries's avatar
 
Dries committed
503 504 505
      if (empty($offset)) {
        $offset = 0;
      }
Dries's avatar
 
Dries committed
506

Dries's avatar
 
Dries committed
507 508 509 510 511
      $forums = forum_get_forums($tid);
      $parents = forum_get_parents($tid);
      if ($tid && !in_array($tid, variable_get("forum_containers", array()))) {
        list($topics, $topic_num) = forum_get_topics($tid, $sortby, $forum_per_page, $offset);
      }
Dries's avatar
 
Dries committed
512

Dries's avatar
 
Dries committed
513 514 515 516 517 518 519
      theme_invoke("forum_render", $forums, $topics, $topic_num, $parents, $tid, $sortby, $forum_per_page, $offset);
    }
    else {
      $theme->header();
      $theme->box(t("Warning"), _forum_message_taxonomy());
      $theme->footer();
    }
Dries's avatar
 
Dries committed
520 521 522 523 524 525 526 527
  }
  else {
    $theme->header();
    $theme->box(t("Access denied"), message_access());
    $theme->footer();
  }
}

Dries's avatar
 
Dries committed
528 529 530 531 532 533 534 535
/**
*** render functions
**/

function forum_render($forums, $topics, $topic_num, $parents, $tid, $sortby, $forum_per_page, $offset) {
  // forum list, topics list, topic browser and "add new topic" link
  global $theme;

Dries's avatar
 
Dries committed
536
  $output .= theme_invoke("forum_forum_list", $forums, $parents, $tid);
Dries's avatar
 
Dries committed
537
  if ($tid && !in_array($tid, variable_get("forum_containers", array()))) {
Dries's avatar
 
Dries committed
538
    $output .= theme_invoke("forum_topic_list", $topics, $topic_num, $sortby, $forum_per_page, $offset);
Dries's avatar
 
Dries committed
539 540 541 542 543
  }

  $theme->header();
  $theme->box(t("Discussion forum"), $output);
  if ($tid && !in_array($tid, variable_get("forum_containers", array()))) {
Dries's avatar
 
Dries committed
544
    $theme->box(t("Control panel"), theme_invoke("forum_topic_browser", $sortby, $forum_per_page, $offset));
Dries's avatar
 
Dries committed
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
  }
  $theme->footer();
}

function forum_forum_list($forums, $parents, $tid) {
  global $user;
  if ($parents) {
    foreach($parents as $p) {
      if ($tid != $p->tid) {
        $t[] = lm($p->name, array("mod" => "forum", "tid" => $p->tid));
      }
      else {
        $t[] = $p->name;
      }
    }
  }
Dries's avatar
 
Dries committed
561
  $t[] = lm(t("Discussion forum"), array("mod" => "forum"));
Dries's avatar
 
Dries committed
562

Dries's avatar
 
Dries committed
563
  $output .= "<table border=\"0\" cellpadding=\"5\" width=\"100%\">\n";
Dries's avatar
 
Dries committed
564 565 566 567 568 569 570
  $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
571
        $output .= " <tr><td colspan=\"5\">". lm(check_output($forum->name), array("mod" => "forum", "tid" => $forum->tid))."<br /><small>". ($forum->description ? check_output($forum->description, 1) : "") ."</small></td></tr>";
572 573
      }
      else {
Dries's avatar
 
Dries committed
574 575 576
        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
577
        $output .= "<td><table border=\"0\"><tr><td width=\"". ($forum->depth * 20) ."\">&nbsp;</td><td>".lm(check_output($forum->name), array("mod" => "forum", "tid" => $forum->tid))."<div style=\"padding-top: 5px;\">". check_output($forum->description, 1);
Dries's avatar
 
Dries committed
578 579 580

        $links = array();
        if ($forum->last_post) {
Dries's avatar
 
Dries committed
581
          $links[] = l(t("the most recent topic"), array("id" => $forum->last_post->nid));
Dries's avatar
 
Dries committed
582 583
        }
        if ($new_topics) {
Dries's avatar
 
Dries committed
584
          $links[] = lm(t("the first new topic"), array("mod" => "forum", "op" => "first_new", "tid" => $forum->tid));
Dries's avatar
 
Dries committed
585 586 587
        }

        if ($links) {
Dries's avatar
 
Dries committed
588
          $output .= "<br />Jump to: ". implode(", ", $links);
Dries's avatar
 
Dries committed
589 590
        }

Dries's avatar
 
Dries committed
591
        $output .= "</div></td></tr></table></td>";
Dries's avatar
 
Dries committed
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
        $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>";
      }
    }
  }
  $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'.")));
}

function forum_topic_list($topics, $num_topics, $sortby, $forum_per_page, $offset) {
  global $theme, $id, $status, $tid, $user;

Dries's avatar
 
Dries committed
633
  $output .= "<div style=\"margin-left: 20px; margin-top: 5px; margin-bottom: 10px;\">" .t("%a topics, %b topics per page, page %c of %d", array("%a" => $num_topics, "%b" => $forum_per_page, "%c" => ceil(($offset + 1)/$forum_per_page), "%d" => ceil($num_topics/$forum_per_page))) ."</div>";
Dries's avatar
 
Dries committed
634 635

  if ($topics) {
Dries's avatar
 
Dries committed
636
    $output .= "<table border=\"0\" cellpadding=\"5\" cellspacing=\"5\" width=\"100%\">\n";
Dries's avatar
 
Dries committed
637 638 639 640 641 642 643 644 645
    $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
      if ($topic->shadow) {
        $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
646 647
            <td valign=\"top\">". check_output($topic->title) ."</td>
            <td align=\"center\" valign=\"top\" colspan=\"3\">".lm(t("This topic has been moved"), array("mod" => "forum", "tid" => $topic->shadow))."</td>
Dries's avatar
 
Dries committed
648 649 650 651 652 653 654
          </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
655 656
            <td valign=\"top\">".l(check_output($topic->title), array("id" => $topic->nid))."</td>
            <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
657 658 659 660 661 662 663 664
            <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
665
  $output .= "<hr />";
Dries's avatar
 
Dries committed
666 667 668
  $output .= "<table width=\"100%\" border=\"0\" cellspacing=\"0\" cellpadding=\"0\"><tr>";

  if ($offset > 0) {
Dries's avatar
 
Dries committed
669
    $output .= "<td width=\"33%\"><div align=\"left\" style=\"font-style: bold;\">". lm(t("previous topics"), array("mod" => "forum", "tid" => $tid, "offset" => ($offset-$forum_per_page))) ."</div></td>";
Dries's avatar
 
Dries committed
670 671 672 673 674
  }
  else {
    $output .= "<td width=\"33%\">&nbsp;</td>";
  }

Dries's avatar
 
Dries committed
675 676
  if (user_access("create forum topics")) {
    $output .= "<td width=\"33%\"><div align=\"center\" style=\"font-style: bold;\">". lm(t("create new forum topic"), array("mod" => "node", "op" => "add", "type" => "forum", "tid" => $tid)) ."</div></td>";
Dries's avatar
 
Dries committed
677
  }
Dries's avatar
 
Dries committed
678 679

  if (count($topics) >= $forum_per_page) {
Dries's avatar
 
Dries committed
680
    $output .= "<td width=\"33%\"><div align=\"right\" style=\"font-style: bold;\">". lm(t("next topics"), array("mod" => "forum", "tid" => $tid, "offset" => ($offset+$forum_per_page))) ."</div></td>";
Dries's avatar
 
Dries committed
681 682 683 684 685 686 687 688 689 690 691 692
  }
  else {
    $output .= "<td width=\"33%\">&nbsp;</td>";
  }

  $output .= "</tr></table>";

  return $output;
}


function _forum_get_icon($node) {
Dries's avatar
 
Dries committed
693 694
  if (variable_get("forum_topic_icon_path", "") && $node->icon) {
    return "<img src=\"".variable_get("forum_topic_icon_path", ""). check_output($node->icon)."\">";
Dries's avatar
 
Dries committed
695 696 697 698 699 700 701 702 703 704
  }
  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
705
  $base_path = variable_get("forum_folder_icon_path", "");
Dries's avatar
 
Dries committed
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
  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";
    }

    return "<img src=\"$file\">";
  }
  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
762 763
function forum_help() {
  ?>
Dries's avatar
 
Dries committed
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
  <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>
  <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>
  Marketing<br />
  -- Market research<br />
  -- Brand management<br />
  <br />
  Sales<br />
  -- Closing the deal<br />
  -- Avoiding ear and throat pain<br />
  <p>If you don't want people posting into the Marketing or Sales folders, you designate them as Containers.<br /></p>
  <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
}

?>