forum.module 33.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.');
Dries's avatar
 
Dries committed
22
    case 'node/add#forum':
23
      return t('Create a new topic for discussion in the forums.');
Dries's avatar
 
Dries committed
24 25 26
  }
}

27 28 29
/**
 * Implementation of hook_node_name().
 */
Dries's avatar
 
Dries committed
30
function forum_node_name($node) {
Dries's avatar
 
Dries committed
31
  return t('forum topic');
Dries's avatar
 
Dries committed
32 33
}

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

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

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

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

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

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

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
  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']) {
88
        $output = _forum_confirm_delete($edit['tid']);
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
        break;
      }
      else {
        $edit['name'] = 0;
      }
    case t('Submit'):
      $edit = taxonomy_save_term($edit);
      if (arg(3) == 'container') {
        $containers = variable_get('forum_containers', array());
        $containers[] = $edit['tid'];
        variable_set('forum_containers', $containers);
       }
      drupal_goto('admin/forum');
    default:
      $output = forum_overview();
  }

  print theme('page', $output);
}

/**
 * Implementation of hook_taxonomy().
 */
function forum_taxonomy($op, $type, $object) {
  if ($op == 'delete' && $type == 'term' && $object->vid == _forum_get_vid())  {
    $results = db_query('SELECT f.nid FROM forum f WHERE f.tid = %d', $object->tid);
    while ($node = db_fetch_object($results)) {
      $edit['nid'] = $node->nid;
      $edit['confirm'] = TRUE;
      node_delete($edit);
Dries's avatar
 
Dries committed
119
    }
120 121
  }
}
Dries's avatar
 
Dries committed
122

123 124 125 126 127
/**
 * Returns a confirmation page for deleting a forum taxonomy term
 *
 * @param $tid ID of the term to be deleted
 */
128
function _forum_confirm_delete($tid) {
129 130 131 132 133 134 135 136 137 138
  $term = taxonomy_get_term($tid);

  $extra = form_hidden('tid', $tid);
  $output = theme('confirm',
                  t('Are you sure you want to delete the forum %name?', array('%name' => '<em>'. $term->name .'</em>')),
                  '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);
139
  return $output;
140 141 142 143 144 145 146 147
}

/**
 * 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()) {
148 149
  $form = form_textfield(t('Container name'), 'name', $edit['name'], 50, 64, t('The container name is used to identify related forums.'), NULL, TRUE);
  $form .= form_textarea(t('Description'), 'description', $edit['description'], 60, 5, t('The container description can give users more information about the forums it contains.'));
150

151 152
  $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.'));
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169

  $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()) {
170 171
  $form = form_textfield(t('Forum name'), 'name', $edit['name'], 50, 64, t('The forum name is used to identify related topic discussions.'), NULL, TRUE);
  $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.'));
172

173 174
  $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.'));
175 176 177 178 179 180 181

  $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']);
  }
182

183 184 185 186 187 188 189 190 191 192
  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
 */
193
function _forum_parent_select($tid, $title, $name, $child_type) {
194 195

  $parents = taxonomy_get_parents($tid);
196 197 198 199 200 201 202 203
  if ($parents) {
    $parent = array_shift($parents);
    $parent = $parent->tid;
  }
  else {
    $parent = 0;
  }

204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
  $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
219 220
    }
  }
221 222 223 224 225 226
  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
227

228
  return form_select($title, $name, $parent, $options, $description, 0, FALSE, TRUE);
Dries's avatar
 
Dries committed
229 230
}

231
/**
232
 * Returns an overview list of existing forums and containers
233
 */
234 235 236 237 238 239 240
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()))) {
241
        $rows[] = array(_forum_depth($term->depth) .' '. check_plain($term->name), l(t('edit container'), "admin/forum/edit/container/$term->tid"));
242 243
      }
      else {
244
        $rows[] = array(_forum_depth($term->depth) .' '. check_plain($term->name), l(t('edit forum'), "admin/forum/edit/forum/$term->tid"));
245 246
       }

Dries's avatar
Dries committed
247 248
    }
  }
249
  else {
250
    $rows[] = array(array('data' => t('There are no containers or forums.'), 'colspan' => 2));
251 252
  }
  return theme('table', $header, $rows);
Dries's avatar
Dries committed
253 254
}

255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
/**
 * 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) {
277
      $vocabulary = taxonomy_save_vocabulary(array('name' => 'Forums', 'multiple' => 0, 'required' => 1, 'hierarchy' => 1, 'relations' => 0, 'module' => 'forum', 'nodes' => array('forum')));
278 279 280 281 282 283 284 285 286 287 288
      $vid = $vocabulary['vid'];
    }
    variable_set('forum_nav_vocabulary', $vid);
  }

  return $vid;
}

/**
 * Implementation of hook_settings
 */
289 290 291
function forum_admin_configure() {
  system_settings_save();

292 293 294 295 296 297 298 299
  $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.'));

300
  print theme('page', system_settings_form($output));
301 302
}

303 304 305
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
306
function forum_load($node) {
Dries's avatar
 
Dries committed
307
  $forum = db_fetch_object(db_query('SELECT * FROM {forum} WHERE nid = %d', $node->nid));
Dries's avatar
 
Dries committed
308 309 310 311

  return $forum;
}

312 313 314 315 316 317
/**
 * Implementation of hook_block().
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
318 319 320
function forum_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
Dries's avatar
 
Dries committed
321 322
      $blocks[0]['info'] = t('Active forum topics');
      $blocks[1]['info'] = t('New forum topics');
323
      return $blocks;
Dries's avatar
 
Dries committed
324

325
    case 'configure':
326
      $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)));
327
      return $output;
Dries's avatar
 
Dries committed
328

329
    case 'save':
330
      variable_set('forum_block_num_'. $delta, $edit['forum_block_num_'. $delta]);
331
      break;
Dries's avatar
 
Dries committed
332

333 334
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
335 336
        switch ($delta) {
          case 0:
337 338 339 340
            $title = t('Active forum topics');
            $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");
            $content = node_title_list(db_query_range($sql, 0, variable_get('forum_block_num_0', '5')));
            break;
Dries's avatar
 
Dries committed
341 342

          case 1:
343 344 345 346
            $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");
            $content = node_title_list(db_query_range($sql, 0, variable_get('forum_block_num_1', '5')));
            break;
Dries's avatar
 
Dries committed
347
        }
Dries's avatar
 
Dries committed
348

349 350 351 352
        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
353
        $block['subject'] = $title;
354 355 356 357 358
        $block['content'] = $content;

        return $block;
      }
  }
Dries's avatar
 
Dries committed
359 360
}

Dries's avatar
 
Dries committed
361 362 363
/**
 * Implementation of hook_link().
 */
364
function forum_link($type, $node = 0, $main = 0) {
Dries's avatar
Dries committed
365
  global $user;
Dries's avatar
 
Dries committed
366

Dries's avatar
 
Dries committed
367 368
  $links = array();

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

Steven Wittens's avatar
Steven Wittens committed
372
    $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));
373
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
374
    $result = db_query($sql, $node->tid);
Dries's avatar
 
Dries committed
375 376 377

    while ($topic = db_fetch_object($result)) {
      if ($stop == 1) {
378
        $next = new StdClass();
Dries's avatar
 
Dries committed
379 380 381 382 383 384 385 386
        $next->nid = $topic->nid;
        $next->title = $topic->title;
        break;
      }
      if ($topic->nid == $node->nid) {
        $stop = 1;
      }
      else {
387
        $prev = new StdClass();
Dries's avatar
 
Dries committed
388 389 390 391 392 393
        $prev->nid = $topic->nid;
        $prev->title = $topic->title;
      }
    }

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

    if ($next) {
398
      $links[] = l(t('next forum topic'), "node/$next->nid", array('title' => check_plain($next->title)));
Dries's avatar
 
Dries committed
399
    }
Dries's avatar
 
Dries committed
400 401
  }

Dries's avatar
 
Dries committed
402
  return $links;
Dries's avatar
 
Dries committed
403 404
}

Dries's avatar
 
Dries committed
405 406 407
/**
 * Implementation of hook_menu().
 */
Dries's avatar
 
Dries committed
408
function forum_menu($may_cache) {
Dries's avatar
 
Dries committed
409 410
  $items = array();

Dries's avatar
 
Dries committed
411 412 413
  if ($may_cache) {
    $items[] = array('path' => 'node/add/forum', 'title' => t('forum topic'),
      'access' => user_access('create forum topics'));
414

Dries's avatar
 
Dries committed
415 416 417
    $items[] = array('path' => 'forum', 'title' => t('forums'),
      'callback' => 'forum_page',
      'access' => user_access('access content'),
418
      'type' => MENU_SUGGESTED_ITEM);
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433

    $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);
434 435 436 437
    $items[] = array('path' => 'admin/forum/configure', 'title' => t('configure'),
      'callback' => 'forum_admin_configure',
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
438 439 440 441 442 443 444

    $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
445
  }
Dries's avatar
 
Dries committed
446 447 448 449

  return $items;
}

450 451 452
/**
 * Implementation of hook_view().
 */
Dries's avatar
 
Dries committed
453
function forum_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
 
Dries committed
454

Dries's avatar
 
Dries committed
455
  if ($page) {
Dries's avatar
 
Dries committed
456
    $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
Dries's avatar
 
Dries committed
457
    // Breadcrumb navigation
Dries's avatar
 
Dries committed
458 459
    $breadcrumb = array();
    $breadcrumb[] = array('path' => 'forum', 'title' => $vocabulary->name);
Dries's avatar
 
Dries committed
460
    if ($parents = taxonomy_get_parents_all($node->tid)) {
Dries's avatar
 
Dries committed
461 462
      $parents = array_reverse($parents);
      foreach ($parents as $p) {
Dries's avatar
 
Dries committed
463
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
464 465
      }
    }
Dries's avatar
 
Dries committed
466 467
    $breadcrumb[] = array('path' => 'node/'. $node->nid);
    menu_set_location($breadcrumb);
468
  }
Dries's avatar
 
Dries committed
469

470
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
471 472
}

473 474 475 476 477 478
/**
 * Implementation of hook_validate().
 *
 * Check in particular that only a "leaf" term in the associated taxonomy
 * vocabulary is selected, not a "container" term.
 */
479 480
function forum_validate(&$node) {
  // Make sure all fields are set properly:
Dries's avatar
 
Dries committed
481
  $node->icon = $node->icon ? $node->icon : '';
Dries's avatar
 
Dries committed
482 483 484

  if ($node->taxonomy) {
    // Extract the node's proper topic ID.
Dries's avatar
 
Dries committed
485
    $vocabulary = variable_get('forum_nav_vocabulary', '');
486
    $containers = variable_get('forum_containers', array());
Dries's avatar
 
Dries committed
487
    foreach ($node->taxonomy as $term) {
Dries's avatar
 
Dries committed
488
      if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
489 490
        if (in_array($term, $containers)) {
          $term = taxonomy_get_term($term);
491
          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))));
492 493 494 495
        }
        else {
          $node->tid = $term;
        }
Dries's avatar
 
Dries committed
496
      }
497
    }
Dries's avatar
 
Dries committed
498 499 500 501 502 503 504
    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
505 506 507
  }
}

Dries's avatar
 
Dries committed
508 509 510 511 512 513 514
/**
 * Implementation of hook_update().
 */
function forum_update($node) {
  db_query('UPDATE {forum} SET tid = %d WHERE nid = %d', $node->tid, $node->nid);
}

515 516 517
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
518
function forum_form(&$node) {
Dries's avatar
 
Dries committed
519
  if (!$node->nid) {
Dries's avatar
Dries committed
520
    // new topic
Dries's avatar
 
Dries committed
521
    $node->taxonomy[] = arg(3);
522
  }
Dries's avatar
 
Dries committed
523 524 525
  else {
    $node->taxonomy = array($node->tid);
  }
526

Dries's avatar
 
Dries committed
527
  $output = implode('', taxonomy_node_form('forum', $node));
Dries's avatar
Dries committed
528 529 530

  if ($node->nid) {
    // if editing, give option to leave shadows
Dries's avatar
 
Dries committed
531 532
    $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
533
  }
Dries's avatar
 
Dries committed
534

535
  $output .= form_textarea(t('Body'), 'body', $node->body, 60, 20, '');
536
  $output .= filter_form('format', $node->format);
Dries's avatar
 
Dries committed
537 538 539 540

  return $output;
}

541 542 543
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
544
function forum_insert($node) {
Dries's avatar
 
Dries committed
545
  db_query('INSERT INTO {forum} (nid, tid) VALUES (%d, %d)', $node->nid, $node->tid);
Dries's avatar
 
Dries committed
546 547
}

548 549 550
/**
 * Implementation of hook_delete().
 */
Dries's avatar
 
Dries committed
551
function forum_delete(&$node) {
Dries's avatar
 
Dries committed
552
  db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
553
}
Dries's avatar
 
Dries committed
554

Dries's avatar
 
Dries committed
555 556 557
/**
 * Formats a topic for display
 *
558
 * @TODO Give a better description. Not sure where this function is used yet.
Dries's avatar
 
Dries committed
559
 */
Dries's avatar
 
Dries committed
560
function _forum_format($topic) {
561
  if ($topic && $topic->timestamp) {
Dries's avatar
 
Dries committed
562
    return t('%time ago<br />by %author', array('%time' => format_interval(time() - $topic->timestamp), '%author' => format_name($topic)));
Dries's avatar
 
Dries committed
563 564 565 566 567 568
  }
  else {
    return message_na();
  }
}

Dries's avatar
 
Dries committed
569 570 571
/**
 * Returns a list of all forums for a given taxonomy id
 *
572
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
573 574 575 576 577 578 579 580 581
 * -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
582
function forum_get_forums($tid = 0) {
583

Dries's avatar
 
Dries committed
584 585 586 587
  if (!$tid) {
    $tid = 0;
  }

Dries's avatar
 
Dries committed
588 589
  $forums = array();
  $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
Dries's avatar
 
Dries committed
590

Dries's avatar
 
Dries committed
591
  if (count($_forums)) {
Dries's avatar
 
Dries committed
592

Dries's avatar
 
Dries committed
593 594
    $counts = array();

Dries's avatar
 
Dries committed
595
    $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";
596
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
597
    $_counts = db_query($sql, $forum->tid);
Dries's avatar
 
Dries committed
598 599 600
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
601
  }
Dries's avatar
 
Dries committed
602

Dries's avatar
 
Dries committed
603 604 605 606
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
607

Dries's avatar
 
Dries committed
608 609 610 611 612 613 614 615 616 617 618
    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
619
    // used to join node_comment_statistics to users.
Dries's avatar
 
Dries committed
620
    $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 /*! USE INDEX (node_comment_timestamp) */, {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";
621
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
622
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
623 624

    $last_post = new StdClass();
Dries's avatar
 
Dries committed
625 626 627 628
    $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
629

Dries's avatar
 
Dries committed
630 631 632 633
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
634 635
}

636 637 638 639
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
640
  $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'";
641
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
642 643
  $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";
644
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
645
  $recent = db_result(db_query($sql, $uid, $term, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
646

647
  return $ancient + $recent;
Dries's avatar
 
Dries committed
648 649
}

Dries's avatar
Dries committed
650
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
651
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
652

Dries's avatar
 
Dries committed
653
  $forum_topic_list_header = array(
Dries's avatar
 
Dries committed
654 655
    array('data' => '&nbsp;'),
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
656
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
657
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
658
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
659
  );
Dries's avatar
 
Dries committed
660

Dries's avatar
 
Dries committed
661
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
662
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
663 664
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
665 666 667 668
    }
  }

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

670
  $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
671
  $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
Dries's avatar
Dries committed
672

673
  $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
674

Steven Wittens's avatar
Steven Wittens committed
675
  $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
Dries's avatar
 
Dries committed
676 677

  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
678 679
    if ($user->uid) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
 
Dries committed
680
      if ($topic->tid != $tid) {
Dries's avatar
Dries committed
681
        $topic->new = 0;
Dries's avatar
 
Dries committed
682 683
      }
      else {
Dries's avatar
 
Dries committed
684
        $history = _forum_user_last_visit($topic->nid);
Dries's avatar
 
Dries committed
685
        $topic->new_replies = comment_num_new($topic->nid, $history);
686
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
687
      }
688 689
    }
    else {
690
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
691 692
      $topic->new_replies = 0;
      $topic->new = 0;
693
    }
Dries's avatar
 
Dries committed
694

Dries's avatar
 
Dries committed
695
    if ($topic->num_comments > 0) {
696
      $last_reply = new StdClass();
Dries's avatar
 
Dries committed
697 698 699 700 701
      $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
702 703 704
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
705
  return $topics;
Dries's avatar
 
Dries committed
706 707
}

Dries's avatar
 
Dries committed
708 709 710
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
711
function _forum_new($tid) {
Dries's avatar
 
Dries committed
712 713
  global $user;

Dries's avatar
 
Dries committed
714
  $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";
715
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
716
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
717 718 719 720

  return $nid ? $nid : 0;
}

721
/**
Dries's avatar
Dries committed
722
 * Menu callback; prints a forum listing.
723
 */
Dries's avatar
Dries committed
724
function forum_page($tid = 0) {
Dries's avatar
 
Dries committed
725
  global $user;
Dries's avatar
 
Dries committed
726

Dries's avatar
 
Dries committed
727
  if (module_exist('taxonomy')) {
Dries's avatar
Dries committed
728 729
    $forum_per_page = variable_get('forum_per_page', 25);
    $sortby = variable_get('forum_order', 1);
Dries's avatar
 
Dries committed
730

Dries's avatar
Dries committed
731 732 733 734
    $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
735
    }
Dries's avatar
Dries committed
736

737
    print theme('page', theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page));
Dries's avatar
 
Dries committed
738 739
  }
  else {
740 741
    drupal_set_title(t('Warning'));
    print theme('page', forum_help('admin/settings/forum'));
Dries's avatar
 
Dries committed
742 743 744
  }
}

Dries's avatar
 
Dries committed
745
/**
Dries's avatar
 
Dries committed
746 747
 * Format the forum body.
 *
Dries's avatar
 
Dries committed
748
 * @ingroup themeable
Dries's avatar
 
Dries committed
749
 */
Dries's avatar
 
Dries committed
750
function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
751
  global $user;
Dries's avatar
 
Dries committed
752
  // forum list, topics list, topic browser and 'add new topic' link
Dries's avatar
 
Dries committed
753

Dries's avatar
 
Dries committed
754
  $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
755
  $title = $vocabulary->name;
Dries's avatar
 
Dries committed
756

Dries's avatar
 
Dries committed
757 758
  // Breadcrumb navigation:
  $breadcrumb = array();
Dries's avatar
 
Dries committed
759
  if ($tid) {
Dries's avatar
 
Dries committed
760
    $breadcrumb[] = array('path' => 'forum', 'title' => $title);
Dries's avatar
 
Dries committed
761
  }
Dries's avatar
 
Dries committed
762 763

  if ($parents) {
Dries's avatar
 
Dries committed
764 765
    $parents = array_reverse($parents);
    foreach ($parents as $p) {
766 767
      if ($p->tid == $tid) {
        $title = $p->name;
Dries's avatar
 
Dries committed
768 769
      }
      else {
Dries's avatar
 
Dries committed
770
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
771 772 773
      }
    }
  }
774 775 776

  drupal_set_title($title);

Dries's avatar
 
Dries committed
777 778
  $breadcrumb[] = array('path' => $_GET['q']);
  menu_set_location($breadcrumb);
Dries's avatar
 
Dries committed
779

Dries's avatar
 
Dries committed
780
  if (count($forums) || count($parents)) {
781 782
    $output  = '<div id="forum">';
    $output .= '<ul>';
Dries's avatar
 
Dries committed
783 784 785

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

Dries's avatar
 
Dries committed
789
      $output .= ' <li>'. l(t('Active forum discussions.'), 'tracker') .'</li>';
Dries's avatar
 
Dries committed
790 791 792
    }

    if (user_access('create forum topics')) {
793
      $output .= '<li>'. l(t('Post new forum topic.'), "node/add/forum/$tid") .'</li>';
Dries's avatar
 
Dries committed
794 795
    }
    else if ($user->uid) {
796
      $output .= '<li>'. t('You are not allowed to post a new forum topic.') .'</li>';
Dries's avatar
 
Dries committed
797 798 799 800
    }
    else {
      $output .= '<li>'. t('<a href="%login">Login</a> to post a new forum topic.', array('%login' => url('user/login'))) .'</li>';
    }
801
    $output .= '</ul>';
Dries's avatar
 
Dries committed
802

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

Dries's avatar
 
Dries committed
805
    if ($tid && !in_array($tid, variable_get('forum_containers', array()))) {
Dries's avatar
 
Dries committed
806 807
      drupal_set_html_head('<link rel="alternate" type="application/rss+xml" title="RSS - '. $title .'" href="'. url('taxonomy/term/'. $tid .'/0/feed') .'" />');

Dries's avatar
 
Dries committed
808
      $output .= theme('forum_topic_list', $tid, $topics, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
809
      $output .= theme('xml_icon', url("taxonomy/term/$tid/0/feed"));
Dries's avatar
 
Dries committed
810
    }
811
    $output .= '</div>';
Dries's avatar
 
Dries committed
812 813
  }
  else {
814
    drupal_set_title(t('No forums defined'));
Dries's avatar
 
Dries committed
815
    $output = '';
Dries's avatar
 
Dries committed
816 817
  }

818
  return $output;
Dries's avatar
 
Dries committed
819 820
}

Dries's avatar
 
Dries committed
821
/**
Dries's avatar
 
Dries committed
822 823
 * Format the forum listing.
 *
Dries's avatar
 
Dries committed
824
 * @ingroup themeable
Dries's avatar
 
Dries committed
825
 */
Dries's avatar
 
Dries committed
826
function theme_forum_list($forums, $parents, $tid) {
Dries's avatar
 
Dries committed
827 828
  global $user;

Dries's avatar
 
Dries committed
829 830
  if ($forums) {

Dries's avatar
 
Dries committed
831
    $header = array(t('Forum'), t('Topics'), t('Posts'), t('Last post'));
Dries's avatar
 
Dries committed
832 833

    foreach ($forums as $forum) {
Dries's avatar
 
Dries committed
834
      if ($forum->container) {
835 836
        $description  = '<div style="margin-left: '. ($forum->depth * 30) ."px;\">\n";
        $description .= ' <div class="name">'. l($forum->name, "forum/$forum->tid") ."</div>\n";
Dries's avatar
 
Dries committed
837 838 839 840 841 842

        if ($forum->description) {
          $description .= " <div class=\"description\">$forum->description</div>\n";
        }
        $description .= "</div>\n";

Dries's avatar
 
Dries committed
843
        $rows[] = array(array('data' => $description, 'class' => 'container', 'colspan' => '4'));
844
      }
Dries's avatar
 
Dries committed
845
      else {
846
        $forum->old_topics = _forum_topics_read($forum->tid, $user->uid);
Dries's avatar
 
Dries committed
847 848 849
        if ($user->uid) {
          $new_topics = $forum->num_topics - $forum->old_topics;
        }
Dries's avatar
 
Dries committed
850 851 852
        else {
          $new_topics = 0;
        }
Dries's avatar
 
Dries committed
853

854 855
        $description  = '<div style="margin-left: '. ($forum->depth * 30) ."px;\">\n";
        $description .= ' <div class="name">'. l($forum->name, "forum/$forum->tid") ."</div>\n";
Dries's avatar
 
Dries committed
856

Dries's avatar
 
Dries committed
857 858 859 860
        if ($forum->description) {
          $description .= " <div class=\"description\">$forum->description</div>\n";
        }
        $description .= "</div>\n";
Dries's avatar
 
Dries committed
861

Dries's avatar
 
Dries committed
862
        $rows[] = array(
Dries's avatar
 
Dries committed
863
          array('data' => $description, 'class' => 'forum'),
864
          array('data' => $forum->num_topics . ($new_topics ? '<br />'. l(t('%a new', array('%a' => $new_topics)), "forum/$forum->tid", NULL, NULL, 'new') : ''), 'class' => 'topics'),
Dries's avatar
 
Dries committed
865 866
          array('data' => $forum->num_posts, 'class' => 'posts'),
          array('data' => _forum_format($forum->last_post), 'class' => 'last-reply'));
Dries's avatar
 
Dries committed
867
      }
Dries's avatar
 
Dries committed
868
    }
Dries's avatar