forum.module 28.1 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 17
      <h3>Creating a forum</h3>
      <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 additonal 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("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\".", array('%created' => url('admin/taxonomy/add/vocabulary')));
Dries's avatar
 
Dries committed
26
    case 'node/add/forum':
27
      return variable_get('forum_help', '');
Dries's avatar
 
Dries committed
28
    case 'node/add#forum':
29
      return t('A forum is a threaded discussion, enabling users to communicate about a particular topic.');
Dries's avatar
 
Dries committed
30 31 32
  }
}

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

40 41 42
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
43
function forum_access($op, $node) {
Dries's avatar
 
Dries committed
44 45
  if ($op == 'create') {
    return user_access('create forum topics');
Dries's avatar
 
Dries committed
46
  }
Dries's avatar
 
Dries committed
47 48
}

49 50 51
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
52
function forum_perm() {
Dries's avatar
 
Dries committed
53
  return array('create forum topics');
Dries's avatar
 
Dries committed
54
}
Dries's avatar
 
Dries committed
55

56 57 58
/**
 * Implementation of hook_settings().
 */
59
function forum_settings() {
Dries's avatar
 
Dries committed
60

Dries's avatar
 
Dries committed
61 62 63
  if (module_exist('taxonomy')) {
    $vocs[0] = '<'. t('none') .'>';
    foreach (taxonomy_get_vocabularies('forum') as $vid => $voc) {
Dries's avatar
 
Dries committed
64 65 66
      $vocs[$vid] = $voc->name;
    }

Dries's avatar
 
Dries committed
67
    if ($voc) {
68
      $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."));
69
      $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') .'>');
70

Dries's avatar
 
Dries committed
71
      $output = form_group(t('Forum structure settings'), $group);
72

Dries's avatar
 
Dries committed
73
      $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.  Useful for helping or instructing your users.'));
74
      $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.'));
Dries's avatar
 
Dries committed
75
      $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 10000));
Dries's avatar
 
Dries committed
76
      $group .= form_select(t('Hot topic threshold'), 'forum_hot_topic', variable_get('forum_hot_topic', 15), $number, t('The number of posts a topic must have to be considered <strong>hot</strong>.'));
Dries's avatar
 
Dries committed
77
      $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
Dries's avatar
 
Dries committed
78 79 80
      $group .= form_select(t('Topics per page'), 'forum_per_page', variable_get('forum_per_page', 25), $number, t('The default number of topics displayed per page; links to browse older messages are automatically being displayed.'));
      $forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4=> t('Posts - least active first'));
      $group .= form_radios(t('Default order'), 'forum_order', variable_get('forum_order', '1'), $forder, t('The default display order for topics.'));
Dries's avatar
 
Dries committed
81
      $output .= form_group(t('Forum viewing options'), $group);
82

83
      $group = 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)), t('The number of topics to show in the "Forum topics" block.  To enable the block, go to the <a href="%block-administration">block administration</a> page.', array('%block-administration' => url('admin/block'))));
Dries's avatar
 
Dries committed
84
      $output .= form_group(t('"Forum topic" block settings'), $group);
Dries's avatar
 
Dries committed
85 86
    }
  }
Dries's avatar
 
Dries committed
87

Dries's avatar
 
Dries committed
88 89 90
  return $output;
}

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

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

  return $forum;
}

112 113 114 115 116 117
/**
 * Implementation of hook_block().
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
Dries's avatar
 
Dries committed
118
function forum_block($op = 'list', $delta = 0) {
Dries's avatar
 
Dries committed
119

Dries's avatar
 
Dries committed
120 121
  if ($op == 'list') {
    $blocks[0]['info'] = t('Forum topics');
122 123
  }
  else {
Dries's avatar
 
Dries committed
124
    if (user_access('access content')) {
Dries's avatar
 
Dries committed
125
      $content  = node_title_list(db_query_range("SELECT DISTINCT(n.nid), n.title, GREATEST(n.created, MAX(c.timestamp)) AS sort FROM {node} n ". node_access_join_sql() ." LEFT JOIN {comments} c ON n.nid = c.nid WHERE n.type = 'forum' AND n.status = 1 AND ". node_access_where_sql() ." GROUP BY n.nid, n.title, n.created ORDER BY sort DESC", 0, variable_get('forum_block_num', '5')), t('Active forum topics:'));
Dries's avatar
 
Dries committed
126

Dries's avatar
 
Dries committed
127
      $content .= node_title_list(db_query_range("SELECT DISTINCT(n.nid), n.title FROM {node} n ". 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
128

Dries's avatar
 
Dries committed
129
      if ($content) {
130
        $content .= '<div class="more-link">'. l(t('more'), 'forum', array('title' => t('Read the latest forum topics.'))) .'</div>';
Dries's avatar
 
Dries committed
131
      }
Dries's avatar
 
Dries committed
132

Dries's avatar
 
Dries committed
133 134
      $blocks['subject'] = t('Forum topics');
      $blocks['content'] = $content;
Dries's avatar
 
Dries committed
135 136
    }
  }
Dries's avatar
 
Dries committed
137

Dries's avatar
 
Dries committed
138 139 140
  return $blocks;
}

Dries's avatar
 
Dries committed
141 142 143
/**
 * Implementation of hook_link().
 */
144
function forum_link($type, $node = 0, $main = 0) {
Dries's avatar
Dries committed
145
  global $user;
Dries's avatar
 
Dries committed
146

Dries's avatar
 
Dries committed
147 148
  $links = array();

Dries's avatar
 
Dries committed
149 150
  if ($type == 'page' && user_access('access content')) {
    $links[] = l(t('forums'), 'forum');
Dries's avatar
 
Dries committed
151 152
  }

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

Dries's avatar
 
Dries committed
156
    $result = db_query('SELECT DISTINCT(n.nid), n.title, n.sticky, GREATEST(n.created, MAX(c.timestamp)) AS date_sort FROM {node} n '. node_access_join_sql() .' INNER JOIN {forum} f ON n.nid = f.nid LEFT JOIN {comments} c ON n.nid = c.nid WHERE n.nid = f.nid AND f.tid = %d AND n.status = 1 AND '. node_access_where_sql() .' GROUP BY n.nid, n.title, n.created ORDER BY n.sticky DESC, '. _forum_get_topic_order_sql(variable_get('forum_order', 1)), $node->tid);
Dries's avatar
 
Dries committed
157 158 159

    while ($topic = db_fetch_object($result)) {
      if ($stop == 1) {
160
        $next = new StdClass();
Dries's avatar
 
Dries committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174
        $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
175
      $links[] = l(t('previous forum topic'), "node/$prev->nid", array('title' => $prev->title));
Dries's avatar
 
Dries committed
176 177 178
    }

    if ($next) {
Dries's avatar
 
Dries committed
179
      $links[] = l(t('next forum topic'), "node/$next->nid", array('title' => $next->title));
Dries's avatar
 
Dries committed
180
    }
Dries's avatar
 
Dries committed
181 182
  }

Dries's avatar
 
Dries committed
183
  return $links;
Dries's avatar
 
Dries committed
184 185
}

Dries's avatar
 
Dries committed
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
/**
 * Implementation of hook_menu().
 */
function forum_menu() {
  $items = array();

  $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);

  return $items;
}

202 203 204
/**
 * Implementation of hook_content().
 */
Dries's avatar
 
Dries committed
205 206
function forum_content($node, $teaser = FALSE) {
  return node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
207 208
}

209 210 211
/**
 * Implementation of hook_view().
 */
Dries's avatar
 
Dries committed
212
function forum_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
 
Dries committed
213

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

Dries's avatar
 
Dries committed
229
  $node = forum_content($node, $teaser);
Dries's avatar
 
Dries committed
230 231
}

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

  if ($node->taxonomy) {
    // Extract the node's proper topic ID.
Dries's avatar
 
Dries committed
245
    $vocabulary = variable_get('forum_nav_vocabulary', '');
246
    $containers = variable_get('forum_containers', array());
Dries's avatar
 
Dries committed
247
    foreach ($node->taxonomy as $term) {
Dries's avatar
 
Dries committed
248
      if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
249 250
        if (in_array($term, $containers)) {
          $term = taxonomy_get_term($term);
Dries's avatar
 
Dries committed
251
          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>")));
252 253 254 255
        }
        else {
          $node->tid = $term;
        }
Dries's avatar
 
Dries committed
256
      }
257
    }
Dries's avatar
Dries committed
258 259 260
  }
}

261 262 263
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
264
function forum_form(&$node) {
Dries's avatar
 
Dries committed
265
  if (!$node->nid) {
Dries's avatar
Dries committed
266
    // new topic
Dries's avatar
 
Dries committed
267
    $node->taxonomy[] = arg(3);
268 269
  }

Dries's avatar
 
Dries committed
270
  $output = implode('', taxonomy_node_form('forum', $node));
Dries's avatar
Dries committed
271 272 273

  if ($node->nid) {
    // if editing, give option to leave shadows
Dries's avatar
 
Dries committed
274
    $output .= form_checkbox(t('Leave shadow copy'), 'shadow', 1, $node->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
275
  }
Dries's avatar
 
Dries committed
276

277
  $output .= form_textarea(t('Body'), 'body', $node->body, 60, 10, '');
Dries's avatar
 
Dries committed
278 279 280 281

  return $output;
}

282 283 284
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
285
function forum_insert($node) {
Dries's avatar
 
Dries committed
286
  db_query('INSERT INTO {forum} (nid, shadow, tid) VALUES (%d, %d, %d)', $node->nid, $node->shadow, $node->tid);
Dries's avatar
 
Dries committed
287 288
}

289 290 291
/**
 * Implementation of hook_update().
 */
Dries's avatar
 
Dries committed
292
function forum_update($node) {
Dries's avatar
 
Dries committed
293
  db_query('UPDATE {forum} SET shadow = %d, tid = %d WHERE nid = %d', $node->shadow, $node->tid, $node->nid);
Dries's avatar
 
Dries committed
294 295
}

296 297 298
/**
 * Implementation of hook_delete().
 */
Dries's avatar
 
Dries committed
299
function forum_delete(&$node) {
Dries's avatar
 
Dries committed
300
  db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
301
}
Dries's avatar
 
Dries committed
302

Dries's avatar
 
Dries committed
303
function _forum_num_comments($nid) {
Dries's avatar
 
Dries committed
304
  $value = db_fetch_object(db_query('SELECT COUNT(cid) AS count FROM {comments} WHERE nid = %d AND status = 0', $nid));
Dries's avatar
 
Dries committed
305 306 307
  return ($value) ? $value->count : 0;
}

Dries's avatar
 
Dries committed
308
function _forum_last_comment($nid) {
Dries's avatar
 
Dries committed
309 310
  $value = db_fetch_object(db_query_range('SELECT timestamp FROM {comments} WHERE nid = %d AND status = 0 ORDER BY timestamp DESC', $nid, 0, 1));
  return ($value) ? format_date($value->timestamp, 'small') : '&nbsp;';
Dries's avatar
 
Dries committed
311 312
}

Dries's avatar
 
Dries committed
313
function _forum_last_reply($nid) {
Dries's avatar
 
Dries committed
314
  $value = db_fetch_object(db_query_range('SELECT c.timestamp, c.name AS anonymous_name, u.name, u.uid FROM {comments} c INNER JOIN {users} u ON c.uid = u.uid WHERE c.nid = %d AND c.status = 0 ORDER BY c.timestamp DESC', $nid, 0, 1));
315 316 317 318 319 320
  if ($value) {
    $value->name = $value->uid ? $value->name : $value->anonymous_name;
  }
  else {
    $value = new StdClass();
  }
Dries's avatar
 
Dries committed
321 322 323 324
  return $value;
}

function _forum_format($topic) {
325
  if ($topic && $topic->timestamp) {
Dries's avatar
 
Dries committed
326
    return t('%time ago<br />by %author', array('%time' => format_interval(time() - $topic->timestamp), '%author' => format_name($topic)));
Dries's avatar
 
Dries committed
327 328 329 330 331 332 333 334 335 336 337
  }
  else {
    return message_na();
  }
}

function forum_get_forums($tid = 0) {
  if (!$tid) {
    $tid = 0;
  }

Dries's avatar
 
Dries committed
338
  $cache = cache_get("forum:$tid");
Dries's avatar
 
Dries committed
339

Dries's avatar
 
Dries committed
340
  if (empty($cache)) {
341
    $forums = array();
Dries's avatar
 
Dries committed
342
    $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
Dries's avatar
 
Dries committed
343
    foreach ($_forums as $forum) {
Dries's avatar
 
Dries committed
344
      if (in_array($forum->tid, variable_get('forum_containers', array()))) {
Dries's avatar
 
Dries committed
345 346
        $forum->container = 1;
      }
Dries's avatar
 
Dries committed
347 348 349
      $forum->num_topics = _forum_num_topics($forum->tid);
      $forum->num_posts = _forum_num_replies($forum->tid) + $forum->num_topics;
      $forum->last_post = _forum_last_post($forum->tid);
Dries's avatar
 
Dries committed
350 351 352
      $forums[$forum->tid] = $forum;
    }

Dries's avatar
 
Dries committed
353
    cache_set("forum:$tid", serialize($forums), 1);
Dries's avatar
 
Dries committed
354
  }
Dries's avatar
 
Dries committed
355 356 357
  else {
    $forums = unserialize($cache->data);
  }
Dries's avatar
 
Dries committed
358

Dries's avatar
 
Dries committed
359 360 361 362
  return $forums;
}

function _forum_num_topics($term) {
Dries's avatar
 
Dries committed
363
  return db_result(db_query('SELECT COUNT(DISTINCT(n.nid)) FROM {forum} f INNER JOIN {node} n ON n.nid = f.nid '. node_access_join_sql() .' WHERE f.tid = %d AND n.status = 1 AND '. node_access_where_sql() .' AND f.shadow = 0', $term));
Dries's avatar
 
Dries committed
364 365 366
}

function _forum_num_replies($term) {
Dries's avatar
 
Dries committed
367
  return db_result(db_query('SELECT COUNT(DISTINCT(n.nid)) AS count FROM {comments} c INNER JOIN {node} n ON n.nid = c.nid '. node_access_join_sql() .' INNER JOIN {forum} f ON n.nid = f.nid WHERE f.tid = %d AND n.nid = f.nid AND n.nid = c.nid AND n.status = 1 AND '. node_access_where_sql() ." AND c.status = 0 AND n.type = 'forum'", $term));
Dries's avatar
 
Dries committed
368 369
}

370 371 372 373
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.
Dries's avatar
 
Dries committed
374 375
  $ancient = db_result(db_query('SELECT COUNT(DISTINCT(n.nid)) FROM {forum} f INNER JOIN {node} n ON f.nid = n.nid '. node_access_join_sql() .' WHERE f.tid = %d AND n.status = 1 AND '. node_access_where_sql() .' AND n.created <= %d AND f.shadow = 0', $term, NODE_NEW_LIMIT));
  $recent = db_result(db_query('SELECT COUNT(DISTINCT(n.nid)) FROM {forum} f INNER JOIN {node} n ON f.nid = n.nid '. node_access_join_sql() .' INNER JOIN {history} h ON n.nid = h.nid WHERE n.status = 1 AND '. node_access_where_sql() .' AND f.tid = %d AND h.uid = %d AND n.created > %d AND f.shadow = 0', $term, $uid, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
376

377
  return $ancient + $recent;
Dries's avatar
 
Dries committed
378 379 380
}

function _forum_last_post($term) {
Dries's avatar
 
Dries committed
381 382
  $topic = db_fetch_object(db_query_range("SELECT DISTINCT(n.nid), n.created AS timestamp, u.name AS name, u.uid AS uid FROM {forum} f INNER JOIN {node} n ON n.nid = f.nid ". node_access_join_sql() ." INNER JOIN {users} u ON n.uid = u.uid WHERE f.tid = %d AND n.nid = f.nid AND n.type = 'forum' AND n.status = 1 AND ". node_access_where_sql() ." ORDER BY timestamp DESC", $term, 0, 1));
  $reply = db_fetch_object(db_query_range("SELECT DISTINCT(n.nid), c.timestamp, c.name AS anonymous_name, u.name AS name, u.uid AS uid FROM {forum} f INNER JOIN {node} n ON n.nid = f.nid ". node_access_join_sql() ." INNER JOIN {comments} c ON n.nid = c.nid INNER JOIN {users} u ON c.uid = u.uid WHERE f.tid = %d AND n.nid = f.nid AND n.type = 'forum' AND n.status = 1 AND ". node_access_where_sql() ." AND c.status = 0 ORDER BY c.timestamp DESC", $term, 0, 1));
383 384 385 386 387 388
  if ($reply) {
    $reply->name = $reply->uid ? $reply->name : $reply->anonymous_name;
  }
  else {
    $reply = new StdClass();
  }
Dries's avatar
 
Dries committed
389 390 391 392 393 394

  $value = ($topic->timestamp > $reply->timestamp) ? $topic : $reply;

  return $value;
}

Dries's avatar
Dries committed
395
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
396
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
397

Dries's avatar
 
Dries committed
398
  $forum_topic_list_header = array(
Dries's avatar
 
Dries committed
399 400 401 402
    array('data' => '&nbsp;'),
    array('data' => t('Topic'), 'field' => 'n.title'),
    array('data' => t('Replies'), 'field' => 'num_comments'),
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
403
    array('data' => t('Last reply'), 'field' => 'date_sort'),
Dries's avatar
 
Dries committed
404
  );
Dries's avatar
 
Dries committed
405

Dries's avatar
 
Dries committed
406
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
407
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
408 409
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
410 411 412 413
    }
  }

  $term = taxonomy_get_term($tid);
Dries's avatar
 
Dries committed
414
  $check_tid = $tid ? "'". check_query($tid) ."'" : 'NULL';
Dries's avatar
 
Dries committed
415

Dries's avatar
Dries committed
416
  // show topics with the correct tid, or in the forum but with shadow = 1
Dries's avatar
 
Dries committed
417 418
  // @TODO: this is not ANSI SQL! ("user error: 'n.created' isn't in GROUP BY")
  // @TODO: timestamp is a sql reserved word. are there more?
Dries's avatar
 
Dries committed
419
  $sql = "SELECT DISTINCT(n.nid), n.title, n.sticky, u.name AS name, u.uid AS uid, n.created AS timestamp, GREATEST(n.created, MAX(c.timestamp)) AS date_sort, COUNT(c.nid) AS num_comments, n.comment AS comment_mode, f.tid FROM {node} n ". node_access_join_sql() ." INNER JOIN {term_node} r ON n.nid = r.nid INNER JOIN {users} u ON n.uid = u.uid LEFT JOIN {comments} c ON n.nid = c.nid INNER JOIN {forum} f ON n.nid = f.nid WHERE ((r.tid = $check_tid AND f.shadow = 1) OR f.tid = $check_tid) AND n.status = 1 AND ". node_access_where_sql() ." AND n.type = 'forum' GROUP BY n.nid, n.title, u.name, u.uid, n.created, n.comment, f.tid";
Dries's avatar
 
Dries committed
420
  $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
Dries's avatar
Dries committed
421

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

Dries's avatar
Dries committed
424
  $result = pager_query($sql, $forum_per_page, 0, $sql_count);
Dries's avatar
 
Dries committed
425 426

  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
427 428 429 430
    if ($user->uid) {
      // folder is new if topic is new or there are new comments since last visit
      if ($topic->shadow > 0) {
        $topic->new = 0;
Dries's avatar
 
Dries committed
431 432
      }
      else {
Dries's avatar
 
Dries committed
433
        $history = _forum_user_last_visit($topic->nid);
Dries's avatar
 
Dries committed
434
        $topic->new_replies = db_result(db_query('SELECT COUNT(DISTINCT(c.nid)) FROM {node} n '. node_access_join_sql() .' INNER JOIN {comments} c ON n.nid = c.nid WHERE n.nid = %d AND n.status = 1 AND '. node_access_where_sql() .' AND c.status = 0 AND c.timestamp > %d', $topic->nid, $history));
435
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
436
      }
437 438
    }
    else {
439
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
440 441
      $topic->new_replies = 0;
      $topic->new = 0;
442
    }
Dries's avatar
 
Dries committed
443 444 445 446 447

    $topic->last_reply = _forum_last_reply($topic->nid);
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
448
  return $topics;
Dries's avatar
 
Dries committed
449 450
}

Dries's avatar
Dries committed
451
function _forum_new($tid) {
Dries's avatar
 
Dries committed
452
  global $user;
Dries's avatar
 
Dries committed
453
  $result = db_query("SELECT DISTINCT(n.nid) FROM {node} n, {history} h, {forum} f ". node_access_join_sql() ." WHERE n.type = 'forum' AND n.status = 1 AND ". node_access_where_sql() ." AND h.nid = n.nid AND f.nid = h.nid AND f.tid = %d AND h.uid = %d", $tid, $user->uid);
Dries's avatar
 
Dries committed
454 455 456 457
  while ($r = db_fetch_object($result)) {
    $read[] = $r->nid;
  }

Dries's avatar
 
Dries committed
458
  $nid = db_result(db_query_range("SELECT DISTINCT(n.nid) FROM {node} n ". node_access_join_sql() ." INNER JOIN {forum} f ON n.nid = f.nid WHERE n.type = 'forum' AND f.nid = n.nid AND n.status = 1 AND ". node_access_where_sql() ." AND f.tid = %d AND n.created > %d ". ($read ? 'AND NOT (n.nid IN ('. implode(',', $read) .')) ' : '') .'ORDER BY created', $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
459 460 461 462

  return $nid ? $nid : 0;
}

463
/**
Dries's avatar
Dries committed
464
 * Menu callback; prints a forum listing.
465 466
 */
function forum_page($tid = 0, $display = 'all') {
Dries's avatar
 
Dries committed
467
  global $user;
Dries's avatar
 
Dries committed
468

Dries's avatar
 
Dries committed
469
  if (module_exist('taxonomy')) {
470
    if ($display == 'new') {
Dries's avatar
 
Dries committed
471
      if ($nid = _forum_new($tid)) {
Dries's avatar
 
Dries committed
472
        drupal_goto("node/$nid");
Dries's avatar
 
Dries committed
473
      }
Dries's avatar
 
Dries committed
474
    }
Dries's avatar
 
Dries committed
475
    else {
Dries's avatar
 
Dries committed
476 477
      $forum_per_page = variable_get('forum_per_page', 25);
      $sortby = variable_get('forum_order', 1);
Dries's avatar
 
Dries committed
478

Dries's avatar
 
Dries committed
479 480 481 482 483
      $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
484

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    foreach ($forums as $forum) {
Dries's avatar
 
Dries committed
576
      if ($forum->container) {
577 578
        $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
579 580 581 582 583 584

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

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

596 597
        $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
598

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

Dries's avatar
 
Dries committed
604
        $rows[] = array(
Dries's avatar
 
Dries committed
605
          array('data' => $description, 'class' => 'forum'),
606
          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
607 608
          array('data' => $forum->num_posts, 'class' => 'posts'),
          array('data' => _forum_format($forum->last_post), 'class' => 'last-reply'));
Dries's avatar
 
Dries committed
609
      }
Dries's avatar
 
Dries committed
610 611 612
    }
  }

Dries's avatar
 
Dries committed
613
  return theme('table', $header, $rows);
Dries's avatar
 
Dries committed
614 615
}

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

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

Dries's avatar
 
Dries committed
626 627
    foreach ($topics as $topic) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
Dries committed
628
      if ($topic->tid != $tid) {
Dries's avatar
 
Dries committed
629
        $rows[] = array(
Dries's avatar
 
Dries committed
630
          array('data' => _forum_icon($topic->new, $topic->num_comments, $topic->comment_mode, $topic->sticky), 'class' => 'icon'),
Dries's avatar
 
Dries committed
631 632
          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
633
        );
Dries's avatar
 
Dries committed
634 635
      }
      else {
Dries's avatar
 
Dries committed
636
        $rows[] = array(
Dries's avatar
 
Dries committed
637
          array('data' => _forum_icon($topic->new, $topic->num_comments, $topic->comment_mode, $topic->sticky), 'class' => 'icon'),
Dries's avatar
 
Dries committed
638 639
          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
640 641
          array('data' => _forum_format($topic), 'class' => 'created'),
          array('data' => _forum_format($topic->last_reply), 'class' => 'last-reply')
Dries's avatar
 
Dries committed
642
        );
Dries's avatar
 
Dries committed
643 644 645
      }
    }

Dries's avatar
 
Dries committed
646 647
    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
648 649
    }
  }
Dries's avatar
 
Dries committed
650

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

Dries's avatar
 
Dries committed
653 654 655
  return $output;
}

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

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

    if ($comment_mode == 1) {
Dries's avatar
 
Dries committed
668
      $icon = 'closed';
Dries's avatar
 
Dries committed
669 670
    }

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

Dries's avatar
 
Dries committed
675
    // default
Dries's avatar
 
Dries committed
676
    $file = "misc/forum-$icon.png";
Dries's avatar
 
Dries committed
677

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

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

  return $output;
Dries's avatar
 
Dries committed
689 690 691 692
}

function _forum_user_last_visit($nid) {
  global $user;
693 694 695
  static $history = array();

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

function _forum_get_topic_order($sortby) {
  switch ($sortby) {
    case 1:
Dries's avatar
 
Dries committed
707
      return array('field' => 'date_sort', 'sort' => 'desc');
Dries's avatar
 
Dries committed
708 709
      break;
    case 2:
Dries's avatar
 
Dries committed
710
      return array('field' => 'date_sort', 'sort' => 'asc');
Dries's avatar
 
Dries committed
711 712
      break;
    case 3:
Dries's avatar
 
Dries committed
713
      return array('field' => 'num_comments', 'sort' => 'desc');
Dries's avatar
 
Dries committed
714 715
      break;
    case 4:
Dries's avatar
 
Dries committed
716
      return array('field' => 'num_comments', 'sort' => 'asc');
Dries's avatar
 
Dries committed
717 718 719 720
      break;
  }
}

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

Dries's avatar
 
Dries committed
726
?>