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". Containers are usually placed at the top (root) level of your forum but you can also place a container within another container or forum.</p>');
18
    case 'admin/forum/add/forum':
19
      return t('<p>A forum holds threaded topic discussions that are related. For example, a forum named "Fruit" might contain topic discussions titled "Apples" and "Bananas". You can place a forum into a container, another forum, or at the top (root) level of your forum.</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('A forum is a threaded discussion, enabling users to communicate about a particular topic.');
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 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
}

/**
 * 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()) {
  $form = form_textfield(t('Container name'), 'name', $edit['name'], 50, 64, t('The container name is used on the forum listing page to identify a group of forums.'), NULL, TRUE);
  $form .= form_textarea(t('Description'), 'description', $edit['description'], 60, 5, t('The description can provide additional information about the forum grouping.'));

  $form .= _forum_parent_select($edit['tid'], t('Parent'), 'parent][');
  $form .= form_weight(t('Weight'), 'weight', $edit['weight'], 10, t('In listings, the heavier terms (with a larger weight) will sink and the lighter terms will be positioned nearer the top.'));

  $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()) {
  $form = form_textfield(t('Forum name'), 'name', $edit['name'], 50, 64, t('The name is used to identify the forum.'), NULL, TRUE);
  $form .= form_textarea(t('Description'), 'description', $edit['description'], 60, 5, t('The description can be used to provide more information about the forum, or further details about the topic.'));

  $form .= _forum_parent_select($edit['tid'], t('Parent'), 'parent][');
  $form .= form_weight(t('Weight'), 'weight', $edit['weight'], 10, t('In listings, the heavier (with a higher weight value) terms will sink and the lighter terms will be positioned nearer the top.'));

  $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 193 194 195
  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
 */
function _forum_parent_select($tid, $title, $name) {

  $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
    }
  }
Dries's avatar
 
Dries committed
221

222
  return form_select($title, $name, $parent, $options, NULL, 0, FALSE, TRUE);
Dries's avatar
 
Dries committed
223 224
}

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

Dries's avatar
Dries committed
241 242
    }
  }
243 244 245 246
  else {
    $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));
  }
  return theme('table', $header, $rows);
Dries's avatar
Dries committed
247 248
}

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

  return $vid;
}

/**
 * Implementation of hook_settings
 */
283 284 285
function forum_admin_configure() {
  system_settings_save();

286 287 288 289 290 291 292 293
  $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.'));

294
  print theme('page', system_settings_form($output));
295 296
}

297 298 299
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
300
function forum_load($node) {
Dries's avatar
 
Dries committed
301
  $forum = db_fetch_object(db_query('SELECT * FROM {forum} WHERE nid = %d', $node->nid));
Dries's avatar
 
Dries committed
302 303 304 305

  return $forum;
}

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

319
    case 'configure':
320
      $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)));
321
      return $output;
Dries's avatar
 
Dries committed
322

323
    case 'save':
324
      variable_set('forum_block_num_'. $delta, $edit['forum_block_num_'. $delta]);
325
      break;
Dries's avatar
 
Dries committed
326

327 328
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
329 330
        switch ($delta) {
          case 0:
331 332 333 334
            $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
335 336

          case 1:
337 338 339 340
            $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
341
        }
Dries's avatar
 
Dries committed
342

343 344 345 346
        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
347
        $block['subject'] = $title;
348 349 350 351 352
        $block['content'] = $content;

        return $block;
      }
  }
Dries's avatar
 
Dries committed
353 354
}

Dries's avatar
 
Dries committed
355 356 357
/**
 * Implementation of hook_link().
 */
358
function forum_link($type, $node = 0, $main = 0) {
Dries's avatar
Dries committed
359
  global $user;
Dries's avatar
 
Dries committed
360

Dries's avatar
 
Dries committed
361 362
  $links = array();

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

Steven Wittens's avatar
Steven Wittens committed
366
    $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));
367
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
368
    $result = db_query($sql, $node->tid);
Dries's avatar
 
Dries committed
369 370 371

    while ($topic = db_fetch_object($result)) {
      if ($stop == 1) {
372
        $next = new StdClass();
Dries's avatar
 
Dries committed
373 374 375 376 377 378 379 380
        $next->nid = $topic->nid;
        $next->title = $topic->title;
        break;
      }
      if ($topic->nid == $node->nid) {
        $stop = 1;
      }
      else {
381
        $prev = new StdClass();
Dries's avatar
 
Dries committed
382 383 384 385 386 387
        $prev->nid = $topic->nid;
        $prev->title = $topic->title;
      }
    }

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

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

Dries's avatar
 
Dries committed
396
  return $links;
Dries's avatar
 
Dries committed
397 398
}

Dries's avatar
 
Dries committed
399 400 401
/**
 * Implementation of hook_menu().
 */
Dries's avatar
 
Dries committed
402
function forum_menu($may_cache) {
Dries's avatar
 
Dries committed
403 404
  $items = array();

Dries's avatar
 
Dries committed
405 406 407
  if ($may_cache) {
    $items[] = array('path' => 'node/add/forum', 'title' => t('forum topic'),
      'access' => user_access('create forum topics'));
408

Dries's avatar
 
Dries committed
409 410 411
    $items[] = array('path' => 'forum', 'title' => t('forums'),
      'callback' => 'forum_page',
      'access' => user_access('access content'),
412
      'type' => MENU_SUGGESTED_ITEM);
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427

    $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);
428 429 430 431
    $items[] = array('path' => 'admin/forum/configure', 'title' => t('configure'),
      'callback' => 'forum_admin_configure',
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
432 433 434 435 436 437 438

    $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
439
  }
Dries's avatar
 
Dries committed
440 441 442 443

  return $items;
}

444 445 446
/**
 * Implementation of hook_view().
 */
Dries's avatar
 
Dries committed
447
function forum_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
 
Dries committed
448

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

464
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
465 466
}

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

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

Dries's avatar
 
Dries committed
502 503 504 505 506 507 508
/**
 * Implementation of hook_update().
 */
function forum_update($node) {
  db_query('UPDATE {forum} SET tid = %d WHERE nid = %d', $node->tid, $node->nid);
}

509 510 511
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
512
function forum_form(&$node) {
Dries's avatar
 
Dries committed
513
  if (!$node->nid) {
Dries's avatar
Dries committed
514
    // new topic
Dries's avatar
 
Dries committed
515
    $node->taxonomy[] = arg(3);
516
  }
Dries's avatar
 
Dries committed
517 518 519
  else {
    $node->taxonomy = array($node->tid);
  }
520

Dries's avatar
 
Dries committed
521
  $output = implode('', taxonomy_node_form('forum', $node));
Dries's avatar
Dries committed
522 523 524

  if ($node->nid) {
    // if editing, give option to leave shadows
Dries's avatar
 
Dries committed
525 526
    $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
527
  }
Dries's avatar
 
Dries committed
528

529
  $output .= form_textarea(t('Body'), 'body', $node->body, 60, 20, '');
530
  $output .= filter_form('format', $node->format);
Dries's avatar
 
Dries committed
531 532 533 534

  return $output;
}

535 536 537
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
538
function forum_insert($node) {
Dries's avatar
 
Dries committed
539
  db_query('INSERT INTO {forum} (nid, tid) VALUES (%d, %d)', $node->nid, $node->tid);
Dries's avatar
 
Dries committed
540 541
}

542 543 544
/**
 * Implementation of hook_delete().
 */
Dries's avatar
 
Dries committed
545
function forum_delete(&$node) {
Dries's avatar
 
Dries committed
546
  db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
547
}
Dries's avatar
 
Dries committed
548

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

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

Dries's avatar
 
Dries committed
578 579 580 581
  if (!$tid) {
    $tid = 0;
  }

Dries's avatar
 
Dries committed
582 583
  $forums = array();
  $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
Dries's avatar
 
Dries committed
584

Dries's avatar
 
Dries committed
585
  if (count($_forums)) {
Dries's avatar
 
Dries committed
586

Dries's avatar
 
Dries committed
587 588
    $counts = array();

Dries's avatar
 
Dries committed
589
    $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";
590
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
591
    $_counts = db_query($sql, $forum->tid);
Dries's avatar
 
Dries committed
592 593 594
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
595
  }
Dries's avatar
 
Dries committed
596

Dries's avatar
 
Dries committed
597 598 599 600
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
601

Dries's avatar
 
Dries committed
602 603 604 605 606 607 608 609 610 611 612
    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
613
    // used to join node_comment_statistics to users.
Dries's avatar
 
Dries committed
614
    $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";
615
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
616
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
617 618

    $last_post = new StdClass();
Dries's avatar
 
Dries committed
619 620 621 622
    $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
623

Dries's avatar
 
Dries committed
624 625 626 627
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
628 629
}

630 631 632 633
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
634
  $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'";
635
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
636 637
  $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";
638
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
639
  $recent = db_result(db_query($sql, $uid, $term, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
640

641
  return $ancient + $recent;
Dries's avatar
 
Dries committed
642 643
}

Dries's avatar
Dries committed
644
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
645
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
646

Dries's avatar
 
Dries committed
647
  $forum_topic_list_header = array(
Dries's avatar
 
Dries committed
648 649
    array('data' => '&nbsp;'),
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
650
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
651
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
652
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
653
  );
Dries's avatar
 
Dries committed
654

Dries's avatar
 
Dries committed
655
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
656
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
657 658
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
659 660 661 662
    }
  }

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

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

667
  $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
668

Steven Wittens's avatar
Steven Wittens committed
669
  $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
Dries's avatar
 
Dries committed
670 671

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

Dries's avatar
 
Dries committed
689
    if ($topic->num_comments > 0) {
690
      $last_reply = new StdClass();
Dries's avatar
 
Dries committed
691 692 693 694 695
      $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
696 697 698
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
699
  return $topics;
Dries's avatar
 
Dries committed
700 701
}

Dries's avatar
 
Dries committed
702 703 704
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
705
function _forum_new($tid) {
Dries's avatar
 
Dries committed
706 707
  global $user;

Dries's avatar
 
Dries committed
708
  $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";
709
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
710
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
711 712 713 714

  return $nid ? $nid : 0;
}

715
/**
Dries's avatar
Dries committed
716
 * Menu callback; prints a forum listing.
717
 */
Dries's avatar
Dries committed
718
function forum_page($tid = 0) {
Dries's avatar
 
Dries committed
719
  global $user;
Dries's avatar
 
Dries committed
720

Dries's avatar
 
Dries committed
721
  if (module_exist('taxonomy')) {
Dries's avatar
Dries committed
722 723
    $forum_per_page = variable_get('forum_per_page', 25);
    $sortby = variable_get('forum_order', 1);
Dries's avatar
 
Dries committed
724

Dries's avatar
Dries committed
725 726 727 728
    $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
729
    }
Dries's avatar
Dries committed
730

731
    print theme('page', theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page));
Dries's avatar
 
Dries committed
732 733
  }
  else {
734 735
    drupal_set_title(t('Warning'));
    print theme('page', forum_help('admin/settings/forum'));
Dries's avatar
 
Dries committed
736 737 738
  }
}

Dries's avatar
 
Dries committed
739
/**
Dries's avatar
 
Dries committed
740 741
 * Format the forum body.
 *
Dries's avatar
 
Dries committed
742
 * @ingroup themeable
Dries's avatar
 
Dries committed
743
 */
Dries's avatar
 
Dries committed
744
function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
745
  global $user;
Dries's avatar
 
Dries committed
746
  // forum list, topics list, topic browser and 'add new topic' link
Dries's avatar
 
Dries committed
747

Dries's avatar
 
Dries committed
748
  $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
749
  $title = $vocabulary->name;
Dries's avatar
 
Dries committed
750

Dries's avatar
 
Dries committed
751 752
  // Breadcrumb navigation:
  $breadcrumb = array();
Dries's avatar
 
Dries committed
753
  if ($tid) {
Dries's avatar
 
Dries committed
754
    $breadcrumb[] = array('path' => 'forum', 'title' => $title);
Dries's avatar
 
Dries committed
755
  }
Dries's avatar
 
Dries committed
756 757

  if ($parents) {
Dries's avatar
 
Dries committed
758 759
    $parents = array_reverse($parents);
    foreach ($parents as $p) {
760 761
      if ($p->tid == $tid) {
        $title = $p->name;
Dries's avatar
 
Dries committed
762 763
      }
      else {
Dries's avatar
 
Dries committed
764
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
765 766 767
      }
    }
  }
768 769 770

  drupal_set_title($title);

Dries's avatar
 
Dries committed
771 772
  $breadcrumb[] = array('path' => $_GET['q']);
  menu_set_location($breadcrumb);
Dries's avatar
 
Dries committed
773

Dries's avatar
 
Dries committed
774
  if (count($forums) || count($parents)) {
775 776
    $output  = '<div id="forum">';
    $output .= '<ul>';
Dries's avatar
 
Dries committed
777 778 779

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

Dries's avatar
 
Dries committed
783
      $output .= ' <li>'. l(t('Active forum discussions.'), 'tracker') .'</li>';
Dries's avatar
 
Dries committed
784 785 786
    }

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

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

Dries's avatar
 
Dries committed
799
    if ($tid && !in_array($tid, variable_get('forum_containers', array()))) {
Dries's avatar
 
Dries committed
800 801
      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
802
      $output .= theme('forum_topic_list', $tid, $topics, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
803
      $output .= theme('xml_icon', url("taxonomy/term/$tid/0/feed"));
Dries's avatar
 
Dries committed
804
    }
805
    $output .= '</div>';
Dries's avatar
 
Dries committed
806 807
  }
  else {
808
    drupal_set_title(t('No forums defined'));
Dries's avatar
 
Dries committed
809
    $output = '';
Dries's avatar
 
Dries committed
810 811
  }

812
  return $output;
Dries's avatar
 
Dries committed
813 814
}

Dries's avatar
 
Dries committed
815
/**
Dries's avatar
 
Dries committed
816 817
 * Format the forum listing.
 *
Dries's avatar
 
Dries committed
818
 * @ingroup themeable
Dries's avatar
 
Dries committed
819
 */
Dries's avatar
 
Dries committed
820
function theme_forum_list($forums, $parents, $tid) {
Dries's avatar
 
Dries committed
821 822
  global $user;

Dries's avatar
 
Dries committed
823 824
  if ($forums) {

Dries's avatar
 
Dries committed
825
    $header = array(t('Forum'), t('Topics'), t('Posts'), t('Last post'));
Dries's avatar
 
Dries committed
826 827

    foreach ($forums as $forum) {
Dries's avatar
 
Dries committed
828
      if ($forum->container) {
829 830
        $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
831 832 833 834 835 836

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

Dries's avatar
 
Dries committed
837
        $rows[] = array(array('data' => $description, 'class' => 'container', 'colspan' => '4'));
838
      }
Dries's avatar
 
Dries committed
839
      else {
840
        $forum->old_topics = _forum_topics_read($forum->tid, $user->uid);
Dries's avatar
 
Dries committed
841 842 843
        if ($user->uid) {
          $new_topics = $forum->num_topics - $forum->old_topics;
        }
Dries's avatar
 
Dries committed
844 845 846
        else {
          $new_topics = 0;
        }
Dries's avatar
 
Dries committed
847

848 849
        $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
850

Dries's avatar
 
Dries committed
851 852 853 854
        if ($forum->description) {
          $description .= " <div class=\"description\">$forum->description</div>\n";
        }
        $description .= "</div>\n";
Dries's avatar
 
Dries committed
855

Dries's avatar
 
Dries committed
856
        $rows[] = array(
Dries's avatar
 
Dries committed
857
          array('data' => $description, 'class' => 'forum'),
858
          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
859 860
          array('data' => $forum->num_posts, 'class' => 'posts'),
          array('data' => _forum_format($forum->last_post), 'class' => 'last-reply'));
Dries's avatar
 
Dries committed
861
      }
Dries's avatar
 
Dries committed
862
    }
Dries's avatar
 
Dries committed
863 864 865

    return theme('table', $header, $rows);

Dries's avatar
 
Dries committed
866 867 868 869
  }

}

Dries's avatar
 
Dries committed
870
/**
Dries's avatar
 
Dries committed
871 872
 * Format the topic listing.
 *
Dries's avatar
 
Dries committed
873
 * @ingroup themeable
Dries's avatar
 
Dries committed
874
 */
Dries's avatar
 
Dries committed
875 876
function theme_forum_topic_list($tid, $topics, $sortby, $forum_per_page) {
  global $forum_topic_list_header;
Dries's avatar
 
Dries committed
877 878

  if ($topics) {
Dries's avatar
 
Dries committed
879

Dries's avatar
 
Dries committed
880 881
    foreach ($topics as $topic) {
      // folder is new if topic is new or there are new comments since last visit