forum.module 42.9 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
/**
 * Implementation of hook_help().
 */
12 13
function forum_help($path, $arg) {
  switch ($path) {
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
    case 'admin/content/forum/settings':
27
      return '<p>'. t('These settings provide the ability to fine tune the display of your forum topics. Choose the content types to use in the forums by editing the options for the <a href="@forum_vocab">forum vocabulary</a>.', array('@forum_vocab' => url('admin/content/taxonomy/edit/vocabulary/'. variable_get('forum_nav_vocabulary', '')))) .'</p>';
Dries's avatar
 
Dries committed
28 29 30
  }
}

31 32 33 34 35 36
/**
 * Implementation of hook_theme()
 */
function forum_theme() {
  return array(
    'forum_display' => array(
37
      'file' => 'forum-display',
38 39 40
      'arguments' => array('forums' => NULL, 'topics' => NULL, 'parents' => NULL, 'tid' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),
    ),
    'forum_list' => array(
41
      'file' => 'forum-list',
42 43 44
      'arguments' => array('forums' => NULL, 'parents' => NULL, 'tid' => NULL),
    ),
    'forum_topic_list' => array(
45
      'file' => 'forum-topic-list',
46 47 48
      'arguments' => array('tid' => NULL, 'topics' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),
    ),
    'forum_icon' => array(
49
      'file' => 'forum-icon',
50 51 52
      'arguments' => array('new_posts' => NULL, 'num_posts' => 0, 'comment_mode' => 0, 'sticky' => 0),
    ),
    'forum_topic_navigation' => array(
53
      'file' => 'forum-topic-navigation',
54 55
      'arguments' => array('node' => NULL),
    ),
56 57 58 59
    'forum_format_topic' => array(
      'file' => 'forum-format-topic',
      'arguments' => array('topic' => NULL),
    ),
60 61 62
  );
}

63 64 65
/**
 * Implementation of hook_menu().
 */
66 67
function forum_menu() {
  $items['node/add/forum'] = array(
68
    'title' => 'Forum topic',
69 70 71
    'access arguments' => array('create forum topics'),
  );
  $items['forum'] = array(
72
    'title' => 'Forums',
73 74 75 76 77
    'page callback' => 'forum_page',
    'access arguments' => array('access content'),
    'type' => MENU_SUGGESTED_ITEM,
  );
  $items['admin/content/forum'] = array(
78 79
    'title' => 'Forums',
    'description' => 'Control forums and their hierarchy and change forum settings.',
80 81 82 83
    'page callback' => 'forum_overview',
    'access arguments' => array('administer forums'),
  );
  $items['admin/content/forum/list'] = array(
84
    'title' => 'List',
85 86 87 88
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/content/forum/add/container'] = array(
89
    'title' => 'Add container',
90 91 92
    'page callback' => 'forum_form_main',
    'page arguments' => array('container'),
    'type' => MENU_LOCAL_TASK,
93
    'parent' => 'admin/content/forum',
94 95
  );
  $items['admin/content/forum/add/forum'] = array(
96
    'title' => 'Add forum',
97 98 99
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum'),
    'type' => MENU_LOCAL_TASK,
100
    'parent' => 'admin/content/forum',
101 102
  );
  $items['admin/content/forum/settings'] = array(
103
    'title' => 'Settings',
104 105 106 107
    'page callback' => 'drupal_get_form',
    'page arguments' => array('forum_admin_settings'),
    'weight' => 5,
    'type' => MENU_LOCAL_TASK,
108
    'parent' => 'admin/content/forum',
109
  );
110
  $items['admin/content/forum/edit/%forum_term'] = array(
111 112 113
    'page callback' => 'forum_form_main',
    'type' => MENU_CALLBACK,
  );
114
  $items['admin/content/forum/edit/container/%forum_term'] = array(
115
    'title' => 'Edit container',
116
    'page callback' => 'forum_form_main',
117
    'page arguments' => array('container', 5),
118
    'type' => MENU_CALLBACK,
119
  );
120
  $items['admin/content/forum/edit/forum/%forum_term'] = array(
121
    'title' => 'Edit forum',
122 123
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum', 5),
124
    'type' => MENU_CALLBACK,
125 126 127
  );
  return $items;
}
128

129 130 131 132

/**
 * Implementation of hook_init().
 */
133 134 135
function forum_init() {
  drupal_add_css(drupal_get_path('module', 'forum') .'/forum.css');
}
136

137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 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 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
/**
 * Implementation of hook_nodeapi().
 */
function forum_nodeapi(&$node, $op, $teaser, $page) {
  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);

  // Operate only on node types assigned for the forum vocabulary.
  if (!in_array($node->type, $vocabulary->nodes)) {
    return;
  }

  switch ($op) {
    case 'view':
      if ($page && $node->taxonomy) {
        // Get the forum terms from the (cached) tree
        $tree = taxonomy_get_tree($vid);
        if ($tree) {
          foreach ($tree as $term) {
            $forum_terms[] = $term->tid;
          }
        }
        foreach ($node->taxonomy as $term_id => $term) {
          if (in_array($term_id, $forum_terms)) {
            $node->tid = $term_id;
          }
        }
        // Breadcrumb navigation
        $breadcrumb = array();
        $breadcrumb[] = array('path' => 'forum', 'title' => $vocabulary->name);
        if ($parents = taxonomy_get_parents_all($node->tid)) {
          $parents = array_reverse($parents);
          foreach ($parents as $p) {
            $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
          }
        }
        $breadcrumb[] = array('path' => 'node/'. $node->nid);
        menu_set_location($breadcrumb);

        $node = node_prepare($node, $teaser);
        if (!$teaser) {
          $node->content['forum_navigation'] = array(
            '#value' => theme('forum_topic_navigation', $node),
            '#weight' => 100,
          );
        }
      }
      return $node;
      break;

    case 'prepare':
      if (empty($node->nid)) {
        // New topic
        $node->taxonomy[arg(3)]->vid = $vid;
        $node->taxonomy[arg(3)]->tid = arg(3);
      }
      return $node;
      break;

    // Check in particular that only a "leaf" term in the associated taxonomy
    // vocabulary is selected, not a "container" term.
    case 'validate':
      if ($node->taxonomy) {
        // Extract the node's proper topic ID.
        $vocabulary = $vid;
        $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)));
            }
          }
        }
      }
      break;

    // Assign forum taxonomy when adding a topic from within a forum.
    case 'submit':
      // Make sure all fields are set properly:
      $node->icon = !empty($node->icon) ? $node->icon : '';

      if ($node->taxonomy) {
        // Get the forum terms from the (cached) tree
        $tree = taxonomy_get_tree($vid);
        if ($tree) {
          foreach ($tree as $term) {
            $forum_terms[] = $term->tid;
          }
        }
        foreach ($node->taxonomy as $term_id => $term) {
          if (in_array($term_id, $forum_terms)) {
            $node->tid = $term_id;
          }
        }
        $old_tid = db_result(db_query_range("SELECT t.tid FROM {term_data} t INNER JOIN {node} n WHERE t.vid = n.vid AND n.nid = %d ORDER BY t.vid DESC", $node->nid, 0, 1));
        if ($old_tid) {
          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;
          }
        }
      }
      break;
  }

  return;
244 245
}

246
/**
247
 * Implementation of hook_node_info().
248
 */
249
function forum_node_info() {
250 251
  return array(
    'forum' => array(
252
      'name' => t('Forum topic'),
253 254 255 256 257
      'module' => 'forum',
      'description' => t('Create a new topic for discussion in the forums.'),
      'title_label' => t('Subject'),
    )
  );
Dries's avatar
 
Dries committed
258 259
}

260 261 262
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
263
function forum_access($op, $node) {
Dries's avatar
 
Dries committed
264 265
  global $user;

Dries's avatar
 
Dries committed
266 267
  if ($op == 'create') {
    return user_access('create forum topics');
Dries's avatar
 
Dries committed
268
  }
Dries's avatar
 
Dries committed
269 270 271 272 273 274

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

277 278 279
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
280
function forum_perm() {
281
  return array('create forum topics', 'edit own forum topics', 'administer forums');
Dries's avatar
 
Dries committed
282
}
Dries's avatar
 
Dries committed
283

284 285 286
/**
 * Implementation of hook_taxonomy().
 */
287
function forum_taxonomy($op, $type, $term = NULL) {
288
  if ($op == 'delete' && $term['vid'] == variable_get('forum_nav_vocabulary', '')) {
289 290
    switch ($type) {
      case 'term':
291
        $results = db_query('SELECT tn.nid FROM {term_node} tn WHERE tn.tid = %d', $term['tid']);
292 293 294 295 296 297 298
        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());
299 300
        $key = array_search($term['tid'], $containers);
        if ($key !== FALSE) {
301 302 303 304 305 306
          unset($containers[$key]);
        }
        variable_set('forum_containers', $containers);
        break;
      case 'vocabulary':
        variable_del('forum_nav_vocabulary');
Dries's avatar
 
Dries committed
307
    }
308 309
  }
}
Dries's avatar
 
Dries committed
310

Dries's avatar
Dries committed
311
function forum_admin_settings() {
312
  $form = array();
313
  $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 150, 200, 250, 300, 350, 400, 500));
314 315 316 317 318 319
  $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.'),
  );
320
  $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
321 322 323 324 325 326
  $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.'),
  );
327
  $forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4 => t('Posts - least active first'));
328 329 330 331 332 333
  $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.'),
  );
334
  return system_settings_form($form);
335 336
}

337 338 339
/**
 * Implementation of hook_form_alter().
 */
340
function forum_form_alter(&$form, $form_state, $form_id) {
341
  // Hide critical options from forum vocabulary
342
  if ($form_id == 'taxonomy_form_vocabulary') {
343 344
    $vid = variable_get('forum_nav_vocabulary', '');
    if (isset($form['vid']) && $form['vid']['#value'] == $vid) {
345 346 347 348
      $form['help_forum_vocab'] = array(
        '#value' => t('This is the designated forum vocabulary. Some of the normal vocabulary options have been removed.'),
        '#weight' => -1,
      );
349
      $form['nodes']['#required'] = TRUE;
350 351 352 353 354 355 356 357 358
      $form['hierarchy'] = array('#type' => 'value', '#value' => 1);
      unset($form['relations']);
      unset($form['tags']);
      unset($form['multiple']);
      $form['required'] = array('#type' => 'value', '#value' => 1);
    }
  }
}

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

  return $forum;
}

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

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

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

389 390
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
391 392
        switch ($delta) {
          case 0:
393
            $title = t('Active forum topics');
394 395
            $sql = db_rewrite_sql("SELECT n.nid, n.title, l.comment_count, l.last_comment_timestamp FROM {node} n INNER JOIN {term_node} tn ON tn.nid = n.nid INNER JOIN {term_data} td ON td.tid = tn.tid INNER JOIN {node_comment_statistics} l ON n.nid = l.nid WHERE n.status = 1 AND td.vid = %d ORDER BY l.last_comment_timestamp DESC");
            $result = db_query_range($sql, variable_get('forum_nav_vocabulary', ''), 0, variable_get('forum_block_num_0', '5'));
396 397 398
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
399
            break;
Dries's avatar
 
Dries committed
400 401

          case 1:
402
            $title = t('New forum topics');
403 404
            $sql = db_rewrite_sql("SELECT n.nid, n.title, l.comment_count FROM {node} n INNER JOIN {term_node} tn ON tn.nid = n.nid INNER JOIN {term_data} td ON td.tid = tn.tid INNER JOIN {node_comment_statistics} l ON n.nid = l.nid WHERE n.status = 1 AND td.vid = %d ORDER BY n.nid DESC");
            $result = db_query_range($sql, variable_get('forum_nav_vocabulary', ''), 0, variable_get('forum_block_num_1', '5'));
405 406 407
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
408
            break;
Dries's avatar
 
Dries committed
409
        }
Dries's avatar
 
Dries committed
410

411
        if (!empty($content)) {
412
          $content .= '<div class="more-link">'. l(t('more'), 'forum', array('title' => t('Read the latest forum topics.'))) .'</div>';
413 414 415
          $block['subject'] = $title;
          $block['content'] = $content;
          return $block;
416 417 418
        }
      }
  }
Dries's avatar
 
Dries committed
419 420
}

421 422 423
/**
 * Implementation of hook_form().
 */
424
function forum_form(&$node, $form_state) {
425
  $type = node_get_types('type', $node);
426
  $form['title'] = array('#type' => 'textfield', '#title' => check_plain($type->title_label), '#default_value' => !empty($node->title) ? $node->title : '', '#required' => TRUE, '#weight' => -5);
427

428
  if (!empty($node->nid)) {
429 430
    $vid = variable_get('forum_nav_vocabulary', '');
    $forum_terms = taxonomy_node_get_terms_by_vocabulary($node, $vid);
Dries's avatar
Dries committed
431
    // if editing, give option to leave shadows
432
    $shadow = (count($forum_terms) > 1);
433
    $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
434
  }
Dries's avatar
 
Dries committed
435

436
  $form['body_field'] = node_body_field($node, $type->body_label, 1);
Dries's avatar
 
Dries committed
437

438 439 440
  $form['#submit'][] = 'forum_submit';
  // Assign the forum topic submit handler.

441
  return $form;
Dries's avatar
 
Dries committed
442 443
}

444 445 446 447 448
/**
 * Returns a form for adding a container to the forum vocabulary
 *
 * @param $edit Associative array containing a container term to be added or edited.
 */
449
function forum_form_container(&$form_state, $edit = array()) {
450 451 452
  $edit += array(
    'name' => '',
    'description' => '',
453
    'tid' => NULL,
454 455
    'weight' => 0,
  );
456 457 458 459 460
  // Handle a delete operation.
  $form['name'] = array(
    '#title' => t('Container name'),
    '#type' => 'textfield',
    '#default_value' => $edit['name'],
461
    '#maxlength' => 255,
462 463 464 465 466 467 468 469 470 471 472 473
    '#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');
474 475
  $form['weight'] = array(
    '#type' => 'weight',
476 477 478 479 480
    '#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.')
  );

481 482 483 484
  $form['vid'] = array(
    '#type' => 'hidden',
    '#value' => variable_get('forum_nav_vocabulary', ''),
  );
485 486
  $form['submit'] = array(
    '#type' => 'submit',
487
    '#value' => t('Save')
488 489 490 491 492
  );
  if ($edit['tid']) {
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['tid'] = array('#type' => 'value', '#value' => $edit['tid']);
  }
493
  $form['#submit'][] = 'forum_form_submit';
494
  $form['#theme'] = 'forum_form';
495

496
  return $form;
497 498
}

499
function forum_form_main($type, $edit = array()) {
500
  if ((isset($_POST['op']) && $_POST['op'] == t('Delete')) || !empty($_POST['confirm'])) {
501 502 503 504 505 506 507 508 509 510 511 512
    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;
  }
}

513 514 515 516 517
/**
 * Returns a form for adding a forum to the forum vocabulary
 *
 * @param $edit Associative array containing a forum term to be added or edited.
 */
518
function forum_form_forum(&$form_state, $edit = array()) {
519
  $edit += array(
520 521 522
    'name' => '',
    'description' => '',
    'tid' => NULL,
523 524
    'weight' => 0,
  );
525 526 527
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Forum name'),
    '#default_value' => $edit['name'],
528
    '#maxlength' => 255,
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
    '#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.'),
  );

545
  $form['vid'] = array('#type' => 'hidden', '#value' => variable_get('forum_nav_vocabulary', ''));
546
  $form['submit' ] = array('#type' => 'submit', '#value' => t('Save'));
547 548 549 550
  if ($edit['tid']) {
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['tid'] = array('#type' => 'hidden', '#value' => $edit['tid']);
  }
551
  $form['#submit'][] = 'forum_form_submit';
552
  $form['#theme'] = 'forum_form';
553

554
  return $form;
555 556 557 558 559
}

/**
 * Process forum form and container form submissions.
 */
560
function forum_form_submit($form, &$form_state) {
561
  if ($form['form_id']['#value'] == 'forum_form_container') {
562 563 564 565
    $container = TRUE;
    $type = t('forum container');
  }
  else {
566
    $container = FALSE;
567 568 569
    $type = t('forum');
  }

570
  $status = taxonomy_save_term($form_state['values']);
571 572 573 574
  switch ($status) {
    case SAVED_NEW:
      if ($container) {
        $containers = variable_get('forum_containers', array());
575
        $containers[] = $form_state['values']['tid'];
576 577
        variable_set('forum_containers', $containers);
      }
578
      drupal_set_message(t('Created new @type %term.', array('%term' => $form_state['values']['name'], '@type' => $type)));
579 580
      break;
    case SAVED_UPDATED:
581
      drupal_set_message(t('The @type %term has been updated.', array('%term' => $form_state['values']['name'], '@type' => $type)));
582 583
      break;
  }
584 585
  $form_state['redirect'] = 'admin/content/forum';
  return;
586 587 588 589 590 591 592
}

/**
 * Returns a confirmation page for deleting a forum taxonomy term.
 *
 * @param $tid ID of the term to be deleted
 */
593
function forum_confirm_delete(&$form_state, $tid) {
594 595 596 597 598
  $term = taxonomy_get_term($tid);

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

599
  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'));
600 601 602 603 604
}

/**
 * Implementation of forms api _submit call. Deletes a forum after confirmation.
 */
605 606 607 608
function forum_confirm_delete_submit($form, &$form_state) {
  taxonomy_del_term($form_state['values']['tid']);
  drupal_set_message(t('The forum %term and all sub-forums and associated posts have been deleted.', array('%term' => $form_state['values']['name'])));
  watchdog('content', 'forum: deleted %term and all its sub-forums and associated posts.', array('%term' => $form_state['values']['name']));
609

610 611
  $form_state['redirect'] = 'admin/content/forum';
  return;
612 613 614 615 616 617 618 619
}

/**
 * Returns an overview list of existing forums and containers
 */
function forum_overview() {
  $header = array(t('Name'), t('Operations'));

620 621
  $vid = variable_get('forum_nav_vocabulary', '');
  $tree = taxonomy_get_tree($vid);
622 623 624
  if ($tree) {
    foreach ($tree as $term) {
      if (in_array($term->tid, variable_get('forum_containers', array()))) {
625
        $rows[] = array(str_repeat(' -- ', $term->depth) .' '. l($term->name, 'forum/'. $term->tid), l(t('edit container'), 'admin/content/forum/edit/container/'. $term->tid));
626 627
      }
      else {
628
        $rows[] = array(str_repeat(' -- ', $term->depth) .' '. l($term->name, 'forum/'. $term->tid), l(t('edit forum'), 'admin/content/forum/edit/forum/'. $term->tid));
629 630 631 632 633
       }

    }
  }
  else {
634
    $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));
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
  }
  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;
  }

657 658
  $vid = variable_get('forum_nav_vocabulary', '');
  $children = taxonomy_get_tree($vid, $tid);
659 660 661 662 663 664 665

  // A term can't be the child of itself, nor of its children.
  foreach ($children as $child) {
    $exclude[] = $child->tid;
  }
  $exclude[] = $tid;

666
  $tree = taxonomy_get_tree($vid);
667 668 669 670
  $options[0] = '<'. t('root') .'>';
  if ($tree) {
    foreach ($tree as $term) {
      if (!in_array($term->tid, $exclude)) {
drumm's avatar
drumm committed
671
        $options[$term->tid] = str_repeat(' -- ', $term->depth) . $term->name;
672 673 674 675 676 677 678 679 680 681 682 683 684
      }
    }
  }
  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);
}

685
function forum_link_alter(&$links, $node) {
686
  foreach ($links as $module => $link) {
687
    if (strstr($module, 'taxonomy_term')) {
688 689
      // 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.
690
      $tid = str_replace('taxonomy/term/', '', $link['href']);
691
      $vid = variable_get('forum_nav_vocabulary', '');
692
      $term = taxonomy_get_term($tid);
693
      if ($term->vid == $vid) {
694
        $links[$module]['href'] = str_replace('taxonomy/term', 'forum', $link['href']);
695
      }
696 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
  $forums = array();
716 717
  $vid = variable_get('forum_nav_vocabulary', '');
  $_forums = taxonomy_get_tree($vid, $tid);
Dries's avatar
 
Dries committed
718

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

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

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

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

736
    if (!empty($counts[$forum->tid])) {
Dries's avatar
 
Dries committed
737 738 739 740 741 742 743 744 745 746
      $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
747
    // used to join node_comment_statistics to users.
748
    $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 tn.tid = %d ORDER BY ncs.last_comment_timestamp DESC";
749
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
750
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
751

752
    $last_post = new stdClass();
753 754 755 756 757
    if (!empty($topic->last_comment_timestamp)) {
      $last_post->timestamp = $topic->last_comment_timestamp;
      $last_post->name = $topic->last_comment_name;
      $last_post->uid = $topic->last_comment_uid;
    }
Dries's avatar
 
Dries committed
758
    $forum->last_post = $last_post;
Dries's avatar
 
Dries committed
759

Dries's avatar
 
Dries committed
760 761 762 763
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
764 765
}

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

Dries's avatar
Dries committed
776
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
777
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
778

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

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

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

796
  $sql = db_rewrite_sql("SELECT n.nid, r.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, {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 = r.vid");
Dries's avatar
 
Dries committed
797
  $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
798
  $sql .= ', n.created DESC';  // Always add a secondary sort order so that the news forum topics are on top.
Dries's avatar
Dries committed
799

800
  $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");
Dries's avatar
 
Dries committed
801

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

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

Dries's avatar
Dries committed
832
  return $topics;
Dries's avatar
 
Dries committed
833 834
}

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

841
  $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 h.nid IS NULL AND n.created > %d ORDER BY created";
842
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
843
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
844 845 846 847

  return $nid ? $nid : 0;
}

848
/**
Dries's avatar
Dries committed
849
 * Menu callback; prints a forum listing.
850
 */
Dries's avatar
Dries committed
851
function forum_page($tid = 0) {
852
  $topics = '';
853 854
  $forum_per_page = variable_get('forum_per_page', 25);
  $sortby = variable_get('forum_order', 1);
Dries's avatar
Dries committed
855

856 857 858 859
  $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
860
  }
861 862

  return theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
863 864
}

Dries's avatar
 
Dries committed
865
/**
866 867 868 869 870 871 872 873 874
 * Process variables for forum-display.tpl.php
 *
 * The $variables array contains the following arguments:
 * - $forums
 * - $topics
 * - $parents
 * - $tid
 * - $sortby
 * - $forum_per_page
Dries's avatar
 
Dries committed
875
 *
876
 * @see forum-display.tpl.php
Dries's avatar
 
Dries committed
877
 */
878
function template_preprocess_forum_display(&$variables) {
Dries's avatar
 
Dries committed
879
  global $user;
Dries's avatar
 
Dries committed
880
  // forum list, topics list, topic browser and 'add new topic' link
Dries's avatar
 
Dries committed
881

882 883
  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);
884
  $title = !empty($vocabulary->name) ? $vocabulary->name : '';
Dries's avatar
 
Dries committed
885

Dries's avatar
 
Dries committed
886 887
  // Breadcrumb navigation:
  $breadcrumb = array();
888
  if ($variables['tid']) {
Dries's avatar