forum.module 41.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
      $output .= '<p>'. t('Forums module <strong>requires Taxonomy and Comments module</strong> be enabled.') .'</p>';
18
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="@forum">Forum page</a>.', array('@forum' => 'http://drupal.org/handbook/modules/forum/')) .'</p>';
19
      return $output;
20
    case 'admin/content/forum':
21
      return '<p>'. t('This is a list of existing containers and forums that you can edit. Containers hold forums and, in turn, forums hold threaded discussions. Both containers and forums can be placed inside other containers and forums. By planning the structure of your containers and forums well, you make it easier for users to find a topic area of interest to them.') .'</p>';
22
    case 'admin/content/forum/add/container':
23
      return '<p>'. t('Containers help you organize your forums. The job of a container is to hold, or contain, other forums that are related. For example, a container named "Food" might hold two forums named "Fruit" and "Vegetables".') .'</p>';
24
    case 'admin/content/forum/add/forum':
25
      return '<p>'. t('A forum holds discussion topics that are related. For example, a forum named "Fruit" might contain topics titled "Apples" and "Bananas".') .'</p>';
26 27
    case 'admin/content/forum/settings':
      return '<p>'. t('These settings provide the ability to fine tune the display of your forum topics.') .'</p>';
Dries's avatar
 
Dries committed
28 29 30
  }
}

31 32 33 34 35 36 37 38 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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
function forum_menu() {
  $items['node/add/forum'] = array(
    'title' => t('Forum topic'),
    'access arguments' => array('create forum topics'),
  );
  $items['forum'] = array(
    'title' => t('Forums'),
    'page callback' => 'forum_page',
    'access arguments' => array('access content'),
    'type' => MENU_SUGGESTED_ITEM,
  );
  $items['admin/content/forum'] = array(
    'title' => t('Forums'),
    'description' => t('Control forums and their hierarchy and change forum settings.'),
    'page callback' => 'forum_overview',
    'access arguments' => array('administer forums'),
  );
  $items['admin/content/forum/list'] = array(
    'title' => t('List'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/content/forum/add/container'] = array(
    'title' => t('Add container'),
    'page callback' => 'forum_form_main',
    'page arguments' => array('container'),
    'type' => MENU_LOCAL_TASK,
84
    'parent' => 'admin/content/forum',
85 86 87 88 89 90
  );
  $items['admin/content/forum/add/forum'] = array(
    'title' => t('Add forum'),
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum'),
    'type' => MENU_LOCAL_TASK,
91
    'parent' => 'admin/content/forum',
92 93 94 95 96 97 98
  );
  $items['admin/content/forum/settings'] = array(
    'title' => t('Settings'),
    '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' => t('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 113 114
    'title' => t('Edit forum'),
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum', 5),
115
    'type' => MENU_CALLBACK,
116 117 118
  );
  return $items;
}
119

120 121 122
function forum_init() {
  drupal_add_css(drupal_get_path('module', 'forum') .'/forum.css');
}
123

124
function forum_term_load($tid) {
125
  return (array)taxonomy_get_term($tid);
126 127
}

128
/**
129
 * Implementation of hook_node_info().
130
 */
131
function forum_node_info() {
132 133
  return array(
    'forum' => array(
134
      'name' => t('Forum topic'),
135 136 137 138 139
      'module' => 'forum',
      'description' => t('Create a new topic for discussion in the forums.'),
      'title_label' => t('Subject'),
    )
  );
Dries's avatar
 
Dries committed
140 141
}

142 143 144
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
145
function forum_access($op, $node) {
Dries's avatar
 
Dries committed
146 147
  global $user;

Dries's avatar
 
Dries committed
148 149
  if ($op == 'create') {
    return user_access('create forum topics');
Dries's avatar
 
Dries committed
150
  }
Dries's avatar
 
Dries committed
151 152 153 154 155 156

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

159 160 161
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
162
function forum_perm() {
163
  return array('create forum topics', 'edit own forum topics', 'administer forums');
Dries's avatar
 
Dries committed
164
}
Dries's avatar
 
Dries committed
165

166 167 168 169 170
/**
 * Implementation of hook_nodeapi().
 */
function forum_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
171
    case 'delete revision':
172 173 174 175 176
      db_query('DELETE FROM {forum} WHERE vid = %d', $node->vid);
      break;
  }
}

177 178 179
/**
 * Implementation of hook_taxonomy().
 */
180
function forum_taxonomy($op, $type, $term = NULL) {
181
  if ($op == 'delete' && $term['vid'] == _forum_get_vid()) {
182 183
    switch ($type) {
      case 'term':
184
        $results = db_query('SELECT f.nid FROM {forum} f WHERE f.tid = %d', $term['tid']);
185 186 187 188 189 190 191
        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());
192 193
        $key = array_search($term['tid'], $containers);
        if ($key !== FALSE) {
194 195 196 197 198 199
          unset($containers[$key]);
        }
        variable_set('forum_containers', $containers);
        break;
      case 'vocabulary':
        variable_del('forum_nav_vocabulary');
Dries's avatar
 
Dries committed
200
    }
201 202
  }
}
Dries's avatar
 
Dries committed
203

Dries's avatar
Dries committed
204
function forum_admin_settings() {
205
  $form = array();
206
  $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 150, 200, 250, 300, 350, 400, 500));
207 208 209 210 211 212
  $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.'),
  );
213
  $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
214 215 216 217 218 219
  $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.'),
  );
220
  $forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4=> t('Posts - least active first'));
221 222 223 224 225 226
  $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.'),
  );
227
  return system_settings_form($form);
228 229
}

230 231 232
/**
 * Implementation of hook_form_alter().
 */
233
function forum_form_alter(&$form, $form_id) {
234 235
  // hide critical options from forum vocabulary
  if ($form_id == 'taxonomy_form_vocabulary') {
236
    if (isset($form['vid']) && $form['vid']['#value'] == _forum_get_vid()) {
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
      $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']);
    }
  }
}

254 255 256
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
257
function forum_load($node) {
258
  $forum = db_fetch_object(db_query('SELECT * FROM {forum} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
259 260 261 262

  return $forum;
}

263 264 265 266 267 268
/**
 * Implementation of hook_block().
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
269 270 271
function forum_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
Dries's avatar
 
Dries committed
272 273
      $blocks[0]['info'] = t('Active forum topics');
      $blocks[1]['info'] = t('New forum topics');
274
      return $blocks;
Dries's avatar
 
Dries committed
275

276
    case 'configure':
277
      $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)));
278
      return $form;
Dries's avatar
 
Dries committed
279

280
    case 'save':
281
      variable_set('forum_block_num_'. $delta, $edit['forum_block_num_'. $delta]);
282
      break;
Dries's avatar
 
Dries committed
283

284 285
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
286 287
        switch ($delta) {
          case 0:
288
            $title = t('Active forum topics');
289
            $sql = db_rewrite_sql("SELECT n.nid, n.title, l.comment_count, l.last_comment_timestamp 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");
290 291 292 293
            $result = db_query_range($sql, 0, variable_get('forum_block_num_0', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
294
            break;
Dries's avatar
 
Dries committed
295 296

          case 1:
297 298
            $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");
299 300 301 302
            $result = db_query_range($sql, 0, variable_get('forum_block_num_1', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
303
            break;
Dries's avatar
 
Dries committed
304
        }
Dries's avatar
 
Dries committed
305

306
        if (!empty($content)) {
307
          $content .= '<div class="more-link">'. l(t('more'), 'forum', array('title' => t('Read the latest forum topics.'))) .'</div>';
308 309 310
          $block['subject'] = $title;
          $block['content'] = $content;
          return $block;
311 312 313
        }
      }
  }
Dries's avatar
 
Dries committed
314 315
}

316 317 318
/**
 * Implementation of hook_view().
 */
Dries's avatar
 
Dries committed
319
function forum_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
 
Dries committed
320
  if ($page) {
321
    $vocabulary = taxonomy_vocabulary_load(variable_get('forum_nav_vocabulary', ''));
Dries's avatar
 
Dries committed
322
    // Breadcrumb navigation
Dries's avatar
 
Dries committed
323 324
    $breadcrumb = array();
    $breadcrumb[] = array('path' => 'forum', 'title' => $vocabulary->name);
Dries's avatar
 
Dries committed
325
    if ($parents = taxonomy_get_parents_all($node->tid)) {
Dries's avatar
 
Dries committed
326 327
      $parents = array_reverse($parents);
      foreach ($parents as $p) {
Dries's avatar
 
Dries committed
328
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
329 330
      }
    }
Dries's avatar
 
Dries committed
331 332
    $breadcrumb[] = array('path' => 'node/'. $node->nid);
    menu_set_location($breadcrumb);
333
  }
Dries's avatar
 
Dries committed
334

335
  $node = node_prepare($node, $teaser);
336 337 338 339 340 341
  if (!$teaser) {
    $node->content['forum_navigation'] = array(
      '#value' => theme('forum_topic_navigation', $node),
      '#weight' => 100,
    );
  }
342
  return $node;
Dries's avatar
 
Dries committed
343 344
}

345
/**
346 347 348 349
 * Implementation of hook_submit().
 *
 * Check in particular that only a "leaf" term in the associated taxonomy
 * vocabulary is selected, not a "container" term.
350
 */
351
function forum_submit(&$node) {
352
  // Make sure all fields are set properly:
Dries's avatar
 
Dries committed
353
  $node->icon = $node->icon ? $node->icon : '';
Dries's avatar
 
Dries committed
354

355
  if ($node->taxonomy) {
356 357 358 359 360 361 362
    // Get the forum terms from the (cached) tree
    $tree = taxonomy_get_tree(_forum_get_vid());
    if ($tree) {
      foreach ($tree as $term) {
        $forum_terms[] = $term->tid;
      }
    }
Dries's avatar
 
Dries committed
363
    foreach ($node->taxonomy as $term) {
364
      if (in_array($term, $forum_terms)) {
365
        $node->tid = $term;
Dries's avatar
 
Dries committed
366
      }
367
    }
368
    $old_tid = db_result(db_query_range("SELECT tid FROM {forum} WHERE nid = %d ORDER BY vid DESC", $node->nid, 0,1));
369
    if ($old_tid) {
370 371 372
      if (($node->tid != $old_tid) && $node->shadow) {
        // A shadow copy needs to be created. Retain new term and add old term.
        $node->taxonomy[] = $old_tid;
Dries's avatar
 
Dries committed
373 374
      }
    }
Dries's avatar
Dries committed
375
  }
376
}
Dries's avatar
Dries committed
377

378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
/**
 * Implementation of hook_validate().
 *
 * Check in particular that only a "leaf" term in the associated taxonomy
 * vocabulary is selected, not a "container" term.
 */
function forum_validate($node) {
  if ($node->taxonomy) {
    // Extract the node's proper topic ID.
    $vocabulary = variable_get('forum_nav_vocabulary', '');
    $containers = variable_get('forum_containers', array());
    foreach ($node->taxonomy as $term) {
      if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
        if (in_array($term, $containers)) {
          $term = taxonomy_get_term($term);
          form_set_error('taxonomy', t('The item %forum is only a container for forums. Please select one of the forums below it.', array('%forum' => $term->name)));
        }
      }
    }
  }
398 399
}

400 401 402 403 404
/**
 * Implementation of hook_update().
 */
function forum_update($node) {
  if ($node->revision) {
405 406 407 408 409
    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
410 411
}

412 413 414
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
415
function forum_form(&$node) {
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
    $forum_terms = taxonomy_node_get_terms_by_vocabulary(_forum_get_vid(), $node);
Dries's avatar
Dries committed
421
    // if editing, give option to leave shadows
422
    $shadow = (count($forum_terms) > 1);
423
    $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
424
  }
Dries's avatar
 
Dries committed
425

426
  $form['body_filter']['body'] = array('#type' => 'textarea', '#title' => check_plain($type->body_label), '#default_value' => !empty($node->body) ? $node->body : '', '#rows' => 20, '#required' => TRUE);
427
  $form['body_filter']['format'] = filter_form($node->format);
Dries's avatar
 
Dries committed
428

429
  return $form;
Dries's avatar
 
Dries committed
430 431
}

432 433 434 435
/**
 * Implementation of hook_prepare; assign forum taxonomy when adding a topic from within a forum.
 */
function forum_prepare(&$node) {
436
  if (empty($node->nid)) {
437
    // new topic
438 439
    $node->taxonomy[arg(3)]->vid = _forum_get_vid();
    $node->taxonomy[arg(3)]->tid = arg(3);
440 441 442
  }
}

443 444 445 446 447 448 449 450 451 452 453 454
/**
 * Implementation of hook_insert().
 */
function forum_insert($node) {
  db_query('INSERT INTO {forum} (nid, vid, tid) VALUES (%d, %d, %d)', $node->nid, $node->vid, $node->tid);
}

/**
 * Implementation of hook_delete().
 */
function forum_delete(&$node) {
  db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
455
}
Dries's avatar
 
Dries committed
456

457 458 459 460 461 462
/**
 * 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()) {
463 464 465 466 467 468
  $edit += array(
    'name' => '',
    'description' => '',
    'tid' => 0,
    'weight' => 0,
  );
469 470 471 472 473
  // Handle a delete operation.
  $form['name'] = array(
    '#title' => t('Container name'),
    '#type' => 'textfield',
    '#default_value' => $edit['name'],
474
    '#maxlength' => 255,
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
    '#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']);
  }
503 504 505
  $form['#submit']['forum_form_submit'] = array();
  $form['#validate']['forum_form_validate'] = array();
  $form['#theme'] = 'forum_form';
506

507
  return $form;
508 509
}

510
function forum_form_main($type, $edit = array()) {
511
  if ((isset($_POST['op']) && $_POST['op'] == t('Delete')) || !empty($_POST['confirm'])) {
512 513 514 515 516 517 518 519 520 521 522 523
    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;
  }
}

524 525 526 527 528 529
/**
 * 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()) {
530
  $edit += array(
531 532 533
    'name' => '',
    'description' => '',
    'tid' => NULL,
534 535
    'weight' => 0,
  );
536 537 538
  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Forum name'),
    '#default_value' => $edit['name'],
539
    '#maxlength' => 255,
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
    '#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']);
  }
562 563 564
  $form['#submit']['forum_form_submit'] = array();
  $form['#validate']['forum_form_validate'] = array();
  $form['#theme'] = 'forum_form';
565

566
  return $form;
567 568 569 570 571 572 573 574 575 576 577
}

/**
 * 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 {
578
    $container = FALSE;
579 580 581 582 583 584 585 586 587 588 589
    $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);
      }
590
      drupal_set_message(t('Created new @type %term.', array('%term' => $form_values['name'], '@type' => $type)));
591 592
      break;
    case SAVED_UPDATED:
593
      drupal_set_message(t('The @type %term has been updated.', array('%term' => $form_values['name'], '@type' => $type)));
594 595
      break;
  }
596
  return 'admin/content/forum';
597 598 599 600 601 602 603
}

/**
 * Returns a confirmation page for deleting a forum taxonomy term.
 *
 * @param $tid ID of the term to be deleted
 */
604
function forum_confirm_delete($tid) {
605 606 607 608 609
  $term = taxonomy_get_term($tid);

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

610
  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'));
611 612 613 614 615 616 617
}

/**
 * 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']);
618 619
  drupal_set_message(t('The forum %term and all sub-forums and associated posts have been deleted.', array('%term' => $form_values['name'])));
  watchdog('content', t('forum: deleted %term and all its sub-forums and associated posts.', array('%term' => $form_values['name'])));
620

621
  return 'admin/content/forum';
622 623 624 625 626 627 628 629 630 631 632 633
}

/**
 * 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()))) {
634
        $rows[] = array(str_repeat(' -- ', $term->depth) .' '. l($term->name, 'forum/'. $term->tid), l(t('edit container'), 'admin/content/forum/edit/container/'. $term->tid));
635 636
      }
      else {
637
        $rows[] = array(str_repeat(' -- ', $term->depth) .' '. l($term->name, 'forum/'. $term->tid), l(t('edit forum'), 'admin/content/forum/edit/forum/'. $term->tid));
638 639 640 641 642
       }

    }
  }
  else {
643
    $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));
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
  }
  return theme('table', $header, $rows);
}

/**
 * Returns a select box for available parent terms
 *
 * @param $tid ID of the term which is being added or edited
 * @param $title Title to display the select box with
 * @param $child_type Whether the child is forum or container
 */
function _forum_parent_select($tid, $title, $child_type) {

  $parents = taxonomy_get_parents($tid);
  if ($parents) {
    $parent = array_shift($parents);
    $parent = $parent->tid;
  }
  else {
    $parent = 0;
  }

  $children = taxonomy_get_tree(_forum_get_vid(), $tid);

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

  $tree = taxonomy_get_tree(_forum_get_vid());
  $options[0] = '<'. t('root') .'>';
  if ($tree) {
    foreach ($tree as $term) {
      if (!in_array($term->tid, $exclude)) {
drumm's avatar
drumm committed
679
        $options[$term->tid] = str_repeat(' -- ', $term->depth) . $term->name;
680 681 682 683 684 685 686 687 688 689 690 691 692
      }
    }
  }
  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);
}

693
function forum_link_alter(&$links, $node) {
694
  foreach ($links as $module => $link) {
695
    if (strstr($module, 'taxonomy_term')) {
696 697
      // 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.
698
      $tid = str_replace('taxonomy/term/', '', $link['href']);
699 700
      $term = taxonomy_get_term($tid);
      if ($term->vid == _forum_get_vid()) {
701
        $links[$module]['href'] = str_replace('taxonomy/term', 'forum', $link['href']);
702
      }
703 704
    }
  }
705 706 707 708 709 710 711 712 713 714 715
}

/**
 * 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) {
716 717
      // Create the forum vocabulary. Assign the vocabulary a low weight so
      // it will appear first in forum topic create and edit forms.
718
      $edit = array('name' => t('Forums'), 'multiple' => 0, 'required' => 1, 'hierarchy' => 1, 'relations' => 0, 'module' => 'forum', 'weight' => -10, 'nodes' => array('forum' => 1));
719 720 721 722 723 724 725 726 727
      taxonomy_save_vocabulary($edit);
      $vid = $edit['vid'];
    }
    variable_set('forum_nav_vocabulary', $vid);
  }

  return $vid;
}

Dries's avatar
 
Dries committed
728 729 730
/**
 * Formats a topic for display
 *
731
 * @TODO Give a better description. Not sure where this function is used yet.
Dries's avatar
 
Dries committed
732
 */
Dries's avatar
 
Dries committed
733
function _forum_format($topic) {
734
  if ($topic && $topic->timestamp) {
735
    return t('@time ago<br />by !author', array('@time' => format_interval(time() - $topic->timestamp), '!author' => theme('username', $topic)));
Dries's avatar
 
Dries committed
736 737
  }
  else {
738
    return t('n/a');
Dries's avatar
 
Dries committed
739 740 741
  }
}

Dries's avatar
 
Dries committed
742 743 744
/**
 * Returns a list of all forums for a given taxonomy id
 *
745
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
746 747 748 749 750 751 752 753 754
 * -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
755
function forum_get_forums($tid = 0) {
756

Dries's avatar
 
Dries committed
757 758
  $forums = array();
  $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
Dries's avatar
 
Dries committed
759

Dries's avatar
 
Dries committed
760
  if (count($_forums)) {
Dries's avatar
 
Dries committed
761

Dries's avatar
 
Dries committed
762 763
    $counts = array();

Dries's avatar
 
Dries committed
764
    $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";
765
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
766
    $_counts = db_query($sql, $forum->tid);
Dries's avatar
 
Dries committed
767 768 769
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
770
  }
Dries's avatar
 
Dries committed
771

Dries's avatar
 
Dries committed
772 773 774 775
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
776

Dries's avatar
 
Dries committed
777 778 779 780 781 782 783 784 785 786 787
    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
788
    // used to join node_comment_statistics to users.
789
    $sql = "SELECT ncs.last_comment_timestamp, IF (ncs.last_comment_uid != 0, u2.name, ncs.last_comment_name) AS last_comment_name, ncs.last_comment_uid FROM {node} n INNER JOIN {users} u1 ON n.uid = u1.uid INNER JOIN {term_node} tn ON n.nid = tn.nid INNER JOIN {node_comment_statistics} ncs ON n.nid = ncs.nid INNER JOIN {users} u2 ON ncs.last_comment_uid=u2.uid WHERE n.status = 1 AND n.type='forum' AND tn.tid = %d ORDER BY ncs.last_comment_timestamp DESC";
790
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
791
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
792

793
    $last_post = new stdClass();
Dries's avatar
 
Dries committed
794 795 796 797
    $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
798

Dries's avatar
 
Dries committed
799 800 801 802
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
803 804
}

805 806 807 808 809
/**
 * Calculate the number of nodes the user has not yet read and are newer
 * than NODE_NEW_LIMIT.
 */
function _forum_topics_unread($term, $uid) {
810
  $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";
811
  $sql = db_rewrite_sql($sql);
812
  return db_result(db_query($sql, $term, $uid, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
813 814
}

Dries's avatar
Dries committed
815
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
816
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
817

Dries's avatar
 
Dries committed
818
  $forum_topic_list_header = array(
819
    array('data' => '&nbsp;', 'field' => NULL),
Dries's avatar
 
Dries committed
820
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
821
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
822
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
823
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
824
  );
Dries's avatar
 
Dries committed
825

Dries's avatar
 
Dries committed
826
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
827
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
828 829
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
830 831 832 833
    }
  }

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

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

839
  $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
840

Steven Wittens's avatar
Steven Wittens committed
841
  $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
Dries's avatar
 
Dries committed
842 843

  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
844 845
    if ($user->uid) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
 
Dries committed
846
      if ($topic->tid != $tid) {
Dries's avatar
Dries committed
847
        $topic->new = 0;
Dries's avatar
 
Dries committed
848 849
      }
      else {
Dries's avatar
 
Dries committed
850
        $history = _forum_user_last_visit($topic->nid);
Dries's avatar
 
Dries committed
851
        $topic->new_replies = comment_num_new($topic->nid, $history);
852
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
853
      }
854 855
    }
    else {
856
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
857 858
      $topic->new_replies = 0;
      $topic->new = 0;
859
    }
Dries's avatar
 
Dries committed
860

Dries's avatar
 
Dries committed
861
    if ($topic->num_comments > 0) {
862
      $last_reply = new stdClass();
Dries's avatar
 
Dries committed
863 864 865 866 867
      $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
868 869 870
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
871
  return $topics;
Dries's avatar
 
Dries committed
872 873
}

Dries's avatar
 
Dries committed
874 875 876
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
877
function _forum_new($tid) {
Dries's avatar
 
Dries committed
878 879
  global $user;

Dries's avatar
 
Dries committed
880
  $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";
881
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
882
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
883 884 885 886

  return $nid ? $nid : 0;
}

887
/**
Dries's avatar
Dries committed
888
 * Menu callback; prints a forum listing.
889
 */
Dries's avatar
Dries committed
890
function forum_page($tid = 0) {
891
  if (module_exists('taxonomy') && module_exists('comment')) {
Dries's avatar
Dries committed
892 893
    $forum_per_page = variable_get('forum_per_page', 25);
    $sortby = variable_get('forum_order', 1);
Dries's avatar
 
Dries committed
894

Dries's avatar
Dries committed
895 896 897 898
    $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
899
    }
Dries's avatar
Dries committed
900

Dries's avatar
 
Dries committed
901
    return theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
902 903
  }
  else {
904 905
    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
906 907 908
  }
}

Dries's avatar
 
Dries committed
909
/**
Dries's avatar
 
Dries committed
910 911
 * Format the forum body.
 *
Dries's avatar
 
Dries committed
912
 * @ingroup themeable
Dries's avatar
 
Dries committed
913
 */
Dries's avatar
 
Dries committed
914
function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed