forum.module 32.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
/**
 * Implementation of hook_help().
 */
12 13
function forum_help($path, $arg) {
  switch ($path) {
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
    case 'admin/content/forum/settings':
27
      return '<p>'. t('These settings provide the ability to fine tune the display of your forum topics. Choose the content types to use in the forums by editing the options for the <a href="@forum_vocab">forum vocabulary</a>.', array('@forum_vocab' => url('admin/content/taxonomy/edit/vocabulary/'. variable_get('forum_nav_vocabulary', '')))) .'</p>';
Dries's avatar
 
Dries committed
28 29 30
  }
}

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

63 64 65
/**
 * Implementation of hook_menu().
 */
66 67
function forum_menu() {
  $items['node/add/forum'] = array(
68
    'title' => 'Forum topic',
69 70 71
    'access arguments' => array('create forum topics'),
  );
  $items['forum'] = array(
72
    'title' => 'Forums',
73 74 75
    'page callback' => 'forum_page',
    'access arguments' => array('access content'),
    'type' => MENU_SUGGESTED_ITEM,
76
    'file' => 'forum.pages.inc',
77 78
  );
  $items['admin/content/forum'] = array(
79 80
    'title' => 'Forums',
    'description' => 'Control forums and their hierarchy and change forum settings.',
81 82
    'page callback' => 'forum_overview',
    'access arguments' => array('administer forums'),
83
    'file' => 'forum.admin.inc',
84 85
  );
  $items['admin/content/forum/list'] = array(
86
    'title' => 'List',
87 88 89 90
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/content/forum/add/container'] = array(
91
    'title' => 'Add container',
92 93 94
    'page callback' => 'forum_form_main',
    'page arguments' => array('container'),
    'type' => MENU_LOCAL_TASK,
95
    'parent' => 'admin/content/forum',
96
    'file' => 'forum.admin.inc',
97 98
  );
  $items['admin/content/forum/add/forum'] = array(
99
    'title' => 'Add forum',
100 101 102
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum'),
    'type' => MENU_LOCAL_TASK,
103
    'parent' => 'admin/content/forum',
104
    'file' => 'forum.admin.inc',
105 106
  );
  $items['admin/content/forum/settings'] = array(
107
    'title' => 'Settings',
108 109 110 111
    'page callback' => 'drupal_get_form',
    'page arguments' => array('forum_admin_settings'),
    'weight' => 5,
    'type' => MENU_LOCAL_TASK,
112
    'parent' => 'admin/content/forum',
113
    'file' => 'forum.admin.inc',
114
  );
115
  $items['admin/content/forum/edit/%forum_term'] = array(
116 117
    'page callback' => 'forum_form_main',
    'type' => MENU_CALLBACK,
118
    'file' => 'forum.admin.inc',
119
  );
120
  $items['admin/content/forum/edit/container/%forum_term'] = array(
121
    'title' => 'Edit container',
122
    'page callback' => 'forum_form_main',
123
    'page arguments' => array('container', 5),
124
    'type' => MENU_CALLBACK,
125
    'file' => 'forum.admin.inc',
126
  );
127
  $items['admin/content/forum/edit/forum/%forum_term'] = array(
128
    'title' => 'Edit forum',
129 130
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum', 5),
131
    'type' => MENU_CALLBACK,
132
    'file' => 'forum.admin.inc',
133 134 135
  );
  return $items;
}
136

137 138 139 140

/**
 * Implementation of hook_init().
 */
141 142 143
function forum_init() {
  drupal_add_css(drupal_get_path('module', 'forum') .'/forum.css');
}
144

145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
/**
 * Implementation of hook_nodeapi().
 */
function forum_nodeapi(&$node, $op, $teaser, $page) {
  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);

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

  switch ($op) {
    case 'view':
      if ($page && $node->taxonomy) {
        // Get the forum terms from the (cached) tree
        $tree = taxonomy_get_tree($vid);
        if ($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;
          }
        }
        // Breadcrumb navigation
        $breadcrumb = array();
        $breadcrumb[] = array('path' => 'forum', 'title' => $vocabulary->name);
        if ($parents = taxonomy_get_parents_all($node->tid)) {
          $parents = array_reverse($parents);
          foreach ($parents as $p) {
            $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
          }
        }
        $breadcrumb[] = array('path' => 'node/'. $node->nid);
        menu_set_location($breadcrumb);

        $node = node_prepare($node, $teaser);
        if (!$teaser) {
          $node->content['forum_navigation'] = array(
            '#value' => theme('forum_topic_navigation', $node),
            '#weight' => 100,
          );
        }
      }
      return $node;
      break;

    case 'prepare':
      if (empty($node->nid)) {
        // New topic
        $node->taxonomy[arg(3)]->vid = $vid;
        $node->taxonomy[arg(3)]->tid = arg(3);
      }
      return $node;
      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.
    case 'submit':
      // Make sure all fields are set properly:
      $node->icon = !empty($node->icon) ? $node->icon : '';

      if ($node->taxonomy) {
        // Get the forum terms from the (cached) tree
        $tree = taxonomy_get_tree($vid);
        if ($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;
          }
        }
        $old_tid = db_result(db_query_range("SELECT t.tid FROM {term_data} t INNER JOIN {node} n WHERE t.vid = n.vid AND n.nid = %d ORDER BY t.vid DESC", $node->nid, 0, 1));
        if ($old_tid) {
          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;
          }
        }
      }
      break;
  }

  return;
252 253
}

254
/**
255
 * Implementation of hook_node_info().
256
 */
257
function forum_node_info() {
258 259
  return array(
    'forum' => array(
260
      'name' => t('Forum topic'),
261 262 263 264 265
      'module' => 'forum',
      'description' => t('Create a new topic for discussion in the forums.'),
      'title_label' => t('Subject'),
    )
  );
Dries's avatar
 
Dries committed
266 267
}

268 269 270
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
271
function forum_access($op, $node) {
Dries's avatar
 
Dries committed
272 273
  global $user;

Dries's avatar
 
Dries committed
274 275
  if ($op == 'create') {
    return user_access('create forum topics');
Dries's avatar
 
Dries committed
276
  }
Dries's avatar
 
Dries committed
277 278 279 280 281 282

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

285 286 287
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
288
function forum_perm() {
289
  return array('create forum topics', 'edit own forum topics', 'administer forums');
Dries's avatar
 
Dries committed
290
}
Dries's avatar
 
Dries committed
291

292 293 294
/**
 * Implementation of hook_taxonomy().
 */
295
function forum_taxonomy($op, $type, $term = NULL) {
296
  if ($op == 'delete' && $term['vid'] == variable_get('forum_nav_vocabulary', '')) {
297 298
    switch ($type) {
      case 'term':
299
        $results = db_query('SELECT tn.nid FROM {term_node} tn WHERE tn.tid = %d', $term['tid']);
300 301 302 303 304 305 306
        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());
307 308
        $key = array_search($term['tid'], $containers);
        if ($key !== FALSE) {
309 310 311 312 313 314
          unset($containers[$key]);
        }
        variable_set('forum_containers', $containers);
        break;
      case 'vocabulary':
        variable_del('forum_nav_vocabulary');
Dries's avatar
 
Dries committed
315
    }
316 317
  }
}
Dries's avatar
 
Dries committed
318

319 320 321
/**
 * Implementation of hook_form_alter().
 */
322
function forum_form_alter(&$form, $form_state, $form_id) {
323
  // Hide critical options from forum vocabulary
324
  if ($form_id == 'taxonomy_form_vocabulary') {
325 326
    $vid = variable_get('forum_nav_vocabulary', '');
    if (isset($form['vid']) && $form['vid']['#value'] == $vid) {
327 328 329 330
      $form['help_forum_vocab'] = array(
        '#value' => t('This is the designated forum vocabulary. Some of the normal vocabulary options have been removed.'),
        '#weight' => -1,
      );
331
      $form['nodes']['#required'] = TRUE;
332 333 334 335 336 337 338 339 340
      $form['hierarchy'] = array('#type' => 'value', '#value' => 1);
      unset($form['relations']);
      unset($form['tags']);
      unset($form['multiple']);
      $form['required'] = array('#type' => 'value', '#value' => 1);
    }
  }
}

341 342 343
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
344
function forum_load($node) {
345
  $forum = db_fetch_object(db_query('SELECT * FROM {term_node} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
346 347 348 349

  return $forum;
}

350 351 352 353 354 355
/**
 * Implementation of hook_block().
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
356 357 358
function forum_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
Dries's avatar
 
Dries committed
359 360
      $blocks[0]['info'] = t('Active forum topics');
      $blocks[1]['info'] = t('New forum topics');
361
      return $blocks;
Dries's avatar
 
Dries committed
362

363
    case 'configure':
364
      $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)));
365
      return $form;
Dries's avatar
 
Dries committed
366

367
    case 'save':
368
      variable_set('forum_block_num_'. $delta, $edit['forum_block_num_'. $delta]);
369
      break;
Dries's avatar
 
Dries committed
370

371 372
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
373 374
        switch ($delta) {
          case 0:
375
            $title = t('Active forum topics');
376 377
            $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.nid = n.nid 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");
            $result = db_query_range($sql, variable_get('forum_nav_vocabulary', ''), 0, variable_get('forum_block_num_0', '5'));
378 379 380
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
381
            break;
Dries's avatar
 
Dries committed
382 383

          case 1:
384
            $title = t('New forum topics');
385 386
            $sql = db_rewrite_sql("SELECT n.nid, n.title, l.comment_count FROM {node} n INNER JOIN {term_node} tn ON tn.nid = n.nid 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");
            $result = db_query_range($sql, variable_get('forum_nav_vocabulary', ''), 0, variable_get('forum_block_num_1', '5'));
387 388 389
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
390
            break;
Dries's avatar
 
Dries committed
391
        }
Dries's avatar
 
Dries committed
392

393
        if (!empty($content)) {
394
          $content .= '<div class="more-link">'. l(t('more'), 'forum', array('title' => t('Read the latest forum topics.'))) .'</div>';
395 396 397
          $block['subject'] = $title;
          $block['content'] = $content;
          return $block;
398 399 400
        }
      }
  }
Dries's avatar
 
Dries committed
401 402
}

403 404 405
/**
 * Implementation of hook_form().
 */
406
function forum_form(&$node, $form_state) {
407
  $type = node_get_types('type', $node);
408
  $form['title'] = array('#type' => 'textfield', '#title' => check_plain($type->title_label), '#default_value' => !empty($node->title) ? $node->title : '', '#required' => TRUE, '#weight' => -5);
409

410
  if (!empty($node->nid)) {
411 412
    $vid = variable_get('forum_nav_vocabulary', '');
    $forum_terms = taxonomy_node_get_terms_by_vocabulary($node, $vid);
Dries's avatar
Dries committed
413
    // if editing, give option to leave shadows
414
    $shadow = (count($forum_terms) > 1);
415
    $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
416
  }
Dries's avatar
 
Dries committed
417

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

420 421 422
  $form['#submit'][] = 'forum_submit';
  // Assign the forum topic submit handler.

423
  return $form;
Dries's avatar
 
Dries committed
424 425
}

426
function forum_link_alter(&$links, $node) {
427
  foreach ($links as $module => $link) {
428
    if (strstr($module, 'taxonomy_term')) {
429 430
      // 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.
431
      $tid = str_replace('taxonomy/term/', '', $link['href']);
432
      $vid = variable_get('forum_nav_vocabulary', '');
433
      $term = taxonomy_get_term($tid);
434
      if ($term->vid == $vid) {
435
        $links[$module]['href'] = str_replace('taxonomy/term', 'forum', $link['href']);
436
      }
437 438
    }
  }
439 440
}

Dries's avatar
 
Dries committed
441 442 443
/**
 * Returns a list of all forums for a given taxonomy id
 *
444
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
445 446 447 448 449 450 451 452 453
 * -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
454
function forum_get_forums($tid = 0) {
455

Dries's avatar
 
Dries committed
456
  $forums = array();
457 458
  $vid = variable_get('forum_nav_vocabulary', '');
  $_forums = taxonomy_get_tree($vid, $tid);
Dries's avatar
 
Dries committed
459

Dries's avatar
 
Dries committed
460
  if (count($_forums)) {
Dries's avatar
 
Dries committed
461

Dries's avatar
 
Dries committed
462 463
    $counts = array();

464
    $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 GROUP BY r.tid";
465
    $sql = db_rewrite_sql($sql);
466
    $_counts = db_query($sql);
Dries's avatar
 
Dries committed
467 468 469
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
470
  }
Dries's avatar
 
Dries committed
471

Dries's avatar
 
Dries committed
472 473 474 475
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
476

477
    if (!empty($counts[$forum->tid])) {
Dries's avatar
 
Dries committed
478 479 480 481 482 483 484 485 486 487
      $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
488
    // used to join node_comment_statistics to users.
489
    $sql = "SELECT ncs.last_comment_timestamp, IF (ncs.last_comment_uid != 0, u2.name, ncs.last_comment_name) AS last_comment_name, ncs.last_comment_uid FROM {node} n INNER JOIN {users} u1 ON n.uid = u1.uid INNER JOIN {term_node} tn ON n.nid = tn.nid INNER JOIN {node_comment_statistics} ncs ON n.nid = ncs.nid INNER JOIN {users} u2 ON ncs.last_comment_uid=u2.uid WHERE n.status = 1 AND tn.tid = %d ORDER BY ncs.last_comment_timestamp DESC";
490
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
491
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
492

493
    $last_post = new stdClass();
494 495 496 497 498
    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
499
    $forum->last_post = $last_post;
Dries's avatar
 
Dries committed
500

Dries's avatar
 
Dries committed
501 502 503 504
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
505 506
}

507 508 509 510 511
/**
 * Calculate the number of nodes the user has not yet read and are newer
 * than NODE_NEW_LIMIT.
 */
function _forum_topics_unread($term, $uid) {
512
  $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.created > %d AND h.nid IS NULL";
513
  $sql = db_rewrite_sql($sql);
514
  return db_result(db_query($sql, $term, $uid, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
515 516
}

Dries's avatar
Dries committed
517
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
518
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
519

Dries's avatar
 
Dries committed
520
  $forum_topic_list_header = array(
521
    array('data' => '&nbsp;', 'field' => NULL),
Dries's avatar
 
Dries committed
522
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
523
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
524
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
525
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
526
  );
Dries's avatar
 
Dries committed
527

Dries's avatar
 
Dries committed
528
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
529
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
530 531
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
532 533 534 535
    }
  }

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

537
  $sql = db_rewrite_sql("SELECT n.nid, r.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, {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 = r.vid");
Dries's avatar
 
Dries committed
538
  $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
539
  $sql .= ', n.created DESC';  // Always add a secondary sort order so that the news forum topics are on top.
Dries's avatar
Dries committed
540

541
  $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");
Dries's avatar
 
Dries committed
542

Steven Wittens's avatar
Steven Wittens committed
543
  $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
544
  $topics = array();
Dries's avatar
 
Dries committed
545
  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
546 547
    if ($user->uid) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
 
Dries committed
548
      if ($topic->tid != $tid) {
Dries's avatar
Dries committed
549
        $topic->new = 0;
Dries's avatar
 
Dries committed
550 551
      }
      else {
Dries's avatar
 
Dries committed
552
        $history = _forum_user_last_visit($topic->nid);
Dries's avatar
 
Dries committed
553
        $topic->new_replies = comment_num_new($topic->nid, $history);
554
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
555
      }
556 557
    }
    else {
558
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
559 560
      $topic->new_replies = 0;
      $topic->new = 0;
561
    }
Dries's avatar
 
Dries committed
562

Dries's avatar
 
Dries committed
563
    if ($topic->num_comments > 0) {
564
      $last_reply = new stdClass();
Dries's avatar
 
Dries committed
565 566 567 568 569
      $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
570 571 572
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
573
  return $topics;
Dries's avatar
 
Dries committed
574 575
}

Dries's avatar
 
Dries committed
576 577 578
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
579
function _forum_new($tid) {
Dries's avatar
 
Dries committed
580 581
  global $user;

582
  $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";
583
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
584
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
585 586 587 588

  return $nid ? $nid : 0;
}

Dries's avatar
 
Dries committed
589
/**
590
 * Process variables for forums.tpl.php
591 592 593 594 595 596 597 598
 *
 * The $variables array contains the following arguments:
 * - $forums
 * - $topics
 * - $parents
 * - $tid
 * - $sortby
 * - $forum_per_page
Dries's avatar
 
Dries committed
599
 *
600
 * @see forums.tpl.php
Dries's avatar
 
Dries committed
601
 */
602
function template_preprocess_forums(&$variables) {
Dries's avatar
 
Dries committed
603
  global $user;
Dries's avatar
 
Dries committed
604
  // forum list, topics list, topic browser and 'add new topic' link
Dries's avatar
 
Dries committed
605

606 607
  $vid = variable_get('forum_nav_vocabulary', '');
  $vocabulary = taxonomy_vocabulary_load($vid);
608
  $title = !empty($vocabulary->name) ? $vocabulary->name : '';
Dries's avatar
 
Dries committed
609

Dries's avatar
 
Dries committed
610 611
  // Breadcrumb navigation:
  $breadcrumb = array();
612
  if ($variables['tid']) {
Dries's avatar
 
Dries committed
613
    $breadcrumb[] = array('path' => 'forum', 'title' => $title);
Dries's avatar
 
Dries committed
614
  }
Dries's avatar
 
Dries committed
615

616 617 618 619
  if ($variables['parents']) {
    $variables['parents'] = array_reverse($variables['parents']);
    foreach ($variables['parents'] as $p) {
      if ($p->tid == $variables['tid']) {
620
        $title = $p->name;
Dries's avatar
 
Dries committed
621 622
      }
      else {
Dries's avatar
 
Dries committed
623
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
624 625 626
      }
    }
  }
627

Dries's avatar
Dries committed
628
  drupal_set_title(check_plain($title));
629

Dries's avatar
 
Dries committed
630 631
  $breadcrumb[] = array('path' => $_GET['q']);
  menu_set_location($breadcrumb);
Dries's avatar
 
Dries committed
632

633 634
  $variables['forums_defined'] = count($variables['forums']) || count($variables['parents']);
  if ($variables['forums_defined']) {
635 636 637 638 639 640 641 642 643
    // 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.
644
        $forum_types[$type] = array('title' => t('Post new @node_type', array('@node_type' => node_get_types('name', $type))), 'href' => "node/add/$type/$variables[tid]");
645
      }
Dries's avatar
 
Dries committed
646
    }
647

648
    if (empty($forum_types)) {
649 650
      // The user is logged-in; but denied access to create any new forum content type.
      if ($user->uid) {
651
        $forum_types['disallowed'] = array('title' => t('You are not allowed to post new content in forum.'));
652 653 654
      }
      // The user is not logged-in; and denied access to create any new forum content type.
      else {
655
        $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);
656
      }
Dries's avatar
 
Dries committed
657
    }
658
    $variables['links'] = $forum_types;
Dries's avatar
 
Dries committed
659

660 661 662 663 664 665
    if (!empty($variables['forums'])) {
      $variables['forums'] = theme('forum_list', $variables['forums'], $variables['parents'], $variables['tid']);
    }
    else {
      $variables['forums'] = '';
    }
Dries's avatar
 
Dries committed
666

667 668 669
    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']);
      drupal_add_feed(url('taxonomy/term/'. $variables['tid'] .'/0/feed'), 'RSS - '. $title);
Dries's avatar
 
Dries committed
670
    }
671 672 673 674 675 676 677
    else {
      $variables['topics'] = '';
    }

    // Provide separate template suggestions based on what's being output. Topic id is also accounted for.
    // Check both variables to be safe.
    if ($variables['forums'] && !$variables['topics']) {
678 679
      $variables['template_files'][] = 'forums-containers';
      $variables['template_files'][] = 'forums-containers-'. $variables['tid'];
680 681
    }
    else {
682 683
      $variables['template_files'][] = 'forums-topics';
      $variables['template_files'][] = 'forums-topics-'. $variables['tid'];
684 685
    }

Dries's avatar
 
Dries committed
686 687
  }
  else {
688
    drupal_set_title(t('No forums defined'));
Dries's avatar
 
Dries committed
689 690 691
  }
}

Dries's avatar
 
Dries committed
692
/**
693
 * Process variables to format a forum listing.
Dries's avatar
 
Dries committed
694
 *
695 696 697 698 699 700 701
 * $variables contains the following information:
 * - $forums
 * - $parents
 * - $tid
 *
 * @see forum-list.tpl.php
 * @see theme_forum_list()
Dries's avatar
 
Dries committed
702
 */
703
function template_preprocess_forum_list(&$variables) {
Dries's avatar
 
Dries committed
704
  global $user;
705 706 707 708 709 710 711 712 713 714 715
  // 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);
    if ($user->uid) {
      $variables['forums'][$id]->new_topics = _forum_topics_unread($forum->tid, $user->uid);
      if ($variables['forums'][$id]->new_topics) {
        $variables['forums'][$id]->new_text = format_plural($variables['forums'][$id]->new_topics, '1 new', '@count new');
        $variables['forums'][$id]->new_url = url("forum/$forum->tid", array('fragment' => 'new'));
Dries's avatar
 
Dries committed
716
      }
717
      $variables['forums'][$id]->old_topics = $forum->num_topics - $variables['forums'][$id]->new_topics;
Dries's avatar
 
Dries committed
718
    }
719 720 721 722
    else {
      $variables['forums'][$id]->new_topics = 0;
      $variables['forums'][$id]->old_topics = $forum->num_topics;
    }
723
    $variables['forums'][$id]->last_reply = theme('forum_submitted', $forum->last_post);
Dries's avatar
 
Dries committed
724 725 726
  }
}

Dries's avatar
 
Dries committed
727
/**
728 729 730 731 732 733 734
 * Preprocess variables to format the topic listing.
 *
 * $variables contains the following data:
 * - $tid
 * - $topics
 * - $sortby
 * - $forum_per_page
Dries's avatar
 
Dries committed
735
 *
736 737
 * @see forum-topic-list.tpl.php
 * @see theme_forum_topic_list()
Dries's avatar
 
Dries committed
738
 */
739
function template_preprocess_forum_topic_list(&$variables) {
Dries's avatar
 
Dries committed
740
  global $forum_topic_list_header;
Dries's avatar
 
Dries committed
741

742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
  // Create the tablesorting header.
  $ts = tablesort_init($forum_topic_list_header);
  $header = '';
  foreach ($forum_topic_list_header as $cell) {
    $cell = tablesort_header($cell, $forum_topic_list_header, $ts);
    $header .= _theme_table_cell($cell, TRUE);
  }
  $variables['header'] = $header;

  $rows = array();
  if (!empty($variables['topics'])) {
    foreach ($variables['topics'] as $id => $topic) {
      $variables['topics'][$id]->icon = theme('forum_icon', $topic->new, $topic->num_comments, $topic->comment_mode, $topic->sticky);

      if ($topic->tid != $variables['tid']) {
        $variables['topics'][$id]->moved = TRUE;
        $variables['topics'][$id]->title = check_plain($topic->title);
        $variables['topics'][$id]->description = l(t('This topic has been moved'), "forum/$topic->tid");
Dries's avatar
 
Dries committed
760 761
      }
      else {
762 763 764 765 766 767
        $variables['topics'][$id]->moved = FALSE;
        $variables['topics'][$id]->title = l($topic->title, "node/$topic->nid");
        if ($topic->new_replies) {
          $variables['topics'][$id]->new_text = format_plural($topic->new_replies, '1 new', '@count new');
          $variables['topics'][$id]->new_url = url("node/$topic->nid", array('fragment' => 'new'));
        }
768 769
        $variables['topics'][$id]->created = theme('forum_submitted', $topic);
        $variables['topics'][$id]->last_reply = theme('forum_submitted', $topic->last_reply);
Dries's avatar
 
Dries committed
770 771
      }
    }
Dries's avatar
 
Dries committed
772
  }
773 774 775 776
  else {
    // Make this safe for the template
    $variables['topics'] = array();
  }
Dries's avatar
 
Dries committed
777

778
  $variables['pager'] = theme('pager', NULL, $variables['forum_per_page'], 0);
Dries's avatar
 
Dries committed
779 780
}

781
/**
782
 * Process variables to format the icon for each individual topic.
783
 *
784 785 786 787 788 789 790 791
 * $variables contains the following data:
 * - $new_posts
 * - $num_posts = 0
 * - $comment_mode = 0
 * - $sticky = 0
 *
 * @see forum-icon.tpl.php
 * @see theme_forum_icon()
792
 */
793 794 795 796
function template_preprocess_forum_icon(&$variables) {
  $variables['hot_threshold'] = variable_get('forum_hot_topic', 15);
  if ($variables['num_posts'] > $variables['hot_threshold']) {
    $variables['icon'] = $variables['new_posts'] ? 'hot-new' : 'hot';
Dries's avatar
 
Dries committed
797 798
  }
  else {
799
    $variables['icon'] = $variables['new_posts'] ? 'new' : 'default';
Dries's avatar
 
Dries committed
800
  }
Dries's avatar
 
Dries committed
801

802 803
  if ($variables['comment_mode'] == COMMENT_NODE_READ_ONLY || $variables['comment_mode'] == COMMENT_NODE_DISABLED) {
    $variables['icon'] = 'closed';
804 805
  }

806 807
  if ($variables['sticky'] == 1) {
    $variables['icon'] = 'sticky';
808
  }
809 810 811
}

/**
812 813 814
 * Preprocess variables to format the next/previous forum topic navigation links.
 *
 * $variables contains $node.
815
 *
816 817
 * @see forum-topic-navigation.tpl.php
 * @see theme_forum_topic_navigation
818
 */
819
function template_preprocess_forum_topic_navigation(&$variables) {
820 821 822
  $output = '';

  // get previous and next topic
823
  $sql = "SELECT n.nid, n.title, n.sticky, l.comment_count, l.last_comment_timestamp FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.status = 1 ORDER BY n.sticky DESC, ". _forum_get_topic_order_sql(variable_get('forum_order', 1));
824 825 826
  $result = db_query(db_rewrite_sql($sql), isset($variables['node']->tid) ? $variables['node']->tid : 0);

  $stop = $variables['prev'] = $variables['next'] = 0;
827 828 829

  while ($topic = db_fetch_object($result)) {
    if ($stop == 1) {
830 831 832
      $variables['next'] = $topic->nid;
      $variables['next_title'] = check_plain($topic->title);
      $variables['next_url'] = url("node/$topic->nid");
833 834
      break;
    }
835
    if ($topic->nid == $variables['node']->nid) {
836 837 838
      $stop = 1;
    }
    else {
839 840 841
      $variables['prev'] = $topic->nid;
      $variables['prev_title'] = check_plain