forum.module 37.2 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 77 78 79 80
/**
 * 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) {
  $result = db_query(db_rewrite_sql('SELECT t.tid, t.vid, t.name, t.description, t.weight FROM {term_data} t WHERE t.tid = %d AND t.vid = %d', 't', 'tid'), $tid, variable_get('forum_nav_vocabulary', ''));
  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
/**
 * Implementation of hook_nodeapi().
 */
function forum_nodeapi(&$node, $op, $teaser, $page) {
162 163 164 165
  // We are going to return if $node->type is not one of the node
  // types assigned to the forum vocabulary.  If forum_nav_vocabulary
  // is undefined or the vocabulary does not exist, it clearly cannot
  // be assigned to $node->type, so return to avoid E_ALL warnings.
166 167
  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);
168 169 170
  if (empty($vocabulary)) {
    return;
  }
171 172 173 174 175 176 177 178

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

  switch ($op) {
    case 'view':
179
      if ($page && taxonomy_node_get_terms_by_vocabulary($node, $vid) && $tree = taxonomy_get_tree($vid)) {
180
        // Get the forum terms from the (cached) tree
181 182
        foreach ($tree as $term) {
          $forum_terms[] = $term->tid;
183 184 185 186 187 188 189
        }
        foreach ($node->taxonomy as $term_id => $term) {
          if (in_array($term_id, $forum_terms)) {
            $node->tid = $term_id;
          }
        }
        // Breadcrumb navigation
190 191
        $breadcrumb[] = l(t('Home'), NULL);
        $breadcrumb[] = l($vocabulary->name, 'forum');
192 193 194
        if ($parents = taxonomy_get_parents_all($node->tid)) {
          $parents = array_reverse($parents);
          foreach ($parents as $p) {
195
            $breadcrumb[] = l($p->name, 'forum/' . $p->tid);
196 197
          }
        }
198
        drupal_set_breadcrumb($breadcrumb);
199 200 201

        if (!$teaser) {
          $node->content['forum_navigation'] = array(
202
            '#markup' => theme('forum_topic_navigation', $node),
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
            '#weight' => 100,
          );
        }
      }
      break;

    case 'prepare':
      if (empty($node->nid)) {
        // New topic
        $node->taxonomy[arg(3)]->vid = $vid;
        $node->taxonomy[arg(3)]->tid = arg(3);
      }
      break;

    // Check in particular that only a "leaf" term in the associated taxonomy
    // vocabulary is selected, not a "container" term.
    case 'validate':
      if ($node->taxonomy) {
        // Extract the node's proper topic ID.
        $vocabulary = $vid;
        $containers = variable_get('forum_containers', array());
        foreach ($node->taxonomy as $term) {
          if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
            if (in_array($term, $containers)) {
              $term = taxonomy_get_term($term);
              form_set_error('taxonomy', t('The item %forum is only a container for forums. Please select one of the forums below it.', array('%forum' => $term->name)));
            }
          }
        }
      }
      break;

    // Assign forum taxonomy when adding a topic from within a forum.
236
    case 'presave':
237 238 239
      // Make sure all fields are set properly:
      $node->icon = !empty($node->icon) ? $node->icon : '';

240 241 242 243
      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;
244
        }
245
        foreach ($node->taxonomy as $term_id) {
246 247 248 249
          if (in_array($term_id, $forum_terms)) {
            $node->tid = $term_id;
          }
        }
250
        $old_tid = db_result(db_query_range("SELECT t.tid FROM {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));
251 252 253
        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;
254 255 256
        }
      }
      break;
257

258
    case 'update':
259
      if (empty($node->revision) && db_result(db_query('SELECT tid FROM {forum} WHERE nid=%d', $node->nid))) {
260 261 262 263 264 265 266
        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);
        }
267 268
        break;
      }
269 270
      // Deliberate no break -- for new revisions and for previously unassigned terms we need an insert.

271
    case 'insert':
272 273 274
      if (!empty($node->tid)) {
        db_query('INSERT INTO {forum} (tid, vid, nid) VALUES (%d, %d, %d)', $node->tid, $node->vid, $node->nid);
      }
275
      break;
276

277 278 279
    case 'delete':
      db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
      break;
280

281
    case 'load':
282
      return db_fetch_array(db_query('SELECT tid AS forum_tid FROM {forum} WHERE vid = %d', $node->vid));
283 284 285
  }

  return;
286 287
}

288
/**
289
 * Implementation of hook_node_info().
290
 */
291
function forum_node_info() {
292 293
  return array(
    'forum' => array(
294
      'name' => t('Forum topic'),
295
      'module' => 'forum',
296
      'description' => t('A <em>forum topic</em> is the initial post to a new discussion thread within a forum.'),
297 298 299
      'title_label' => t('Subject'),
    )
  );
Dries's avatar
 
Dries committed
300 301
}

302 303 304
/**
 * Implementation of hook_access().
 */
305
function forum_access($op, $node, $account) {
306 307
  switch ($op) {
    case 'create':
308
      return user_access('create forum content', $account);
309
    case 'update':
310
      return user_access('edit any forum content', $account) || (user_access('edit own forum content', $account) && ($account->uid == $node->uid));
311
    case 'delete':
312
      return user_access('delete any forum content', $account) || (user_access('delete own forum content', $account) && ($account->uid == $node->uid));
Dries's avatar
 
Dries committed
313
  }
Dries's avatar
 
Dries committed
314 315
}

316 317 318
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
319
function forum_perm() {
320 321 322 323 324
  $perms = array(
    'administer forums' => t('Manage forums and configure forum administration settings.'),
  );
  $perms += node_list_permissions('forum');
  return $perms;
Dries's avatar
 
Dries committed
325
}
Dries's avatar
 
Dries committed
326

327 328 329
/**
 * Implementation of hook_taxonomy().
 */
330
function forum_taxonomy($op, $type, $term = NULL) {
331
  if ($op == 'delete' && $term['vid'] == variable_get('forum_nav_vocabulary', '')) {
332 333
    switch ($type) {
      case 'term':
334
        $results = db_query('SELECT tn.nid FROM {term_node} tn WHERE tn.tid = %d', $term['tid']);
335 336 337 338 339 340 341
        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());
342 343
        $key = array_search($term['tid'], $containers);
        if ($key !== FALSE) {
344 345 346 347 348 349
          unset($containers[$key]);
        }
        variable_set('forum_containers', $containers);
        break;
      case 'vocabulary':
        variable_del('forum_nav_vocabulary');
Dries's avatar
 
Dries committed
350
    }
351 352
  }
}
Dries's avatar
 
Dries committed
353

354 355 356
/**
 * Implementation of hook_form_alter().
 */
357
function forum_form_alter(&$form, $form_state, $form_id) {
358 359 360 361
  $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') {
362
      $form['help_forum_vocab'] = array(
363
        '#markup' => t('This is the designated forum vocabulary. Some of the normal vocabulary options have been removed.'),
364 365
        '#weight' => -1,
      );
366
      $form['content_types']['nodes']['#required'] = TRUE;
367
      $form['hierarchy'] = array('#type' => 'value', '#value' => 1);
368 369 370 371
      $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);
372
      unset($form['delete']);
373
    }
374 375 376
    // Hide multiple parents select from forum terms.
    elseif ($form_id == 'taxonomy_form_term') {
      $form['advanced']['parent']['#access'] = FALSE;
377
    }
378
  }
379 380 381 382 383 384
  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 -');
  }
385 386
}

387 388 389
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
390
function forum_load($node) {
391
  $forum = db_fetch_object(db_query('SELECT * FROM {term_node} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
392 393 394 395

  return $forum;
}

396 397 398 399 400 401
/**
 * Implementation of hook_block().
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
402
function forum_block($op = 'list', $delta = '', $edit = array()) {
403 404
  switch ($op) {
    case 'list':
405 406
      $blocks['active']['info'] = t('Active forum topics');
      $blocks['new']['info'] = t('New forum topics');
407
      return $blocks;
Dries's avatar
 
Dries committed
408

409
    case 'configure':
410
      $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)));
411
      return $form;
Dries's avatar
 
Dries committed
412

413
    case 'save':
414
      variable_set('forum_block_num_' . $delta, $edit['forum_block_num_' . $delta]);
415
      break;
Dries's avatar
 
Dries committed
416

417 418
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
419
        switch ($delta) {
420
          case 'active':
421
            $title = t('Active forum topics');
422
            $sql = db_rewrite_sql("SELECT n.nid, n.title, l.comment_count, l.last_comment_timestamp FROM {node} n INNER JOIN {term_node} tn ON tn.vid = n.vid INNER JOIN {term_data} td ON td.tid = tn.tid INNER JOIN {node_comment_statistics} l ON n.nid = l.nid WHERE n.status = 1 AND td.vid = %d ORDER BY l.last_comment_timestamp DESC");
423
            $result = db_query_range($sql, variable_get('forum_nav_vocabulary', ''), 0, variable_get('forum_block_num_active', '5'));
424
            $content = node_title_list($result);
425
            break;
Dries's avatar
 
Dries committed
426

427
          case 'new':
428
            $title = t('New forum topics');
429
            $sql = db_rewrite_sql("SELECT n.nid, n.title, l.comment_count FROM {node} n INNER JOIN {term_node} tn ON tn.vid = n.vid INNER JOIN {term_data} td ON td.tid = tn.tid INNER JOIN {node_comment_statistics} l ON n.nid = l.nid WHERE n.status = 1 AND td.vid = %d ORDER BY n.nid DESC");
430
            $result = db_query_range($sql, variable_get('forum_nav_vocabulary', ''), 0, variable_get('forum_block_num_new', '5'));
431
            $content = node_title_list($result);
432
            break;
Dries's avatar
 
Dries committed
433
        }
Dries's avatar
 
Dries committed
434

435 436
        if (!empty($content)) {
          $block['subject'] = $title;
437
          $block['content'] = $content . theme('more_link', url('forum'), t('Read the latest forum topics.'));
438
          return $block;
439 440 441
        }
      }
  }
Dries's avatar
 
Dries committed
442 443
}

444 445 446
/**
 * Implementation of hook_form().
 */
447
function forum_form(&$node, $form_state) {
448
  $type = node_get_types('type', $node);
449
  $form['title'] = array('#type' => 'textfield', '#title' => check_plain($type->title_label), '#default_value' => !empty($node->title) ? $node->title : '', '#required' => TRUE, '#weight' => -5);
450

451
  if (!empty($node->nid)) {
452 453
    $vid = variable_get('forum_nav_vocabulary', '');
    $forum_terms = taxonomy_node_get_terms_by_vocabulary($node, $vid);
Dries's avatar
Dries committed
454
    // if editing, give option to leave shadows
455
    $shadow = (count($forum_terms) > 1);
456
    $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
457
  }
Dries's avatar
 
Dries committed
458

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

461 462 463
  $form['#submit'][] = 'forum_submit';
  // Assign the forum topic submit handler.

464
  return $form;
Dries's avatar
 
Dries committed
465 466
}

467 468 469 470 471
/**
 * Implementation of hook_term_path().
 */
function forum_term_path($term) {
  return 'forum/' . $term->tid;
472 473
}

Dries's avatar
 
Dries committed
474 475 476
/**
 * Returns a list of all forums for a given taxonomy id
 *
477
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
478 479 480 481 482 483 484 485 486
 * -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
487
function forum_get_forums($tid = 0) {
488

Dries's avatar
 
Dries committed
489
  $forums = array();
490 491
  $vid = variable_get('forum_nav_vocabulary', '');
  $_forums = taxonomy_get_tree($vid, $tid);
Dries's avatar
 
Dries committed
492

Dries's avatar
 
Dries committed
493
  if (count($_forums)) {
Dries's avatar
 
Dries committed
494

Dries's avatar
 
Dries committed
495 496
    $counts = array();

497
    $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.vid = r.vid WHERE n.status = 1 GROUP BY r.tid";
498
    $sql = db_rewrite_sql($sql);
499
    $_counts = db_query($sql);
Dries's avatar
 
Dries committed
500 501 502
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
503
  }
Dries's avatar
 
Dries committed
504

Dries's avatar
 
Dries committed
505 506 507 508
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
509

510
    if (!empty($counts[$forum->tid])) {
Dries's avatar
 
Dries committed
511 512 513 514 515 516 517 518 519 520
      $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
521
    // used to join node_comment_statistics to users.
522
    $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.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";
523
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
524
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
525

526
    $last_post = new stdClass();
527 528 529 530 531
    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
532
    $forum->last_post = $last_post;
Dries's avatar
 
Dries committed
533

Dries's avatar
 
Dries committed
534 535 536 537
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
538 539
}

540 541 542 543 544
/**
 * Calculate the number of nodes the user has not yet read and are newer
 * than NODE_NEW_LIMIT.
 */
function _forum_topics_unread($term, $uid) {
545
  $sql = "SELECT COUNT(n.nid) FROM {node} n INNER JOIN {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";
546
  $sql = db_rewrite_sql($sql);
547
  return db_result(db_query($sql, $term, $uid, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
548 549
}

Dries's avatar
Dries committed
550
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
551
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
552

Dries's avatar
 
Dries committed
553
  $forum_topic_list_header = array(
554
    array('data' => '&nbsp;', 'field' => NULL),
Dries's avatar
 
Dries committed
555
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
556
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
557
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
558
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
559
  );
Dries's avatar
 
Dries committed
560

Dries's avatar
 
Dries committed
561
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
562
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
563 564
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
565 566 567 568
    }
  }

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

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

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

Steven Wittens's avatar
Steven Wittens committed
576
  $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
577
  $topics = array();
Dries's avatar
 
Dries committed
578
  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
579 580
    if ($user->uid) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
 
Dries committed
581
      if ($topic->tid != $tid) {
Dries's avatar
Dries committed
582
        $topic->new = 0;
Dries's avatar
 
Dries committed
583 584
      }
      else {
Dries's avatar
 
Dries committed
585
        $history = _forum_user_last_visit($topic->nid);
Dries's avatar
 
Dries committed
586
        $topic->new_replies = comment_num_new($topic->nid, $history);
587
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
588
      }
589 590
    }
    else {
591
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
592 593
      $topic->new_replies = 0;
      $topic->new = 0;
594
    }
Dries's avatar
 
Dries committed
595

Dries's avatar
 
Dries committed
596
    if ($topic->num_comments > 0) {
597
      $last_reply = new stdClass();
Dries's avatar
 
Dries committed
598 599 600 601 602
      $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
603 604 605
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
606
  return $topics;
Dries's avatar
 
Dries committed
607 608
}

Dries's avatar
 
Dries committed
609 610 611
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
612
function _forum_new($tid) {
Dries's avatar
 
Dries committed
613 614
  global $user;

615
  $sql = "SELECT n.nid FROM {node} n LEFT JOIN {history} h ON n.nid = h.nid AND h.uid = %d INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.status = 1 AND h.nid IS NULL AND n.created > %d ORDER BY created";
616
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
617
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
618 619 620 621

  return $nid ? $nid : 0;
}

Dries's avatar
 
Dries committed
622
/**
623
 * Process variables for forums.tpl.php
624 625 626 627 628 629 630 631
 *
 * The $variables array contains the following arguments:
 * - $forums
 * - $topics
 * - $parents
 * - $tid
 * - $sortby
 * - $forum_per_page
Dries's avatar
 
Dries committed
632
 *
633
 * @see forums.tpl.php
Dries's avatar
 
Dries committed
634
 */
635
function template_preprocess_forums(&$variables) {
Dries's avatar
 
Dries committed
636
  global $user;
Dries's avatar
 
Dries committed
637

638 639
  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);
640
  $title = !empty($vocabulary->name) ? $vocabulary->name : '';
Dries's avatar
 
Dries committed
641

Dries's avatar
 
Dries committed
642
  // Breadcrumb navigation:
643
  $breadcrumb[] = l(t('Home'), NULL);
644
  if ($variables['tid']) {
645
    $breadcrumb[] = l($vocabulary->name, 'forum');
Dries's avatar
 
Dries committed
646
  }
647 648 649 650
  if ($variables['parents']) {
    $variables['parents'] = array_reverse($variables['parents']);
    foreach ($variables['parents'] as $p) {
      if ($p->tid == $variables['tid']) {
651
        $title = $p->name;
Dries's avatar
 
Dries committed
652 653
      }
      else {
654
        $breadcrumb[] = l($p->name, 'forum/' . $p->tid);
Dries's avatar
 
Dries committed
655 656 657
      }
    }
  }
658
  drupal_set_breadcrumb($breadcrumb);
Dries's avatar
Dries committed
659
  drupal_set_title(check_plain($title));
660

661
  if ($variables['forums_defined'] = count($variables['forums']) || count($variables['parents'])) {
662 663 664 665 666 667 668 669 670
    // 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.
671
        $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']);
672
      }
Dries's avatar
 
Dries committed
673
    }
674

675
    if (empty($forum_types)) {
676 677
      // The user is logged-in; but denied access to create any new forum content type.
      if ($user->uid) {
678
        $forum_types['disallowed'] = array('title' => t('You are not allowed to post new content in forum.'));
679 680 681
      }
      // The user is not logged-in; and denied access to create any new forum content type.
      else {
682
        $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);
683
      }
Dries's avatar
 
Dries committed
684
    }
685
    $variables['links'] = $forum_types;
Dries's avatar
 
Dries committed
686

687 688 689 690 691 692
    if (!empty($variables['forums'])) {
      $variables['forums'] = theme('forum_list', $variables['forums'], $variables['parents'], $variables['tid']);
    }
    else {
      $variables['forums'] = '';
    }
Dries's avatar
 
Dries committed
693

694 695
    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']);
696
      drupal_add_feed(url('taxonomy/term/' . $variables['tid'] . '/0/feed'), 'RSS - ' . $title);
Dries's avatar
 
Dries committed
697
    }
698 699 700 701 702
    else {
      $variables['topics'] = '';
    }

    // Provide separate template suggestions based on what's being output. Topic id is also accounted for.
703
    // Check both variables to be safe then the inverse. Forums with topic ID's take precedence.
704
    if ($variables['forums'] && !$variables['topics']) {
705
      $variables['template_files'][] = 'forums-containers';
706 707
      $variables['template_files'][] = 'forums-' . $variables['tid'];
      $variables['template_files'][] = 'forums-containers-' . $variables['tid'];
708
    }
709
    elseif (!$variables['forums'] && $variables['topics']) {
710
      $variables['template_files'][] = 'forums-topics';
711 712
      $variables['template_files'][] = 'forums-' . $variables['tid'];
      $variables['template_files'][] = 'forums-topics-' . $variables['tid'];
713
    }
714
    else {
715
      $variables['template_files'][] = 'forums-' . $variables['tid'];
716
    }
717

Dries's avatar
 
Dries committed
718 719
  }
  else {
720
    drupal_set_title(t('No forums defined'));
721 722 723
    $variables['links'] = array();
    $variables['forums'] = '';
    $variables['topics'] = '';
Dries's avatar
 
Dries committed
724 725 726
  }
}

Dries's avatar
 
Dries committed
727
/**
728
 * Process variables to format a forum listing.
Dries's avatar
 
Dries committed
729
 *
730 731 732 733 734 735 736
 * $variables contains the following information:
 * - $forums
 * - $parents
 * - $tid
 *
 * @see forum-list.tpl.php
 * @see theme_forum_list()
Dries's avatar
 
Dries committed
737
 */
738
function template_preprocess_forum_list(&$variables) {
Dries's avatar
 
Dries committed
739
  global $user;
740
  $row = 0;
741 742 743 744 745 746
  // Sanitize each forum so that the template can safely print the data.
  foreach ($variables['forums'] as $id => $forum) {
    $variables['forums'][$id]->description = !empty($forum->description) ? filter_xss_admin($forum->description) : '';
    $variables['forums'][$id]->link = url("forum/$forum->tid");
    $variables['forums'][$id]->name = check_plain($forum->name);
    $variables['forums'][$id]->is_container = !empty($forum->container);
747 748 749 750 751 752 753
    $variables['forums'][$id]->zebra = $row % 2 == 0 ? 'odd' : 'even';
    $row++;

    $variables['forums'][$id]->new_text = '';
    $variables['forums'][$id]->new_url = '';
    $variables['forums'][$id]->new_topics = 0;
    $variables['forums'][$id]->old_topics = $forum->num_topics;
754 755 756
    if ($user->uid) {
      $variables['forums'][$id]->new_topics = _forum_topics_unread($forum->tid, $user->uid);
      if ($variables['forums'][$id]->new_topics) {
757
        $variables['forums'][$id]->new_text = format_plural($variables['forums'][$id]->new_topics, '1 new', '@count new');
758
        $variables['forums'][$id]->new_url = url("forum/$forum->tid", array('fragment' => 'new'));
Dries's avatar
 
Dries committed
759
      }