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

Dries's avatar
 
Dries committed
4 5 6 7 8
/**
 * @file
 * Enable threaded discussions about general topics.
 */

9 10 11 12
/**
 * Implementation of hook_help().
 */
function forum_help($section) {
Dries's avatar
 
Dries committed
13 14
  switch ($section) {
    case 'admin/help#forum':
15
      return t("
Dries's avatar
 
Dries committed
16
      <h3>Creating a forum</h3>
17
      <p>The forum module uses taxonomy to organize itself. To create a forum you first have to create a <a href=\"%taxonomy\">taxonomy vocabulary</a>. When doing this, choose a sensible name for it (such as \"fora\") and make sure under \"Types\" that \"forum\" is selected. Once you have done this, <a href=\"%taxo-terms\">add some terms</a> to it. Each term will become a forum. If you fill in the description field, users will be given additional information about the forum on the main forum page. For example: \"troubleshooting\" - \"Please ask your questions here.\"</p>
18
      <p>When you are happy with your vocabulary, go to <a href=\"%forums\">administer &raquo; settings &raquo; forum</a> and set <strong>Forum vocabulary</strong> to the one you have just created. There will now be fora active on the site. For users to access them they must have the \"access content\" <a href=\"%permission\">permission</a> and to create a topic they must have the \"create forum topics\" <a href=\"%permission\">permission</a>. These permissions can be set in the <a href=\"%permission\">permission</a> pages.</p>
Dries's avatar
 
Dries committed
19
      <h4>Icons</h4>
20
      <p>To disable icons, set the icon path as blank in <a href=\"%forums\">administer &raquo; settings &raquo; forum</a>.</p>
21
      <p>All files in the icon directory are assumed to be images. You may use images of whatever size you wish, but it is recommended to use 15x15 or 16x16.</p>", array("%taxonomy" => url('admin/taxonomy/add/vocabulary'), '%taxo-terms' => url('admin/taxonomy'), '%forums' => url('admin/settings/forum'), '%permission' => url('admin/user/configure/permission')));
Dries's avatar
 
Dries committed
22
    case 'admin/modules#description':
23
      return t('Enable threaded discussions about general topics.');
Dries's avatar
 
Dries committed
24
    case 'admin/settings/forum':
25
      return t("<p>Forums are threaded discussions based on the taxonomy system.  For the forums to work, the taxonomy module has to be installed and enabled.  When activated, a taxonomy vocabulary (eg. \"forums\") needs to be <a href=\"%created\">created</a> and bound to the node type \"forum topic\".</p>", array('%created' => url('admin/taxonomy/add/vocabulary')));
Dries's avatar
 
Dries committed
26
    case 'node/add#forum':
27
      return t('A forum is a threaded discussion, enabling users to communicate about a particular topic.');
Dries's avatar
 
Dries committed
28
  }
Dries's avatar
 
Dries committed
29 30 31 32 33

  // The 'add forum topic' form takes a variable argument:
  if (substr($section, 0, 14) == 'node/add/forum'){
    return variable_get('forum_help', '');
  }
Dries's avatar
 
Dries committed
34 35
}

36 37 38
/**
 * Implementation of hook_node_name().
 */
Dries's avatar
 
Dries committed
39
function forum_node_name($node) {
Dries's avatar
 
Dries committed
40
  return t('forum topic');
Dries's avatar
 
Dries committed
41 42
}

43 44 45
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
46
function forum_access($op, $node) {
Dries's avatar
 
Dries committed
47 48
  global $user;

Dries's avatar
 
Dries committed
49 50
  if ($op == 'create') {
    return user_access('create forum topics');
Dries's avatar
 
Dries committed
51
  }
Dries's avatar
 
Dries committed
52 53 54 55 56 57

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

60 61 62
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
63
function forum_perm() {
Dries's avatar
 
Dries committed
64
  return array('create forum topics', 'edit own forum topics');
Dries's avatar
 
Dries committed
65
}
Dries's avatar
 
Dries committed
66

67 68 69
/**
 * Implementation of hook_settings().
 */
70
function forum_settings() {
Dries's avatar
 
Dries committed
71

Dries's avatar
 
Dries committed
72 73 74
  if (module_exist('taxonomy')) {
    $vocs[0] = '<'. t('none') .'>';
    foreach (taxonomy_get_vocabularies('forum') as $vid => $voc) {
Dries's avatar
 
Dries committed
75 76 77
      $vocs[$vid] = $voc->name;
    }

Dries's avatar
 
Dries committed
78
    if ($voc) {
79
      $group  = form_select(t('Forum vocabulary'), 'forum_nav_vocabulary', variable_get('forum_nav_vocabulary', ''), $vocs, t("The taxonomy vocabulary that will be used as the navigation tree.  The vocabulary's terms define the forums."));
80
      $group .= _taxonomy_term_select(t('Containers'), 'forum_containers', variable_get('forum_containers', array()), variable_get('forum_nav_vocabulary', ''), t('You can choose forums which will not have topics, but will be just containers for other forums.  This lets you both group and nest forums.'), 1, '<'. t('none') .'>');
Dries's avatar
 
Dries committed
81
      $output = form_group(t('Forum structure settings'), $group);
82

83
      $group  = form_textarea(t('Explanation or submission guidelines'), 'forum_help', variable_get('forum_help', ''), 70, 5, t('This text will be displayed at the top of the forum submission form.  It is useful for helping or instructing your users.'));
84
      $group .= form_textfield(t('Forum icon path'), 'forum_icon_path', variable_get('forum_icon_path', ''), 30, 255, t('The path to the forum icons.  Leave blank to disable icons.  Don\'t add a trailing slash.  Default icons are available in the "misc" directory.'));
85 86 87
      $group .= form_select(t('Hot topic threshold'), 'forum_hot_topic', variable_get('forum_hot_topic', 15), drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 10000)), t('The number of posts a topic must have to be considered <strong>hot</strong>.'));
      $group .= form_select(t('Topics per page'), 'forum_per_page', variable_get('forum_per_page', 25), drupal_map_assoc(array(10, 25, 50, 75, 100)), t('The default number of topics displayed per page; links to browse older messages are automatically being displayed.'));
      $group .= form_radios(t('Default order'), 'forum_order', variable_get('forum_order', '1'), array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4=> t('Posts - least active first')), t('The default display order for topics.'));
Dries's avatar
 
Dries committed
88
      $output .= form_group(t('Forum viewing options'), $group);
Dries's avatar
 
Dries committed
89 90
    }
  }
Dries's avatar
 
Dries committed
91

Dries's avatar
 
Dries committed
92 93 94
  return $output;
}

95 96 97
/**
 * Implementation of hook_taxonomy().
 */
Dries's avatar
Dries committed
98
function forum_taxonomy($op, $type, $object) {
Dries's avatar
 
Dries committed
99 100
  if ($type == 'vocabulary' && ($op == 'insert' || $op == 'update')) {
    if (variable_get('forum_nav_vocabulary', '') == '' && in_array('forum', $object['nodes'])) {
Dries's avatar
Dries committed
101
      // since none is already set, silently set this vocabulary as the navigation vocabulary
Dries's avatar
 
Dries committed
102
      variable_set('forum_nav_vocabulary', $object['vid']);
Dries's avatar
Dries committed
103 104 105 106
    }
  }
}

107 108 109
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
110
function forum_load($node) {
Dries's avatar
 
Dries committed
111
  $forum = db_fetch_object(db_query('SELECT * FROM {forum} WHERE nid = %d', $node->nid));
Dries's avatar
 
Dries committed
112 113 114 115

  return $forum;
}

116 117 118 119 120 121
/**
 * Implementation of hook_block().
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
122 123 124 125 126
function forum_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
      $blocks[0]['info'] = t('Forum topics');
      return $blocks;
Dries's avatar
 
Dries committed
127

128 129 130
    case 'configure':
      $output = form_select(t('Number of topics in block'), 'forum_block_num', variable_get('forum_block_num', '5'), drupal_map_assoc(array(2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20)));
      return $output;
Dries's avatar
 
Dries committed
131

132 133 134
    case 'save':
      variable_set('forum_block_num', $edit['forum_block_num']);
      break;
Dries's avatar
 
Dries committed
135

136 137
    case 'view':
      if (user_access('access content')) {
138
        $content  = node_title_list(db_query_range("SELECT DISTINCT(n.nid), n.title, l.last_comment_timestamp, l.comment_count FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid ". node_access_join_sql() ." WHERE n.status = 1 AND n.type='forum' AND ". node_access_where_sql() ." ORDER BY l.last_comment_timestamp DESC", 0, variable_get('forum_block_num', '5')), t('Active forum topics:'));
Dries's avatar
 
Dries committed
139

140
        $content .= node_title_list(db_query_range("SELECT DISTINCT(n.nid), n.title, l.comment_count FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid ". node_access_join_sql() ." WHERE n.type = 'forum' AND n.status = 1 AND ". node_access_where_sql() ." ORDER BY n.nid DESC", 0, variable_get('forum_block_num', '5')), t('New forum topics:'));
Dries's avatar
 
Dries committed
141

142 143 144 145 146 147 148 149 150 151
        if ($content) {
          $content .= '<div class="more-link">'. l(t('more'), 'forum', array('title' => t('Read the latest forum topics.'))) .'</div>';
        }

        $block['subject'] = t('Forum topics');
        $block['content'] = $content;

        return $block;
      }
  }
Dries's avatar
 
Dries committed
152 153
}

Dries's avatar
 
Dries committed
154 155 156
/**
 * Implementation of hook_link().
 */
157
function forum_link($type, $node = 0, $main = 0) {
Dries's avatar
Dries committed
158
  global $user;
Dries's avatar
 
Dries committed
159

Dries's avatar
 
Dries committed
160 161
  $links = array();

Dries's avatar
 
Dries committed
162
  if (!$main && $type == 'node' && $node->type == 'forum') {
Dries's avatar
 
Dries committed
163 164
    // get previous and next topic

165
    $result = db_query("SELECT DISTINCT(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 " . node_access_join_sql() . " INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.status = 1 AND n.type='forum' AND " . node_access_where_sql() . ' ORDER BY n.sticky DESC, '. _forum_get_topic_order_sql(variable_get('forum_order', 1)), $node->tid);
Dries's avatar
 
Dries committed
166 167 168

    while ($topic = db_fetch_object($result)) {
      if ($stop == 1) {
169
        $next = new StdClass();
Dries's avatar
 
Dries committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183
        $next->nid = $topic->nid;
        $next->title = $topic->title;
        break;
      }
      if ($topic->nid == $node->nid) {
        $stop = 1;
      }
      else {
        $prev->nid = $topic->nid;
        $prev->title = $topic->title;
      }
    }

    if ($prev) {
Dries's avatar
 
Dries committed
184
      $links[] = l(t('previous forum topic'), "node/$prev->nid", array('title' => $prev->title));
Dries's avatar
 
Dries committed
185 186 187
    }

    if ($next) {
Dries's avatar
 
Dries committed
188
      $links[] = l(t('next forum topic'), "node/$next->nid", array('title' => $next->title));
Dries's avatar
 
Dries committed
189
    }
Dries's avatar
 
Dries committed
190 191
  }

Dries's avatar
 
Dries committed
192
  return $links;
Dries's avatar
 
Dries committed
193 194
}

Dries's avatar
 
Dries committed
195 196 197
/**
 * Implementation of hook_menu().
 */
Dries's avatar
 
Dries committed
198
function forum_menu($may_cache) {
Dries's avatar
 
Dries committed
199 200
  $items = array();

Dries's avatar
 
Dries committed
201 202 203 204 205 206 207 208
  if ($may_cache) {
    $items[] = array('path' => 'node/add/forum', 'title' => t('forum topic'),
      'access' => user_access('create forum topics'));
    $items[] = array('path' => 'forum', 'title' => t('forums'),
      'callback' => 'forum_page',
      'access' => user_access('access content'),
      'type' => MENU_CALLBACK);
  }
Dries's avatar
 
Dries committed
209 210 211 212

  return $items;
}

213 214 215
/**
 * Implementation of hook_view().
 */
Dries's avatar
 
Dries committed
216
function forum_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
 
Dries committed
217

Dries's avatar
 
Dries committed
218
  if ($page) {
Dries's avatar
 
Dries committed
219
    $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
Dries's avatar
 
Dries committed
220
    // Breadcrumb navigation
Dries's avatar
 
Dries committed
221 222
    $breadcrumb = array();
    $breadcrumb[] = array('path' => 'forum', 'title' => $vocabulary->name);
Dries's avatar
 
Dries committed
223
    if ($parents = taxonomy_get_parents_all($node->tid)) {
Dries's avatar
 
Dries committed
224 225
      $parents = array_reverse($parents);
      foreach ($parents as $p) {
Dries's avatar
 
Dries committed
226
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
227 228
      }
    }
Dries's avatar
 
Dries committed
229 230
    $breadcrumb[] = array('path' => 'node/'. $node->nid);
    menu_set_location($breadcrumb);
231
  }
Dries's avatar
 
Dries committed
232

233
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
234 235
}

236 237 238 239 240 241
/**
 * Implementation of hook_validate().
 *
 * Check in particular that only a "leaf" term in the associated taxonomy
 * vocabulary is selected, not a "container" term.
 */
242 243
function forum_validate(&$node) {
  // Make sure all fields are set properly:
Dries's avatar
 
Dries committed
244
  $node->icon = $node->icon ? $node->icon : '';
Dries's avatar
 
Dries committed
245 246 247

  if ($node->taxonomy) {
    // Extract the node's proper topic ID.
Dries's avatar
 
Dries committed
248
    $vocabulary = variable_get('forum_nav_vocabulary', '');
249
    $containers = variable_get('forum_containers', array());
Dries's avatar
 
Dries committed
250
    foreach ($node->taxonomy as $term) {
Dries's avatar
 
Dries committed
251
      if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
252 253
        if (in_array($term, $containers)) {
          $term = taxonomy_get_term($term);
Dries's avatar
 
Dries committed
254
          form_set_error('taxonomy', t('The item %forum is only a container for forums. Please select one of the forums below it.', array('%forum' => "<em>$term->name</em>")));
255 256 257 258
        }
        else {
          $node->tid = $term;
        }
Dries's avatar
 
Dries committed
259
      }
260
    }
Dries's avatar
 
Dries committed
261 262 263 264 265 266 267
    if ($node->tid && $node->shadow) {
      $terms = array_keys(taxonomy_node_get_terms($node->nid));
      if (!in_array($node->tid, $terms)) {
        $terms[] = $node->tid;
      }
      $node->taxonomy = $terms;
    }
Dries's avatar
Dries committed
268 269 270
  }
}

Dries's avatar
 
Dries committed
271 272 273 274 275 276 277
/**
 * Implementation of hook_update().
 */
function forum_update($node) {
  db_query('UPDATE {forum} SET tid = %d WHERE nid = %d', $node->tid, $node->nid);
}

278 279 280
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
281
function forum_form(&$node) {
Dries's avatar
 
Dries committed
282
  if (!$node->nid) {
Dries's avatar
Dries committed
283
    // new topic
Dries's avatar
 
Dries committed
284
    $node->taxonomy[] = arg(3);
285
  }
Dries's avatar
 
Dries committed
286 287 288
  else {
    $node->taxonomy = array($node->tid);
  }
289

Dries's avatar
 
Dries committed
290
  $output = implode('', taxonomy_node_form('forum', $node));
Dries's avatar
Dries committed
291 292 293

  if ($node->nid) {
    // if editing, give option to leave shadows
Dries's avatar
 
Dries committed
294 295
    $shadow = (count(taxonomy_node_get_terms($node->nid)) > 1);
    $output .= form_checkbox(t('Leave shadow copy'), 'shadow', 1, $shadow, t('If you move this topic, you can leave a link in the old forum to the new forum.'));
Dries's avatar
Dries committed
296
  }
Dries's avatar
 
Dries committed
297

298
  $output .= form_textarea(t('Body'), 'body', $node->body, 60, 20, '');
299
  $output .= filter_form('format', $node->format);
Dries's avatar
 
Dries committed
300 301 302 303

  return $output;
}

304 305 306
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
307
function forum_insert($node) {
Dries's avatar
 
Dries committed
308
  db_query('INSERT INTO {forum} (nid, tid) VALUES (%d, %d)', $node->nid, $node->tid);
Dries's avatar
 
Dries committed
309 310
}

311 312 313
/**
 * Implementation of hook_delete().
 */
Dries's avatar
 
Dries committed
314
function forum_delete(&$node) {
Dries's avatar
 
Dries committed
315
  db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
316
}
Dries's avatar
 
Dries committed
317

Dries's avatar
 
Dries committed
318 319 320
/**
 * Formats a topic for display
 *
321
 * @TODO Give a better description. Not sure where this function is used yet.
Dries's avatar
 
Dries committed
322
 */
Dries's avatar
 
Dries committed
323
function _forum_format($topic) {
324
  if ($topic && $topic->timestamp) {
Dries's avatar
 
Dries committed
325
    return t('%time ago<br />by %author', array('%time' => format_interval(time() - $topic->timestamp), '%author' => format_name($topic)));
Dries's avatar
 
Dries committed
326 327 328 329 330 331
  }
  else {
    return message_na();
  }
}

Dries's avatar
 
Dries committed
332 333 334
/**
 * Returns a list of all forums for a given taxonomy id
 *
335
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
336 337 338 339 340 341 342 343 344
 * -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
345 346 347 348 349
function forum_get_forums($tid = 0) {
  if (!$tid) {
    $tid = 0;
  }

Dries's avatar
 
Dries committed
350 351
  $forums = array();
  $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
Dries's avatar
 
Dries committed
352

Dries's avatar
 
Dries committed
353
  if (count($_forums)) {
Dries's avatar
 
Dries committed
354

Dries's avatar
 
Dries committed
355 356 357 358 359 360
    $counts = array();

    $_counts = db_query("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 " . node_access_join_sql() . " WHERE n.status = 1 AND n.type = 'forum' AND " . node_access_where_sql() . " GROUP BY r.tid", $forum->tid);
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
361
  }
Dries's avatar
 
Dries committed
362

Dries's avatar
 
Dries committed
363 364 365 366
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
367

Dries's avatar
 
Dries committed
368 369 370 371 372 373 374 375 376 377 378
    if ($counts[$forum->tid]) {
      $forum->num_topics = $counts[$forum->tid]->topic_count;
      $forum->num_posts = $counts[$forum->tid]->topic_count + $counts[$forum->tid]->comment_count;
    }
    else {
      $forum->num_topics = 0;
      $forum->num_posts = 0;
    }

    // This query does not use full ANSI syntax since MySQL 3.x does not support
    // table1 INNER JOIN table2 INNER JOIN table3 ON table2_criteria ON table3_criteria
Dries's avatar
 
Dries committed
379
    // used to join node_comment_statistics to users.
380
    $topic = db_fetch_object(db_query_range('SELECT DISTINCT(n.nid), l.last_comment_timestamp, IF(l.last_comment_uid, cu.name, l.last_comment_name) as last_comment_name, l.last_comment_uid FROM {node} n ' . node_access_join_sql() . ", {node_comment_statistics} l /*! USE INDEX (node_comment_timestamp) */, {users} cu, {term_node} r WHERE  n.nid = r.nid AND r.tid = %d AND n.status = 1 AND n.type = 'forum' AND l.last_comment_uid = cu.uid AND n.nid = l.nid AND " . node_access_where_sql() . ' ORDER BY l.last_comment_timestamp DESC', $forum->tid, 0, 1));
Dries's avatar
 
Dries committed
381 382 383 384
    $last_post->timestamp = $topic->last_comment_timestamp;
    $last_post->name = $topic->last_comment_name;
    $last_post->uid = $topic->last_comment_uid;
    $forum->last_post = $last_post;
Dries's avatar
 
Dries committed
385

Dries's avatar
 
Dries committed
386 387 388 389
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
390 391
}

392 393 394 395
function _forum_topics_read($term, $uid) {
  // Calculate the number of topics the user has read. Assume all entries older
  // than NODE_NEW_LIMIT are read, and include the recent posts that user has
  // read.
396 397
  $ancient = db_result(db_query("SELECT COUNT(n.nid) FROM {node} n INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d ". node_access_join_sql() ." WHERE n.created <= %d AND n.status = 1 AND n.type = 'forum' AND ". node_access_where_sql(), $term, NODE_NEW_LIMIT));
  $recent = db_result(db_query("SELECT COUNT(n.nid) FROM {node} n ". node_access_join_sql() ." INNER JOIN {history} h ON n.nid = h.nid AND h.uid = %d INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.status = 1 AND n.type = 'forum' AND n.created > %d AND ". node_access_where_sql(), $uid, $term, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
398

399
  return $ancient + $recent;
Dries's avatar
 
Dries committed
400 401
}

Dries's avatar
Dries committed
402
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
403
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
404

Dries's avatar
 
Dries committed
405
  $forum_topic_list_header = array(
Dries's avatar
 
Dries committed
406 407
    array('data' => '&nbsp;'),
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
408
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
409
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
410
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
411
  );
Dries's avatar
 
Dries committed
412

Dries's avatar
 
Dries committed
413
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
414
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
415 416
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
417 418 419 420
    }
  }

  $term = taxonomy_get_term($tid);
Dries's avatar
 
Dries committed
421
  $check_tid = $tid ? "'". db_escape_string($tid) ."'" : 'NULL';
Dries's avatar
 
Dries committed
422

423
  $sql = "SELECT DISTINCT(n.nid), f.tid, n.title, n.sticky, u.name, u.uid, n.created AS timestamp, n.comment AS comment_mode, l.last_comment_timestamp, IF(l.last_comment_uid, cu.name, l.last_comment_name) as last_comment_name, l.last_comment_uid, l.comment_count AS num_comments FROM {node} n ". node_access_join_sql() .", {node_comment_statistics} l, {users} cu, {term_node} r, {users} u, {forum} f WHERE n.status = 1 AND l.last_comment_uid = cu.uid AND n.nid = l.nid AND n.nid = r.nid AND r.tid = $check_tid AND n.uid = u.uid AND n.nid = f.nid AND ". node_access_where_sql();
Dries's avatar
 
Dries committed
424
  $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
Dries's avatar
Dries committed
425

426
  $sql_count = "SELECT COUNT(DISTINCT(n.nid)) FROM {node} n ". node_access_join_sql() ." INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = $check_tid WHERE n.status = 1 AND n.type = 'forum' AND ". node_access_where_sql();
Dries's avatar
 
Dries committed
427

Dries's avatar
Dries committed
428
  $result = pager_query($sql, $forum_per_page, 0, $sql_count);
Dries's avatar
 
Dries committed
429 430

  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
431 432
    if ($user->uid) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
 
Dries committed
433
      if ($topic->tid != $tid) {
Dries's avatar
Dries committed
434
        $topic->new = 0;
Dries's avatar
 
Dries committed
435 436
      }
      else {
Dries's avatar
 
Dries committed
437
        $history = _forum_user_last_visit($topic->nid);
Dries's avatar
 
Dries committed
438
        $topic->new_replies = comment_num_new($topic->nid, $history);
439
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
440
      }
441 442
    }
    else {
443
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
444 445
      $topic->new_replies = 0;
      $topic->new = 0;
446
    }
Dries's avatar
 
Dries committed
447

Dries's avatar
 
Dries committed
448 449 450 451 452 453
    if ($topic->num_comments > 0) {
      $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
454 455 456
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
457
  return $topics;
Dries's avatar
 
Dries committed
458 459
}

Dries's avatar
 
Dries committed
460 461 462
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
463
function _forum_new($tid) {
Dries's avatar
 
Dries committed
464 465
  global $user;

466
  $nid = db_result(db_query_range("SELECT DISTINCT(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 " . node_access_join_sql() . " WHERE n.status = 1 AND n.type = 'forum' AND h.nid IS NULL AND n.created > %d AND " . node_access_where_sql() . " ORDER BY created", $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
467 468 469 470

  return $nid ? $nid : 0;
}

471
/**
Dries's avatar
Dries committed
472
 * Menu callback; prints a forum listing.
473
 */
Dries's avatar
Dries committed
474
function forum_page($tid = 0) {
Dries's avatar
 
Dries committed
475
  global $user;
Dries's avatar
 
Dries committed
476

Dries's avatar
 
Dries committed
477
  if (module_exist('taxonomy')) {
Dries's avatar
Dries committed
478 479
    $forum_per_page = variable_get('forum_per_page', 25);
    $sortby = variable_get('forum_order', 1);
Dries's avatar
 
Dries committed
480

Dries's avatar
Dries committed
481 482 483 484
    $forums = forum_get_forums($tid);
    $parents = taxonomy_get_parents_all($tid);
    if ($tid && !in_array($tid, variable_get('forum_containers', array()))) {
      $topics = forum_get_topics($tid, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
485
    }
Dries's avatar
Dries committed
486 487

    print theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
488 489
  }
  else {
Dries's avatar
 
Dries committed
490
    print theme('page', forum_help('admin/settings/forum'), t('Warning'));
Dries's avatar
 
Dries committed
491 492 493
  }
}

Dries's avatar
 
Dries committed
494
/**
Dries's avatar
 
Dries committed
495 496
 * Format the forum body.
 *
Dries's avatar
 
Dries committed
497
 * @ingroup themeable
Dries's avatar
 
Dries committed
498
 */
Dries's avatar
 
Dries committed
499
function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
500
  global $user;
Dries's avatar
 
Dries committed
501
  // forum list, topics list, topic browser and 'add new topic' link
Dries's avatar
 
Dries committed
502

Dries's avatar
 
Dries committed
503 504
  $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
  $title = $vocabulary->name;
Dries's avatar
 
Dries committed
505

Dries's avatar
 
Dries committed
506 507
  // Breadcrumb navigation:
  $breadcrumb = array();
Dries's avatar
 
Dries committed
508
  if ($tid) {
Dries's avatar
 
Dries committed
509
    $breadcrumb[] = array('path' => 'forum', 'title' => $title);
Dries's avatar
 
Dries committed
510
  }
Dries's avatar
 
Dries committed
511 512

  if ($parents) {
Dries's avatar
 
Dries committed
513 514
    $parents = array_reverse($parents);
    foreach ($parents as $p) {
515 516
      if ($p->tid == $tid) {
        $title = $p->name;
Dries's avatar
 
Dries committed
517 518
      }
      else {
Dries's avatar
 
Dries committed
519
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
520 521 522
      }
    }
  }
Dries's avatar
 
Dries committed
523 524
  $breadcrumb[] = array('path' => $_GET['q']);
  menu_set_location($breadcrumb);
Dries's avatar
 
Dries committed
525

Dries's avatar
 
Dries committed
526
  if (count($forums) || count($parents)) {
527 528
    $output  = '<div id="forum">';
    $output .= '<ul>';
Dries's avatar
 
Dries committed
529 530 531

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

Dries's avatar
 
Dries committed
535
      $output .= ' <li>'. l(t('Active forum discussions.'), 'tracker') .'</li>';
Dries's avatar
 
Dries committed
536 537 538
    }

    if (user_access('create forum topics')) {
539
      $output .= '<li>'. l(t('Post new forum topic.'), "node/add/forum/$tid") .'</li>';
Dries's avatar
 
Dries committed
540 541
    }
    else if ($user->uid) {
542
      $output .= '<li>'. t('You are not allowed to post a new forum topic.') .'</li>';
Dries's avatar
 
Dries committed
543 544 545 546
    }
    else {
      $output .= '<li>'. t('<a href="%login">Login</a> to post a new forum topic.', array('%login' => url('user/login'))) .'</li>';
    }
547
    $output .= '</ul>';
Dries's avatar
 
Dries committed
548

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

Dries's avatar
 
Dries committed
551
    if ($tid && !in_array($tid, variable_get('forum_containers', array()))) {
Dries's avatar
 
Dries committed
552
      $output .= theme('forum_topic_list', $tid, $topics, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
553
    }
554
    $output .= '</div>';
Dries's avatar
 
Dries committed
555 556
  }
  else {
Dries's avatar
 
Dries committed
557
    $title = t('No forums defined');
Dries's avatar
 
Dries committed
558
    $output = '';
Dries's avatar
 
Dries committed
559 560
  }

Dries's avatar
 
Dries committed
561
  print theme('page', $output, $title);
Dries's avatar
 
Dries committed
562 563
}

Dries's avatar
 
Dries committed
564
/**
Dries's avatar
 
Dries committed
565 566
 * Format the forum listing.
 *
Dries's avatar
 
Dries committed
567
 * @ingroup themeable
Dries's avatar
 
Dries committed
568
 */
Dries's avatar
 
Dries committed
569
function theme_forum_list($forums, $parents, $tid) {
Dries's avatar
 
Dries committed
570 571
  global $user;

Dries's avatar
 
Dries committed
572 573
  if ($forums) {

Dries's avatar
 
Dries committed
574
    $header = array(t('Forum'), t('Topics'), t('Posts'), t('Last post'));
Dries's avatar
 
Dries committed
575 576

    foreach ($forums as $forum) {
Dries's avatar
 
Dries committed
577
      if ($forum->container) {
578 579
        $description  = '<div style="margin-left: '. ($forum->depth * 30) ."px;\">\n";
        $description .= ' <div class="name">'. l($forum->name, "forum/$forum->tid") ."</div>\n";
Dries's avatar
 
Dries committed
580 581 582 583 584 585

        if ($forum->description) {
          $description .= " <div class=\"description\">$forum->description</div>\n";
        }
        $description .= "</div>\n";

Dries's avatar
 
Dries committed
586
        $rows[] = array(array('data' => $description, 'class' => 'container', 'colspan' => '4'));
587
      }
Dries's avatar
 
Dries committed
588
      else {
589
        $forum->old_topics = _forum_topics_read($forum->tid, $user->uid);
Dries's avatar
 
Dries committed
590 591 592
        if ($user->uid) {
          $new_topics = $forum->num_topics - $forum->old_topics;
        }
Dries's avatar
 
Dries committed
593 594 595
        else {
          $new_topics = 0;
        }
Dries's avatar
 
Dries committed
596

597 598
        $description  = '<div style="margin-left: '. ($forum->depth * 30) ."px;\">\n";
        $description .= ' <div class="name">'. l($forum->name, "forum/$forum->tid") ."</div>\n";
Dries's avatar
 
Dries committed
599

Dries's avatar
 
Dries committed
600 601 602 603
        if ($forum->description) {
          $description .= " <div class=\"description\">$forum->description</div>\n";
        }
        $description .= "</div>\n";
Dries's avatar
 
Dries committed
604

Dries's avatar
 
Dries committed
605
        $rows[] = array(
Dries's avatar
 
Dries committed
606
          array('data' => $description, 'class' => 'forum'),
607
          array('data' => $forum->num_topics . ($new_topics ? '<br />'. l(t('%a new', array('%a' => $new_topics)), "forum/$forum->tid", NULL, NULL, 'new') : ''), 'class' => 'topics'),
Dries's avatar
 
Dries committed
608 609
          array('data' => $forum->num_posts, 'class' => 'posts'),
          array('data' => _forum_format($forum->last_post), 'class' => 'last-reply'));
Dries's avatar
 
Dries committed
610
      }
Dries's avatar
 
Dries committed
611
    }
Dries's avatar
 
Dries committed
612 613 614

    return theme('table', $header, $rows);

Dries's avatar
 
Dries committed
615 616 617 618
  }

}

Dries's avatar
 
Dries committed
619
/**
Dries's avatar
 
Dries committed
620 621
 * Format the topic listing.
 *
Dries's avatar
 
Dries committed
622
 * @ingroup themeable
Dries's avatar
 
Dries committed
623
 */
Dries's avatar
 
Dries committed
624 625
function theme_forum_topic_list($tid, $topics, $sortby, $forum_per_page) {
  global $forum_topic_list_header;
Dries's avatar
 
Dries committed
626 627

  if ($topics) {
Dries's avatar
 
Dries committed
628

Dries's avatar
 
Dries committed
629 630
    foreach ($topics as $topic) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
Dries committed
631
      if ($topic->tid != $tid) {
Dries's avatar
 
Dries committed
632
        $rows[] = array(
Dries's avatar
 
Dries committed
633
          array('data' => _forum_icon($topic->new, $topic->num_comments, $topic->comment_mode, $topic->sticky), 'class' => 'icon'),
Dries's avatar
 
Dries committed
634 635
          array('data' => $topic->title, 'class' => 'title'),
          array('data' => l(t('This topic has been moved'), "forum/$topic->tid"), 'colspan' => '3')
Dries's avatar
 
Dries committed
636
        );
Dries's avatar
 
Dries committed
637 638
      }
      else {
Dries's avatar
 
Dries committed
639
        $rows[] = array(
Dries's avatar
 
Dries committed
640
          array('data' => _forum_icon($topic->new, $topic->num_comments, $topic->comment_mode, $topic->sticky), 'class' => 'icon'),
Dries's avatar
 
Dries committed
641 642
          array('data' => l($topic->title, "node/$topic->nid"), 'class' => 'topic'),
          array('data' => $topic->num_comments . ($topic->new_replies ? '<br />'. l(t('%a new', array('%a' => $topic->new_replies)), "node/$topic->nid", NULL, NULL, 'new') : ''), 'class' => 'replies'),
Dries's avatar
 
Dries committed
643 644
          array('data' => _forum_format($topic), 'class' => 'created'),
          array('data' => _forum_format($topic->last_reply), 'class' => 'last-reply')
Dries's avatar
 
Dries committed
645
        );
Dries's avatar
 
Dries committed
646 647 648
      }
    }

Dries's avatar
 
Dries committed
649 650
    if ($pager = theme('pager', NULL, $forum_per_page, 0, tablesort_pager())) {
      $rows[] = array(array('data' => $pager, 'colspan' => '5', 'class' => 'pager'));
Dries's avatar
 
Dries committed
651 652
    }
  }
Dries's avatar
 
Dries committed
653

Dries's avatar
 
Dries committed
654
  $output .= theme('table', $forum_topic_list_header, $rows);
Dries's avatar
 
Dries committed
655

Dries's avatar
 
Dries committed
656 657 658
  return $output;
}

Dries's avatar
 
Dries committed
659
function _forum_icon($new_posts, $num_posts = 0, $comment_mode = 0, $sticky = 0) {
Dries's avatar
 
Dries committed
660

Dries's avatar
 
Dries committed
661
  $base_path = variable_get('forum_icon_path', '');
Dries's avatar
 
Dries committed
662
  if ($base_path) {
Dries's avatar
 
Dries committed
663 664
    if ($num_posts > variable_get('forum_hot_topic', 15)) {
      $icon = $new_posts ? 'hot-new' : 'hot';
Dries's avatar
 
Dries committed
665 666
    }
    else {
Dries's avatar
 
Dries committed
667
      $icon = $new_posts ? 'new' : 'default';
Dries's avatar
 
Dries committed
668 669 670
    }

    if ($comment_mode == 1) {
Dries's avatar
 
Dries committed
671
      $icon = 'closed';
Dries's avatar
 
Dries committed
672 673
    }

Dries's avatar
 
Dries committed
674 675 676 677
    if ($sticky == 1) {
      $icon = 'sticky';
    }

Dries's avatar
 
Dries committed
678
    // default
Dries's avatar
 
Dries committed
679
    $file = "misc/forum-$icon.png";
Dries's avatar
 
Dries committed
680

Dries's avatar
 
Dries committed
681
    $output = theme('image', $file);
Dries's avatar
 
Dries committed
682 683
  }
  else {
Dries's avatar
 
Dries committed
684
    $output = '&nbsp;';
Dries's avatar
 
Dries committed
685
  }
Dries's avatar
 
Dries committed
686 687 688 689 690 691

  if ($new_posts) {
    $output = "<a name=\"new\">$output</a>";
  }

  return $output;
Dries's avatar
 
Dries committed
692 693 694 695
}

function _forum_user_last_visit($nid) {
  global $user;
696 697 698
  static $history = array();

  if (empty($history)) {
Dries's avatar
 
Dries committed
699
    $result = db_query('SELECT nid, timestamp FROM {history} WHERE uid = %d', $user->uid);
Dries's avatar
 
Dries committed
700
    while ($t = db_fetch_object($result)) {
701
      $history[$t->nid] = $t->timestamp > NODE_NEW_LIMIT ? $t->timestamp : NODE_NEW_LIMIT;
Dries's avatar
 
Dries committed
702 703
    }
  }
704
  return $history[$nid] ? $history[$nid] : NODE_NEW_LIMIT;
Dries's avatar
 
Dries committed
705 706 707 708 709
}

function _forum_get_topic_order($sortby) {
  switch ($sortby) {
    case 1:
Dries's avatar
 
Dries committed
710
      return array('field' => 'l.last_comment_timestamp', 'sort' => 'desc');
Dries's avatar
 
Dries committed
711 712
      break;
    case 2:
Dries's avatar
 
Dries committed
713
      return array('field' => 'l.last_comment_timestamp', 'sort' => 'asc');
Dries's avatar
 
Dries committed
714 715
      break;
    case 3:
Dries's avatar
 
Dries committed
716
      return array('field' => 'l.comment_count', 'sort' => 'desc');
Dries's avatar
 
Dries committed
717 718
      break;
    case 4:
Dries's avatar
 
Dries committed
719
      return array('field' => 'l.comment_count', 'sort' => 'asc');
Dries's avatar
 
Dries committed
720 721 722 723
      break;
  }
}

Dries's avatar
 
Dries committed
724 725 726 727 728
function _forum_get_topic_order_sql($sortby) {
  $order = _forum_get_topic_order($sortby);
  return $order['field'] .' '. $order['sort'];
}

Dries's avatar
 
Dries committed
729
?>