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

Dries's avatar
 
Dries committed
4 5 6 7 8
/**
 * @file
 * Enable threaded discussions about general topics.
 */

9 10 11 12
/**
 * Implementation of hook_help().
 */
function forum_help($section) {
Dries's avatar
 
Dries committed
13
  switch ($section) {
14
    case 'admin/forum':
15
      return t('<p>This is a list of existing containers and forums that you can edit. Containers hold forums and, in turn, forums hold threaded discussions. Both containers and forums can be placed inside other containers and forums. By planning the structure of your containers and forums well, you make it easier for users to find a topic area of interest to them.</p>');
16
    case 'admin/forum/add/container':
17
      return t('<p>Containers help you organize your forums. The job of a container is to hold, or contain, other forums that are related. For example, a container named "Food" might hold two forums named "Fruit" and "Vegetables".</p>');
18
    case 'admin/forum/add/forum':
19
      return t('<p>A forum holds discussion topics that are related. For example, a forum named "Fruit" might contain topics titled "Apples" and "Bananas".</p>');
Dries's avatar
 
Dries committed
20
    case 'admin/modules#description':
21
      return t('Enables threaded discussions about general topics.');
22 23
    case 'admin/forum/configure':
      return t('This is where you can configure system-wide options for how your forums act and display.');
Dries's avatar
 
Dries committed
24
    case 'node/add#forum':
25
      return t('Create a new topic for discussion in the forums.');
Dries's avatar
 
Dries committed
26 27 28
  }
}

29
/**
30
 * Implementation of hook_node_info().
31
 */
32
function forum_node_info() {
33
  return array('forum' => array('name' => t('forum topic'), 'base' => 'forum'));
Dries's avatar
 
Dries committed
34 35
}

36 37 38
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
39
function forum_access($op, $node) {
Dries's avatar
 
Dries committed
40 41
  global $user;

Dries's avatar
 
Dries committed
42 43
  if ($op == 'create') {
    return user_access('create forum topics');
Dries's avatar
 
Dries committed
44
  }
Dries's avatar
 
Dries committed
45 46 47 48 49 50

  if ($op == 'update' || $op == 'delete') {
    if (user_access('edit own forum topics') && ($user->uid == $node->uid)) {
      return TRUE;
    }
  }
Dries's avatar
 
Dries committed
51 52
}

53 54 55
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
56
function forum_perm() {
57
  return array('create forum topics', 'edit own forum topics', 'administer forums');
Dries's avatar
 
Dries committed
58
}
Dries's avatar
 
Dries committed
59

60
/**
61
 * Administration page which allows maintaining forums
62
 */
63 64 65 66 67 68 69
function forum_admin() {
  $op = $_POST['op'];
  $edit = $_POST['edit'];

  if (empty($op)) {
    $op = arg(2);
  }
Dries's avatar
 
Dries committed
70

71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
  switch ($op) {
    case 'add':
      if (arg(3) == 'forum') {
        $output = forum_form_forum();
      }
      else if (arg(3) == 'container') {
        $output = forum_form_container();
      }
      break;
    case 'edit':
      if (arg(3) == 'forum') {
        $output = forum_form_forum(object2array(taxonomy_get_term(arg(4))));
      }
      else if (arg(3) == 'container') {
         $output = forum_form_container(object2array(taxonomy_get_term(arg(4))));
      }
      break;
    case t('Delete'):
      if (!$edit['confirm']) {
90
        $output = _forum_confirm_delete($edit['tid']);
91 92 93
        break;
      }
      else {
94
        $name = $edit['name'];
95 96 97
        $edit['name'] = 0;
      }
    case t('Submit'):
98
      $status = taxonomy_save_term($edit);
99
      if (arg(3) == 'container') {
100 101 102 103 104 105 106 107 108 109 110 111 112
        switch ($status) {
          case SAVED_NEW:
            $containers = variable_get('forum_containers', array());
            $containers[] = $edit['tid'];
            variable_set('forum_containers', $containers);
            drupal_set_message(t('Created new forum container %term.', array('%term' => theme('placeholder', $edit['name']))));
            break;
          case SAVED_UPDATED:
            drupal_set_message(t('The forum container %term has been updated.', array('%term' => theme('placeholder', $edit['name']))));
            break;
          case SAVED_UPDATED:
            drupal_set_message(t('The forum container %term has been deleted.', array('%term' => theme('placeholder', $name))));
            break;
113 114 115
        }
      }
      else {
116 117 118 119 120 121 122 123 124 125
        switch ($status) {
          case SAVED_NEW:
            drupal_set_message(t('Created new forum %term.', array('%term' => theme('placeholder', $edit['name']))));
            break;
          case SAVED_UPDATED:
            drupal_set_message(t('The forum %term has been updated.', array('%term' => theme('placeholder', $edit['name']))));
            break;
          case SAVED_DELETED:
            drupal_set_message(t('The forum %term has been deleted.', array('%term' => theme('placeholder', $name))));
            break;
126 127
        }
      }
128 129 130 131 132
      drupal_goto('admin/forum');
    default:
      $output = forum_overview();
  }

Dries's avatar
 
Dries committed
133
  return $output;
134 135 136 137 138 139 140
}

/**
 * Implementation of hook_taxonomy().
 */
function forum_taxonomy($op, $type, $object) {
  if ($op == 'delete' && $type == 'term' && $object->vid == _forum_get_vid())  {
Dries's avatar
Dries committed
141
    $results = db_query('SELECT f.nid FROM {forum} f WHERE f.tid = %d', $object->tid);
142 143 144 145
    while ($node = db_fetch_object($results)) {
      $edit['nid'] = $node->nid;
      $edit['confirm'] = TRUE;
      node_delete($edit);
Dries's avatar
 
Dries committed
146
    }
147
  }
148 149 150
  elseif ($op == 'delete' && $type == 'vocabulary' && $object->vid == _forum_get_vid())  {
    variable_del('forum_nav_vocabulary');
  }
151
}
Dries's avatar
 
Dries committed
152

153 154 155 156 157
/**
 * Returns a confirmation page for deleting a forum taxonomy term
 *
 * @param $tid ID of the term to be deleted
 */
158
function _forum_confirm_delete($tid) {
159 160 161 162
  $term = taxonomy_get_term($tid);

  $extra = form_hidden('tid', $tid);
  $output = theme('confirm',
Steven Wittens's avatar
Steven Wittens committed
163
                  t('Are you sure you want to delete the forum %name?', array('%name' => theme('placeholder', $term->name))),
164 165 166 167 168
                  'admin/forums',
                  t('Deleting a forum or container will delete all sub-forums as well. This action cannot be undone.'),
                  t('Delete'),
                  t('Cancel'),
                  $extra);
169
  return $output;
170 171 172 173 174 175 176 177
}

/**
 * Returns a form for adding a container to the forum vocabulary
 *
 * @param $edit Associative array containing a container term to be added or edited.
 */
function forum_form_container($edit = array()) {
178
  $form = form_textfield(t('Container name'), 'name', $edit['name'], 60, 64, t('The container name is used to identify related forums.'), NULL, TRUE);
179
  $form .= form_textarea(t('Description'), 'description', $edit['description'], 60, 5, t('The container description can give users more information about the forums it contains.'));
180

181 182
  $form .= _forum_parent_select($edit['tid'], t('Parent'), 'parent][', 'container');
  $form .= form_weight(t('Weight'), 'weight', $edit['weight'], 10, t('When listing containers, those with with light (small) weights get listed before containers with heavier (larger) weights. Containers with equal weights are sorted alphabetically.'));
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199

  $form .= form_hidden('vid', _forum_get_vid());
  $form .= form_submit(t('Submit'));
  if ($edit['tid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('tid', $edit['tid']);
  }

  return form($form);
}

/**
 * Returns a form for adding a forum to the forum vocabulary
 *
 * @param $edit Associative array containing a forum term to be added or edited.
 */
function forum_form_forum($edit = array()) {
200
  $form = form_textfield(t('Forum name'), 'name', $edit['name'], 60, 64, t('The forum name is used to identify related topic discussions.'), NULL, TRUE);
201
  $form .= form_textarea(t('Description'), 'description', $edit['description'], 60, 5, t('The forum description can give users more information about the discussion topics it contains.'));
202

203 204
  $form .= _forum_parent_select($edit['tid'], t('Parent'), 'parent][', 'forum');
  $form .= form_weight(t('Weight'), 'weight', $edit['weight'], 10, t('When listing forums, those with light (small) weights get listed before forums with heavier (larger) weights. Forums with equal weights are sorted alphabetically.'));
205 206 207 208 209 210 211

  $form .= form_hidden('vid', _forum_get_vid());
  $form .= form_submit(t('Submit'));
  if ($edit['tid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('tid', $edit['tid']);
  }
212

213 214 215 216 217 218 219 220 221 222
  return form($form);
}

/**
 * Returns a select box for available parent terms
 *
 * @param $tid ID of the term which is being added or edited
 * @param $title Title to display the select box with
 * @param $name Name to use in the forum
 */
223
function _forum_parent_select($tid, $title, $name, $child_type) {
224 225

  $parents = taxonomy_get_parents($tid);
226 227 228 229 230 231 232 233
  if ($parents) {
    $parent = array_shift($parents);
    $parent = $parent->tid;
  }
  else {
    $parent = 0;
  }

234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
  $children = taxonomy_get_tree(_forum_get_vid, $tid);

  // A term can't be the child of itself, nor of its children.
  foreach ($children as $child) {
    $exclude[] = $child->tid;
  }
  $exclude[] = $tid;

  $tree = taxonomy_get_tree(_forum_get_vid());
  $options[0] = '<'. t('root') .'>';
  if ($tree) {
    foreach ($tree as $term) {
      if (!in_array($term->tid, $exclude)) {
        $options[$term->tid] = _forum_depth($term->depth).$term->name;
      }
Dries's avatar
 
Dries committed
249 250
    }
  }
251 252 253 254 255 256
  if ($child_type == 'container') {
    $description = t('Containers are usually placed at the top (root) level of your forum but you can also place a container inside a parent container or forum.');
  }
  else if ($child_type == 'forum') {
    $description = t('You may place your forum inside a parent container or forum, or at the top (root) level of your forum.');
  }
Dries's avatar
 
Dries committed
257

258
  return form_select($title, $name, $parent, $options, $description, 0, FALSE, TRUE);
Dries's avatar
 
Dries committed
259 260
}

261
/**
262
 * Returns an overview list of existing forums and containers
263
 */
264 265 266 267 268 269 270
function forum_overview() {
  $header = array(t('Name'), t('Operations'));

  $tree = taxonomy_get_tree(_forum_get_vid());
  if ($tree) {
    foreach ($tree as $term) {
      if (in_array($term->tid, variable_get('forum_containers', array()))) {
271
        $rows[] = array(_forum_depth($term->depth) .' '. check_plain($term->name), l(t('edit container'), "admin/forum/edit/container/$term->tid"));
272 273
      }
      else {
274
        $rows[] = array(_forum_depth($term->depth) .' '. check_plain($term->name), l(t('edit forum'), "admin/forum/edit/forum/$term->tid"));
275 276
       }

Dries's avatar
Dries committed
277 278
    }
  }
279
  else {
280
    $rows[] = array(array('data' => '<em>' . t('There are no existing containers or forums. You may add some on the <a href="%container">add container</a> or <a href="%forum">add forum</a> pages.', array('%container' => url('admin/forum/add/container'), '%forum' => url('admin/forum/add/forum'))) . '</em>', 'colspan' => 2));
281 282
  }
  return theme('table', $header, $rows);
Dries's avatar
Dries committed
283 284
}

285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
/**
 * Helper function used to generate indentation for forum list
 *
 * @param $depth Depth of the indentation
 * @param $graphic HTML text to be repeated for each stage of depth
 */
function _forum_depth($depth, $graphic = '--') {
  for ($n = 0; $n < $depth; $n++) {
    $result .= $graphic;
  }
  return $result;
}

/**
 * Returns the vocabulary id for forum navigation.
 */
function _forum_get_vid() {
  $vid = variable_get('forum_nav_vocabulary', '');
  if (empty($vid)) {
    // Check to see if a forum vocabulary exists
    $vid = db_result(db_query("SELECT vid FROM {vocabulary} WHERE module='%s'", 'forum'));
    if (!$vid) {
307 308 309
      $edit = array('name' => 'Forums', 'multiple' => 0, 'required' => 1, 'hierarchy' => 1, 'relations' => 0, 'module' => 'forum', 'nodes' => array('forum'));
      taxonomy_save_vocabulary($edit);
      $vid = $edit['vid'];
310 311 312 313 314 315 316 317 318 319
    }
    variable_set('forum_nav_vocabulary', $vid);
  }

  return $vid;
}

/**
 * Implementation of hook_settings
 */
320 321 322
function forum_admin_configure() {
  system_settings_save();

323 324 325 326 327 328 329 330
  $output .= form_textfield(t('Forum icon path'), 'forum_icon_path', variable_get('forum_icon_path', ''), 30, 255, t('The path to the forum icons.  Leave blank to disable icons. Don\'t add a trailing slash.  Default icons are available in the "misc" directory. You may use images of whatever size you wish, but it is recommended to use 15x15 or 16x16. '));
  $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 10000));
  $output .= form_select(t('Hot topic threshold'), 'forum_hot_topic', variable_get('forum_hot_topic', 15), $number, t('The number of posts a topic must have to be considered hot.'));
  $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
  $output .= form_select(t('Topics per page'), 'forum_per_page', variable_get('forum_per_page', 25), $number, t('The default number of topics displayed per page; links to browse older messages are automatically being displayed.'));
  $forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4=> t('Posts - least active first'));
  $output .= form_radios(t('Default order'), 'forum_order', variable_get('forum_order', '1'), $forder, t('The default display order for topics.'));

Dries's avatar
 
Dries committed
331
  return system_settings_form($output);
332 333
}

334 335 336
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
337
function forum_load($node) {
Dries's avatar
 
Dries committed
338
  $forum = db_fetch_object(db_query('SELECT * FROM {forum} WHERE nid = %d', $node->nid));
Dries's avatar
 
Dries committed
339 340 341 342

  return $forum;
}

343 344 345 346 347 348
/**
 * Implementation of hook_block().
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
349 350 351
function forum_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
Dries's avatar
 
Dries committed
352 353
      $blocks[0]['info'] = t('Active forum topics');
      $blocks[1]['info'] = t('New forum topics');
354
      return $blocks;
Dries's avatar
 
Dries committed
355

356
    case 'configure':
357
      $output = form_select(t('Number of topics'), 'forum_block_num_'. $delta, variable_get('forum_block_num_'. $delta, '5'), drupal_map_assoc(array(2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20)));
358
      return $output;
Dries's avatar
 
Dries committed
359

360
    case 'save':
361
      variable_set('forum_block_num_'. $delta, $edit['forum_block_num_'. $delta]);
362
      break;
Dries's avatar
 
Dries committed
363

364 365
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
366 367
        switch ($delta) {
          case 0:
368
            $title = t('Active forum topics');
369
            $sql = db_rewrite_sql("SELECT n.nid, n.title, l.last_comment_timestamp, l.comment_count FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid WHERE n.status = 1 AND n.type = 'forum' ORDER BY l.last_comment_timestamp DESC");
370 371 372 373
            $result = db_query_range($sql, 0, variable_get('forum_block_num_0', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
374
            break;
Dries's avatar
 
Dries committed
375 376

          case 1:
377 378
            $title = t('New forum topics');
            $sql = db_rewrite_sql("SELECT n.nid, n.title, l.comment_count FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid WHERE n.type = 'forum' AND n.status = 1 ORDER BY n.nid DESC");
379 380 381 382
            $result = db_query_range($sql, 0, variable_get('forum_block_num_1', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
383
            break;
Dries's avatar
 
Dries committed
384
        }
Dries's avatar
 
Dries committed
385

386 387 388 389
        if ($content) {
          $content .= '<div class="more-link">'. l(t('more'), 'forum', array('title' => t('Read the latest forum topics.'))) .'</div>';
        }

Dries's avatar
 
Dries committed
390
        $block['subject'] = $title;
391 392 393 394 395
        $block['content'] = $content;

        return $block;
      }
  }
Dries's avatar
 
Dries committed
396 397
}

Dries's avatar
 
Dries committed
398 399 400
/**
 * Implementation of hook_link().
 */
401
function forum_link($type, $node = 0, $main = 0) {
Dries's avatar
Dries committed
402
  global $user;
Dries's avatar
 
Dries committed
403

Dries's avatar
 
Dries committed
404 405
  $links = array();

Dries's avatar
 
Dries committed
406
  if (!$main && $type == 'node' && $node->type == 'forum') {
Dries's avatar
 
Dries committed
407 408
    // get previous and next topic

Steven Wittens's avatar
Steven Wittens committed
409
    $sql = "SELECT n.nid, n.title, n.sticky, l.comment_count, l.last_comment_timestamp FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.status = 1 AND n.type = 'forum' ORDER BY n.sticky DESC, ". _forum_get_topic_order_sql(variable_get('forum_order', 1));
410
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
411
    $result = db_query($sql, $node->tid);
Dries's avatar
 
Dries committed
412 413 414

    while ($topic = db_fetch_object($result)) {
      if ($stop == 1) {
415
        $next = new StdClass();
Dries's avatar
 
Dries committed
416 417 418 419 420 421 422 423
        $next->nid = $topic->nid;
        $next->title = $topic->title;
        break;
      }
      if ($topic->nid == $node->nid) {
        $stop = 1;
      }
      else {
424
        $prev = new StdClass();
Dries's avatar
 
Dries committed
425 426 427 428 429 430
        $prev->nid = $topic->nid;
        $prev->title = $topic->title;
      }
    }

    if ($prev) {
431
      $links[] = l(t('previous forum topic'), "node/$prev->nid", array('title' => check_plain($prev->title)));
Dries's avatar
 
Dries committed
432 433 434
    }

    if ($next) {
435
      $links[] = l(t('next forum topic'), "node/$next->nid", array('title' => check_plain($next->title)));
Dries's avatar
 
Dries committed
436
    }
Dries's avatar
 
Dries committed
437 438
  }

Dries's avatar
 
Dries committed
439
  return $links;
Dries's avatar
 
Dries committed
440 441
}

Dries's avatar
 
Dries committed
442 443 444
/**
 * Implementation of hook_menu().
 */
Dries's avatar
 
Dries committed
445
function forum_menu($may_cache) {
Dries's avatar
 
Dries committed
446 447
  $items = array();

Dries's avatar
 
Dries committed
448 449 450
  if ($may_cache) {
    $items[] = array('path' => 'node/add/forum', 'title' => t('forum topic'),
      'access' => user_access('create forum topics'));
451

Dries's avatar
 
Dries committed
452 453 454
    $items[] = array('path' => 'forum', 'title' => t('forums'),
      'callback' => 'forum_page',
      'access' => user_access('access content'),
455
      'type' => MENU_SUGGESTED_ITEM);
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470

    $items[] = array('path' => 'admin/forum', 'title' => t('forums'),
      'callback' => 'forum_admin',
      'access' => user_access('administer forums'),
      'type' => MENU_NORMAL_ITEM);

    $items[] = array('path' => 'admin/forum/list', 'title' => t('list'),
      'access' => user_access('administer forums'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
    $items[] = array('path' => 'admin/forum/add/container', 'title' => t('add container'),
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
    $items[] = array('path' => 'admin/forum/add/forum', 'title' => t('add forum'),
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
471 472 473 474
    $items[] = array('path' => 'admin/forum/configure', 'title' => t('configure'),
      'callback' => 'forum_admin_configure',
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
475 476 477 478 479 480 481

    $items[] = array('path' => 'admin/forum/edit/container', 'title' => t('edit container'),
      'access' => user_access('administer forums'),
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'admin/forum/edit/forum', 'title' => t('edit forum'),
      'access' => user_access('administer forums'),
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
482
  }
Dries's avatar
 
Dries committed
483 484 485 486

  return $items;
}

487 488 489
/**
 * Implementation of hook_view().
 */
Dries's avatar
 
Dries committed
490
function forum_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
 
Dries committed
491

Dries's avatar
 
Dries committed
492
  if ($page) {
Dries's avatar
 
Dries committed
493
    $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
Dries's avatar
 
Dries committed
494
    // Breadcrumb navigation
Dries's avatar
 
Dries committed
495 496
    $breadcrumb = array();
    $breadcrumb[] = array('path' => 'forum', 'title' => $vocabulary->name);
Dries's avatar
 
Dries committed
497
    if ($parents = taxonomy_get_parents_all($node->tid)) {
Dries's avatar
 
Dries committed
498 499
      $parents = array_reverse($parents);
      foreach ($parents as $p) {
Dries's avatar
 
Dries committed
500
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
501 502
      }
    }
Dries's avatar
 
Dries committed
503 504
    $breadcrumb[] = array('path' => 'node/'. $node->nid);
    menu_set_location($breadcrumb);
505
  }
Dries's avatar
 
Dries committed
506

507
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
508 509
}

510 511 512 513 514 515
/**
 * Implementation of hook_validate().
 *
 * Check in particular that only a "leaf" term in the associated taxonomy
 * vocabulary is selected, not a "container" term.
 */
516 517
function forum_validate(&$node) {
  // Make sure all fields are set properly:
Dries's avatar
 
Dries committed
518
  $node->icon = $node->icon ? $node->icon : '';
Dries's avatar
 
Dries committed
519 520 521

  if ($node->taxonomy) {
    // Extract the node's proper topic ID.
Dries's avatar
 
Dries committed
522
    $vocabulary = variable_get('forum_nav_vocabulary', '');
523
    $containers = variable_get('forum_containers', array());
Dries's avatar
 
Dries committed
524
    foreach ($node->taxonomy as $term) {
Dries's avatar
 
Dries committed
525
      if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
526 527
        if (in_array($term, $containers)) {
          $term = taxonomy_get_term($term);
528
          form_set_error('taxonomy', t('The item %forum is only a container for forums. Please select one of the forums below it.', array('%forum' => theme('placeholder', $term->name))));
529 530 531 532
        }
        else {
          $node->tid = $term;
        }
Dries's avatar
 
Dries committed
533
      }
534
    }
Dries's avatar
 
Dries committed
535 536 537 538 539 540 541
    if ($node->tid && $node->shadow) {
      $terms = array_keys(taxonomy_node_get_terms($node->nid));
      if (!in_array($node->tid, $terms)) {
        $terms[] = $node->tid;
      }
      $node->taxonomy = $terms;
    }
Dries's avatar
Dries committed
542 543 544
  }
}

Dries's avatar
 
Dries committed
545 546 547 548 549 550 551
/**
 * Implementation of hook_update().
 */
function forum_update($node) {
  db_query('UPDATE {forum} SET tid = %d WHERE nid = %d', $node->tid, $node->nid);
}

552 553 554
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
555
function forum_form(&$node) {
Dries's avatar
 
Dries committed
556
  if (!$node->nid) {
Dries's avatar
Dries committed
557
    // new topic
Dries's avatar
 
Dries committed
558
    $node->taxonomy[] = arg(3);
559
  }
Dries's avatar
 
Dries committed
560 561 562
  else {
    $node->taxonomy = array($node->tid);
  }
563

Dries's avatar
 
Dries committed
564
  $output = implode('', taxonomy_node_form('forum', $node));
Dries's avatar
Dries committed
565 566 567

  if ($node->nid) {
    // if editing, give option to leave shadows
Dries's avatar
 
Dries committed
568 569
    $shadow = (count(taxonomy_node_get_terms($node->nid)) > 1);
    $output .= form_checkbox(t('Leave shadow copy'), 'shadow', 1, $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
570
  }
Dries's avatar
 
Dries committed
571

572
  $output .= form_textarea(t('Body'), 'body', $node->body, 60, 20, '');
573
  $output .= filter_form('format', $node->format);
Dries's avatar
 
Dries committed
574 575 576 577

  return $output;
}

578 579 580
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
581
function forum_insert($node) {
Dries's avatar
 
Dries committed
582
  db_query('INSERT INTO {forum} (nid, tid) VALUES (%d, %d)', $node->nid, $node->tid);
Dries's avatar
 
Dries committed
583 584
}

585 586 587
/**
 * Implementation of hook_delete().
 */
Dries's avatar
 
Dries committed
588
function forum_delete(&$node) {
Dries's avatar
 
Dries committed
589
  db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
590
}
Dries's avatar
 
Dries committed
591

Dries's avatar
 
Dries committed
592 593 594
/**
 * Formats a topic for display
 *
595
 * @TODO Give a better description. Not sure where this function is used yet.
Dries's avatar
 
Dries committed
596
 */
Dries's avatar
 
Dries committed
597
function _forum_format($topic) {
598
  if ($topic && $topic->timestamp) {
599
    return t('%time ago<br />by %author', array('%time' => format_interval(time() - $topic->timestamp), '%author' => theme('username', $topic)));
Dries's avatar
 
Dries committed
600 601 602 603 604 605
  }
  else {
    return message_na();
  }
}

Dries's avatar
 
Dries committed
606 607 608
/**
 * Returns a list of all forums for a given taxonomy id
 *
609
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
610 611 612 613 614 615 616 617 618
 * -num_topics Number of topics in the forum
 * -num_posts Total number of posts in all topics
 * -last_post Most recent post for the forum
 *
 * @param $tid
 *   Taxonomy ID of the vocabulary that holds the forum list.
 * @return
 *   Array of object containing the forum information.
 */
Dries's avatar
 
Dries committed
619
function forum_get_forums($tid = 0) {
620

Dries's avatar
 
Dries committed
621 622 623 624
  if (!$tid) {
    $tid = 0;
  }

Dries's avatar
 
Dries committed
625 626
  $forums = array();
  $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
Dries's avatar
 
Dries committed
627

Dries's avatar
 
Dries committed
628
  if (count($_forums)) {
Dries's avatar
 
Dries committed
629

Dries's avatar
 
Dries committed
630 631
    $counts = array();

Dries's avatar
 
Dries committed
632
    $sql = "SELECT r.tid, COUNT(n.nid) AS topic_count, SUM(l.comment_count) AS comment_count FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid INNER JOIN {term_node} r ON n.nid = r.nid WHERE n.status = 1 AND n.type = 'forum' GROUP BY r.tid";
633
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
634
    $_counts = db_query($sql, $forum->tid);
Dries's avatar
 
Dries committed
635 636 637
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
638
  }
Dries's avatar
 
Dries committed
639

Dries's avatar
 
Dries committed
640 641 642 643
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
644

Dries's avatar
 
Dries committed
645 646 647 648 649 650 651 652 653 654 655
    if ($counts[$forum->tid]) {
      $forum->num_topics = $counts[$forum->tid]->topic_count;
      $forum->num_posts = $counts[$forum->tid]->topic_count + $counts[$forum->tid]->comment_count;
    }
    else {
      $forum->num_topics = 0;
      $forum->num_posts = 0;
    }

    // This query does not use full ANSI syntax since MySQL 3.x does not support
    // table1 INNER JOIN table2 INNER JOIN table3 ON table2_criteria ON table3_criteria
Dries's avatar
 
Dries committed
656
    // used to join node_comment_statistics to users.
657
    $sql = "SELECT n.nid, l.last_comment_timestamp, IF(l.last_comment_uid, cu.name, l.last_comment_name) as last_comment_name, l.last_comment_uid FROM {node} n, {node_comment_statistics} l, {users} cu, {term_node} r WHERE  n.nid = r.nid AND r.tid = %d AND n.status = 1 AND n.type = 'forum' AND l.last_comment_uid = cu.uid AND n.nid = l.nid ORDER BY l.last_comment_timestamp DESC";
658
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
659
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
660 661

    $last_post = new StdClass();
Dries's avatar
 
Dries committed
662 663 664 665
    $last_post->timestamp = $topic->last_comment_timestamp;
    $last_post->name = $topic->last_comment_name;
    $last_post->uid = $topic->last_comment_uid;
    $forum->last_post = $last_post;
Dries's avatar
 
Dries committed
666

Dries's avatar
 
Dries committed
667 668 669 670
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
671 672
}

673 674 675 676
function _forum_topics_read($term, $uid) {
  // Calculate the number of topics the user has read. Assume all entries older
  // than NODE_NEW_LIMIT are read, and include the recent posts that user has
  // read.
Dries's avatar
 
Dries committed
677
  $sql = "SELECT COUNT(n.nid) FROM {node} n INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.created <= %d AND n.status = 1 AND n.type = 'forum'";
678
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
679 680
  $ancient = db_result(db_query($sql, $term, NODE_NEW_LIMIT));
  $sql = "SELECT COUNT(n.nid) FROM {node} n INNER JOIN {history} h ON n.nid = h.nid AND h.uid = %d INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.status = 1 AND n.type = 'forum' AND n.created > %d";
681
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
682
  $recent = db_result(db_query($sql, $uid, $term, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
683

684
  return $ancient + $recent;
Dries's avatar
 
Dries committed
685 686
}

Dries's avatar
Dries committed
687
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
688
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
689

Dries's avatar
 
Dries committed
690
  $forum_topic_list_header = array(
Dries's avatar
 
Dries committed
691 692
    array('data' => '&nbsp;'),
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
693
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
694
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
695
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
696
  );
Dries's avatar
 
Dries committed
697

Dries's avatar
 
Dries committed
698
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
699
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
700 701
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
702 703 704 705
    }
  }

  $term = taxonomy_get_term($tid);
Dries's avatar
 
Dries committed
706

707
  $sql = db_rewrite_sql("SELECT n.nid, f.tid, n.title, n.sticky, u.name, u.uid, n.created AS timestamp, n.comment AS comment_mode, l.last_comment_timestamp, IF(l.last_comment_uid, cu.name, l.last_comment_name) AS last_comment_name, l.last_comment_uid, l.comment_count AS num_comments FROM {node} n, {node_comment_statistics} l, {users} cu, {term_node} r, {users} u, {forum} f WHERE n.status = 1 AND l.last_comment_uid = cu.uid AND n.nid = l.nid AND n.nid = r.nid AND r.tid = %d AND n.uid = u.uid AND n.nid = f.nid");
Dries's avatar
 
Dries committed
708
  $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
Dries's avatar
Dries committed
709

710
  $sql_count = db_rewrite_sql("SELECT COUNT(n.nid) FROM {node} n INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.status = 1 AND n.type = 'forum'");
Dries's avatar
 
Dries committed
711

Steven Wittens's avatar
Steven Wittens committed
712
  $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
Dries's avatar
 
Dries committed
713 714

  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
715 716
    if ($user->uid) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
 
Dries committed
717
      if ($topic->tid != $tid) {
Dries's avatar
Dries committed
718
        $topic->new = 0;
Dries's avatar
 
Dries committed
719 720
      }
      else {
Dries's avatar
 
Dries committed
721
        $history = _forum_user_last_visit($topic->nid);
Dries's avatar
 
Dries committed
722
        $topic->new_replies = comment_num_new($topic->nid, $history);
723
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
724
      }
725 726
    }
    else {
727
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
728 729
      $topic->new_replies = 0;
      $topic->new = 0;
730
    }
Dries's avatar
 
Dries committed
731

Dries's avatar
 
Dries committed
732
    if ($topic->num_comments > 0) {
733
      $last_reply = new StdClass();
Dries's avatar
 
Dries committed
734 735 736 737 738
      $last_reply->timestamp = $topic->last_comment_timestamp;
      $last_reply->name = $topic->last_comment_name;
      $last_reply->uid = $topic->last_comment_uid;
      $topic->last_reply = $last_reply;
    }
Dries's avatar
 
Dries committed
739 740 741
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
742
  return $topics;
Dries's avatar
 
Dries committed
743 744
}

Dries's avatar
 
Dries committed
745 746 747
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
748
function _forum_new($tid) {
Dries's avatar
 
Dries committed
749 750
  global $user;

Dries's avatar
 
Dries committed
751
  $sql = "SELECT n.nid FROM {node} n LEFT JOIN {history} h ON n.nid = h.nid AND h.uid = %d INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.status = 1 AND n.type = 'forum' AND h.nid IS NULL AND n.created > %d ORDER BY created";
752
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
753
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
754 755 756 757

  return $nid ? $nid : 0;
}

758
/**
Dries's avatar
Dries committed
759
 * Menu callback; prints a forum listing.
760
 */
Dries's avatar
Dries committed
761
function forum_page($tid = 0) {
Dries's avatar
 
Dries committed
762
  global $user;
Dries's avatar
 
Dries committed
763

Dries's avatar
 
Dries committed
764
  if (module_exist('taxonomy')) {
Dries's avatar
Dries committed
765 766
    $forum_per_page = variable_get('forum_per_page', 25);
    $sortby = variable_get('forum_order', 1);
Dries's avatar
 
Dries committed
767

Dries's avatar
Dries committed
768 769 770 771
    $forums = forum_get_forums($tid);
    $parents = taxonomy_get_parents_all($tid);
    if ($tid && !in_array($tid, variable_get('forum_containers', array()))) {
      $topics = forum_get_topics($tid, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
772
    }
Dries's avatar
Dries committed
773

Dries's avatar
 
Dries committed
774
    return theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
775 776
  }
  else {
777
    drupal_set_title(t('Warning'));
Dries's avatar
 
Dries committed
778
    return forum_help('admin/settings/forum');
Dries's avatar
 
Dries committed
779 780 781
  }
}

Dries's avatar
 
Dries committed
782
/**
Dries's avatar
 
Dries committed
783 784
 * Format the forum body.
 *
Dries's avatar
 
Dries committed
785
 * @ingroup themeable
Dries's avatar
 
Dries committed
786
 */
Dries's avatar
 
Dries committed
787
function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
788
  global $user;
Dries's avatar
 
Dries committed
789
  // forum list, topics list, topic browser and 'add new topic' link
Dries's avatar
 
Dries committed
790

Dries's avatar
 
Dries committed
791
  $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
792
  $title = $vocabulary->name;
Dries's avatar
 
Dries committed
793

Dries's avatar
 
Dries committed
794 795
  // Breadcrumb navigation:
  $breadcrumb = array();
Dries's avatar
 
Dries committed
796
  if ($tid) {
Dries's avatar
 
Dries committed
797
    $breadcrumb[] = array('path' => 'forum', 'title' => $title);
Dries's avatar
 
Dries committed
798
  }
Dries's avatar
 
Dries committed
799 800

  if ($parents) {
Dries's avatar
 
Dries committed
801 802
    $parents = array_reverse($parents);
    foreach ($parents as $p) {
803 804
      if ($p->tid == $tid) {
        $title = $p->name;
Dries's avatar
 
Dries committed
805 806
      }
      else {
Dries's avatar
 
Dries committed
807
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
808 809 810
      }
    }
  }
811 812 813

  drupal_set_title($title);

Dries's avatar
 
Dries committed
814 815
  $breadcrumb[] = array('path' => $_GET['q']);
  menu_set_location($breadcrumb);
Dries's avatar
 
Dries committed
816

Dries's avatar
 
Dries committed
817
  if (count($forums) || count($parents)) {
818 819
    $output  = '<div id="forum">';
    $output .= '<ul>';
Dries's avatar
 
Dries committed
820 821 822

    if (module_exist('tracker')) {
      if ($user->uid) {
Dries's avatar
 
Dries committed
823
        $output .= ' <li>'. l(t('My forum discussions.'), "tracker/$user->uid") .'</li>';
Dries's avatar
 
Dries committed
824 825
      }

Dries's avatar
 
Dries committed
826
      $output .= ' <li>'. l(t('Active forum discussions.'), 'tracker') .'</li>';
Dries's avatar
 
Dries committed
827 828 829
    }

    if (user_access('create forum topics')) {
830
      $output .= '<li>'. l(t('Post new forum topic.'), "node/add/forum/$tid") .'</li>';
Dries's avatar
 
Dries committed
831 832
    }
    else if ($user->uid) {
833
      $output .= '<li>'. t('You are not allowed to post a new forum topic.') .'</li>';
Dries's avatar
 
Dries committed
834 835 836 837
    }
    else {
      $output .= '<li>'. t('<a href="%login">Login</a> to post a new forum topic.', array('%login' => url('user/login'))) .'</li>';
    }
838
    $output .= '</ul>';
Dries's avatar
 
Dries committed
839

Dries's avatar
 
Dries committed
840
    $output .= theme('forum_list', $forums, $parents, $tid);
Dries's avatar
 
Dries committed
841

Dries's avatar
 
Dries committed
842
    if ($tid && !in_array($tid, variable_get('forum_containers', array()))) {
843 844 845 846
      drupal_add_link(array('rel' => 'alternate',
                            'type' => 'application/rss+xml',
                            'title' => 'RSS - '. $title,
                            'href' => url('taxonomy/term/'. $tid .'/0/feed')));
Dries's avatar
 
Dries committed
847

Dries's avatar
 
Dries committed
848
      $output .= theme('forum_topic_list', $tid, $topics, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
849
      $output .= theme('xml_icon', url("taxonomy/term/$tid/0/feed"));
Dries's avatar
 
Dries committed
850
    }
851
    $output .= '</div>';
Dries's avatar
 
Dries committed
852 853
  }
  else {
854
    drupal_set_title(t('No forums defined'));
Dries's avatar
 
Dries committed
855
    $output = '';
Dries's avatar
 
Dries committed
856 857
  }

858
  return $output;
Dries's avatar
 
Dries committed
859 860
}

Dries's avatar
 
Dries committed
861
/**