forum.module 40.7 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 18 19 20 21 22 23 24 25
      $output .= '<p>'. t('Forums module <strong>requires Taxonomy and Comments module</strong> be enabled.') .'</p>';
      $output .= t('<p>You can</p>
<ul>
<li>administer forums at <a href="%admin-forum">administer &gt;&gt; forums</a>.</li>
<li>enable the required comment and taxonomy modules at <a href="%admin-modules">administer &gt;&gt; modules</a>.</li>
<li>read about the comment module at <a href="%admin-help-comment">administer &gt;&gt; help &gt;&gt; comment</a>.</li>
<li>read about the taxonomy module at <a href="%admin-help-taxonomy">administer &gt;&gt; help &gt;&gt; taxonomy</a>.</li>
</ul>
', array('%admin-forum' => url('admin/forum'), '%admin-modules' => url('admin/modules'), '%admin-help-comment' => url('admin/help/comment'), '%admin-help-taxonomy' => url('admin/help/taxonomy')));
26
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="%forum">Forum page</a>.', array('%forum' => 'http://drupal.org/handbook/modules/forum/')) .'</p>';
27 28 29
      return $output;
    case 'admin/modules#description':
      return t('Enables threaded discussions about general topics.');
30
    case 'admin/forum':
31
      return t('<p>This is a list of existing containers and forums that you can edit. Containers hold forums and, in turn, forums hold threaded discussions. Both containers and forums can be placed inside other containers and forums. By planning the structure of your containers and forums well, you make it easier for users to find a topic area of interest to them.</p>');
32
    case 'admin/forum/add/container':
33
      return t('<p>Containers help you organize your forums. The job of a container is to hold, or contain, other forums that are related. For example, a container named "Food" might hold two forums named "Fruit" and "Vegetables".</p>');
34
    case 'admin/forum/add/forum':
35
      return t('<p>A forum holds discussion topics that are related. For example, a forum named "Fruit" might contain topics titled "Apples" and "Bananas".</p>');
Dries's avatar
 
Dries committed
36
    case 'node/add#forum':
37
      return t('Create a new topic for discussion in the forums.');
Dries's avatar
 
Dries committed
38 39 40
  }
}

41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
/**
 * Implementation of hook_menu().
 */
function forum_menu($may_cache) {
  $items = array();

  if ($may_cache) {
    $items[] = array('path' => 'node/add/forum',
      'title' => t('forum topic'),
      'access' => user_access('create forum topics'));
    $items[] = array('path' => 'forum',
      'title' => t('forums'),
      'callback' => 'forum_page',
      'access' => user_access('access content'),
      'type' => MENU_SUGGESTED_ITEM);
    $items[] = array('path' => 'admin/forum',
      'title' => t('forums'),
      'callback' => 'forum_overview',
      'access' => user_access('administer forums'),
      'type' => MENU_NORMAL_ITEM);
    $items[] = array('path' => 'admin/forum/list',
      'title' => t('list'),
      'access' => user_access('administer forums'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -10);
    $items[] = array('path' => 'admin/forum/add/container',
      'title' => t('add container'),
      'callback' => 'forum_form_container',
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
    $items[] = array('path' => 'admin/forum/add/forum',
      'title' => t('add forum'),
      'callback' => 'forum_form_forum',
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
Dries's avatar
Dries committed
76 77 78
    $items[] = array('path' => 'admin/settings/forum',
      'title' => t('forums'),
      'callback' => 'forum_admin_settings',
79
      'access' => user_access('administer forums'),
Dries's avatar
Dries committed
80
      'type' => MENU_NORMAL_ITEM);
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
  }
  elseif (is_numeric(arg(4))) {
    $term = taxonomy_get_term(arg(4));
    // Check if this is a valid term.
    if ($term) {
      $items[] = array('path' => 'admin/forum/edit/container',
        'title' => t('edit container'),
        'callback' => 'forum_form_container',
        'callback arguments' => array((array)$term),
        'access' => user_access('administer forums'),
        'type' => MENU_CALLBACK);
      $items[] = array('path' => 'admin/forum/edit/forum',
        'title' => t('edit forum'),
        'callback' => 'forum_form_forum',
        'callback arguments' => array((array)$term),
        'access' => user_access('administer forums'),
        'type' => MENU_CALLBACK);
    }
  }

  return $items;
}

104
/**
105
 * Implementation of hook_node_info().
106
 */
107
function forum_node_info() {
108
  return array('forum' => array('name' => t('forum topic'), 'base' => 'forum'));
Dries's avatar
 
Dries committed
109 110
}

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

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

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

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

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

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

Dries's avatar
Dries committed
173
function forum_admin_settings() {
174

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

198
  return system_settings_form('forum_admin_configure', $form);
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
/**
 * 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']);
    }
  }
}

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

  return $forum;
}

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

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

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

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

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

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

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

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

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

308
  $node = node_prepare($node, $teaser);
309 310

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

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

  if ($node->taxonomy) {
    // Extract the node's proper topic ID.
Dries's avatar
 
Dries committed
325
    $vocabulary = variable_get('forum_nav_vocabulary', '');
Dries's avatar
 
Dries committed
326
    foreach ($node->taxonomy as $term) {
Dries's avatar
 
Dries committed
327
      if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
328
        $node->tid = $term;
Dries's avatar
 
Dries committed
329
      }
330
    }
Dries's avatar
 
Dries committed
331
    if ($node->tid && $node->shadow) {
332
      // A shadow copy needs to be created. Retain existing term and add new term.
333
      $terms = array_keys(taxonomy_node_get_terms($node->nid));
334
      if (!in_array($node->tid, $terms)) {
Dries's avatar
 
Dries committed
335 336 337 338
        $terms[] = $node->tid;
      }
      $node->taxonomy = $terms;
    }
Dries's avatar
Dries committed
339 340 341
  }
}

342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
/**
 * 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' => theme('placeholder', $term->name))));
        }
      }
    }
  }
}

Dries's avatar
 
Dries committed
364 365 366 367
/**
 * Implementation of hook_update().
 */
function forum_update($node) {
368
  if ($node->revision) {
369 370 371 372 373
    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
374 375
}

376 377 378
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
379
function forum_form(&$node) {
380
  $form['title'] = array('#type' => 'textfield', '#title' => t('Subject'), '#default_value' => $node->title, '#required' => TRUE, '#weight' => -5);
381

382
  if ($node->nid) {
383
    $forum_terms = taxonomy_node_get_terms_by_vocabulary(_forum_get_vid(), $node->nid);
Dries's avatar
Dries committed
384
    // if editing, give option to leave shadows
385
    $shadow = (count($forum_terms) > 1);
386
    $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
387
  }
Dries's avatar
 
Dries committed
388

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

392
  return $form;
Dries's avatar
 
Dries committed
393 394
}

395 396 397 398 399 400
/**
 * Implementation of hook_prepare; assign forum taxonomy when adding a topic from within a forum.
 */
function forum_prepare(&$node) {
  if (!$node->nid) {
    // new topic
401 402
    $node->taxonomy[arg(3)]->vid = _forum_get_vid();
    $node->taxonomy[arg(3)]->tid = arg(3);
403 404 405
  }
}

406 407 408
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
409
function forum_insert($node) {
410
  db_query('INSERT INTO {forum} (nid, vid, tid) VALUES (%d, %d, %d)', $node->nid, $node->vid, $node->tid);
Dries's avatar
 
Dries committed
411 412
}

413 414 415
/**
 * Implementation of hook_delete().
 */
Dries's avatar
 
Dries committed
416
function forum_delete(&$node) {
Dries's avatar
 
Dries committed
417
  db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
418
}
Dries's avatar
 
Dries committed
419

420 421 422 423 424 425 426 427 428 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 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 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
/**
 * 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.
  if ($_POST['op'] == t('Delete') || $_POST['edit']['confirm']) {
    return _forum_confirm_delete($edit['tid']);
  }

  $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']);
  }

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

/**
 * 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()) {
  // Handle a delete operation.
  if ($_POST['op'] == t('Delete') || $_POST['edit']['confirm']) {
    return _forum_confirm_delete($edit['tid']);
  }

  $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']);
  }

  return drupal_get_form('forum_form_forum', $form, 'forum_form');
}

/**
 * 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 {
518
    $container = FALSE;
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
    $type = t('forum');
  }

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

/**
 * Returns a confirmation page for deleting a forum taxonomy term.
 *
 * @param $tid ID of the term to be deleted
 */
function _forum_confirm_delete($tid) {
  $term = taxonomy_get_term($tid);

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

550
  return confirm_form('forum_confirm_delete', $form, t('Are you sure you want to delete the forum %name?', array('%name' => theme('placeholder', $term->name))), 'admin/forums', t('Deleting a forum or container will delete all sub-forums and associated posts as well. This action cannot be undone.'), t('Delete'), t('Cancel'));
551 552 553 554 555 556 557
}

/**
 * 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']);
558 559
  drupal_set_message(t('The forum %term and all sub-forums and associated posts have been deleted.', array('%term' => theme('placeholder', $form_values['name']))));
  watchdog('content', t('forum: deleted %term and all its sub-forums and associated posts.', array('%term' => theme('placeholder', $form_values['name']))));
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 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

  return 'admin/forum';
}

/**
 * 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()))) {
        $rows[] = array(_taxonomy_depth($term->depth) .' '. check_plain($term->name), l(t('edit container'), "admin/forum/edit/container/$term->tid"));
      }
      else {
        $rows[] = array(_taxonomy_depth($term->depth) .' '. check_plain($term->name), l(t('edit forum'), "admin/forum/edit/forum/$term->tid"));
       }

    }
  }
  else {
    $rows[] = array(array('data' => '<em>' . t('There are no existing containers or forums. You may add some on the <a href="%container">add container</a> or <a href="%forum">add forum</a> pages.', array('%container' => url('admin/forum/add/container'), '%forum' => url('admin/forum/add/forum'))) . '</em>', 'colspan' => 2));
  }
  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)) {
        $options[$term->tid] = _taxonomy_depth($term->depth) . $term->name;
      }
    }
  }
  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);
}

633
function forum_link_alter(&$node, &$links) {
634
  foreach ($links as $module => $link) {
635
    if (strstr($module, 'taxonomy_term')) {
636 637
      // 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.
638
      $tid = str_replace('taxonomy/term/', '', $link['href']);
639 640
      $term = taxonomy_get_term($tid);
      if ($term->vid == _forum_get_vid()) {
641
        $links[$module]['href'] = str_replace('taxonomy/term', 'forum', $link['href']);
642
      }
643 644
    }
  }
645 646 647 648 649 650 651 652 653 654 655
}

/**
 * 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) {
656 657 658
      // 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));
659 660 661 662 663 664 665 666 667
      taxonomy_save_vocabulary($edit);
      $vid = $edit['vid'];
    }
    variable_set('forum_nav_vocabulary', $vid);
  }

  return $vid;
}

Dries's avatar
 
Dries committed
668 669 670
/**
 * Formats a topic for display
 *
671
 * @TODO Give a better description. Not sure where this function is used yet.
Dries's avatar
 
Dries committed
672
 */
Dries's avatar
 
Dries committed
673
function _forum_format($topic) {
674
  if ($topic && $topic->timestamp) {
675
    return t('%time ago<br />by %author', array('%time' => format_interval(time() - $topic->timestamp), '%author' => theme('username', $topic)));
Dries's avatar
 
Dries committed
676 677
  }
  else {
678
    return t('n/a');
Dries's avatar
 
Dries committed
679 680 681
  }
}

Dries's avatar
 
Dries committed
682 683 684
/**
 * Returns a list of all forums for a given taxonomy id
 *
685
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
686 687 688 689 690 691 692 693 694
 * -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
695
function forum_get_forums($tid = 0) {
696

Dries's avatar
 
Dries committed
697 698
  $forums = array();
  $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
Dries's avatar
 
Dries committed
699

Dries's avatar
 
Dries committed
700
  if (count($_forums)) {
Dries's avatar
 
Dries committed
701

Dries's avatar
 
Dries committed
702 703
    $counts = array();

Dries's avatar
 
Dries committed
704
    $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";
705
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
706
    $_counts = db_query($sql, $forum->tid);
Dries's avatar
 
Dries committed
707 708 709
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
710
  }
Dries's avatar
 
Dries committed
711

Dries's avatar
 
Dries committed
712 713 714 715
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
716

Dries's avatar
 
Dries committed
717 718 719 720 721 722 723 724 725 726 727
    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
728
    // used to join node_comment_statistics to users.
729
    $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";
730
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
731
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
732 733

    $last_post = new StdClass();
Dries's avatar
 
Dries committed
734 735 736 737
    $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
738

Dries's avatar
 
Dries committed
739 740 741 742
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
743 744
}

745 746 747 748 749
/**
 * Calculate the number of nodes the user has not yet read and are newer
 * than NODE_NEW_LIMIT.
 */
function _forum_topics_unread($term, $uid) {
750
  $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";
751
  $sql = db_rewrite_sql($sql);
752
  return db_result(db_query($sql, $term, $uid, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
753 754
}

Dries's avatar
Dries committed
755
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
756
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
757

Dries's avatar
 
Dries committed
758
  $forum_topic_list_header = array(
Dries's avatar
 
Dries committed
759 760
    array('data' => '&nbsp;'),
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
761
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
762
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
763
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
764
  );
Dries's avatar
 
Dries committed
765

Dries's avatar
 
Dries committed
766
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
767
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
768 769
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
770 771 772 773
    }
  }

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

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

779
  $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
780

Steven Wittens's avatar
Steven Wittens committed
781
  $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
Dries's avatar
 
Dries committed
782 783

  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
784 785
    if ($user->uid) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
 
Dries committed
786
      if ($topic->tid != $tid) {
Dries's avatar
Dries committed
787
        $topic->new = 0;
Dries's avatar
 
Dries committed
788 789
      }
      else {
Dries's avatar
 
Dries committed
790
        $history = _forum_user_last_visit($topic->nid);
Dries's avatar
 
Dries committed
791
        $topic->new_replies = comment_num_new($topic->nid, $history);
792
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
793
      }
794 795
    }
    else {
796
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
797 798
      $topic->new_replies = 0;
      $topic->new = 0;
799
    }
Dries's avatar
 
Dries committed
800

Dries's avatar
 
Dries committed
801
    if ($topic->num_comments > 0) {
802
      $last_reply = new StdClass();
Dries's avatar
 
Dries committed
803 804 805 806 807
      $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
808 809 810
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
811
  return $topics;
Dries's avatar
 
Dries committed
812 813
}

Dries's avatar
 
Dries committed
814 815 816
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
817
function _forum_new($tid) {
Dries's avatar
 
Dries committed
818 819
  global $user;

Dries's avatar
 
Dries committed
820
  $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";
821
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
822
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
823 824 825 826

  return $nid ? $nid : 0;
}

827
/**
Dries's avatar
Dries committed
828
 * Menu callback; prints a forum listing.
829
 */
Dries's avatar
Dries committed
830
function forum_page($tid = 0) {
831
  if (module_exist('taxonomy') && module_exist('comment')) {
Dries's avatar
Dries committed
832 833
    $forum_per_page = variable_get('forum_per_page', 25);
    $sortby = variable_get('forum_order', 1);
Dries's avatar
 
Dries committed
834

Dries's avatar
Dries committed
835 836 837 838
    $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
839
    }
Dries's avatar
Dries committed
840

Dries's avatar
 
Dries committed
841
    return theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
842 843
  }
  else {
844 845
    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
846 847 848
  }
}

Dries's avatar
 
Dries committed
849
/**
Dries's avatar
 
Dries committed
850 851
 * Format the forum body.
 *
Dries's avatar
 
Dries committed
852
 * @ingroup themeable
Dries's avatar
 
Dries committed
853
 */
Dries's avatar
 
Dries committed
854
function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
855
  global $user;
Dries's avatar
 
Dries committed
856
  // forum list, topics list, topic browser and 'add new topic' link
Dries's avatar
 
Dries committed
857

Dries's avatar
 
Dries committed
858
  $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
859
  $title = $vocabulary->name;
Dries's avatar
 
Dries committed
860

Dries's avatar
 
Dries committed
861 862
  // Breadcrumb navigation:
  $breadcrumb = array();
Dries's avatar
 
Dries committed
863
  if ($tid) {
Dries's avatar
 
Dries committed
864
    $breadcrumb[] = array('path' => 'forum', 'title' => $title);
Dries's avatar
 
Dries committed
865
  }
Dries's avatar
 
Dries committed
866 867

  if ($parents) {
Dries's avatar
 
Dries committed
868 869
    $parents = array_reverse($parents);
    foreach ($parents as $p) {
870 871
      if ($p->tid == $tid) {
        $title = $p->name;
Dries's avatar
 
Dries committed
872 873
      }
      else {
Dries's avatar
 
Dries committed
874
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
875 876 877
      }
    }
  }
878 879 880

  drupal_set_title($title);

Dries's avatar
 
Dries committed
881 882
  $breadcrumb[] = array('path' => $_GET['q']);
  menu_set_location($breadcrumb);
Dries's avatar
 
Dries committed
883

Dries's avatar
 
Dries committed
884
  if (count($forums) || count($parents)) {
885 886
    $output  = '<div id="forum">';
    $output .= '<ul>';
Dries's avatar
 
Dries committed
887 888 889

    if (module_exist('tracker')) {
      if ($user->uid) {
890
        $output .= ' <li>'. l(t('My discussions.'), "tracker/$user->uid") .'</li>';
Dries's avatar
 
Dries committed
891 892
      }

893
      $output .= ' <li>'. l(t('Active discussions.'), 'tracker') .'</li>';
Dries's avatar
 
Dries committed
894 895 896
    }

    if (user_access('create forum topics')) {
897
      $output .= '<li>'. l(t('Post new forum topic.'), "node/add/forum/$tid") .'</li>';
Dries's avatar
 
Dries committed
898 899
    }
    else if ($user->uid) {
900
      $output .= '<li>'. t('You are not allowed to post a new forum topic.') .'</li>';
Dries's avatar
 
Dries committed
901 902 903 904
    }
    else {
      $output .= '<li>'. t('<a href="%login">Login</a> to post a new forum topic.', array('%login' => url('user/login'))) .'</li>';
    }
905
    $output .= '</ul>';
Dries's avatar
 
Dries committed
906

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

Dries's avatar
 
Dries committed
909
    if ($tid && !in_array($tid, variable_get('forum_containers', array()))) {
910 911 912 913
      drupal_add_link(array('rel' => 'alternate',
                            'type' => 'application/rss+xml',
                            'title' => 'RSS - '. $title,
                            'href' => url('taxonomy/term/'. $tid .'/0/feed')));
Dries's avatar
 
Dries committed
914

Dries's avatar
 
Dries committed
915
      $output .= theme('forum_topic_list', $tid, $topics, $sortby, $forum_per_page);
916
      $output .= theme('feed_icon', url("taxonomy/term/$tid/0/feed"));
Dries's avatar
 
Dries committed
917
    }
918
    $output .= '</div>';
Dries's avatar
 
Dries committed
919 920
  }
  else {
921
    drupal_set_title(t('No forums defined'));
Dries's avatar
 
Dries committed
922
    $output = '';
Dries's avatar
 
Dries committed
923 924
  }

925
  return $output;
Dries's avatar
 
Dries committed
926 927
}

Dries's avatar
 
Dries committed
928
/**
Dries's avatar
 
Dries committed
929 930
 * Format the forum listing.
 *
Dries's avatar
 
Dries committed
931
 * @ingroup themeable
Dries's avatar
 
Dries committed
932
 */
Dries's avatar
 
Dries committed
933
function theme_forum_list($forums, $parents, $tid) {
Dries's avatar
 
Dries committed
934 935
  global $user;

Dries's avatar
 
Dries committed
936 937
  if ($forums) {

Dries's avatar
 
Dries committed
938
    $header = array(t('Forum'), t('Topics'), t('Posts'), t('Last post'));
Dries's avatar
 
Dries committed
939 940

    foreach ($forums as $forum) {
Dries's avatar
 
Dries committed
941
      if ($forum->container) {
942 943
        $description  = '<div style="margin-left: '. ($forum->depth * 30) ."px;\">\n";
        $description .= ' <div class="name">'. l($forum->name, "forum/$forum->tid") ."</div>\n";
Dries's avatar
 
Dries committed
944 945

        if ($forum->description) {
946
          $description .= ' <div class="description">'. filter_xss_admin($forum->description) ."</div>\n";
Dries's avatar
 
Dries committed
947 948 949