forum.module 42.1 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 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
/**
 * Implementation of hook_theme()
 */
function forum_theme() {
  return array(
    'forum_display' => array(
      'arguments' => array('forums' => NULL, 'topics' => NULL, 'parents' => NULL, 'tid' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),
    ),
    'forum_list' => array(
      'arguments' => array('forums' => NULL, 'parents' => NULL, 'tid' => NULL),
    ),
    'forum_topic_list' => array(
      'arguments' => array('tid' => NULL, 'topics' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),
    ),
    'forum_icon' => array(
      'arguments' => array('new_posts' => NULL, 'num_posts' => 0, 'comment_mode' => 0, 'sticky' => 0),
    ),
    'forum_topic_navigation' => array(
      'arguments' => array('node' => NULL),
    ),
  );
}

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

120 121 122 123

/**
 * Implementation of hook_init().
 */
124 125 126
function forum_init() {
  drupal_add_css(drupal_get_path('module', 'forum') .'/forum.css');
}
127

128 129 130 131 132 133 134 135 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
/**
 * 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;
235 236
}

237
/**
238
 * Implementation of hook_node_info().
239
 */
240
function forum_node_info() {
241 242
  return array(
    'forum' => array(
243
      'name' => t('Forum topic'),
244 245 246 247 248
      'module' => 'forum',
      'description' => t('Create a new topic for discussion in the forums.'),
      'title_label' => t('Subject'),
    )
  );
Dries's avatar
 
Dries committed
249 250
}

251 252 253
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
254
function forum_access($op, $node) {
Dries's avatar
 
Dries committed
255 256
  global $user;

Dries's avatar
 
Dries committed
257 258
  if ($op == 'create') {
    return user_access('create forum topics');
Dries's avatar
 
Dries committed
259
  }
Dries's avatar
 
Dries committed
260 261 262 263 264 265

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

268 269 270
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
271
function forum_perm() {
272
  return array('create forum topics', 'edit own forum topics', 'administer forums');
Dries's avatar
 
Dries committed
273
}
Dries's avatar
 
Dries committed
274

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

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

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

350 351 352
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
353
function forum_load($node) {
354
  $forum = db_fetch_object(db_query('SELECT * FROM {term_node} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
355 356 357 358

  return $forum;
}

359 360 361 362 363 364
/**
 * Implementation of hook_block().
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
365 366 367
function forum_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
Dries's avatar
 
Dries committed
368 369
      $blocks[0]['info'] = t('Active forum topics');
      $blocks[1]['info'] = t('New forum topics');
370
      return $blocks;
Dries's avatar
 
Dries committed
371

372
    case 'configure':
373
      $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)));
374
      return $form;
Dries's avatar
 
Dries committed
375

376
    case 'save':
377
      variable_set('forum_block_num_'. $delta, $edit['forum_block_num_'. $delta]);
378
      break;
Dries's avatar
 
Dries committed
379

380 381
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
382 383
        switch ($delta) {
          case 0:
384
            $title = t('Active forum topics');
385 386
            $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'));
387 388 389
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
390
            break;
Dries's avatar
 
Dries committed
391 392

          case 1:
393
            $title = t('New forum topics');
394 395
            $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'));
396 397 398
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
399
            break;
Dries's avatar
 
Dries committed
400
        }
Dries's avatar
 
Dries committed
401

402
        if (!empty($content)) {
403
          $content .= '<div class="more-link">'. l(t('more'), 'forum', array('title' => t('Read the latest forum topics.'))) .'</div>';
404 405 406
          $block['subject'] = $title;
          $block['content'] = $content;
          return $block;
407 408 409
        }
      }
  }
Dries's avatar
 
Dries committed
410 411
}

412 413 414
/**
 * Implementation of hook_form().
 */
415
function forum_form(&$node, $form_state) {
416
  $type = node_get_types('type', $node);
417
  $form['title'] = array('#type' => 'textfield', '#title' => check_plain($type->title_label), '#default_value' => !empty($node->title) ? $node->title : '', '#required' => TRUE, '#weight' => -5);
418

419
  if (!empty($node->nid)) {
420 421
    $vid = variable_get('forum_nav_vocabulary', '');
    $forum_terms = taxonomy_node_get_terms_by_vocabulary($node, $vid);
Dries's avatar
Dries committed
422
    // if editing, give option to leave shadows
423
    $shadow = (count($forum_terms) > 1);
424
    $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
425
  }
Dries's avatar
 
Dries committed
426

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

429 430 431
  $form['#submit'][] = 'forum_submit';
  // Assign the forum topic submit handler.

432
  return $form;
Dries's avatar
 
Dries committed
433 434
}

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

472 473 474 475
  $form['vid'] = array(
    '#type' => 'hidden',
    '#value' => variable_get('forum_nav_vocabulary', ''),
  );
476 477
  $form['submit'] = array(
    '#type' => 'submit',
478
    '#value' => t('Save')
479 480 481 482 483
  );
  if ($edit['tid']) {
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['tid'] = array('#type' => 'value', '#value' => $edit['tid']);
  }
484
  $form['#submit'][] = 'forum_form_submit';
485
  $form['#theme'] = 'forum_form';
486

487
  return $form;
488 489
}

490
function forum_form_main($type, $edit = array()) {
491
  if ((isset($_POST['op']) && $_POST['op'] == t('Delete')) || !empty($_POST['confirm'])) {
492 493 494 495 496 497 498 499 500 501 502 503
    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;
  }
}

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

536
  $form['vid'] = array('#type' => 'hidden', '#value' => variable_get('forum_nav_vocabulary', ''));
537
  $form['submit' ] = array('#type' => 'submit', '#value' => t('Save'));
538 539 540 541
  if ($edit['tid']) {
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['tid'] = array('#type' => 'hidden', '#value' => $edit['tid']);
  }
542
  $form['#submit'][] = 'forum_form_submit';
543
  $form['#theme'] = 'forum_form';
544

545
  return $form;
546 547 548 549 550
}

/**
 * Process forum form and container form submissions.
 */
551
function forum_form_submit($form, &$form_state) {
552
  if ($form['form_id']['#value'] == 'forum_form_container') {
553 554 555 556
    $container = TRUE;
    $type = t('forum container');
  }
  else {
557
    $container = FALSE;
558 559 560
    $type = t('forum');
  }

561
  $status = taxonomy_save_term($form_state['values']);
562 563 564 565
  switch ($status) {
    case SAVED_NEW:
      if ($container) {
        $containers = variable_get('forum_containers', array());
566
        $containers[] = $form_state['values']['tid'];
567 568
        variable_set('forum_containers', $containers);
      }
569
      drupal_set_message(t('Created new @type %term.', array('%term' => $form_state['values']['name'], '@type' => $type)));
570 571
      break;
    case SAVED_UPDATED:
572
      drupal_set_message(t('The @type %term has been updated.', array('%term' => $form_state['values']['name'], '@type' => $type)));
573 574
      break;
  }
575 576
  $form_state['redirect'] = 'admin/content/forum';
  return;
577 578 579 580 581 582 583
}

/**
 * Returns a confirmation page for deleting a forum taxonomy term.
 *
 * @param $tid ID of the term to be deleted
 */
584
function forum_confirm_delete(&$form_state, $tid) {
585 586 587 588 589
  $term = taxonomy_get_term($tid);

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

590
  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'));
591 592 593 594 595
}

/**
 * Implementation of forms api _submit call. Deletes a forum after confirmation.
 */
596 597 598 599
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']));
600

601 602
  $form_state['redirect'] = 'admin/content/forum';
  return;
603 604 605 606 607 608 609 610
}

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

611 612
  $vid = variable_get('forum_nav_vocabulary', '');
  $tree = taxonomy_get_tree($vid);
613 614 615
  if ($tree) {
    foreach ($tree as $term) {
      if (in_array($term->tid, variable_get('forum_containers', array()))) {
616
        $rows[] = array(str_repeat(' -- ', $term->depth) .' '. l($term->name, 'forum/'. $term->tid), l(t('edit container'), 'admin/content/forum/edit/container/'. $term->tid));
617 618
      }
      else {
619
        $rows[] = array(str_repeat(' -- ', $term->depth) .' '. l($term->name, 'forum/'. $term->tid), l(t('edit forum'), 'admin/content/forum/edit/forum/'. $term->tid));
620 621 622 623 624
       }

    }
  }
  else {
625
    $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));
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
  }
  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;
  }

648 649
  $vid = variable_get('forum_nav_vocabulary', '');
  $children = taxonomy_get_tree($vid, $tid);
650 651 652 653 654 655 656

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

657
  $tree = taxonomy_get_tree($vid);
658 659 660 661
  $options[0] = '<'. t('root') .'>';
  if ($tree) {
    foreach ($tree as $term) {
      if (!in_array($term->tid, $exclude)) {
drumm's avatar
drumm committed
662
        $options[$term->tid] = str_repeat(' -- ', $term->depth) . $term->name;
663 664 665 666 667 668 669 670 671 672 673 674 675
      }
    }
  }
  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);
}

676
function forum_link_alter(&$links, $node) {
677
  foreach ($links as $module => $link) {
678
    if (strstr($module, 'taxonomy_term')) {
679 680
      // 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.
681
      $tid = str_replace('taxonomy/term/', '', $link['href']);
682
      $vid = variable_get('forum_nav_vocabulary', '');
683
      $term = taxonomy_get_term($tid);
684
      if ($term->vid == $vid) {
685
        $links[$module]['href'] = str_replace('taxonomy/term', 'forum', $link['href']);
686
      }
687 688
    }
  }
689 690
}

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

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

Dries's avatar
 
Dries committed
720
  $forums = array();
721 722
  $vid = variable_get('forum_nav_vocabulary', '');
  $_forums = taxonomy_get_tree($vid, $tid);
Dries's avatar
 
Dries committed
723

Dries's avatar
 
Dries committed
724
  if (count($_forums)) {
Dries's avatar
 
Dries committed
725

Dries's avatar
 
Dries committed
726 727
    $counts = array();

728
    $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";
729
    $sql = db_rewrite_sql($sql);
730
    $_counts = db_query($sql);
Dries's avatar
 
Dries committed
731 732 733
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
734
  }
Dries's avatar
 
Dries committed
735

Dries's avatar
 
Dries committed
736 737 738 739
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
740

741
    if (!empty($counts[$forum->tid])) {
Dries's avatar
 
Dries committed
742 743 744 745 746 747 748 749 750 751
      $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
752
    // used to join node_comment_statistics to users.
753
    $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";
754
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
755
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
756

757
    $last_post = new stdClass();
758 759 760 761 762
    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
763
    $forum->last_post = $last_post;
Dries's avatar
 
Dries committed
764

Dries's avatar
 
Dries committed
765 766 767 768
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
769 770
}

771 772 773 774 775
/**
 * Calculate the number of nodes the user has not yet read and are newer
 * than NODE_NEW_LIMIT.
 */
function _forum_topics_unread($term, $uid) {
776
  $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";
777
  $sql = db_rewrite_sql($sql);
778
  return db_result(db_query($sql, $term, $uid, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
779 780
}

Dries's avatar
Dries committed
781
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
782
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
783

Dries's avatar
 
Dries committed
784
  $forum_topic_list_header = array(
785
    array('data' => '&nbsp;', 'field' => NULL),
Dries's avatar
 
Dries committed
786
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
787
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
788
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
789
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
790
  );
Dries's avatar
 
Dries committed
791

Dries's avatar
 
Dries committed
792
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
793
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
794 795
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
796 797 798 799
    }
  }

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

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

805
  $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
806

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

Dries's avatar
 
Dries committed
827
    if ($topic->num_comments > 0) {
828
      $last_reply = new stdClass();
Dries's avatar
 
Dries committed
829 830 831 832 833
      $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
834 835 836
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
837
  return $topics;
Dries's avatar
 
Dries committed
838 839
}

Dries's avatar
 
Dries committed
840 841 842
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
843
function _forum_new($tid) {
Dries's avatar
 
Dries committed
844 845
  global $user;

846
  $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";
847
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
848
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
849 850 851 852

  return $nid ? $nid : 0;
}

853
/**
Dries's avatar
Dries committed
854
 * Menu callback; prints a forum listing.
855
 */
Dries's avatar
Dries committed
856
function forum_page($tid = 0) {
857
  $topics = '';
858 859
  $forum_per_page = variable_get('forum_per_page', 25);
  $sortby = variable_get('forum_order', 1);
Dries's avatar
Dries committed
860

861 862 863 864
  $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
865
  }
866 867

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

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

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

Dries's avatar
 
Dries committed
883 884
  // Breadcrumb navigation:
  $breadcrumb = array();
Dries's avatar
 
Dries committed
885
  if ($tid) {
Dries's avatar
 
Dries committed
886
    $breadcrumb[] = array('path' => 'forum', 'title' => $title);
Dries's avatar
 
Dries committed
887
  }
Dries's avatar
 
Dries committed
888 889

  if ($parents) {
Dries's avatar
 
Dries committed
890 891
    $parents = array_reverse($parents);
    foreach ($parents as $p) {