forum.module 38.4 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 15 16 17 18 19 20 21 22 23 24 25
    case 'admin/help#forum':
      $output = '<p>'. t('The forum module lets you create threaded discussion forums for a particular topic on your site. This is similar to a message board system such as phpBB. Forums are very useful because they allow community members to discuss topics with one another, and they are archived for future reference.') .'</p>';
      $output .= '<p>'. t('Forums can be organized under what are called <em>containers</em>. 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.  Forum topics can be moved by selecting a different forum and can be left in the existing forum by selecting <em>leave a shadow copy</em>.  Forum topics can also have their own URL.') .'</p>';
      $output .= '<p>'. t('Forums module <strong>requires Taxonomy and Comments module</strong> be enabled.') .'</p>';
      $output .= t('<p>You can</p>
<ul>
<li>administer forums at <a href="%admin-forum">administer &gt;&gt; forums</a>.</li>
<li>enable the required comment and taxonomy modules at <a href="%admin-modules">administer &gt;&gt; modules</a>.</li>
<li>read about the comment module at <a href="%admin-help-comment">administer &gt;&gt; help &gt;&gt; comment</a>.</li>
<li>read about the taxonomy module at <a href="%admin-help-taxonomy">administer &gt;&gt; help &gt;&gt; taxonomy</a>.</li>
</ul>
', array('%admin-forum' => url('admin/forum'), '%admin-modules' => url('admin/modules'), '%admin-help-comment' => url('admin/help/comment'), '%admin-help-taxonomy' => url('admin/help/taxonomy')));
26
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="%forum">Forum page</a>.', array('%forum' => 'http://drupal.org/handbook/modules/forum/')) .'</p>';
27 28 29
      return $output;
    case 'admin/modules#description':
      return t('Enables threaded discussions about general topics.');
30
    case 'admin/forum':
31
      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>');
32
    case 'admin/forum/add/container':
33
      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>');
34
    case 'admin/forum/add/forum':
35
      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>');
36 37
    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
38
    case 'node/add#forum':
39
      return t('Create a new topic for discussion in the forums.');
Dries's avatar
 
Dries committed
40 41 42
  }
}

43
/**
44
 * Implementation of hook_node_info().
45
 */
46
function forum_node_info() {
47
  return array('forum' => array('name' => t('forum topic'), 'base' => 'forum'));
Dries's avatar
 
Dries committed
48 49
}

50 51 52
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
53
function forum_access($op, $node) {
Dries's avatar
 
Dries committed
54 55
  global $user;

Dries's avatar
 
Dries committed
56 57
  if ($op == 'create') {
    return user_access('create forum topics');
Dries's avatar
 
Dries committed
58
  }
Dries's avatar
 
Dries committed
59 60 61 62 63 64

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

67 68 69
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
70
function forum_perm() {
71
  return array('create forum topics', 'edit own forum topics', 'administer forums');
Dries's avatar
 
Dries committed
72
}
Dries's avatar
 
Dries committed
73

74 75 76 77 78
/**
 * Implementation of hook_nodeapi().
 */
function forum_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
79
    case 'delete revision':
80 81 82 83 84 85
      db_query('DELETE FROM {forum} WHERE vid = %d', $node->vid);
      break;
  }
}


86
/**
87
 * Administration page which allows maintaining forums
88
 */
89
function forum_admin($arg = NULL, $type = NULL, $tid = NULL) {
90 91 92
  $op = $_POST['op'];
  $edit = $_POST['edit'];

93 94
  if ($op == t('Delete') || $edit['confirm']) {
    return _forum_confirm_delete($tid);
95
  }
Dries's avatar
 
Dries committed
96

97
  switch ($arg) {
98
    case 'add':
99
      if ($type == 'forum') {
100 101
        $output = forum_form_forum();
      }
102
      else if ($type == 'container') {
103 104 105 106
        $output = forum_form_container();
      }
      break;
    case 'edit':
107 108
      if ($type == 'forum') {
        $output = forum_form_forum((array)taxonomy_get_term($tid));
109
      }
110 111
      else if ($type == 'container') {
         $output = forum_form_container((array)taxonomy_get_term($tid));
112 113 114 115 116 117
      }
      break;
    default:
      $output = forum_overview();
  }

Dries's avatar
 
Dries committed
118
  return $output;
119 120 121 122 123
}

/**
 * Implementation of hook_taxonomy().
 */
124
function forum_taxonomy($op, $type, $object = NULL) {
125
  if ($op == 'delete' && $type == 'term' && $object->vid == _forum_get_vid())  {
Dries's avatar
Dries committed
126
    $results = db_query('SELECT f.nid FROM {forum} f WHERE f.tid = %d', $object->tid);
127
    while ($node = db_fetch_object($results)) {
128
      node_delete($node->nid);
Dries's avatar
 
Dries committed
129
    }
130
  }
131 132 133
  elseif ($op == 'delete' && $type == 'vocabulary' && $object->vid == _forum_get_vid())  {
    variable_del('forum_nav_vocabulary');
  }
134
}
Dries's avatar
 
Dries committed
135

136 137 138 139 140
/**
 * Returns a confirmation page for deleting a forum taxonomy term
 *
 * @param $tid ID of the term to be deleted
 */
141
function _forum_confirm_delete($tid) {
142 143
  $term = taxonomy_get_term($tid);

144 145
  $form['tid'] = array('#type' => 'value', '#value' => $tid);
  $form['name'] = array('#type' => 'value', '#value' => $term->name);
146 147 148

  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'));
149 150
}

151 152 153 154 155 156 157 158 159 160 161
/**
 * Implementation of forms api _submit call. Deletes a forum after
 * confirmation.
 */
function forum_confirm_delete_submit($form_id, $form_values) {
  taxonomy_del_term($form_values['tid']);
  drupal_set_message(t('The forum %term has been deleted.', array('%term' => theme('placeholder', $form_values['name']))));

  return 'admin/forum';
}

162 163 164 165 166 167
/**
 * 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()) {
168
  $form['name'] = array(
Dries's avatar
Dries committed
169 170 171 172 173
    '#title' => t('Container name'),
    '#type' => 'textfield',
    '#default_value' => $edit['name'],
    '#maxlength' =>  64,
    '#description' => t('The container name is used to identify related forums.'),
174 175 176 177
    '#required' => TRUE
  );

  $form['description'] = array(
Dries's avatar
Dries committed
178 179 180
    '#type' => 'textarea',
    '#title' => t('Description'),
    '#default_value' => $edit['description'],
181 182
    '#description' => t('The container description can give users more information about the forums it contains.')
  );
183
  $form['parent']['#tree'] = TRUE;
184
  $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'container');
185
  $form['weight'] = array(
Dries's avatar
Dries committed
186 187 188
    '#type' => 'weight',
    '#title' => t('Weight'),
    '#default_value' => $edit['weight'],
189 190
    '#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.')
  );
191

192
  $form['vid'] = array(
Dries's avatar
Dries committed
193
    '#type' => 'hidden',
194 195
    '#value' => _forum_get_vid());
  $form['submit'] = array(
Dries's avatar
Dries committed
196
    '#type' => 'submit',
197 198
    '#value' => t('Submit')
  );
199
  if ($edit['tid']) {
200
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
201
    $form['tid'] = array('#type' => 'value', '#value' => $edit['tid']);
202 203
  }

204
  return drupal_get_form('forum_form_container', $form, 'forum_form');
205 206
}

207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
function forum_form_submit($form_id, $form_values) {
  if ($form_id == 'forum_form_container') {
    $container = TRUE;
    $type = t('forum container');
  }
  else {
    $container = false;
    $type = t('forum');
  }

  $status = taxonomy_save_term($form_values);
  switch ($status) {
    case SAVED_NEW:
      if ($container) {
        $containers = variable_get('forum_containers', array());
        $containers[] = $form_values['tid'];
        variable_set('forum_containers', $containers);
      }
      drupal_set_message(t('Created new %type %term.', array('%term' => theme('placeholder', $form_values['name']), '%type' => $type)));
      break;
    case SAVED_UPDATED:
      drupal_set_message(t('The %type %term has been updated.', array('%term' => theme('placeholder', $form_values['name']), '%type' => $type)));
      break;
  }
  return 'admin/forum';
}


235 236 237 238 239 240
/**
 * 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()) {
241
  $form['name'] = array('#type' => 'textfield', '#title' => t('Forum name'), '#default_value' => $edit['name'], '#maxlength' =>  64, '#description' => t('The forum name is used to identify related discussions.'), '#required' => TRUE);
242
  $form['description'] = array('#type' => 'textarea', '#title' => t('Description'), '#default_value' => $edit['description'], '#description' => t('The forum description can give users more information about the discussion topics it contains.'));
243
  $form['parent']['#tree'] = TRUE;
244
  $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'forum');
245
  $form['weight'] = array('#type' => 'weight', '#title' => t('Weight'), '#default_value' => $edit['weight'], '#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.'));
246

247 248
  $form['vid'] = array('#type' => 'hidden', '#value' => _forum_get_vid());
  $form['submit' ] = array('#type' => 'submit', '#value' => t('Submit'));
249
  if ($edit['tid']) {
250 251
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['tid'] = array('#type' => 'hidden', '#value' => $edit['tid']);
252
  }
253

254
  return drupal_get_form('forum_form_forum', $form, 'forum_form');
255 256 257 258 259 260 261
}

/**
 * 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
262
 * @param $child_type Whether the child is forum or container
263
 */
264
function _forum_parent_select($tid, $title, $child_type) {
265 266

  $parents = taxonomy_get_parents($tid);
267 268 269 270 271 272 273 274
  if ($parents) {
    $parent = array_shift($parents);
    $parent = $parent->tid;
  }
  else {
    $parent = 0;
  }

275
  $children = taxonomy_get_tree(_forum_get_vid(), $tid);
276 277 278 279 280 281 282 283 284 285 286 287

  // 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)) {
288
        $options[$term->tid] = _taxonomy_depth($term->depth) . $term->name;
289
      }
Dries's avatar
 
Dries committed
290 291
    }
  }
292 293 294 295 296 297
  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
298

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

302
/**
303
 * Returns an overview list of existing forums and containers
304
 */
305 306 307 308 309 310 311
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()))) {
312
        $rows[] = array(_taxonomy_depth($term->depth) .' '. check_plain($term->name), l(t('edit container'), "admin/forum/edit/container/$term->tid"));
313 314
      }
      else {
315
        $rows[] = array(_taxonomy_depth($term->depth) .' '. check_plain($term->name), l(t('edit forum'), "admin/forum/edit/forum/$term->tid"));
316 317
       }

Dries's avatar
Dries committed
318 319
    }
  }
320
  else {
321
    $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));
322 323
  }
  return theme('table', $header, $rows);
Dries's avatar
Dries committed
324 325
}

326 327 328 329 330 331 332
/**
 * 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
333
    $vid = db_result(db_query("SELECT vid FROM {vocabulary} WHERE module = '%s'", 'forum'));
334
    if (!$vid) {
335
      $edit = array('name' => 'Forums', 'multiple' => 0, 'required' => 1, 'hierarchy' => 1, 'relations' => 0, 'module' => 'forum', 'nodes' => array('forum' => 1));
336 337
      taxonomy_save_vocabulary($edit);
      $vid = $edit['vid'];
338 339 340 341 342 343 344 345 346 347
    }
    variable_set('forum_nav_vocabulary', $vid);
  }

  return $vid;
}

/**
 * Implementation of hook_settings
 */
348
function forum_admin_configure() {
349

350
  $form = array();
351
  $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 10000));
352
  $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.'));
353
  $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
354
  $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.'));
355
  $forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4=> t('Posts - least active first'));
356
  $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.'));
357

358
  return system_settings_form('forum_admin_configure', $form);
359 360
}

361 362 363
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
364
function forum_load($node) {
365
  $forum = db_fetch_object(db_query('SELECT * FROM {forum} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
366 367 368 369

  return $forum;
}

370 371 372 373 374 375
/**
 * Implementation of hook_block().
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
376 377 378
function forum_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
Dries's avatar
 
Dries committed
379 380
      $blocks[0]['info'] = t('Active forum topics');
      $blocks[1]['info'] = t('New forum topics');
381
      return $blocks;
Dries's avatar
 
Dries committed
382

383
    case 'configure':
384
      $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)));
385
      return $form;
Dries's avatar
 
Dries committed
386

387
    case 'save':
388
      variable_set('forum_block_num_'. $delta, $edit['forum_block_num_'. $delta]);
389
      break;
Dries's avatar
 
Dries committed
390

391 392
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
393 394
        switch ($delta) {
          case 0:
395
            $title = t('Active forum topics');
396
            $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.status = 1 AND n.type = 'forum' ORDER BY l.last_comment_timestamp DESC");
397 398 399 400
            $result = db_query_range($sql, 0, variable_get('forum_block_num_0', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
401
            break;
Dries's avatar
 
Dries committed
402 403

          case 1:
404 405
            $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");
406 407 408 409
            $result = db_query_range($sql, 0, variable_get('forum_block_num_1', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
410
            break;
Dries's avatar
 
Dries committed
411
        }
Dries's avatar
 
Dries committed
412

413
        if ($content) {
414
          $content .= '<div class="more-link">'. l(t('more'), 'forum', array('title' => t('Read the latest forum topics.'))) .'</div>';
415 416
        }

Dries's avatar
 
Dries committed
417
        $block['subject'] = $title;
418 419 420 421 422
        $block['content'] = $content;

        return $block;
      }
  }
Dries's avatar
 
Dries committed
423 424
}

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

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

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

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

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

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

  return $items;
}

474 475 476
/**
 * Implementation of hook_view().
 */
Dries's avatar
 
Dries committed
477
function forum_view(&$node, $teaser = FALSE, $page = FALSE) {
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);
494 495

  $node->body .= theme('forum_topic_navigation', $node);
Dries's avatar
 
Dries committed
496 497
}

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

  if ($node->taxonomy) {
    // Extract the node's proper topic ID.
Dries's avatar
 
Dries committed
510
    $vocabulary = variable_get('forum_nav_vocabulary', '');
Dries's avatar
 
Dries committed
511
    foreach ($node->taxonomy as $term) {
Dries's avatar
 
Dries committed
512
      if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
513
        $node->tid = $term;
Dries's avatar
 
Dries committed
514
      }
515
    }
Dries's avatar
 
Dries committed
516
    if ($node->tid && $node->shadow) {
517 518
      $terms = array_keys(taxonomy_node_get_terms($node->nid));
      if (!in_array($node->tid, $node->terms)) {
Dries's avatar
 
Dries committed
519 520 521 522
        $terms[] = $node->tid;
      }
      $node->taxonomy = $terms;
    }
Dries's avatar
Dries committed
523 524 525
  }
}

526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
/**
 * Implementation of hook_validate().
 *
 * Check in particular that only a "leaf" term in the associated taxonomy
 * vocabulary is selected, not a "container" term.
 */
function forum_validate($node) {
  node_validate_title($node,t('You have to specify a subject.'));

  if ($node->taxonomy) {
    // Extract the node's proper topic ID.
    $vocabulary = variable_get('forum_nav_vocabulary', '');
    $containers = variable_get('forum_containers', array());
    foreach ($node->taxonomy as $term) {
      if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
        if (in_array($term, $containers)) {
          $term = taxonomy_get_term($term);
          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))));
        }
      }
    }
  }
}

Dries's avatar
 
Dries committed
550 551 552 553
/**
 * Implementation of hook_update().
 */
function forum_update($node) {
554 555 556 557 558 559
  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
560 561
}

562 563 564
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
565
function forum_form(&$node) {
566
  $form['title'] = array('#type' => 'textfield', '#title' => t('Subject'), '#default_value' => $node->title, '#required' => TRUE, '#weight' => -5);
567

568
  if ($node->nid) {
569
    $forum_terms = taxonomy_node_get_terms_by_vocabulary(_forum_get_vid(), $node->nid);
Dries's avatar
Dries committed
570
    // if editing, give option to leave shadows
571
    $shadow = (count($forum_terms) > 1);
572
    $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
573
  }
Dries's avatar
 
Dries committed
574

575
  $form['body_filter']['body'] = array('#type' => 'textarea', '#title' => t('Body'), '#default_value' => $node->body, '#rows' => 20, '#required' => TRUE);
576
  $form['body_filter']['format'] = filter_form($node->format);
Dries's avatar
 
Dries committed
577

578
  return $form;
Dries's avatar
 
Dries committed
579 580
}

581 582 583 584 585 586
/**
 * Implementation of hook_prepare; assign forum taxonomy when adding a topic from within a forum.
 */
function forum_prepare(&$node) {
  if (!$node->nid) {
    // new topic
587
    $node->taxonomy[arg(3)] = 1;
588 589 590
  }
}

591 592 593
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
594
function forum_insert($node) {
595
  db_query('INSERT INTO {forum} (nid, vid, tid) VALUES (%d, %d, %d)', $node->nid, $node->vid, $node->tid);
Dries's avatar
 
Dries committed
596 597
}

598 599 600
/**
 * Implementation of hook_delete().
 */
Dries's avatar
 
Dries committed
601
function forum_delete(&$node) {
Dries's avatar
 
Dries committed
602
  db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
603
}
Dries's avatar
 
Dries committed
604

Dries's avatar
 
Dries committed
605 606 607
/**
 * Formats a topic for display
 *
608
 * @TODO Give a better description. Not sure where this function is used yet.
Dries's avatar
 
Dries committed
609
 */
Dries's avatar
 
Dries committed
610
function _forum_format($topic) {
611
  if ($topic && $topic->timestamp) {
612
    return t('%time ago<br />by %author', array('%time' => format_interval(time() - $topic->timestamp), '%author' => theme('username', $topic)));
Dries's avatar
 
Dries committed
613 614 615 616 617 618
  }
  else {
    return message_na();
  }
}

Dries's avatar
 
Dries committed
619 620 621
/**
 * Returns a list of all forums for a given taxonomy id
 *
622
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
623 624 625 626 627 628 629 630 631
 * -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
632
function forum_get_forums($tid = 0) {
633

Dries's avatar
 
Dries committed
634 635 636 637
  if (!$tid) {
    $tid = 0;
  }

Dries's avatar
 
Dries committed
638 639
  $forums = array();
  $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
Dries's avatar
 
Dries committed
640

Dries's avatar
 
Dries committed
641
  if (count($_forums)) {
Dries's avatar
 
Dries committed
642

Dries's avatar
 
Dries committed
643 644
    $counts = array();

Dries's avatar
 
Dries committed
645
    $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";
646
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
647
    $_counts = db_query($sql, $forum->tid);
Dries's avatar
 
Dries committed
648 649 650
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
651
  }
Dries's avatar
 
Dries committed
652

Dries's avatar
 
Dries committed
653 654 655 656
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
657

Dries's avatar
 
Dries committed
658 659 660 661 662 663 664 665 666 667 668
    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
669
    // used to join node_comment_statistics to users.
670
    $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";
671
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
672
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
673 674

    $last_post = new StdClass();
Dries's avatar
 
Dries committed
675 676 677 678
    $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
679

Dries's avatar
 
Dries committed
680 681 682 683
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
684 685
}

686 687 688 689 690
/**
 * Calculate the number of nodes the user has not yet read and are newer
 * than NODE_NEW_LIMIT.
 */
function _forum_topics_unread($term, $uid) {
691
  $sql = "SELECT COUNT(n.nid) FROM {node} n INNER JOIN {term_node} tn ON n.nid = tn.nid AND tn.tid = %d LEFT JOIN {history} h ON n.nid = h.nid AND h.uid = %d WHERE n.status = 1 AND n.type = 'forum' AND n.created > %d AND h.nid IS NULL";
692
  $sql = db_rewrite_sql($sql);
693
  return db_result(db_query($sql, $term, $uid, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
694 695
}

Dries's avatar
Dries committed
696
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
697
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
698

Dries's avatar
 
Dries committed
699
  $forum_topic_list_header = array(
Dries's avatar
 
Dries committed
700 701
    array('data' => '&nbsp;'),
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
702
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
703
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
704
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
705
  );
Dries's avatar
 
Dries committed
706

Dries's avatar
 
Dries committed
707
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
708
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
709 710
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
711 712 713 714
    }
  }

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

716
  $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_comment_statistics} l, {users} cu, {term_node} r, {users} u, {forum} f, {node} n 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
717
  $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
718
  $sql .= ', n.created DESC';  // Always add a secondary sort order so that the news forum topics are on top.
Dries's avatar
Dries committed
719

720
  $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
721

Steven Wittens's avatar
Steven Wittens committed
722
  $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
Dries's avatar
 
Dries committed
723 724

  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
725 726
    if ($user->uid) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
 
Dries committed
727
      if ($topic->tid != $tid) {
Dries's avatar
Dries committed
728
        $topic->new = 0;
Dries's avatar
 
Dries committed
729 730
      }
      else {
Dries's avatar
 
Dries committed
731
        $history = _forum_user_last_visit($topic->nid);
Dries's avatar
 
Dries committed
732
        $topic->new_replies = comment_num_new($topic->nid, $history);
733
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
734
      }
735 736
    }
    else {
737
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
738 739
      $topic->new_replies = 0;
      $topic->new = 0;
740
    }
Dries's avatar
 
Dries committed
741

Dries's avatar
 
Dries committed
742
    if ($topic->num_comments > 0) {
743
      $last_reply = new StdClass();
Dries's avatar
 
Dries committed
744 745 746 747 748
      $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
749 750 751
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
752
  return $topics;
Dries's avatar
 
Dries committed
753 754
}

Dries's avatar
 
Dries committed
755 756 757
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
758
function _forum_new($tid) {
Dries's avatar
 
Dries committed
759 760
  global $user;

Dries's avatar
 
Dries committed
761
  $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";
762
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
763
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
764 765 766 767

  return $nid ? $nid : 0;
}

768
/**
Dries's avatar
Dries committed
769
 * Menu callback; prints a forum listing.
770
 */
Dries's avatar
Dries committed
771
function forum_page($tid = 0) {
772
  if (module_exist('taxonomy') && module_exist('comment')) {
Dries's avatar
Dries committed
773 774
    $forum_per_page = variable_get('forum_per_page', 25);
    $sortby = variable_get('forum_order', 1);
Dries's avatar
 
Dries committed
775

Dries's avatar
Dries committed
776 777 778 779
    $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
780
    }
Dries's avatar
Dries committed
781

Dries's avatar
 
Dries committed
782
    return theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
783 784
  }
  else {
785 786
    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
787 788 789
  }
}

Dries's avatar
 
Dries committed
790
/**
Dries's avatar
 
Dries committed
791 792
 * Format the forum body.
 *
Dries's avatar
 
Dries committed
793
 * @ingroup themeable
Dries's avatar
 
Dries committed
794
 */
Dries's avatar
 
Dries committed
795
function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
796
  global $user;
Dries's avatar
 
Dries committed
797
  // forum list, topics list, topic browser and 'add new topic' link
Dries's avatar
 
Dries committed
798

Dries's avatar
 
Dries committed
799
  $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
800
  $title = $vocabulary->name;
Dries's avatar
 
Dries committed
801

Dries's avatar
 
Dries committed
802 803
  // Breadcrumb navigation:
  $breadcrumb = array();
Dries's avatar
 
Dries committed
804
  if ($tid) {
Dries's avatar
 
Dries committed
805
    $breadcrumb[] = array('path' => 'forum', 'title' => $title);
Dries's avatar
 
Dries committed
806
  }
Dries's avatar
 
Dries committed
807 808

  if ($parents) {
Dries's avatar
 
Dries committed
809 810
    $parents = array_reverse($parents);
    foreach ($parents as $p) {
811 812
      if ($p->tid == $tid) {
        $title = $p->name;
Dries's avatar
 
Dries committed
813 814
      }
      else {
Dries's avatar
 
Dries committed
815
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
816 817 818
      }
    }
  }
819 820 821

  drupal_set_title($title);

Dries's avatar
 
Dries committed
822 823
  $breadcrumb[] = array('path' => $_GET['q']);
  menu_set_location($breadcrumb);
Dries's avatar