forum.module 33.2 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 31
/**
 * Implementation of hook_node_name().
 */
Dries's avatar
 
Dries committed
32
function forum_node_name($node) {
Dries's avatar
 
Dries committed
33
  return t('forum topic');
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 94 95 96 97 98 99 100 101 102 103 104 105 106 107
        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();
  }

Dries's avatar
 
Dries committed
108
  return $output;
109 110 111 112 113 114 115
}

/**
 * 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
116
    $results = db_query('SELECT f.nid FROM {forum} f WHERE f.tid = %d', $object->tid);
117 118 119 120
    while ($node = db_fetch_object($results)) {
      $edit['nid'] = $node->nid;
      $edit['confirm'] = TRUE;
      node_delete($edit);
Dries's avatar
 
Dries committed
121
    }
122 123
  }
}
Dries's avatar
 
Dries committed
124

125 126 127 128 129
/**
 * Returns a confirmation page for deleting a forum taxonomy term
 *
 * @param $tid ID of the term to be deleted
 */
130
function _forum_confirm_delete($tid) {
131 132 133 134 135 136 137 138 139 140
  $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);
141
  return $output;
142 143 144 145 146 147 148 149
}

/**
 * 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()) {
150 151
  $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.'));
152

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

  $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()) {
172 173
  $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.'));
174

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

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

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

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

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

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

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

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

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

  return $vid;
}

/**
 * Implementation of hook_settings
 */
291 292 293
function forum_admin_configure() {
  system_settings_save();

294 295 296 297 298 299 300 301
  $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
302
  return system_settings_form($output);
303 304
}

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

  return $forum;
}

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

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

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

335 336
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
337 338
        switch ($delta) {
          case 0:
339 340 341 342
            $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
343 344

          case 1:
345 346 347 348
            $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
349
        }
Dries's avatar
 
Dries committed
350

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

        return $block;
      }
  }
Dries's avatar
 
Dries committed
361 362
}

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

Dries's avatar
 
Dries committed
369 370
  $links = array();

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

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

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

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

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

Dries's avatar
 
Dries committed
404
  return $links;
Dries's avatar
 
Dries committed
405 406
}

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

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

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

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

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

  return $items;
}

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

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

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

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

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

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

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

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

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

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

  return $output;
}

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

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

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

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

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

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

Dries's avatar
 
Dries committed
593
  if (count($_forums)) {
Dries's avatar
 
Dries committed
594

Dries's avatar
 
Dries committed
595 596
    $counts = array();

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

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

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

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

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

  return $forums;
Dries's avatar
 
Dries committed
636 637
}

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

649
  return $ancient + $recent;
Dries's avatar
 
Dries committed
650 651
}

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

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

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

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

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

675
  $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
676

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

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

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

Dries's avatar
Dries committed
707
  return $topics;
Dries's avatar
 
Dries committed
708 709
}

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

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

  return $nid ? $nid : 0;
}

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

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

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

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

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

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

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

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

  drupal_set_title($title);

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

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

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

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

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

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

Dries's avatar
 
Dries committed
807
    if ($tid && !in_array($tid, variable_get('forum_containers', array()))) {
Dries's avatar
 
Dries committed
808 809
      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
810
      $output .= theme('forum_topic_list', $tid, $topics, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
811
      $output .= theme('xml_icon', url("taxonomy/term/$tid/0/feed"));
Dries's avatar
 
Dries committed
812
    }
813
    $output .= '</div>';
Dries's avatar
 
Dries committed
814 815
  }
  else {
816
    drupal_set_title(t('No forums defined'));
Dries's avatar
 
Dries committed
817
    $output = '';
Dries's avatar
 
Dries committed
818 819
  }

820
  return $output;
Dries's avatar
 
Dries committed
821 822
}

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

Dries's avatar
 
Dries committed
831 832
  if ($forums) {

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

    foreach ($forums as $forum) {
Dries's avatar
 
Dries committed
836
      if ($forum->container) {
837 838
        $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
839 840 841 842 843 844

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

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

856 857
        $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
858

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

Dries's avatar
 
Dries committed
864
        $rows[] = array(
Dries's avatar
 
Dries committed
865
          array('data' => $description, 'class' => 'forum'),