forum.module 39.1 KB
Newer Older
Dries's avatar
 
Dries committed
1 2 3
<?php
// $Id$

Dries's avatar
 
Dries committed
4 5
/**
 * @file
6
 * Provides discussion forums.
Dries's avatar
 
Dries committed
7 8
 */

9 10 11
/**
 * Implementation of hook_help().
 */
12 13
function forum_help($path, $arg) {
  switch ($path) {
14
    case 'admin/help#forum':
15 16 17 18 19 20 21 22
      $output = '<p>' . t('The forum module lets you create threaded discussion forums with functionality similar to other message board systems. Forums are useful because they allow community members to discuss topics with one another while ensuring those conversations are archived for later reference. The <a href="@create-topic">forum topic</a> menu item (under <em>Create content</em> on the Navigation menu) creates the initial post of a new threaded discussion, or thread.', array('@create-topic' => url('node/add/forum'))) . '</p>';
      $output .= '<p>' . t('A threaded discussion occurs as people leave comments on a forum topic (or on other comments within that topic). A forum topic is contained within a forum, which may hold many similar or related forum topics. Forums are (optionally) nested within a container, which may hold many similar or related forums. Both containers and forums may be nested within other containers and forums, and provide structure for your message board. By carefully planning this structure, you make it easier for users to find and comment on a specific forum topic.') . '</p>';
      $output .= '<p>' . t('When administering a forum, note that:') . '</p>';
      $output .= '<ul><li>' . t('a forum topic (and all of its comments) may be moved between forums by selecting a different forum while editing a forum topic.') . '</li>';
      $output .= '<li>' . t('when moving a forum topic between forums, the <em>Leave shadow copy</em> option creates a link in the original forum pointing to the new location.') . '</li>';
      $output .= '<li>' . t('selecting <em>Read only</em> under <em>Comment settings</em> while editing a forum topic will lock (prevent new comments) on the thread.') . '</li>';
      $output .= '<li>' . t('selecting <em>Disabled</em> under <em>Comment settings</em> while editing a forum topic will hide all existing comments on the thread, and prevent new ones.') . '</li></ul>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@forum">Forum module</a>.', array('@forum' => 'http://drupal.org/handbook/modules/forum/')) . '</p>';
23
      return $output;
24
    case 'admin/build/forum':
25
      return '<p>' . t('This page displays a list of existing forums and containers. Containers (optionally) hold forums, and forums hold forum topics (a forum topic is the initial post to a threaded discussion). To provide structure, both containers and forums may be placed inside other containers and forums. To rearrange forums and containers, grab a drag-and-drop handle under the <em>Name</em> column and drag the forum or container to a new location in the list. (Grab a handle by clicking and holding the mouse while hovering over a handle icon.) Remember that your changes will not be saved until you click the <em>Save</em> button at the bottom of the page.') . '</p>';
26
    case 'admin/build/forum/add/container':
27
      return '<p>' . t('By grouping related or similar forums, containers help organize forums. For example, a container named "Food" may hold two forums named "Fruit" and "Vegetables", respectively.') . '</p>';
28
    case 'admin/build/forum/add/forum':
29
      return '<p>' . t('A forum holds related or similar forum topics (a forum topic is the initial post to a threaded discussion). For example, a forum named "Fruit" may contain forum topics titled "Apples" and "Bananas", respectively.') . '</p>';
30
    case 'admin/build/forum/settings':
31
      return '<p>' . t('These settings allow you to adjust the display of your forum topics. The content types available for use within a forum may be selected by editing the <em>Content types</em> on the <a href="@forum-vocabulary">forum vocabulary page</a>.', array('@forum-vocabulary' => url('admin/content/taxonomy/edit/vocabulary/' . variable_get('forum_nav_vocabulary', '')))) . '</p>';
Dries's avatar
 
Dries committed
32 33 34
  }
}

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

67 68 69 70 71 72 73 74 75 76
/**
 * Fetch a forum term.
 *
 * @param $tid
 *   The ID of the term which should be loaded.
 *
 * @return
 *   An associative array containing the term data or FALSE if the term cannot be loaded, or is not part of the forum vocabulary.
 */
function forum_term_load($tid) {
77
  $result = db_query(db_rewrite_sql('SELECT t.tid, t.vid, t.name, t.description, t.weight FROM {taxonomy_term_data} t WHERE t.tid = %d AND t.vid = %d', 't', 'tid'), $tid, variable_get('forum_nav_vocabulary', ''));
78 79 80
  return db_fetch_array($result);
}

81 82 83
/**
 * Implementation of hook_menu().
 */
84 85
function forum_menu() {
  $items['forum'] = array(
86
    'title' => 'Forums',
87 88 89 90
    'page callback' => 'forum_page',
    'access arguments' => array('access content'),
    'type' => MENU_SUGGESTED_ITEM,
  );
91
  $items['admin/build/forum'] = array(
92 93
    'title' => 'Forums',
    'description' => 'Control forums and their hierarchy and change forum settings.',
94 95
    'page callback' => 'drupal_get_form',
    'page arguments' => array('forum_overview'),
96 97
    'access arguments' => array('administer forums'),
  );
98
  $items['admin/build/forum/list'] = array(
99
    'title' => 'List',
100 101 102
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
103
  $items['admin/build/forum/add/container'] = array(
104
    'title' => 'Add container',
105 106
    'page callback' => 'forum_form_main',
    'page arguments' => array('container'),
107
    'access arguments' => array('administer forums'),
108
    'type' => MENU_LOCAL_TASK,
109
    'parent' => 'admin/build/forum',
110
  );
111
  $items['admin/build/forum/add/forum'] = array(
112
    'title' => 'Add forum',
113 114
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum'),
115
    'access arguments' => array('administer forums'),
116
    'type' => MENU_LOCAL_TASK,
117
    'parent' => 'admin/build/forum',
118
  );
119
  $items['admin/build/forum/settings'] = array(
120
    'title' => 'Settings',
121 122
    'page callback' => 'drupal_get_form',
    'page arguments' => array('forum_admin_settings'),
123
    'access arguments' => array('administer forums'),
124 125
    'weight' => 5,
    'type' => MENU_LOCAL_TASK,
126
    'parent' => 'admin/build/forum',
127
  );
128
  $items['admin/build/forum/edit/%forum_term'] = array(
129
    'page callback' => 'forum_form_main',
130
    'access arguments' => array('administer forums'),
131 132
    'type' => MENU_CALLBACK,
  );
133
  $items['admin/build/forum/edit/container/%forum_term'] = array(
134
    'title' => 'Edit container',
135
    'page callback' => 'forum_form_main',
136
    'page arguments' => array('container', 5),
137
    'access arguments' => array('administer forums'),
138
    'type' => MENU_CALLBACK,
139
  );
140
  $items['admin/build/forum/edit/forum/%forum_term'] = array(
141
    'title' => 'Edit forum',
142 143
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum', 5),
144
    'access arguments' => array('administer forums'),
145
    'type' => MENU_CALLBACK,
146 147 148
  );
  return $items;
}
149

150 151 152 153

/**
 * Implementation of hook_init().
 */
154
function forum_init() {
155
  drupal_add_css(drupal_get_path('module', 'forum') . '/forum.css');
156
}
157

158
/**
159 160 161
 * _forum_nodeapi_check_node_type
 *
 * @param mixed $node
162 163 164
 * @param mixed $vocabulary
 * @access protected
 * @return bool
165
 */
166
function _forum_nodeapi_check_node_type($node, $vocabulary) {
167
  // We are going to return if $node->type is not one of the node
168
  // types assigned to the forum vocabulary. If forum_nav_vocabulary
169 170 171
  // is undefined or the vocabulary does not exist, it clearly cannot
  // be assigned to $node->type, so return to avoid E_ALL warnings.
  if (empty($vocabulary)) {
172
    return FALSE;
173
  }
174 175 176

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

180 181
  return TRUE;
}
182

183 184 185
/**
 * Implementation of hook_nodeapi_view().
 */
186
function forum_nodeapi_view($node, $teaser) {
187 188 189
  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);
  if (_forum_nodeapi_check_node_type($node, $vocabulary)) {
190
    if ((bool)menu_get_object() && taxonomy_node_get_terms_by_vocabulary($node, $vid) && $tree = taxonomy_get_tree($vid)) {
191 192 193 194 195 196 197
      // Get the forum terms from the (cached) tree
      foreach ($tree as $term) {
        $forum_terms[] = $term->tid;
      }
      foreach ($node->taxonomy as $term_id => $term) {
        if (in_array($term_id, $forum_terms)) {
          $node->tid = $term_id;
198 199
        }
      }
200 201 202 203 204 205 206 207 208 209
      // Breadcrumb navigation
      $breadcrumb[] = l(t('Home'), NULL);
      $breadcrumb[] = l($vocabulary->name, 'forum');
      if ($parents = taxonomy_get_parents_all($node->tid)) {
        $parents = array_reverse($parents);
        foreach ($parents as $p) {
          $breadcrumb[] = l($p->name, 'forum/' . $p->tid);
        }
      }
      drupal_set_breadcrumb($breadcrumb);
210

211 212 213 214 215
      if (!$teaser) {
        $node->content['forum_navigation'] = array(
          '#markup' => theme('forum_topic_navigation', $node),
          '#weight' => 100,
        );
216
      }
217 218 219
    }
  }
}
220

221 222 223
/**
 * Implementation of hook_nodeapi_prepare().
 */
224
function forum_nodeapi_prepare($node) {
225 226 227 228 229
  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);
  if (_forum_nodeapi_check_node_type($node, $vocabulary)) {
    if (empty($node->nid)) {
      // New topic
230 231 232 233
      $node->taxonomy[arg(3)] = (object) array(
        'vid' => $vid,
        'tid' => arg(3),
      );
234 235 236 237 238 239
    }
  }
}

/**
 * Implementation of hook_nodeapi_validate().
240
 *
241 242
 * Check in particular that only a "leaf" term in the associated taxonomy.
 */
243
function forum_nodeapi_validate($node, $form) {
244 245 246
  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);
  if (_forum_nodeapi_check_node_type($node, $vocabulary)) {
247
    // vocabulary is selected, not a "container" term.
248 249 250 251 252
    if ($node->taxonomy) {
      // Extract the node's proper topic ID.
      $vocabulary = $vid;
      $containers = variable_get('forum_containers', array());
      foreach ($node->taxonomy as $term) {
253
        if (db_result(db_query('SELECT COUNT(*) FROM {taxonomy_term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
254 255 256
          if (in_array($term, $containers)) {
            $term = taxonomy_term_load($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)));
257 258 259
          }
        }
      }
260 261 262
    }
  }
}
263

264 265 266 267 268
/**
 * Implementation of hook_nodeapi_presave().
 *
 * Assign forum taxonomy when adding a topic from within a forum.
 */
269
function forum_nodeapi_presave($node) {
270 271 272 273 274
  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);
  if (_forum_nodeapi_check_node_type($node, $vocabulary)) {
    // Make sure all fields are set properly:
    $node->icon = !empty($node->icon) ? $node->icon : '';
275

276 277 278 279
    if ($node->taxonomy && $tree = taxonomy_get_tree($vid)) {
      // Get the forum terms from the (cached) tree if we have a taxonomy.
      foreach ($tree as $term) {
        $forum_terms[] = $term->tid;
280
      }
281 282 283
      foreach ($node->taxonomy as $term_id) {
        if (in_array($term_id, $forum_terms)) {
          $node->tid = $term_id;
284
        }
285
      }
286
      $old_tid = db_result(db_query_range("SELECT t.tid FROM {taxonomy_term_node} t INNER JOIN {node} n ON t.vid = n.vid WHERE n.nid = %d ORDER BY t.vid DESC", $node->nid, 0, 1));
287 288 289 290 291 292 293
      if ($old_tid && isset($node->tid) && ($node->tid != $old_tid) && !empty($node->shadow)) {
        // A shadow copy needs to be created. Retain new term and add old term.
        $node->taxonomy[] = $old_tid;
      }
    }
  }
}
294

295 296 297
/**
 * Implementation of hook_nodeapi_update().
 */
298
function forum_nodeapi_update($node) {
299 300 301 302 303 304 305 306 307 308 309 310 311
  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);
  if (_forum_nodeapi_check_node_type($node, $vocabulary)) {
    if (empty($node->revision) && db_result(db_query('SELECT tid FROM {forum} WHERE nid=%d', $node->nid))) {
      if (!empty($node->tid)) {
        db_query('UPDATE {forum} SET tid = %d WHERE vid = %d', $node->tid, $node->vid);
      }
      // The node is removed from the forum.
      else {
        db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
      }
    }
    else {
312 313 314
      if (!empty($node->tid)) {
        db_query('INSERT INTO {forum} (tid, vid, nid) VALUES (%d, %d, %d)', $node->tid, $node->vid, $node->nid);
      }
315 316 317
    }
  }
}
318

319 320 321
/**
 * Implementation of hook_nodeapi_insert().
 */
322
function forum_nodeapi_insert($node) {
323 324 325 326 327 328 329 330
  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);
  if (_forum_nodeapi_check_node_type($node, $vocabulary)) {
    if (!empty($node->tid)) {
      db_query('INSERT INTO {forum} (tid, vid, nid) VALUES (%d, %d, %d)', $node->tid, $node->vid, $node->nid);
    }
  }
}
331

332 333 334
/**
 * Implementation of hook_nodeapi_delete().
 */
335
function forum_nodeapi_delete($node) {
336 337 338 339
  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);
  if (_forum_nodeapi_check_node_type($node, $vocabulary)) {
    db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
340
  }
341
}
342

343 344 345
/**
 * Implementation of hook_nodeapi_load().
 */
346
function forum_nodeapi_load($nodes, $types) {
347
  $vid = variable_get('forum_nav_vocabulary', '');
348 349 350 351
  // If no forum vocabulary is set up, return.
  if ($vid == '') {
    return;
  }
352
  $vocabulary = taxonomy_vocabulary_load($vid);
353 354 355 356 357 358 359 360

  $node_vids = array();
  foreach ($nodes as $node) {
    if (isset($vocabulary->nodes[$node->type])) {
      $node_vids[] = $node->vid;
    }
  }
  if (!empty($node_vids)) {
361
    $result = db_query('SELECT nid, tid FROM {forum} WHERE vid IN(:node_vids)', array(':node_vids' => $node_vids));
362 363 364
    foreach ($result as $record) {
      $nodes[$record->nid]->forum_tid = $record->tid;
    }
365
  }
366 367
}

368
/**
369
 * Implementation of hook_node_info().
370
 */
371
function forum_node_info() {
372 373
  return array(
    'forum' => array(
374
      'name' => t('Forum topic'),
375
      'base' => 'forum',
376
      'description' => t('A <em>forum topic</em> is the initial post to a new discussion thread within a forum.'),
377 378 379
      'title_label' => t('Subject'),
    )
  );
Dries's avatar
 
Dries committed
380 381
}

382 383 384
/**
 * Implementation of hook_access().
 */
385
function forum_access($op, $node, $account) {
386 387
  switch ($op) {
    case 'create':
388
      return user_access('create forum content', $account);
389
    case 'update':
390
      return user_access('edit any forum content', $account) || (user_access('edit own forum content', $account) && ($account->uid == $node->uid));
391
    case 'delete':
392
      return user_access('delete any forum content', $account) || (user_access('delete own forum content', $account) && ($account->uid == $node->uid));
Dries's avatar
 
Dries committed
393
  }
Dries's avatar
 
Dries committed
394 395
}

396 397 398
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
399
function forum_perm() {
400
  $perms = array(
401 402 403 404
    'administer forums' => array(
      'title' => t('Administer forums'),
      'description' => t('Manage forums and configure forum administration settings.'),
    ),
405 406 407
  );
  $perms += node_list_permissions('forum');
  return $perms;
Dries's avatar
 
Dries committed
408
}
Dries's avatar
 
Dries committed
409

410 411 412
/**
 * Implementation of hook_taxonomy().
 */
413
function forum_taxonomy($op, $type, $term = NULL) {
414
  if ($op == 'delete' && $term['vid'] == variable_get('forum_nav_vocabulary', '')) {
415 416
    switch ($type) {
      case 'term':
417
        $results = db_query('SELECT tn.nid FROM {taxonomy_term_node} tn WHERE tn.tid = %d', $term['tid']);
418 419 420 421 422 423 424
        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());
425 426
        $key = array_search($term['tid'], $containers);
        if ($key !== FALSE) {
427 428 429 430 431 432
          unset($containers[$key]);
        }
        variable_set('forum_containers', $containers);
        break;
      case 'vocabulary':
        variable_del('forum_nav_vocabulary');
Dries's avatar
 
Dries committed
433
    }
434 435
  }
}
Dries's avatar
 
Dries committed
436

437 438 439
/**
 * Implementation of hook_form_alter().
 */
440
function forum_form_alter(&$form, $form_state, $form_id) {
441 442 443 444
  $vid = variable_get('forum_nav_vocabulary', '');
  if (isset($form['vid']) && $form['vid']['#value'] == $vid) {
    // Hide critical options from forum vocabulary.
    if ($form_id == 'taxonomy_form_vocabulary') {
445
      $form['help_forum_vocab'] = array(
446
        '#markup' => t('This is the designated forum vocabulary. Some of the normal vocabulary options have been removed.'),
447 448
        '#weight' => -1,
      );
449
      $form['content_types']['nodes']['#required'] = TRUE;
450
      $form['hierarchy'] = array('#type' => 'value', '#value' => 1);
451 452 453 454
      $form['settings']['required'] = array('#type' => 'value', '#value' => FALSE);
      $form['settings']['relations'] = array('#type' => 'value', '#value' => FALSE);
      $form['settings']['tags'] = array('#type' => 'value', '#value' => FALSE);
      $form['settings']['multiple'] = array('#type' => 'value', '#value' => FALSE);
455
      unset($form['delete']);
456
    }
457 458 459
    // Hide multiple parents select from forum terms.
    elseif ($form_id == 'taxonomy_form_term') {
      $form['advanced']['parent']['#access'] = FALSE;
460
    }
461
  }
462 463 464 465 466 467
  if ($form_id == 'forum_node_form') {
    // Make the vocabulary required for 'real' forum-nodes.
    $vid = variable_get('forum_nav_vocabulary', '');
    $form['taxonomy'][$vid]['#required'] = TRUE;
    $form['taxonomy'][$vid]['#options'][''] = t('- Please choose -');
  }
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
 * Implementation of hook_block_list().
 */
function forum_block_list() {
  $blocks['active']['info'] = t('Active forum topics');
  $blocks['new']['info'] = t('New forum topics');
  return $blocks;
}

/**
 * Implementation of hook_block_configure().
 */
function forum_block_configure($delta = '') {
  $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)));
  return $form;
}

/**
 * Implementation of hook_block_save().
 */
function forum_block_save($delta = '', $edit = array()) {
  variable_set('forum_block_num_' . $delta, $edit['forum_block_num_' . $delta]);
}

/**
 * Implementation of hook_block_view().
496 497 498 499
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
500 501 502 503 504
function forum_block_view($delta = '') {
  if (user_access('access content')) {
    switch ($delta) {
      case 'active':
        $title = t('Active forum topics');
505
        $query = db_select('node', 'n');
506 507
        $tn_alias = $query->join('taxonomy_term_node', 'tn', 'tn.vid = n.vid');
        $td_alias = $query->join('taxonomy_term_data', 'td', 'tn.tid = tn.tid');
508 509 510 511 512 513 514 515 516 517 518
        $l_alias = $query->join('node_comment_statistics', 'l', 'n.nid = l.nid');
        $query->addField('n', 'nid', 'nid');
        $query->addField('n', 'title', 'title');
        $query->addField($l_alias, 'comment_count', 'comment_count');
        $query->addField($l_alias, 'last_comment_timestamp');
        $query->condition("n.status", 1);
        $query->condition("{$td_alias}.vid", variable_get('forum_nav_vocabulary', ''));
        $query->orderBy("{$l_alias}.last_comment_timestamp", 'DESC');
        $query->range(0, variable_get('forum_block_num_active', '5'));
        $query->addTag('node_access');
        $result = $query->execute();
519 520
        $content = node_title_list($result);
        break;
Dries's avatar
 
Dries committed
521

522 523
      case 'new':
        $title = t('New forum topics');
524
        $sql = db_rewrite_sql("SELECT n.nid, n.title, l.comment_count FROM {node} n INNER JOIN {taxonomy_term_node} tn ON tn.vid = n.vid INNER JOIN {taxonomy_term_data} td ON td.tid = tn.tid INNER JOIN {node_comment_statistics} l ON n.nid = l.nid WHERE n.status = 1 AND td.vid = %d ORDER BY n.nid DESC");
525 526 527 528 529 530 531 532 533 534
        $result = db_query_range($sql, variable_get('forum_nav_vocabulary', ''), 0, variable_get('forum_block_num_new', '5'));
        $content = node_title_list($result);
        break;
    }

    if (!empty($content)) {
      $block['subject'] = $title;
      $block['content'] = $content . theme('more_link', url('forum'), t('Read the latest forum topics.'));
      return $block;
    }
535
  }
Dries's avatar
 
Dries committed
536 537
}

538 539 540
/**
 * Implementation of hook_form().
 */
541
function forum_form(&$node, $form_state) {
542
  $type = node_get_types('type', $node);
543
  $form['title'] = array('#type' => 'textfield', '#title' => check_plain($type->title_label), '#default_value' => !empty($node->title) ? $node->title : '', '#required' => TRUE, '#weight' => -5);
544

545
  if (!empty($node->nid)) {
546 547
    $vid = variable_get('forum_nav_vocabulary', '');
    $forum_terms = taxonomy_node_get_terms_by_vocabulary($node, $vid);
Dries's avatar
Dries committed
548
    // if editing, give option to leave shadows
549
    $shadow = (count($forum_terms) > 1);
550
    $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
551
  }
Dries's avatar
 
Dries committed
552

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

555 556 557
  $form['#submit'][] = 'forum_submit';
  // Assign the forum topic submit handler.

558
  return $form;
Dries's avatar
 
Dries committed
559 560
}

561 562 563 564 565
/**
 * Implementation of hook_term_path().
 */
function forum_term_path($term) {
  return 'forum/' . $term->tid;
566 567
}

Dries's avatar
 
Dries committed
568 569 570
/**
 * Returns a list of all forums for a given taxonomy id
 *
571
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
572 573 574 575 576 577 578 579 580
 * -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
581
function forum_get_forums($tid = 0) {
582

Dries's avatar
 
Dries committed
583
  $forums = array();
584 585
  $vid = variable_get('forum_nav_vocabulary', '');
  $_forums = taxonomy_get_tree($vid, $tid);
Dries's avatar
 
Dries committed
586

Dries's avatar
 
Dries committed
587
  if (count($_forums)) {
Dries's avatar
 
Dries committed
588

Dries's avatar
 
Dries committed
589 590
    $counts = array();

591
    $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 {taxonomy_term_node} r ON n.vid = r.vid WHERE n.status = 1 GROUP BY r.tid";
592
    $sql = db_rewrite_sql($sql);
593
    $_counts = db_query($sql);
Dries's avatar
 
Dries committed
594 595 596
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
597
  }
Dries's avatar
 
Dries committed
598

Dries's avatar
 
Dries committed
599 600 601 602
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
603

604
    if (!empty($counts[$forum->tid])) {
Dries's avatar
 
Dries committed
605 606 607 608 609 610 611 612 613 614
      $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
615
    // used to join node_comment_statistics to users.
616
    $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 {taxonomy_term_node} tn ON n.vid = tn.vid 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";
617
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
618
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
619

620
    $last_post = new stdClass();
621 622 623 624 625
    if (!empty($topic->last_comment_timestamp)) {
      $last_post->timestamp = $topic->last_comment_timestamp;
      $last_post->name = $topic->last_comment_name;
      $last_post->uid = $topic->last_comment_uid;
    }
Dries's avatar
 
Dries committed
626
    $forum->last_post = $last_post;
Dries's avatar
 
Dries committed
627

Dries's avatar
 
Dries committed
628 629 630 631
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
632 633
}

634 635 636 637 638
/**
 * Calculate the number of nodes the user has not yet read and are newer
 * than NODE_NEW_LIMIT.
 */
function _forum_topics_unread($term, $uid) {
639
  $sql = "SELECT COUNT(n.nid) FROM {node} n INNER JOIN {taxonomy_term_node} tn ON n.vid = tn.vid AND tn.tid = %d LEFT JOIN {history} h ON n.nid = h.nid AND h.uid = %d WHERE n.status = 1 AND n.created > %d AND h.nid IS NULL";
640
  $sql = db_rewrite_sql($sql);
641
  return db_result(db_query($sql, $term, $uid, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
642 643
}

Dries's avatar
Dries committed
644
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
645
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
646

Dries's avatar
 
Dries committed
647
  $forum_topic_list_header = array(
648
    NULL,
Dries's avatar
 
Dries committed
649
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
650
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
651
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
652
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
653
  );
Dries's avatar
 
Dries committed
654

Dries's avatar
 
Dries committed
655
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
656
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
657 658
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
659 660 661
    }
  }

662
  $sql = db_rewrite_sql("SELECT n.nid, r.tid, n.title, n.type, 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, f.tid AS forum_tid FROM {node_comment_statistics} l INNER JOIN {node} n ON n.nid = l.nid INNER JOIN {users} cu ON l.last_comment_uid = cu.uid INNER JOIN {taxonomy_term_node} r ON n.vid = r.vid INNER JOIN {users} u ON n.uid = u.uid INNER JOIN {forum} f ON n.vid = f.vid WHERE n.status = 1 AND r.tid = %d");
Dries's avatar
 
Dries committed
663
  $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
664
  $sql .= ', n.created DESC';  // Always add a secondary sort order so that the news forum topics are on top.
Dries's avatar
Dries committed
665

666
  $sql_count = db_rewrite_sql("SELECT COUNT(n.nid) FROM {node} n INNER JOIN {taxonomy_term_node} r ON n.vid = r.vid AND r.tid = %d WHERE n.status = 1");
Dries's avatar
 
Dries committed
667

Steven Wittens's avatar
Steven Wittens committed
668
  $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
669
  $topics = array();
Dries's avatar
 
Dries committed
670
  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
671 672
    if ($user->uid) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
 
Dries committed
673
      if ($topic->tid != $tid) {
Dries's avatar
Dries committed
674
        $topic->new = 0;
Dries's avatar
 
Dries committed
675 676
      }
      else {
Dries's avatar
 
Dries committed
677
        $history = _forum_user_last_visit($topic->nid);
Dries's avatar
 
Dries committed
678
        $topic->new_replies = comment_num_new($topic->nid, $history);
679
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
680
      }
681 682
    }
    else {
683
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
684 685
      $topic->new_replies = 0;
      $topic->new = 0;
686
    }
Dries's avatar
 
Dries committed
687

Dries's avatar
 
Dries committed
688
    if ($topic->num_comments > 0) {
689
      $last_reply = new stdClass();
Dries's avatar
 
Dries committed
690 691 692 693 694
      $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
695 696 697
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
698
  return $topics;
Dries's avatar
 
Dries committed
699 700
}

Dries's avatar
 
Dries committed
701
/**
702
 * Process variables for forums.tpl.php
703 704 705 706 707 708 709 710
 *
 * The $variables array contains the following arguments:
 * - $forums
 * - $topics
 * - $parents
 * - $tid
 * - $sortby
 * - $forum_per_page
Dries's avatar
 
Dries committed
711
 *
712
 * @see forums.tpl.php
Dries's avatar
 
Dries committed
713
 */
714
function template_preprocess_forums(&$variables) {
Dries's avatar
 
Dries committed
715
  global $user;
Dries's avatar
 
Dries committed
716

717 718
  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);
719
  $title = !empty($vocabulary->name) ? $vocabulary->name : '';
Dries's avatar
 
Dries committed
720

Dries's avatar
 
Dries committed
721
  // Breadcrumb navigation:
722
  $breadcrumb[] = l(t('Home'), NULL);
723
  if ($variables['tid']) {
724
    $breadcrumb[] = l($vocabulary->name, 'forum');
Dries's avatar
 
Dries committed
725
  }
726 727 728 729
  if ($variables['parents']) {
    $variables['parents'] = array_reverse($variables['parents']);
    foreach ($variables['parents'] as $p) {
      if ($p->tid == $variables['tid']) {
730
        $title = $p->name;
Dries's avatar
 
Dries committed
731 732
      }
      else {
733
        $breadcrumb[] = l($p->name, 'forum/' . $p->tid);
Dries's avatar
 
Dries committed
734 735 736
      }
    }
  }
737
  drupal_set_breadcrumb($breadcrumb);
738
  drupal_set_title($title);
739

740
  if ($variables['forums_defined'] = count($variables['forums']) || count($variables['parents'])) {
741 742 743 744 745 746 747 748 749
    // Format the "post new content" links listing.
    $forum_types = array();

    // Loop through all node types for forum vocabulary.
    foreach ($vocabulary->nodes as $type) {
      // Check if the current user has the 'create' permission for this node type.
      if (node_access('create', $type)) {
        // Fetch the "General" name of the content type;
        // Push the link with title and url to the array.
750
        $forum_types[$type] = array('title' => t('Post new @node_type', array('@node_type' => node_get_types('name', $type))), 'href' => 'node/add/' . str_replace('_', '-', $type) . '/' . $variables['tid']);
751
      }
Dries's avatar
 
Dries committed
752
    }
753

754
    if (empty($forum_types)) {
755 756
      // The user is logged-in; but denied access to create any new forum content type.
      if ($user->uid) {
757
        $forum_types['disallowed'] = array('title' => t('You are not allowed to post new content in forum.'));
758 759 760
      }
      // The user is not logged-in; and denied access to create any new forum content type.
      else {
761
        $forum_types['login'] = array('title' => t('<a href="@login">Login</a> to post new content in forum.', array('@login' => url('user/login', array('query' => drupal_get_destination())))), 'html' => TRUE);
762
      }
Dries's avatar
 
Dries committed
763
    }
764
    $variables['links'] = $forum_types;
Dries's avatar
 
Dries committed
765

766 767 768 769 770 771
    if (!empty($variables['forums'])) {
      $variables['forums'] = theme('forum_list', $variables['forums'], $variables['parents'], $variables['tid']);
    }
    else {
      $variables['forums'] = '';
    }
Dries's avatar
 
Dries committed
772

773 774
    if ($variables['tid'] && !in_array($variables['tid'], variable_get('forum_containers', array()))) {
      $variables['topics'] = theme('forum_topic_list', $variables['tid'], $variables['topics'], $variables['sortby'], $variables['forum_per_page']);
775
      drupal_add_feed(url('taxonomy/term/' . $variables['tid'] . '/0/feed'), 'RSS - ' . $title);
Dries's avatar
 
Dries committed
776
    }
777 778 779 780 781
    else {
      $variables['topics'] = '';
    }

    // Provide separate template suggestions based on what's being output. Topic id is also accounted for.
782
    // Check both variables to be safe then the inverse. Forums with topic ID's take precedence.
783
    if ($variables['forums'] && !$variables['topics']) {
784
      $variables['template_files'][] = 'forums-containers';
785 786
      $variables['template_files'][] = 'forums-' . $variables['tid'];
      $variables['template_files'][] = 'forums-containers-' . $variables['tid'];
787
    }
788
    elseif (!$variables['forums'] && $variables['topics']) {
789
      $variables['template_files'][] = 'forums-topics';
790 791
      $variables['template_files'][] = 'forums-' . $variables['tid'];
      $variables['template_files'][] = 'forums-topics-' . $variables['tid'];
792
    }
793
    else {