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

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

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

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

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

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

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

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

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

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

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

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

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

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

161
  $form['tid'] = array('#type' => 'hidden', '#value' => $tid);
162 163 164

  return confirm_form('forum_confirm_delete', $form, t('Are you sure you want to delete the forum %name?', array('%name' => theme('placeholder', $term->name))),
                  'admin/forums', t('Deleting a forum or container will delete all sub-forums as well. This action cannot be undone.'), t('Delete'), t('Cancel'));
165 166 167 168 169 170 171 172
}

/**
 * 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()) {
173 174 175
  $form['name'] = array('#title' => t('Container name'), '#type' => 'textfield', '#default_value' => $edit['name'], '#size' => 60, '#maxlength' =>  64, '#description' => t('The container name is used to identify related forums.'), '#required' => TRUE);
  $form['description'] = array('#type' => 'textarea', '#title' => t('Description'), '#default_value' => $edit['description'], '#cols' => 60, '#rows' => 5, '#description' => ('The container description can give users more information about the forums it contains.'));
  $form['parent']['#tree'] = TRUE;
176
  $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'container');
177
  $form['weight'] = array('#type' => 'weight', '#title' => t('Weight'), '#default_value' => $edit['weight'], '#delta' => 10, '#description' => 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.'));
178

179 180
  $form['vid'] = array('#type' => 'hidden', '#value' => _forum_get_vid());
  $form['submit'] = array('#type' => 'submit', '#value' => t('Submit'));
181
  if ($edit['tid']) {
182 183
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['tid'] = array('#type' => 'hidden', '#value' => $edit['tid']);
184 185
  }

186
  return drupal_get_form('forum_form_container', $form);
187 188 189 190 191 192 193 194
}

/**
 * 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()) {
195 196 197
  $form['name'] = array('#type' => 'textfield', '#title' => t('Forum name'), '#default_value' => $edit['name'], '#size' => 60, '#maxlength' =>  64, '#description' => t('The forum name is used to identify related discussions.'), '#required' => TRUE);
  $form['description'] = array('#type' => 'textarea', '#title' => t('Description'), '#default_value' => $edit['description'], '#cols' => 60, '#rows' => 5, '#description' => ('The forum description can give users more information about the discussion topics it contains.'));
  $form['parent']['#tree'] = TRUE;
198
  $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'forum');
199
  $form['weight'] = array('#type' => 'weight', '#title' => t('Weight'), '#default_value' => $edit['weight'], '#delta' => 10, '#description' => t('When listing forums, those with with light (small) weights get listed before containers with heavier (larger) weights. Forums with equal weights are sorted alphabetically.'));
200

201 202
  $form['vid'] = array('#type' => 'hidden', '#value' => _forum_get_vid());
  $form['submit' ] = array('#type' => 'submit', '#value' => t('Submit'));
203
  if ($edit['tid']) {
204 205
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['tid'] = array('#type' => 'hidden', '#value' => $edit['tid']);
206
  }
207

208
  return drupal_get_form('forum_form_forum', $form);
209 210 211 212 213 214 215
}

/**
 * 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
216
 * @param $child_type Whether the child is forum or container
217
 */
218
function _forum_parent_select($tid, $title, $child_type) {
219 220

  $parents = taxonomy_get_parents($tid);
221 222 223 224 225 226 227 228
  if ($parents) {
    $parent = array_shift($parents);
    $parent = $parent->tid;
  }
  else {
    $parent = 0;
  }

229 230 231 232 233 234 235 236 237 238 239 240 241
  $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)) {
242
        $options[$term->tid] = _taxonomy_depth($term->depth) . $term->name;
243
      }
Dries's avatar
 
Dries committed
244 245
    }
  }
246 247 248 249 250 251
  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
252

253
  return array('#type' => 'select', '#title' => $title, '#default_value' => $parent, '#options' => $options, '#description' => $description, '#required' => TRUE);
Dries's avatar
 
Dries committed
254 255
}

256
/**
257
 * Returns an overview list of existing forums and containers
258
 */
259 260 261 262 263 264 265
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()))) {
266
        $rows[] = array(_taxonomy_depth($term->depth) .' '. check_plain($term->name), l(t('edit container'), "admin/forum/edit/container/$term->tid"));
267 268
      }
      else {
269
        $rows[] = array(_taxonomy_depth($term->depth) .' '. check_plain($term->name), l(t('edit forum'), "admin/forum/edit/forum/$term->tid"));
270 271
       }

Dries's avatar
Dries committed
272 273
    }
  }
274
  else {
275
    $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));
276 277
  }
  return theme('table', $header, $rows);
Dries's avatar
Dries committed
278 279
}

280 281 282 283 284 285 286
/**
 * 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
Dries's avatar
Dries committed
287
    $vid = db_result(db_query("SELECT vid FROM {vocabulary} WHERE module = '%s'", 'forum'));
288
    if (!$vid) {
289
      $edit = array('name' => 'Forums', 'multiple' => 0, 'required' => 1, 'hierarchy' => 1, 'relations' => 0, 'module' => 'forum', 'nodes' => array('forum' => 1));
290 291
      taxonomy_save_vocabulary($edit);
      $vid = $edit['vid'];
292 293 294 295 296 297 298 299 300 301
    }
    variable_set('forum_nav_vocabulary', $vid);
  }

  return $vid;
}

/**
 * Implementation of hook_settings
 */
302
function forum_admin_configure() {
303

304
  $form = array();
305
  $form['forum_icon_path'] = array('#type' => 'textfield', '#title' => t('Forum icon path'), '#default_value' => variable_get('forum_icon_path', ''), '#size' => 30, '#maxlength' =>  255, '#description' => 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. '));
306
  $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 10000));
307
  $form['forum_hot_topic'] = array('#type' => 'select', '#title' => t('Hot topic threshold'), '#default_value' => variable_get('forum_hot_topic', 15), '#options' => $number, '#description' => t('The number of posts a topic must have to be considered hot.'));
308
  $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
309
  $form['forum_per_page'] = array('#type' => 'select', '#title' => t('Topics per page'), '#default_value' => variable_get('forum_per_page', 25), '#options' => $number, '#description' => t('The default number of topics displayed per page; links to browse older messages are automatically being displayed.'));
310
  $forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4=> t('Posts - least active first'));
311
  $form['forum_order'] = array('#type' => 'radios', '#title' => t('Default order'), '#default_value' => variable_get('forum_order', '1'), '#options' => $forder, '#description' => t('The default display order for topics.'));
312

313
  return system_settings_form('forum_admin_configure', $form);
314 315
}

316 317 318
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
319
function forum_load($node) {
320
  $forum = db_fetch_object(db_query('SELECT * FROM {forum} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
321 322 323 324

  return $forum;
}

325 326 327 328 329 330
/**
 * Implementation of hook_block().
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
331 332 333
function forum_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
Dries's avatar
 
Dries committed
334 335
      $blocks[0]['info'] = t('Active forum topics');
      $blocks[1]['info'] = t('New forum topics');
336
      return $blocks;
Dries's avatar
 
Dries committed
337

338
    case 'configure':
339
      $form['forum_block_num_'. $delta] = array('#type' => 'select', '#title' => t('Number of topics'), '#default_value' => variable_get('forum_block_num_'. $delta, '5'), '#options' => drupal_map_assoc(array(2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20)));
340
      return $form;
Dries's avatar
 
Dries committed
341

342
    case 'save':
343
      variable_set('forum_block_num_'. $delta, $edit['forum_block_num_'. $delta]);
344
      break;
Dries's avatar
 
Dries committed
345

346 347
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
348 349
        switch ($delta) {
          case 0:
350
            $title = t('Active forum topics');
351
            $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");
352 353 354 355
            $result = db_query_range($sql, 0, variable_get('forum_block_num_0', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
356
            break;
Dries's avatar
 
Dries committed
357 358

          case 1:
359 360
            $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");
361 362 363 364
            $result = db_query_range($sql, 0, variable_get('forum_block_num_1', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
365
            break;
Dries's avatar
 
Dries committed
366
        }
Dries's avatar
 
Dries committed
367

368
        if ($content) {
Steven Wittens's avatar
Steven Wittens committed
369
          $content .= '<div class="more-link">'. l(t('more'), 'forum', array('#title' => t('Read the latest forum topics.'))) .'</div>';
370 371
        }

Dries's avatar
 
Dries committed
372
        $block['subject'] = $title;
373 374 375 376 377
        $block['content'] = $content;

        return $block;
      }
  }
Dries's avatar
 
Dries committed
378 379
}

Dries's avatar
 
Dries committed
380 381 382
/**
 * Implementation of hook_link().
 */
383
function forum_link($type, $node = 0, $main = 0) {
Dries's avatar
Dries committed
384
  global $user;
Dries's avatar
 
Dries committed
385

Dries's avatar
 
Dries committed
386 387
  $links = array();

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

Steven Wittens's avatar
Steven Wittens committed
391
    $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));
392
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
393
    $result = db_query($sql, $node->tid);
Dries's avatar
 
Dries committed
394 395 396

    while ($topic = db_fetch_object($result)) {
      if ($stop == 1) {
397
        $next = new StdClass();
Dries's avatar
 
Dries committed
398 399 400 401 402 403 404 405
        $next->nid = $topic->nid;
        $next->title = $topic->title;
        break;
      }
      if ($topic->nid == $node->nid) {
        $stop = 1;
      }
      else {
406
        $prev = new StdClass();
Dries's avatar
 
Dries committed
407 408 409 410 411 412
        $prev->nid = $topic->nid;
        $prev->title = $topic->title;
      }
    }

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

    if ($next) {
417
      $links[] = l(t('next forum topic'), "node/$next->nid", array('title' => check_plain($next->title)));
Dries's avatar
 
Dries committed
418
    }
Dries's avatar
 
Dries committed
419 420
  }

Dries's avatar
 
Dries committed
421
  return $links;
Dries's avatar
 
Dries committed
422 423
}

424 425 426 427
function forum_term_path($term) {
  return 'forum/'. $term->tid;
}

Dries's avatar
 
Dries committed
428 429 430
/**
 * Implementation of hook_menu().
 */
Dries's avatar
 
Dries committed
431
function forum_menu($may_cache) {
Dries's avatar
 
Dries committed
432 433
  $items = array();

Dries's avatar
 
Dries committed
434 435 436
  if ($may_cache) {
    $items[] = array('path' => 'node/add/forum', 'title' => t('forum topic'),
      'access' => user_access('create forum topics'));
437

Dries's avatar
 
Dries committed
438 439 440
    $items[] = array('path' => 'forum', 'title' => t('forums'),
      'callback' => 'forum_page',
      'access' => user_access('access content'),
441
      'type' => MENU_SUGGESTED_ITEM);
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456

    $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);
457 458 459 460
    $items[] = array('path' => 'admin/forum/configure', 'title' => t('configure'),
      'callback' => 'forum_admin_configure',
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
461 462 463 464 465 466 467

    $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
468
  }
Dries's avatar
 
Dries committed
469 470 471 472

  return $items;
}

473 474 475
/**
 * Implementation of hook_view().
 */
Dries's avatar
 
Dries committed
476
function forum_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
 
Dries committed
477

Dries's avatar
 
Dries committed
478
  if ($page) {
Dries's avatar
 
Dries committed
479
    $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
Dries's avatar
 
Dries committed
480
    // Breadcrumb navigation
Dries's avatar
 
Dries committed
481 482
    $breadcrumb = array();
    $breadcrumb[] = array('path' => 'forum', 'title' => $vocabulary->name);
Dries's avatar
 
Dries committed
483
    if ($parents = taxonomy_get_parents_all($node->tid)) {
Dries's avatar
 
Dries committed
484 485
      $parents = array_reverse($parents);
      foreach ($parents as $p) {
Dries's avatar
 
Dries committed
486
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
487 488
      }
    }
Dries's avatar
 
Dries committed
489 490
    $breadcrumb[] = array('path' => 'node/'. $node->nid);
    menu_set_location($breadcrumb);
491
  }
Dries's avatar
 
Dries committed
492

493
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
494 495
}

496 497 498 499 500 501
/**
 * Implementation of hook_validate().
 *
 * Check in particular that only a "leaf" term in the associated taxonomy
 * vocabulary is selected, not a "container" term.
 */
502 503
function forum_validate(&$node) {
  // Make sure all fields are set properly:
Dries's avatar
 
Dries committed
504
  $node->icon = $node->icon ? $node->icon : '';
Dries's avatar
 
Dries committed
505

506 507
  node_validate_title($node,t('You have to specify a subject.'));

Dries's avatar
 
Dries committed
508 509
  if ($node->taxonomy) {
    // Extract the node's proper topic ID.
Dries's avatar
 
Dries committed
510
    $vocabulary = variable_get('forum_nav_vocabulary', '');
511
    $containers = variable_get('forum_containers', array());
Dries's avatar
 
Dries committed
512
    foreach ($node->taxonomy as $term) {
Dries's avatar
 
Dries committed
513
      if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
514 515
        if (in_array($term, $containers)) {
          $term = taxonomy_get_term($term);
516
          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))));
517 518 519 520
        }
        else {
          $node->tid = $term;
        }
Dries's avatar
 
Dries committed
521
      }
522
    }
Dries's avatar
 
Dries committed
523 524 525 526 527 528 529
    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
530 531 532
  }
}

Dries's avatar
 
Dries committed
533 534 535 536
/**
 * Implementation of hook_update().
 */
function forum_update($node) {
537 538 539 540 541 542
  if ($node->is_new || $node->revision) {
    db_query("INSERT INTO {forum} (nid, vid, tid) VALUES (%d, %d, %d)", $node->nid, $node->vid, $node->tid);
  }
  else {
    db_query('UPDATE {forum} SET tid = %d WHERE vid = %d', $node->tid, $node->vid);
  }
Dries's avatar
 
Dries committed
543 544
}

545 546 547
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
548
function forum_form(&$node) {
549
  $form['title'] = array('#type' => 'textfield', '#title' => t('Subject'), '#default_value' => $node->title, '#size' => 60, '#maxlength' => 128, '#required' => TRUE);
550

Dries's avatar
 
Dries committed
551
  if (!$node->nid) {
Dries's avatar
Dries committed
552
    // new topic
Dries's avatar
 
Dries committed
553
    $node->taxonomy[] = arg(3);
554
  }
Dries's avatar
 
Dries committed
555 556 557
  else {
    $node->taxonomy = array($node->tid);
  }
558

Dries's avatar
Dries committed
559 560
  if ($node->nid) {
    // if editing, give option to leave shadows
Dries's avatar
 
Dries committed
561
    $shadow = (count(taxonomy_node_get_terms($node->nid)) > 1);
562
    $form['shadow'] = array('#type' => 'checkbox', 'title' => t('Leave shadow copy'),  '#default_value' => $shadow, '#description' => t('If you move this topic, you can leave a link in the old forum to the new forum.'));
Dries's avatar
Dries committed
563
  }
Dries's avatar
 
Dries committed
564

565
  $form['body'] = array('#type' => 'textarea', '#title' => t('Body'), '#default_value' => $node->body, '#required' => TRUE
566 567
  );
  $form = array_merge($form, filter_form($node->format));
Dries's avatar
 
Dries committed
568

569
  return $form;
Dries's avatar
 
Dries committed
570 571
}

572 573 574
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
575
function forum_insert($node) {
576
  db_query('INSERT INTO {forum} (nid, vid, tid) VALUES (%d, %d, %d)', $node->nid, $node->vid, $node->tid);
Dries's avatar
 
Dries committed
577 578
}

579 580 581
/**
 * Implementation of hook_delete().
 */
Dries's avatar
 
Dries committed
582
function forum_delete(&$node) {
Dries's avatar
 
Dries committed
583
  db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
584
}
Dries's avatar
 
Dries committed
585

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

Dries's avatar
 
Dries committed
600 601 602
/**
 * Returns a list of all forums for a given taxonomy id
 *
603
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
604 605 606 607 608 609 610 611 612
 * -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
613
function forum_get_forums($tid = 0) {
614

Dries's avatar
 
Dries committed
615 616 617 618
  if (!$tid) {
    $tid = 0;
  }

Dries's avatar
 
Dries committed
619 620
  $forums = array();
  $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
Dries's avatar
 
Dries committed
621

Dries's avatar
 
Dries committed
622
  if (count($_forums)) {
Dries's avatar
 
Dries committed
623

Dries's avatar
 
Dries committed
624 625
    $counts = array();

Dries's avatar
 
Dries committed
626
    $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";
627
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
628
    $_counts = db_query($sql, $forum->tid);
Dries's avatar
 
Dries committed
629 630 631
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
632
  }
Dries's avatar
 
Dries committed
633

Dries's avatar
 
Dries committed
634 635 636 637
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
638

Dries's avatar
 
Dries committed
639 640 641 642 643 644 645 646 647 648 649
    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
650
    // used to join node_comment_statistics to users.
651
    $sql = "SELECT n.nid, l.last_comment_timestamp, IF(l.last_comment_uid != 0, cu.name, l.last_comment_name) as last_comment_name, l.last_comment_uid FROM {node} n, {node_comment_statistics} l, {users} cu, {term_node} r WHERE  n.nid = r.nid AND r.tid = %d AND n.status = 1 AND n.type = 'forum' AND l.last_comment_uid = cu.uid AND n.nid = l.nid ORDER BY l.last_comment_timestamp DESC";
652
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
653
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
654 655

    $last_post = new StdClass();
Dries's avatar
 
Dries committed
656 657 658 659
    $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
660

Dries's avatar
 
Dries committed
661 662 663 664
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
665 666
}

667 668 669 670
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
671
  $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'";
672
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
673 674
  $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";
675
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
676
  $recent = db_result(db_query($sql, $uid, $term, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
677

678
  return $ancient + $recent;
Dries's avatar
 
Dries committed
679 680
}

Dries's avatar
Dries committed
681
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
682
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
683

Dries's avatar
 
Dries committed
684
  $forum_topic_list_header = array(
Dries's avatar
 
Dries committed
685 686
    array('data' => '&nbsp;'),
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
687
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
688
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
689
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
690
  );
Dries's avatar
 
Dries committed
691

Dries's avatar
 
Dries committed
692
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
693
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
694 695
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
696 697 698 699
    }
  }

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

701
  $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 != 0, 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.vid = f.vid");
Dries's avatar
 
Dries committed
702
  $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
703
  $sql .= ', n.created DESC';  // Always add a secondary sort order so that the news forum topics are on top.
Dries's avatar
Dries committed
704

705
  $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
706

Steven Wittens's avatar
Steven Wittens committed
707
  $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
Dries's avatar
 
Dries committed
708 709

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

Dries's avatar
 
Dries committed
727
    if ($topic->num_comments > 0) {
728
      $last_reply = new StdClass();
Dries's avatar
 
Dries committed
729 730 731 732 733
      $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
734 735 736
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
737
  return $topics;
Dries's avatar
 
Dries committed
738 739
}

Dries's avatar
 
Dries committed
740 741 742
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
743
function _forum_new($tid) {
Dries's avatar
 
Dries committed
744 745
  global $user;

Dries's avatar
 
Dries committed
746
  $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";
747
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
748
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
749 750 751 752

  return $nid ? $nid : 0;
}

753
/**
Dries's avatar
Dries committed
754
 * Menu callback; prints a forum listing.
755
 */
Dries's avatar
Dries committed
756
function forum_page($tid = 0) {
Dries's avatar
 
Dries committed
757
  global $user;
Dries's avatar
 
Dries committed
758

759
  if (module_exist('taxonomy') && module_exist('comment')) {
Dries's avatar
Dries committed
760 761
    $forum_per_page = variable_get('forum_per_page', 25);
    $sortby = variable_get('forum_order', 1);
Dries's avatar
 
Dries committed
762

Dries's avatar
Dries committed
763 764 765 766
    $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
767
    }
Dries's avatar
Dries committed
768

Dries's avatar
 
Dries committed
769
    return theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
770 771
  }
  else {
772 773
    drupal_set_message(t('The forum module requires both the taxonomy module and the comment module to be enabled and configured.'), 'error');
    return ' ';
Dries's avatar
 
Dries committed
774 775 776
  }
}

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

Dries's avatar
 
Dries committed
786
  $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
787
  $title = $vocabulary->name;
Dries's avatar
 
Dries committed
788

Dries's avatar
 
Dries committed
789 790
  // Breadcrumb navigation:
  $breadcrumb = array();
Dries's avatar
 
Dries committed
791
  if ($tid) {
Dries's avatar
 
Dries committed
792
    $breadcrumb[] = array('path' => 'forum', 'title' => $title);
Dries's avatar
 
Dries committed
793
  }
Dries's avatar
 
Dries committed
794 795

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

  drupal_set_title($title);

Dries's avatar
 
Dries committed
809