forum.module 40 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
    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>';
16
      $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>';
17
      $output .= '<p>'. t('Forums module <strong>requires Taxonomy and Comments module</strong> be enabled.') .'</p>';
18
      $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>';
19
      return $output;
20
    case 'admin/content/forum':
21
      return '<p>'. t('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>';
22
    case 'admin/content/forum/add/container':
23
      return '<p>'. t('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>';
24
    case 'admin/content/forum/add/forum':
25
      return '<p>'. t('A forum holds discussion topics that are related. For example, a forum named "Fruit" might contain topics titled "Apples" and "Bananas".') .'</p>';
26 27
    case 'admin/content/forum/settings':
      return '<p>'. t('These settings provide the ability to fine tune the display of your forum topics.') .'</p>';
Dries's avatar
 
Dries committed
28 29 30
  }
}

31 32 33
/**
 * Implementation of hook_menu().
 */
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
function forum_menu() {
  $items['node/add/forum'] = array(
    'title' => t('Forum topic'),
    'access arguments' => array('create forum topics'),
  );
  $items['forum'] = array(
    'title' => t('Forums'),
    'page callback' => 'forum_page',
    'access arguments' => array('access content'),
    'type' => MENU_SUGGESTED_ITEM,
  );
  $items['admin/content/forum'] = array(
    'title' => t('Forums'),
    'description' => t('Control forums and their hierarchy and change forum settings.'),
    'page callback' => 'forum_overview',
    'access arguments' => array('administer forums'),
  );
  $items['admin/content/forum/list'] = array(
    'title' => t('List'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/content/forum/add/container'] = array(
    'title' => t('Add container'),
    'page callback' => 'forum_form_main',
    'page arguments' => array('container'),
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/content/forum/add/forum'] = array(
    'title' => t('Add forum'),
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum'),
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/content/forum/settings'] = array(
    'title' => t('Settings'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('forum_admin_settings'),
    'weight' => 5,
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/content/forum/edit'] = array(
    'page callback' => 'forum_form_main',
    'map arguments' => array('_forum_get_term', 5, array()),
    'type' => MENU_CALLBACK,
  );
  $items['admin/content/forum/edit/container/%'] = array(
    'title' => t('Edit container'),
    'page arguments' => array('container', 5),
  );
  $items['admin/content/forum/edit/forum/%'] = array(
    'title' => t('Edit forum'),
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum', 5),
  );
  return $items;
}
91

92 93 94
function forum_init() {
  drupal_add_css(drupal_get_path('module', 'forum') .'/forum.css');
}
95

96 97
function _forum_get_term($tid) {
  return (array)taxonomy_get_term($tid);
98 99
}

100
/**
101
 * Implementation of hook_node_info().
102
 */
103
function forum_node_info() {
104 105
  return array(
    'forum' => array(
106
      'name' => t('Forum topic'),
107 108 109 110 111
      'module' => 'forum',
      'description' => t('Create a new topic for discussion in the forums.'),
      'title_label' => t('Subject'),
    )
  );
Dries's avatar
 
Dries committed
112 113
}

114 115 116
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
117
function forum_access($op, $node) {
Dries's avatar
 
Dries committed
118 119
  global $user;

Dries's avatar
 
Dries committed
120 121
  if ($op == 'create') {
    return user_access('create forum topics');
Dries's avatar
 
Dries committed
122
  }
Dries's avatar
 
Dries committed
123 124 125 126 127 128

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

131 132 133
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
134
function forum_perm() {
135
  return array('create forum topics', 'edit own forum topics', 'administer forums');
Dries's avatar
 
Dries committed
136
}
Dries's avatar
 
Dries committed
137

138 139 140 141 142
/**
 * Implementation of hook_nodeapi().
 */
function forum_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
143
    case 'delete revision':
144 145 146 147 148
      db_query('DELETE FROM {forum} WHERE vid = %d', $node->vid);
      break;
  }
}

149 150 151
/**
 * Implementation of hook_taxonomy().
 */
152
function forum_taxonomy($op, $type, $term = NULL) {
153
  if ($op == 'delete' && $term['vid'] == _forum_get_vid()) {
154 155
    switch ($type) {
      case 'term':
156
        $results = db_query('SELECT f.nid FROM {forum} f WHERE f.tid = %d', $term['tid']);
157 158 159 160 161 162 163
        while ($node = db_fetch_object($results)) {
          // node_delete will also remove any association with non-forum vocabularies.
          node_delete($node->nid);
        }

        // For containers, remove the tid from the forum_containers variable.
        $containers = variable_get('forum_containers', array());
164 165
        $key = array_search($term['tid'], $containers);
        if ($key !== FALSE) {
166 167 168 169 170 171
          unset($containers[$key]);
        }
        variable_set('forum_containers', $containers);
        break;
      case 'vocabulary':
        variable_del('forum_nav_vocabulary');
Dries's avatar
 
Dries committed
172
    }
173 174
  }
}
Dries's avatar
 
Dries committed
175

Dries's avatar
Dries committed
176
function forum_admin_settings() {
177
  $form = array();
178
  $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 150, 200, 250, 300, 350, 400, 500));
179 180 181 182 183 184
  $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.'),
  );
185
  $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
186 187 188 189 190 191
  $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.'),
  );
192
  $forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4=> t('Posts - least active first'));
193 194 195 196 197 198
  $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.'),
  );
199
  return system_settings_form($form);
200 201
}

202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
/**
 * Implementation of hook_form_alter().
 */
function forum_form_alter($form_id, &$form) {
  // hide critical options from forum vocabulary
  if ($form_id == 'taxonomy_form_vocabulary') {
    if ($form['vid']['#value'] == _forum_get_vid()) {
      $form['help_forum_vocab'] = array(
        '#value' => t('This is the designated forum vocabulary. Some of the normal vocabulary options have been removed.'),
        '#weight' => -1,
      );
      $form['nodes']['forum'] = array('#type' => 'checkbox', '#value' => 1, '#title' => t('forum topic'), '#attributes' => array('disabled' => '' ), '#description' => t('forum topic is affixed to the forum vocabulary.'));
      $form['hierarchy'] = array('#type' => 'value', '#value' => 1);
      unset($form['relations']);
      unset($form['tags']);
      unset($form['multiple']);
      $form['required'] = array('#type' => 'value', '#value' => 1);
    }
    else {
      unset($form['nodes']['forum']);
    }
  }
}

226 227 228
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
229
function forum_load($node) {
230
  $forum = db_fetch_object(db_query('SELECT * FROM {forum} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
231 232 233 234

  return $forum;
}

235 236 237 238 239 240
/**
 * Implementation of hook_block().
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
241 242 243
function forum_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
Dries's avatar
 
Dries committed
244 245
      $blocks[0]['info'] = t('Active forum topics');
      $blocks[1]['info'] = t('New forum topics');
246
      return $blocks;
Dries's avatar
 
Dries committed
247

248
    case 'configure':
249
      $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)));
250
      return $form;
Dries's avatar
 
Dries committed
251

252
    case 'save':
253
      variable_set('forum_block_num_'. $delta, $edit['forum_block_num_'. $delta]);
254
      break;
Dries's avatar
 
Dries committed
255

256 257
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
258 259
        switch ($delta) {
          case 0:
260
            $title = t('Active forum topics');
261
            $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");
262 263 264 265
            $result = db_query_range($sql, 0, variable_get('forum_block_num_0', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
266
            break;
Dries's avatar
 
Dries committed
267 268

          case 1:
269 270
            $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");
271 272 273 274
            $result = db_query_range($sql, 0, variable_get('forum_block_num_1', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
275
            break;
Dries's avatar
 
Dries committed
276
        }
Dries's avatar
 
Dries committed
277

278
        if ($content) {
279
          $content .= '<div class="more-link">'. l(t('more'), 'forum', array('title' => t('Read the latest forum topics.'))) .'</div>';
280 281
        }

Dries's avatar
 
Dries committed
282
        $block['subject'] = $title;
283 284 285 286 287
        $block['content'] = $content;

        return $block;
      }
  }
Dries's avatar
 
Dries committed
288 289
}

290 291 292
/**
 * Implementation of hook_view().
 */
Dries's avatar
 
Dries committed
293
function forum_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
 
Dries committed
294
  if ($page) {
Dries's avatar
 
Dries committed
295
    $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
Dries's avatar
 
Dries committed
296
    // Breadcrumb navigation
Dries's avatar
 
Dries committed
297 298
    $breadcrumb = array();
    $breadcrumb[] = array('path' => 'forum', 'title' => $vocabulary->name);
Dries's avatar
 
Dries committed
299
    if ($parents = taxonomy_get_parents_all($node->tid)) {
Dries's avatar
 
Dries committed
300 301
      $parents = array_reverse($parents);
      foreach ($parents as $p) {
Dries's avatar
 
Dries committed
302
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
303 304
      }
    }
Dries's avatar
 
Dries committed
305 306
    $breadcrumb[] = array('path' => 'node/'. $node->nid);
    menu_set_location($breadcrumb);
307
  }
Dries's avatar
 
Dries committed
308

309
  $node = node_prepare($node, $teaser);
310 311 312 313 314 315
  if (!$teaser) {
    $node->content['forum_navigation'] = array(
      '#value' => theme('forum_topic_navigation', $node),
      '#weight' => 100,
    );
  }
316
  return $node;
Dries's avatar
 
Dries committed
317 318
}

319
/**
320 321 322 323
 * Implementation of hook_submit().
 *
 * Check in particular that only a "leaf" term in the associated taxonomy
 * vocabulary is selected, not a "container" term.
324
 */
325
function forum_submit(&$node) {
326
  // Make sure all fields are set properly:
Dries's avatar
 
Dries committed
327
  $node->icon = $node->icon ? $node->icon : '';
Dries's avatar
 
Dries committed
328

329
  if ($node->taxonomy) {
330 331 332 333 334 335 336
    // Get the forum terms from the (cached) tree
    $tree = taxonomy_get_tree(_forum_get_vid());
    if ($tree) {
      foreach ($tree as $term) {
        $forum_terms[] = $term->tid;
      }
    }
Dries's avatar
 
Dries committed
337
    foreach ($node->taxonomy as $term) {
338
      if (in_array($term, $forum_terms)) {
339
        $node->tid = $term;
Dries's avatar
 
Dries committed
340
      }
341
    }
342
    $old_tid = db_result(db_query_range("SELECT tid FROM {forum} WHERE nid = %d ORDER BY vid DESC", $node->nid, 0,1));
343
    if ($old_tid) {
344 345 346
      if (($node->tid != $old_tid) && $node->shadow) {
        // A shadow copy needs to be created. Retain new term and add old term.
        $node->taxonomy[] = $old_tid;
Dries's avatar
 
Dries committed
347 348
      }
    }
Dries's avatar
Dries committed
349
  }
350
}
Dries's avatar
Dries committed
351

352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
/**
 * 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) {
  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' => $term->name)));
        }
      }
    }
  }
372 373
}

374 375 376 377 378
/**
 * Implementation of hook_update().
 */
function forum_update($node) {
  if ($node->revision) {
379 380 381 382 383
    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
384 385
}

386 387 388
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
389
function forum_form(&$node) {
390 391
  $type = node_get_types('type', $node);
  $form['title'] = array('#type' => 'textfield', '#title' => check_plain($type->title_label), '#default_value' => $node->title, '#required' => TRUE, '#weight' => -5);
392

393
  if ($node->nid) {
394
    $forum_terms = taxonomy_node_get_terms_by_vocabulary(_forum_get_vid(), $node->nid);
Dries's avatar
Dries committed
395
    // if editing, give option to leave shadows
396
    $shadow = (count($forum_terms) > 1);
397
    $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
398
  }
Dries's avatar
 
Dries committed
399

400
  $form['body_filter']['body'] = array('#type' => 'textarea', '#title' => check_plain($type->body_label), '#default_value' => $node->body, '#rows' => 20, '#required' => TRUE);
401
  $form['body_filter']['format'] = filter_form($node->format);
Dries's avatar
 
Dries committed
402

403
  return $form;
Dries's avatar
 
Dries committed
404 405
}

406 407 408 409 410 411
/**
 * Implementation of hook_prepare; assign forum taxonomy when adding a topic from within a forum.
 */
function forum_prepare(&$node) {
  if (!$node->nid) {
    // new topic
412 413
    $node->taxonomy[arg(3)]->vid = _forum_get_vid();
    $node->taxonomy[arg(3)]->tid = arg(3);
414 415 416
  }
}

417 418 419 420 421 422 423 424 425 426 427 428
/**
 * Implementation of hook_insert().
 */
function forum_insert($node) {
  db_query('INSERT INTO {forum} (nid, vid, tid) VALUES (%d, %d, %d)', $node->nid, $node->vid, $node->tid);
}

/**
 * Implementation of hook_delete().
 */
function forum_delete(&$node) {
  db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
429
}
Dries's avatar
 
Dries committed
430

431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
/**
 * 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()) {
  // Handle a delete operation.
  $form['name'] = array(
    '#title' => t('Container name'),
    '#type' => 'textfield',
    '#default_value' => $edit['name'],
    '#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'],
    '#description' => t('The container description can give users more information about the forums it contains.')
  );
  $form['parent']['#tree'] = TRUE;
  $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'container');
  $form['weight'] = array('#type' => 'weight',
    '#title' => t('Weight'),
    '#default_value' => $edit['weight'],
    '#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.')
  );

  $form['vid'] = array('#type' => 'hidden',
    '#value' => _forum_get_vid());
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Submit')
  );
  if ($edit['tid']) {
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['tid'] = array('#type' => 'value', '#value' => $edit['tid']);
  }
471
  $form['#base'] = 'forum_form';
472

473
  return $form;
474 475
}

476 477 478 479 480 481 482 483 484 485 486 487 488 489
function forum_form_main($type, $edit = array()) {
  if ($_POST['op'] == t('Delete') || $_POST['confirm']) {
    return drupal_get_form('forum_confirm_delete', $edit['tid']);
  }
  switch ($type) {
    case 'forum':
      return drupal_get_form('forum_form_forum', $edit);
      break;
    case 'container':
      return drupal_get_form('forum_form_container', $edit);
      break;
  }
}

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
/**
 * Returns a form for adding a forum to the forum vocabulary
 *
 * @param $edit Associative array containing a forum term to be added or edited.
 */
function forum_form_forum($edit = array()) {
  $form['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,
  );
  $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.'),
  );
  $form['parent']['#tree'] = TRUE;
  $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'forum');
  $form['weight'] = array('#type' => 'weight',
    '#title' => t('Weight'),
    '#default_value' => $edit['weight'],
    '#description' => t('When listing forums, those with lighter (smaller) weights get listed before containers with heavier (larger) weights. Forums with equal weights are sorted alphabetically.'),
  );

  $form['vid'] = array('#type' => 'hidden', '#value' => _forum_get_vid());
  $form['submit' ] = array('#type' => 'submit', '#value' => t('Submit'));
  if ($edit['tid']) {
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['tid'] = array('#type' => 'hidden', '#value' => $edit['tid']);
  }
522
  $form['#base'] = 'forum_form';
523

524
  return $form;
525 526 527 528 529 530 531 532 533 534 535
}

/**
 * Process forum form and container form submissions.
 */
function forum_form_submit($form_id, $form_values) {
  if ($form_id == 'forum_form_container') {
    $container = TRUE;
    $type = t('forum container');
  }
  else {
536
    $container = FALSE;
537 538 539 540 541 542 543 544 545 546 547
    $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);
      }
548
      drupal_set_message(t('Created new @type %term.', array('%term' => $form_values['name'], '@type' => $type)));
549 550
      break;
    case SAVED_UPDATED:
551
      drupal_set_message(t('The @type %term has been updated.', array('%term' => $form_values['name'], '@type' => $type)));
552 553
      break;
  }
554
  return 'admin/content/forum';
555 556 557 558 559 560 561
}

/**
 * Returns a confirmation page for deleting a forum taxonomy term.
 *
 * @param $tid ID of the term to be deleted
 */
562
function forum_confirm_delete($tid) {
563 564 565 566 567
  $term = taxonomy_get_term($tid);

  $form['tid'] = array('#type' => 'value', '#value' => $tid);
  $form['name'] = array('#type' => 'value', '#value' => $term->name);

568
  return confirm_form($form, t('Are you sure you want to delete the forum %name?', array('%name' => $term->name)), 'admin/content/forum', t('Deleting a forum or container will delete all sub-forums and associated posts as well. This action cannot be undone.'), t('Delete'), t('Cancel'));
569 570 571 572 573 574 575
}

/**
 * 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']);
576 577
  drupal_set_message(t('The forum %term and all sub-forums and associated posts have been deleted.', array('%term' => $form_values['name'])));
  watchdog('content', t('forum: deleted %term and all its sub-forums and associated posts.', array('%term' => $form_values['name'])));
578

579
  return 'admin/content/forum';
580 581 582 583 584 585 586 587 588 589 590 591
}

/**
 * Returns an overview list of existing forums and containers
 */
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()))) {
592
        $rows[] = array(str_repeat(' -- ', $term->depth) .' '. l(check_plain($term->name), 'forum/'. $term->tid), l(t('edit container'), 'admin/content/forum/edit/container/'. $term->tid));
593 594
      }
      else {
595
        $rows[] = array(str_repeat(' -- ', $term->depth) .' '. l(check_plain($term->name), 'forum/'. $term->tid), l(t('edit forum'), 'admin/content/forum/edit/forum/'. $term->tid));
596 597 598 599 600
       }

    }
  }
  else {
601
    $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/content/forum/add/container'), '@forum' => url('admin/content/forum/add/forum'))) . '</em>', 'colspan' => 2));
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
  }
  return theme('table', $header, $rows);
}

/**
 * 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 $child_type Whether the child is forum or container
 */
function _forum_parent_select($tid, $title, $child_type) {

  $parents = taxonomy_get_parents($tid);
  if ($parents) {
    $parent = array_shift($parents);
    $parent = $parent->tid;
  }
  else {
    $parent = 0;
  }

  $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)) {
drumm's avatar
drumm committed
637
        $options[$term->tid] = str_repeat(' -- ', $term->depth) . $term->name;
638 639 640 641 642 643 644 645 646 647 648 649 650
      }
    }
  }
  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.');
  }

  return array('#type' => 'select', '#title' => $title, '#default_value' => $parent, '#options' => $options, '#description' => $description, '#required' => TRUE);
}

651
function forum_link_alter(&$node, &$links) {
652
  foreach ($links as $module => $link) {
653
    if (strstr($module, 'taxonomy_term')) {
654 655
      // Link back to the forum and not the taxonomy term page. We'll only
      // do this if the taxonomy term in question belongs to forums.
656
      $tid = str_replace('taxonomy/term/', '', $link['href']);
657 658
      $term = taxonomy_get_term($tid);
      if ($term->vid == _forum_get_vid()) {
659
        $links[$module]['href'] = str_replace('taxonomy/term', 'forum', $link['href']);
660
      }
661 662
    }
  }
663 664 665 666 667 668 669 670 671 672 673
}

/**
 * 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) {
674 675 676
      // Create the forum vocabulary. Assign the vocabulary a low weight so
      // it will appear first in forum topic create and edit forms.
      $edit = array('name' => 'Forums', 'multiple' => 0, 'required' => 1, 'hierarchy' => 1, 'relations' => 0, 'module' => 'forum', 'weight' => -10, 'nodes' => array('forum' => 1));
677 678 679 680 681 682 683 684 685
      taxonomy_save_vocabulary($edit);
      $vid = $edit['vid'];
    }
    variable_set('forum_nav_vocabulary', $vid);
  }

  return $vid;
}

Dries's avatar
 
Dries committed
686 687 688
/**
 * Formats a topic for display
 *
689
 * @TODO Give a better description. Not sure where this function is used yet.
Dries's avatar
 
Dries committed
690
 */
Dries's avatar
 
Dries committed
691
function _forum_format($topic) {
692
  if ($topic && $topic->timestamp) {
693
    return t('@time ago<br />by !author', array('@time' => format_interval(time() - $topic->timestamp), '!author' => theme('username', $topic)));
Dries's avatar
 
Dries committed
694 695
  }
  else {
696
    return t('n/a');
Dries's avatar
 
Dries committed
697 698 699
  }
}

Dries's avatar
 
Dries committed
700 701 702
/**
 * Returns a list of all forums for a given taxonomy id
 *
703
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
704 705 706 707 708 709 710 711 712
 * -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
713
function forum_get_forums($tid = 0) {
714

Dries's avatar
 
Dries committed
715 716
  $forums = array();
  $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
Dries's avatar
 
Dries committed
717

Dries's avatar
 
Dries committed
718
  if (count($_forums)) {
Dries's avatar
 
Dries committed
719

Dries's avatar
 
Dries committed
720 721
    $counts = array();

Dries's avatar
 
Dries committed
722
    $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";
723
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
724
    $_counts = db_query($sql, $forum->tid);
Dries's avatar
 
Dries committed
725 726 727
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
728
  }
Dries's avatar
 
Dries committed
729

Dries's avatar
 
Dries committed
730 731 732 733
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
734

Dries's avatar
 
Dries committed
735 736 737 738 739 740 741 742 743 744 745
    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
746
    // used to join node_comment_statistics to users.
747
    $sql = "SELECT ncs.last_comment_timestamp, IF (ncs.last_comment_uid != 0, u2.name, ncs.last_comment_name) AS last_comment_name, ncs.last_comment_uid FROM {node} n INNER JOIN {users} u1 ON n.uid = u1.uid INNER JOIN {term_node} tn ON n.nid = tn.nid INNER JOIN {node_comment_statistics} ncs ON n.nid = ncs.nid INNER JOIN {users} u2 ON ncs.last_comment_uid=u2.uid WHERE n.status = 1 AND n.type='forum' AND tn.tid = %d ORDER BY ncs.last_comment_timestamp DESC";
748
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
749
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
750

751
    $last_post = new stdClass();
Dries's avatar
 
Dries committed
752 753 754 755
    $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
756

Dries's avatar
 
Dries committed
757 758 759 760
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
761 762
}

763 764 765 766 767
/**
 * Calculate the number of nodes the user has not yet read and are newer
 * than NODE_NEW_LIMIT.
 */
function _forum_topics_unread($term, $uid) {
768
  $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";
769
  $sql = db_rewrite_sql($sql);
770
  return db_result(db_query($sql, $term, $uid, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
771 772
}

Dries's avatar
Dries committed
773
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
774
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
775

Dries's avatar
 
Dries committed
776
  $forum_topic_list_header = array(
777
    array('data' => '&nbsp;', 'field' => NULL),
Dries's avatar
 
Dries committed
778
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
779
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
780
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
781
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
782
  );
Dries's avatar
 
Dries committed
783

Dries's avatar
 
Dries committed
784
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
785
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
786 787
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
788 789 790 791
    }
  }

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

793
  $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
794
  $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
795
  $sql .= ', n.created DESC';  // Always add a secondary sort order so that the news forum topics are on top.
Dries's avatar
Dries committed
796

797
  $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
798

Steven Wittens's avatar
Steven Wittens committed
799
  $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
Dries's avatar
 
Dries committed
800 801

  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
802 803
    if ($user->uid) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
 
Dries committed
804
      if ($topic->tid != $tid) {
Dries's avatar
Dries committed
805
        $topic->new = 0;
Dries's avatar
 
Dries committed
806 807
      }
      else {
Dries's avatar
 
Dries committed
808
        $history = _forum_user_last_visit($topic->nid);
Dries's avatar
 
Dries committed
809
        $topic->new_replies = comment_num_new($topic->nid, $history);
810
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
811
      }
812 813
    }
    else {
814
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
815 816
      $topic->new_replies = 0;
      $topic->new = 0;
817
    }
Dries's avatar
 
Dries committed
818

Dries's avatar
 
Dries committed
819
    if ($topic->num_comments > 0) {
820
      $last_reply = new stdClass();
Dries's avatar
 
Dries committed
821 822 823 824 825
      $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
826 827 828
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
829
  return $topics;
Dries's avatar
 
Dries committed
830 831
}

Dries's avatar
 
Dries committed
832 833 834
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
835
function _forum_new($tid) {
Dries's avatar
 
Dries committed
836 837
  global $user;

Dries's avatar
 
Dries committed
838
  $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";
839
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
840
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
841 842 843 844

  return $nid ? $nid : 0;
}

845
/**
Dries's avatar
Dries committed
846
 * Menu callback; prints a forum listing.
847
 */
Dries's avatar
Dries committed
848
function forum_page($tid = 0) {
849
  if (module_exists('taxonomy') && module_exists('comment')) {
Dries's avatar
Dries committed
850 851
    $forum_per_page = variable_get('forum_per_page', 25);
    $sortby = variable_get('forum_order', 1);
Dries's avatar
 
Dries committed
852

Dries's avatar
Dries committed
853 854 855 856
    $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
857
    }
Dries's avatar
Dries committed
858

Dries's avatar
 
Dries committed
859
    return theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
860 861
  }
  else {
862 863
    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
864 865 866
  }
}

Dries's avatar
 
Dries committed
867
/**
Dries's avatar
 
Dries committed
868 869
 * Format the forum body.
 *
Dries's avatar
 
Dries committed
870
 * @ingroup themeable
Dries's avatar
 
Dries committed
871
 */
Dries's avatar
 
Dries committed
872
function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
873
  global $user;
Dries's avatar
 
Dries committed
874
  // forum list, topics list, topic browser and 'add new topic' link
Dries's avatar
 
Dries committed
875

Dries's avatar
 
Dries committed
876
  $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
877
  $title = $vocabulary->name;
Dries's avatar
 
Dries committed
878

Dries's avatar
 
Dries committed
879 880
  // Breadcrumb navigation:
  $breadcrumb = array();
Dries's avatar
 
Dries committed
881
  if ($tid) {
Dries's avatar
 
Dries committed
882
    $breadcrumb[] = array('path' => 'forum', 'title' => $title);
Dries's avatar
 
Dries committed
883
  }
Dries's avatar
 
Dries committed
884 885

  if ($parents) {
Dries's avatar
 
Dries committed
886 887
    $parents = array_reverse($parents);
    foreach ($parents as $p) {
888 889
      if ($p->tid == $tid) {
        $title = $p->name;
Dries's avatar
 
Dries committed
890 891
      }
      else {
Dries's avatar
 
Dries committed
892
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
893 894 895
      }
    }
  }
896

Dries's avatar
Dries committed
897
  drupal_set_title(check_plain($title));
898

Dries's avatar
 
Dries committed
899 900
  $breadcrumb[] = array('path' => $_GET['q']);
  menu_set_location($breadcrumb);
Dries's avatar
 
Dries committed
901

Dries's avatar
 
Dries committed
902
  if (count($forums) || count($parents)) {
903 904
    $output  = '<div id="forum">';
    $output .= '<ul>';
Dries's avatar
 
Dries committed
905 906

    if (user_access('create forum topics')) {
907
      $output .= '<li>'. l(t('Post new forum topic.'), "node/add/forum/$tid") .'</li>';
Dries's avatar
 
Dries committed
908 909
    }
    else if ($user->uid) {
910
      $output .= '<li>'. t('You are not allowed to post a new forum topic.') .'</li>';
Dries's avatar
 
Dries committed
911 912
    }
    else {
913
      $output .= '<li>'. t('<a href="@login">Login</a> to post a new forum topic.', array('@login' => url('user/login', drupal_get_destination()))) .'</li>';
Dries's avatar
 
Dries committed
914
    }
915
    $output .= '</ul>';
Dries's avatar
 
Dries committed
916

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

Dries's avatar
 
Dries committed
919
    if ($tid && !in_array($tid, variable_get('forum_containers', array()))) {
Dries's avatar
 
Dries committed
920
      $output .= theme('forum_topic_list', $tid, $topics, $sortby, $forum_per_page);
921
      drupal_add_feed(url('taxonomy/term/'. $tid .'/0/feed'), 'RSS - '. $title);
Dries's avatar
 
Dries committed
922
    }
923
    $output .= '</div>';
Dries's avatar
 
Dries committed