forum.module 41 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
      $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>
25
', array('%admin-forum' => url('admin/content/forum'), '%admin-modules' => url('admin/settings/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
      return $output;
28
    case 'admin/settings/modules#description':
29
      return t('Enables threaded discussions about general topics.');
30
    case 'admin/content/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/content/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/content/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
/**
 * 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);
56
    $items[] = array('path' => 'admin/content/forum',
57
      'title' => t('forums'),
58
      'description' => t('Control forums and their hierarchy and change forum settings.'),
59 60 61
      'callback' => 'forum_overview',
      'access' => user_access('administer forums'),
      'type' => MENU_NORMAL_ITEM);
62
    $items[] = array('path' => 'admin/content/forum/list',
63 64 65 66
      'title' => t('list'),
      'access' => user_access('administer forums'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -10);
67
    $items[] = array('path' => 'admin/content/forum/add/container',
68 69 70 71
      'title' => t('add container'),
      'callback' => 'forum_form_container',
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
72
    $items[] = array('path' => 'admin/content/forum/add/forum',
73 74 75 76
      'title' => t('add forum'),
      'callback' => 'forum_form_forum',
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
77 78
    $items[] = array('path' => 'admin/content/forum/settings',
      'title' => t('settings'),
Dries's avatar
Dries committed
79
      'callback' => 'forum_admin_settings',
80
      'weight' => 5,
81
      'access' => user_access('administer forums'),
82
      'type' => MENU_LOCAL_TASK);
83
  }
84 85
  elseif (is_numeric(arg(5))) {
    $term = taxonomy_get_term(arg(5));
86 87
    // Check if this is a valid term.
    if ($term) {
88
      $items[] = array('path' => 'admin/content/forum/edit/container',
89 90 91 92 93
        'title' => t('edit container'),
        'callback' => 'forum_form_container',
        'callback arguments' => array((array)$term),
        'access' => user_access('administer forums'),
        'type' => MENU_CALLBACK);
94
      $items[] = array('path' => 'admin/content/forum/edit/forum',
95 96 97 98 99 100 101 102 103 104 105
        'title' => t('edit forum'),
        'callback' => 'forum_form_forum',
        'callback arguments' => array((array)$term),
        'access' => user_access('administer forums'),
        'type' => MENU_CALLBACK);
    }
  }

  return $items;
}

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

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

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

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

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

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

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

Dries's avatar
Dries committed
175
function forum_admin_settings() {
176

177
  $form = array();
178
  $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 150, 200, 250, 300, 350, 400, 500));
179 180 181 182 183 184
  $form['forum_hot_topic'] = array('#type' => 'select',
    '#title' => t('Hot topic threshold'),
    '#default_value' => variable_get('forum_hot_topic', 15),
    '#options' => $number,
    '#description' => t('The number of posts a topic must have to be considered hot.'),
  );
185
  $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
186 187 188 189 190 191
  $form['forum_per_page'] = array('#type' => 'select',
    '#title' => t('Topics per page'),
    '#default_value' => variable_get('forum_per_page', 25),
    '#options' => $number,
    '#description' => t('The default number of topics displayed per page; links to browse older messages are automatically being displayed.'),
  );
192
  $forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4=> t('Posts - least active first'));
193 194 195 196 197 198
  $form['forum_order'] = array('#type' => 'radios',
    '#title' => t('Default order'),
    '#default_value' => variable_get('forum_order', '1'),
    '#options' => $forder,
    '#description' => t('The default display order for topics.'),
  );
199

200
  return system_settings_form('forum_admin_configure', $form);
201 202
}

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

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

  return $forum;
}

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

249
    case 'configure':
250
      $form['forum_block_num_'. $delta] = array('#type' => 'select', '#title' => t('Number of topics'), '#default_value' => variable_get('forum_block_num_'. $delta, '5'), '#options' => drupal_map_assoc(array(2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20)));
251
      return $form;
Dries's avatar
 
Dries committed
252

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

257 258
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
259 260
        switch ($delta) {
          case 0:
261
            $title = t('Active forum topics');
262
            $sql = db_rewrite_sql("SELECT n.nid, n.title, l.comment_count FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid WHERE n.status = 1 AND n.type = 'forum' ORDER BY l.last_comment_timestamp DESC");
263 264 265 266
            $result = db_query_range($sql, 0, variable_get('forum_block_num_0', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
267
            break;
Dries's avatar
 
Dries committed
268 269

          case 1:
270 271
            $title = t('New forum topics');
            $sql = db_rewrite_sql("SELECT n.nid, n.title, l.comment_count FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid WHERE n.type = 'forum' AND n.status = 1 ORDER BY n.nid DESC");
272 273 274 275
            $result = db_query_range($sql, 0, variable_get('forum_block_num_1', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
276
            break;
Dries's avatar
 
Dries committed
277
        }
Dries's avatar
 
Dries committed
278

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

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

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

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

310
  $node = node_prepare($node, $teaser);
311 312

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

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

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

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
/**
 * 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
366 367 368 369
/**
 * Implementation of hook_update().
 */
function forum_update($node) {
370
  if ($node->revision) {
371 372 373 374 375
    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
376 377
}

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

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

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

394
  return $form;
Dries's avatar
 
Dries committed
395 396
}

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

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

415 416 417
/**
 * Implementation of hook_delete().
 */
Dries's avatar
 
Dries committed
418
function forum_delete(&$node) {
Dries's avatar
 
Dries committed
419
  db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
420
}
Dries's avatar
 
Dries committed
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 518 519
/**
 * 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 {
520
    $container = FALSE;
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
    $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;
  }
538
  return 'admin/content/forum';
539 540 541 542 543 544 545 546 547 548 549 550 551
}

/**
 * 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);

552
  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/content/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'));
553 554 555 556 557 558 559
}

/**
 * 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']);
560 561
  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']))));
562

563
  return 'admin/content/forum';
564 565 566 567 568 569 570 571 572 573 574 575
}

/**
 * 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()))) {
576
        $rows[] = array(_taxonomy_depth($term->depth) .' '. check_plain($term->name), l(t('edit container'), "admin/content/forum/edit/container/$term->tid"));
577 578
      }
      else {
579
        $rows[] = array(_taxonomy_depth($term->depth) .' '. check_plain($term->name), l(t('edit forum'), "admin/content/forum/edit/forum/$term->tid"));
580 581 582 583 584
       }

    }
  }
  else {
585
    $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));
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 633 634
  }
  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);
}

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

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

  return $vid;
}

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

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

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

Dries's avatar
 
Dries committed
702
  if (count($_forums)) {
Dries's avatar
 
Dries committed
703

Dries's avatar
 
Dries committed
704 705
    $counts = array();

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

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

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

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

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

  return $forums;
Dries's avatar
 
Dries committed
745 746
}

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

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

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

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

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

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

781
  $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
782

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

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

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

Dries's avatar
Dries committed
813
  return $topics;
Dries's avatar
 
Dries committed
814 815
}

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

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

  return $nid ? $nid : 0;
}

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

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

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

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

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

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

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

  drupal_set_title($title);

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

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

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

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

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

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

Dries's avatar
 
Dries committed
911
    if ($tid && !in_array($tid, variable_get('forum_containers', array()))) {
912 913 914 915
      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
916

Dries's avatar
 
Dries committed
917
      $output .= theme('forum_topic_list', $tid, $topics, $sortby, $forum_per_page);