forum.module 40.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
    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 34 35 36 37 38
/**
 * Implementation of hook_menu().
 */
function forum_menu($may_cache) {
  $items = array();

  if ($may_cache) {
    $items[] = array('path' => 'forum',
39
      'title' => t('Forums'),
40 41 42
      'callback' => 'forum_page',
      'access' => user_access('access content'),
      'type' => MENU_SUGGESTED_ITEM);
43
    $items[] = array('path' => 'admin/content/forum',
44
      'title' => t('Forums'),
45
      'description' => t('Control forums and their hierarchy and change forum settings.'),
46 47 48
      'callback' => 'forum_overview',
      'access' => user_access('administer forums'),
      'type' => MENU_NORMAL_ITEM);
49
    $items[] = array('path' => 'admin/content/forum/list',
50
      'title' => t('List'),
51 52 53
      'access' => user_access('administer forums'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -10);
54
    $items[] = array('path' => 'admin/content/forum/add/container',
55
      'title' => t('Add container'),
56 57
      'callback' => 'forum_form_main',
      'callback arguments' => array('container'),
58 59
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
60
    $items[] = array('path' => 'admin/content/forum/add/forum',
61
      'title' => t('Add forum'),
62 63
      'callback' => 'forum_form_main',
      'callback arguments' => array('forum'),
64 65
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
66
    $items[] = array('path' => 'admin/content/forum/settings',
67
      'title' => t('Settings'),
68 69
      'callback' => 'drupal_get_form',
      'callback arguments' => array('forum_admin_settings'),
70
      'weight' => 5,
71
      'access' => user_access('administer forums'),
72
      'type' => MENU_LOCAL_TASK);
73
  }
74 75
  elseif (is_numeric(arg(5))) {
    $term = taxonomy_get_term(arg(5));
76 77
    // Check if this is a valid term.
    if ($term) {
78
      $items[] = array('path' => 'admin/content/forum/edit/container',
79
        'title' => t('Edit container'),
80 81
        'callback' => 'forum_form_main',
        'callback arguments' => array('container', (array)$term),
82 83
        'access' => user_access('administer forums'),
        'type' => MENU_CALLBACK);
84
      $items[] = array('path' => 'admin/content/forum/edit/forum',
85
        'title' => t('Edit forum'),
86 87
        'callback' => 'forum_form_main',
        'callback arguments' => array('forum', (array)$term),
88 89 90 91
        'access' => user_access('administer forums'),
        'type' => MENU_CALLBACK);
    }
  }
92 93 94 95 96
  else {
    // Add the CSS for this module
    // We put this in !$may_cache so it's only added once per request
    drupal_add_css(drupal_get_path('module', 'forum') .'/forum.css');
  }
97 98 99 100

  return $items;
}

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

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

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

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

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

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

150 151 152
/**
 * Implementation of hook_taxonomy().
 */
153
function forum_taxonomy($op, $type, $term = NULL) {
154
  if ($op == 'delete' && $term['vid'] == _forum_get_vid()) {
155 156
    switch ($type) {
      case 'term':
157
        $results = db_query('SELECT f.nid FROM {forum} f WHERE f.tid = %d', $term['tid']);
158 159 160 161 162 163 164
        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());
165 166
        $key = array_search($term['tid'], $containers);
        if ($key !== FALSE) {
167 168 169 170 171 172
          unset($containers[$key]);
        }
        variable_set('forum_containers', $containers);
        break;
      case 'vocabulary':
        variable_del('forum_nav_vocabulary');
Dries's avatar
 
Dries committed
173
    }
174 175
  }
}
Dries's avatar
 
Dries committed
176

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

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

  return $forum;
}

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

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

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

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

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

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

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

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

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

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

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

328
  if ($node->taxonomy) {
329 330 331 332 333 334 335
    // 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
336
    foreach ($node->taxonomy as $term) {
337
      if (in_array($term, $forum_terms)) {
338
        $node->tid = $term;
Dries's avatar
 
Dries committed
339
      }
340
    }
341
    $old_tid = db_result(db_query_range("SELECT tid FROM {forum} WHERE nid = %d ORDER BY vid DESC", $node->nid, 0,1));
342
    if ($old_tid) {
343 344 345
      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
346 347
      }
    }
Dries's avatar
Dries committed
348
  }
349
}
Dries's avatar
Dries committed
350

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

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

385 386 387
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
388
function forum_form(&$node) {
389 390
  $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);
391

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

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

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

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

416 417 418 419 420 421 422 423 424 425 426 427
/**
 * 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
428
}
Dries's avatar
 
Dries committed
429

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
/**
 * 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']);
  }
470
  $form['#base'] = 'forum_form';
471

472
  return $form;
473 474
}

475 476 477 478 479 480 481 482 483 484 485 486 487 488
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;
  }
}

489 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
/**
 * 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']);
  }
521
  $form['#base'] = 'forum_form';
522

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

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

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

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

567
  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'));
568 569 570 571 572 573 574
}

/**
 * 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']);
575 576
  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'])));
577

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

/**
 * 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()))) {
drumm's avatar
drumm committed
591
        $rows[] = array(str_repeat(' -- ', $term->depth) .' '. check_plain($term->name), l(t('edit container'), "admin/content/forum/edit/container/$term->tid"));
592 593
      }
      else {
drumm's avatar
drumm committed
594
        $rows[] = array(str_repeat(' -- ', $term->depth) .' '. check_plain($term->name), l(t('edit forum'), "admin/content/forum/edit/forum/$term->tid"));
595 596 597 598 599
       }

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

650
function forum_link_alter(&$node, &$links) {
651
  foreach ($links as $module => $link) {
652
    if (strstr($module, 'taxonomy_term')) {
653 654
      // 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.
655
      $tid = str_replace('taxonomy/term/', '', $link['href']);
656 657
      $term = taxonomy_get_term($tid);
      if ($term->vid == _forum_get_vid()) {
658
        $links[$module]['href'] = str_replace('taxonomy/term', 'forum', $link['href']);
659
      }
660 661
    }
  }
662 663 664 665 666 667 668 669 670 671 672
}

/**
 * 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) {
673 674 675
      // 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));
676 677 678 679 680 681 682 683 684
      taxonomy_save_vocabulary($edit);
      $vid = $edit['vid'];
    }
    variable_set('forum_nav_vocabulary', $vid);
  }

  return $vid;
}

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

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

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

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

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

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

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

Dries's avatar
 
Dries committed
734 735 736 737 738 739 740 741 742 743 744
    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
745
    // used to join node_comment_statistics to users.
746
    $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";
747
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
748
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
749 750

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $nid ? $nid : 0;
}

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

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

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

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

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

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

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

  drupal_set_title($title);

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