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

4 5 6 7
/**
 * Implementation of hook_help().
 */
function forum_help($section) {
Dries's avatar
 
Dries committed
8 9
  switch ($section) {
    case 'admin/help#forum':
10
      return t("
Dries's avatar
 
Dries committed
11 12 13 14 15
      <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>
      <p>When you are happy with your vocabulary, go to <a href=\"%forums\">administer &raquo; configutation &raquo; modules &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>
      <h4>Icons</h4>
      <p>To disable icons, set the icon path as blank in <a href=\"%forums\">administer &raquo; configutation &raquo; modules &raquo; forum</a>.</p>
16
      <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/system/modules/forum'), '%permission' => url('admin/user/permission')));
Dries's avatar
 
Dries committed
17
    case 'admin/system/modules#description':
18
      return t('Enable threaded discussions about general topics.');
Dries's avatar
 
Dries committed
19
    case 'admin/system/modules/forum':
20
      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
21
    case 'node/add/forum':
22
      return variable_get('forum_help', '');
Dries's avatar
 
Dries committed
23
    case 'node/add#forum':
24
      return t('A forum is a threaded discussion, enabling users to communicate about a particular topic.');
Dries's avatar
 
Dries committed
25 26 27
  }
}

28 29 30
/**
 * Implementation of hook_node_name().
 */
Dries's avatar
 
Dries committed
31
function forum_node_name($node) {
Dries's avatar
 
Dries committed
32
  return t('forum topic');
Dries's avatar
 
Dries committed
33 34
}

35 36 37
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
38
function forum_access($op, $node) {
Dries's avatar
 
Dries committed
39
  if ($op == 'view') {
Dries's avatar
 
Dries committed
40 41
    return $node->status;
  }
Dries's avatar
 
Dries committed
42 43
  if ($op == 'create') {
    return user_access('create forum topics');
Dries's avatar
 
Dries committed
44
  }
Dries's avatar
 
Dries committed
45 46
}

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

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

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

Dries's avatar
 
Dries committed
65
    if ($voc) {
Dries's avatar
 
Dries committed
66
      $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 vacabulary's terms define the forums."));
67
      $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') .'>');
68

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

Dries's avatar
 
Dries committed
71
      $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.'));
72
      $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
73
      $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 10000));
Dries's avatar
 
Dries committed
74
      $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
75
      $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
Dries's avatar
 
Dries committed
76 77 78
      $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
79
      $output .= form_group(t('Forum viewing options'), $group);
80

81
      $group = form_textfield(t('Number of topics in block'), 'forum_block_num', variable_get('forum_block_num', '5'), 5, 5, 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/system/block'))));
Dries's avatar
 
Dries committed
82
      $output .= form_group(t('"Forum topic" block settings'), $group);
Dries's avatar
 
Dries committed
83 84
    }
  }
Dries's avatar
 
Dries committed
85

Dries's avatar
 
Dries committed
86 87 88
  return $output;
}

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

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

  return $forum;
}

110 111 112 113 114 115
/**
 * 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
116
function forum_block($op = 'list', $delta = 0) {
Dries's avatar
 
Dries committed
117 118
  global $user;

Dries's avatar
 
Dries committed
119 120
  if ($op == 'list') {
    $blocks[0]['info'] = t('Forum topics');
121 122
  }
  else {
Dries's avatar
 
Dries committed
123
    if (user_access('access content')) {
Dries's avatar
 
Dries committed
124
      $content  = node_title_list(db_query_range("SELECT n.nid, n.title, GREATEST(n.created, MAX(c.timestamp)) AS sort FROM {node} n LEFT JOIN {comments} c ON n.nid = c.nid WHERE n.type = 'forum' AND n.status = 1 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
125

Dries's avatar
 
Dries committed
126
      $content .= node_title_list(db_query_range("SELECT nid, title FROM {node} WHERE type = 'forum' AND status = 1 ORDER BY nid DESC", 0, variable_get('forum_block_num', '5')), t('New forum topics:'));
Dries's avatar
 
Dries committed
127

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

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

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

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

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

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

Dries's avatar
 
Dries committed
152
  if ($type == 'system') {
153
    menu('node/add/forum', t('forum topic'), user_access('create forum topics') ? MENU_FALLTHROUGH : MENU_DENIED);
Dries's avatar
 
Dries committed
154
    menu('forum', t('forums'), user_access('access content') ? 'forum_page' : MENU_DENIED, 0, MENU_HIDE);
Dries's avatar
 
Dries committed
155 156
  }

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

Dries's avatar
 
Dries committed
160
    $result = db_query('SELECT n.nid, n.title, GREATEST(n.created, MAX(c.timestamp)) AS date_sort, COUNT(c.nid) AS num_comments FROM {node} n INNER JOIN {forum} f ON n.nid = f.nid INNER JOIN {comments} c ON n.nid = c.nid WHERE n.nid = f.nid AND f.tid = %d AND n.status = 1 GROUP BY n.nid, n.title, n.created ORDER BY '. _forum_get_topic_order(isset($user->sortby) ? $user->sortby : variable_get('forum_order', 1)), $node->tid);
Dries's avatar
 
Dries committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177

    while ($topic = db_fetch_object($result)) {
      if ($stop == 1) {
        $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
178
      $links[] = l(t('previous forum topic'), "node/view/$prev->nid", array('title' => $prev->title));
Dries's avatar
 
Dries committed
179 180 181
    }

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

Dries's avatar
 
Dries committed
186
  return $links;
Dries's avatar
 
Dries committed
187 188
}

189 190 191
/**
 * Implementation of hook_content().
 */
Dries's avatar
 
Dries committed
192 193
function forum_content($node, $main = 0) {
  return node_prepare($node, $main);
Dries's avatar
 
Dries committed
194 195
}

196 197 198
/**
 * Implementation of hook_view().
 */
Dries's avatar
 
Dries committed
199
function forum_view($node, $main = 0, $page = 0) {
Dries's avatar
 
Dries committed
200

Dries's avatar
 
Dries committed
201
  if ($page) {
Dries's avatar
 
Dries committed
202
    $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
Dries's avatar
 
Dries committed
203
    // Breadcrumb navigation
Dries's avatar
 
Dries committed
204
    $breadcrumb = array(l(t('Home'), NULL), l($vocabulary->name, 'forum'));
Dries's avatar
 
Dries committed
205
    if ($parents = taxonomy_get_parents_all($node->tid)) {
Dries's avatar
 
Dries committed
206 207 208 209 210
      $parents = array_reverse($parents);
      foreach ($parents as $p) {
        $breadcrumb[] = l($p->name, "forum/$p->tid");
      }
    }
Dries's avatar
 
Dries committed
211
    drupal_set_breadcrumb($breadcrumb);
212
  }
Dries's avatar
 
Dries committed
213

Dries's avatar
 
Dries committed
214
  return theme('node', forum_content($node, $main), $main, $page);
Dries's avatar
 
Dries committed
215 216
}

217 218 219 220 221 222
/**
 * Implementation of hook_validate().
 *
 * Check in particular that only a "leaf" term in the associated taxonomy
 * vocabulary is selected, not a "container" term.
 */
223 224
function forum_validate(&$node) {
  // Make sure all fields are set properly:
Dries's avatar
 
Dries committed
225
  $node->icon = $node->icon ? $node->icon : '';
226
  $node->shadow = $node->shadow ? $node->shadow : 0;
Dries's avatar
 
Dries committed
227 228 229

  if ($node->taxonomy) {
    // Extract the node's proper topic ID.
Dries's avatar
 
Dries committed
230
    $vocabulary = variable_get('forum_nav_vocabulary', '');
231
    $containers = variable_get('forum_containers', array());
Dries's avatar
 
Dries committed
232
    foreach ($node->taxonomy as $term) {
Dries's avatar
 
Dries committed
233
      if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
234 235 236 237 238 239 240
        if (in_array($term, $containers)) {
          $term = taxonomy_get_term($term);
          $error['taxonomy'] = theme('error', t('The item \'%forum\' is only a container for forums. Please select one of the forums below it.', array('%forum' => $term->name)));
        }
        else {
          $node->tid = $term;
        }
Dries's avatar
 
Dries committed
241
      }
242
    }
Dries's avatar
Dries committed
243
  }
244
  return $error;
Dries's avatar
Dries committed
245 246
}

247 248 249
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
250
function forum_form(&$node, &$error) {
Dries's avatar
 
Dries committed
251
  if (!$node->nid) {
Dries's avatar
Dries committed
252
    // new topic
Dries's avatar
 
Dries committed
253
    $node->taxonomy[] = arg(3);
254 255
  }

256
  $output = implode('', taxonomy_node_form('forum', $node, $error));
Dries's avatar
Dries committed
257 258 259

  if ($node->nid) {
    // if editing, give option to leave shadows
Dries's avatar
 
Dries committed
260
    $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
261
  }
Dries's avatar
 
Dries committed
262

Dries's avatar
 
Dries committed
263
  $output .= form_textarea(t('Body'), 'body', $node->body, 60, 10, filter_tips_short());
Dries's avatar
 
Dries committed
264 265 266 267

  return $output;
}

268 269 270
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
271
function forum_insert($node) {
Dries's avatar
 
Dries committed
272
  db_query('INSERT INTO {forum} (nid, shadow, tid) VALUES (%d, %d, %d)', $node->nid, $node->shadow, $node->tid);
Dries's avatar
 
Dries committed
273 274
}

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

282 283 284
/**
 * Implementation of hook_delete().
 */
Dries's avatar
 
Dries committed
285
function forum_delete(&$node) {
Dries's avatar
 
Dries committed
286
  db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
287
}
Dries's avatar
 
Dries committed
288

Dries's avatar
 
Dries committed
289
function _forum_num_comments($nid) {
Dries's avatar
 
Dries committed
290
  $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
291 292 293
  return ($value) ? $value->count : 0;
}

Dries's avatar
 
Dries committed
294
function _forum_last_comment($nid) {
Dries's avatar
 
Dries committed
295 296
  $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
297 298
}

Dries's avatar
 
Dries committed
299
function _forum_last_reply($nid) {
Dries's avatar
 
Dries committed
300
  $value = db_fetch_object(db_query_range('SELECT c.timestamp, 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));
Dries's avatar
 
Dries committed
301 302 303 304 305
  return $value;
}

function _forum_format($topic) {
  if ($topic) {
Dries's avatar
 
Dries committed
306
    return t('%time ago<br />by %author', array('%time' => format_interval(time() - $topic->timestamp), '%author' => format_name($topic)));
Dries's avatar
 
Dries committed
307 308 309 310 311 312 313 314 315 316 317 318 319
  }
  else {
    return message_na();
  }
}

function forum_get_forums($tid = 0) {
  global $user;

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

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

Dries's avatar
 
Dries committed
322
  if (empty($cache)) {
323
    $forums = array();
Dries's avatar
 
Dries committed
324
    $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
Dries's avatar
 
Dries committed
325 326
    $n = 0;
    foreach ($_forums as $forum) {
Dries's avatar
 
Dries committed
327
      if (in_array($forum->tid, variable_get('forum_containers', array()))) {
Dries's avatar
 
Dries committed
328 329
        $forum->container = 1;
      }
Dries's avatar
 
Dries committed
330 331 332
      $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
333 334 335 336
      $forums[$forum->tid] = $forum;
      $n++;
    }

Dries's avatar
 
Dries committed
337
    cache_set("forum:$tid", serialize($forums), 1);
Dries's avatar
 
Dries committed
338
  }
Dries's avatar
 
Dries committed
339 340 341
  else {
    $forums = unserialize($cache->data);
  }
Dries's avatar
 
Dries committed
342

Dries's avatar
 
Dries committed
343 344 345 346
  return $forums;
}

function _forum_num_topics($term) {
Dries's avatar
 
Dries committed
347
  return db_result(db_query('SELECT COUNT(*) FROM {forum} f INNER JOIN {node} n ON n.nid = f.nid WHERE f.tid = %d AND n.status = 1 AND f.shadow = 0', $term));
Dries's avatar
 
Dries committed
348 349 350
}

function _forum_num_replies($term) {
351
  return db_result(db_query("SELECT COUNT(*) AS count FROM {comments} c INNER JOIN {node} n ON n.nid = c.nid 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 c.status = 0 AND n.type = 'forum'", $term));
Dries's avatar
 
Dries committed
352 353
}

354 355 356 357
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
358 359
  $ancient = db_result(db_query('SELECT COUNT(*) FROM {forum} f INNER JOIN {node} n ON f.nid = n.nid WHERE f.tid = %d AND n.status = 1 AND n.created <= %d AND f.shadow = 0', $term, NODE_NEW_LIMIT));
  $recent = db_result(db_query('SELECT COUNT(*) FROM {forum} f INNER JOIN {node} n ON f.nid = n.nid INNER JOIN {history} h ON n.nid = h.nid WHERE n.status = 1 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
360

361
  return $ancient + $recent;
Dries's avatar
 
Dries committed
362 363 364
}

function _forum_last_post($term) {
Dries's avatar
 
Dries committed
365
  $topic = db_fetch_object(db_query_range("SELECT 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 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 ORDER BY timestamp DESC", $term, 0, 1));
Dries's avatar
 
Dries committed
366

Dries's avatar
 
Dries committed
367
  $reply = db_fetch_object(db_query_range("SELECT n.nid, c.timestamp, u.name AS name, u.uid AS uid FROM {forum} f INNER JOIN {node} n ON n.nid = f.nid 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 c.status = 0 ORDER BY c.timestamp DESC", $term, 0, 1));
Dries's avatar
 
Dries committed
368 369 370 371 372 373

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

  return $value;
}

Dries's avatar
Dries committed
374
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
375
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
376

Dries's avatar
 
Dries committed
377
  $forum_topic_list_header = array(
Dries's avatar
 
Dries committed
378 379 380 381 382
    array('data' => '&nbsp;'),
    array('data' => t('Topic'), 'field' => 'n.title'),
    array('data' => t('Replies'), 'field' => 'num_comments'),
    array('data' => t('Created'), 'field' => 'n.created'),
    array('data' => t('Last reply'), 'field' => 'date_sort', 'sort' => 'desc'),
Dries's avatar
 
Dries committed
383
  );
Dries's avatar
 
Dries committed
384 385

  $sql_sortby = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
386
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
387 388
    if ($forum_topic_list_header[$i]['field'] == $sql_sortby) {
      $forum_topic_list_header[$i]['order'] = $sql_sortby;
Dries's avatar
 
Dries committed
389 390 391 392 393
    }
  }

  $term = taxonomy_get_term($tid);
  $voc = taxonomy_get_vocabulary($term->vid);
Dries's avatar
 
Dries committed
394
  $check_tid = $tid ? "'". check_query($tid) ."'" : 'NULL';
Dries's avatar
 
Dries committed
395

Dries's avatar
Dries committed
396
  // show topics with the correct tid, or in the forum but with shadow = 1
Dries's avatar
 
Dries committed
397 398
  // @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
399
  $sql = "SELECT n.nid, n.title, 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 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 n.nid = r.nid AND ((r.tid = $check_tid AND f.shadow = 1) OR f.tid = $check_tid) AND n.status = 1 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
400
  $sql .= tablesort_sql($forum_topic_list_header);
Dries's avatar
Dries committed
401

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

Dries's avatar
Dries committed
404
  $result = pager_query($sql, $forum_per_page, 0, $sql_count);
Dries's avatar
 
Dries committed
405 406 407 408
  $topic_num = db_num_rows($result);

  $n = 0;
  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
409 410 411 412 413
    if ($user->uid) {
      $history = _forum_user_last_visit($topic->nid);
      // 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
414 415
      }
      else {
Dries's avatar
 
Dries committed
416
        $topic->new_replies = db_result(db_query('SELECT COUNT(c.nid) FROM {node} n INNER JOIN {comments} c ON n.nid = c.nid WHERE n.nid = %d AND n.status = 1 AND c.status = 0 AND c.timestamp > %d', $topic->nid, $history));
417
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
418
      }
419 420
    }
    else {
421
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
422 423
      $topic->new_replies = 0;
      $topic->new = 0;
424
    }
Dries's avatar
 
Dries committed
425 426 427 428 429

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

Dries's avatar
Dries committed
430
  return $topics;
Dries's avatar
 
Dries committed
431 432
}

Dries's avatar
Dries committed
433
function _forum_new($tid) {
Dries's avatar
 
Dries committed
434
  global $user;
Dries's avatar
 
Dries committed
435
  $result = db_query("SELECT n.nid FROM {node} n, {history} h, {forum} f WHERE n.type = 'forum' AND n.status = 1 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
436 437 438 439
  while ($r = db_fetch_object($result)) {
    $read[] = $r->nid;
  }

440
  $nid = db_result(db_query_range("SELECT n.nid FROM {node} n INNER JOIN {forum} f ON n.nid = f.nid WHERE n.type = 'forum' AND f.nid = n.nid AND n.status = 1 AND f.tid = %d ". ($read ? 'AND NOT (n.nid IN ('. implode(',', $read) .')) ' : '') .'ORDER BY created', $tid, 0, 1));
Dries's avatar
 
Dries committed
441 442 443 444

  return $nid ? $nid : 0;
}

445
/**
Dries's avatar
Dries committed
446
 * Menu callback; prints a forum listing.
447 448
 */
function forum_page($tid = 0, $display = 'all') {
Dries's avatar
 
Dries committed
449
  global $sortby, $forum_per_page, $from, $user;
Dries's avatar
 
Dries committed
450

Dries's avatar
 
Dries committed
451
  $op = $_POST['op'];
Dries's avatar
 
Dries committed
452

Dries's avatar
 
Dries committed
453
  if (module_exist('taxonomy')) {
454
    if ($display == 'new') {
Dries's avatar
 
Dries committed
455 456
      if ($nid = _forum_new($tid)) {
        drupal_goto("node/view/$nid");
Dries's avatar
 
Dries committed
457
      }
Dries's avatar
 
Dries committed
458
    }
Dries's avatar
 
Dries committed
459 460 461 462
    else {
      if (empty($sortby)) {
        $sortby = isset($user->sortby) ? $user->sortby : variable_get('forum_order', 1);
      }
Dries's avatar
 
Dries committed
463

Dries's avatar
 
Dries committed
464 465 466
      if (empty($forum_per_page)) {
        $forum_per_page = isset($user->forum_per_page) ? $user->forum_per_page : variable_get('forum_per_page', 25);
      }
Dries's avatar
 
Dries committed
467

Dries's avatar
 
Dries committed
468
      $offset = ($from / $forum_per_page) + 1;
Dries's avatar
 
Dries committed
469

Dries's avatar
 
Dries committed
470 471 472 473 474
      $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
475

Dries's avatar
 
Dries committed
476
      print theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page, $offset);
Dries's avatar
 
Dries committed
477
    }
Dries's avatar
 
Dries committed
478 479
  }
  else {
Dries's avatar
 
Dries committed
480
    print theme('page', forum_help('admin/system/modules/forum'), t('Warning'));
Dries's avatar
 
Dries committed
481 482 483
  }
}

Dries's avatar
 
Dries committed
484
/**
Dries's avatar
 
Dries committed
485 486 487
 * @addtogroup themeable
 * @{
 */
Dries's avatar
 
Dries committed
488 489

/**
Dries's avatar
 
Dries committed
490 491 492 493 494 495 496 497 498 499 500 501
 * Format the forum body.
 *
 * @param forums
 * @param topics
 * @param parents
 * @param tid
 * @param sortby
 * @param forum_per_page
 * @param offset
 *
 * @return the output for the forum body.
 */
Dries's avatar
 
Dries committed
502
function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page, $offset) {
Dries's avatar
 
Dries committed
503
  global $user;
Dries's avatar
 
Dries committed
504
  // forum list, topics list, topic browser and 'add new topic' link
Dries's avatar
 
Dries committed
505

Dries's avatar
 
Dries committed
506 507
  $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
  $title = $vocabulary->name;
Dries's avatar
 
Dries committed
508

Dries's avatar
 
Dries committed
509 510 511
  /*
  ** Breadcrumb navigation:
  */
Dries's avatar
 
Dries committed
512
  $breadcrumb[] = l(t('Home'), '');
Dries's avatar
 
Dries committed
513
  if ($tid) {
Dries's avatar
 
Dries committed
514
    $breadcrumb[] = l($title, 'forum');
Dries's avatar
 
Dries committed
515
  }
Dries's avatar
 
Dries committed
516 517

  if ($parents) {
Dries's avatar
 
Dries committed
518 519
    $parents = array_reverse($parents);
    foreach ($parents as $p) {
520 521
      if ($p->tid == $tid) {
        $title = $p->name;
Dries's avatar
 
Dries committed
522 523
      }
      else {
Dries's avatar
 
Dries committed
524
        $breadcrumb[] = l($p->name, "forum/$p->tid");
Dries's avatar
 
Dries committed
525 526 527 528
      }
    }
  }

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

    if (module_exist('tracker')) {
      if ($user->uid) {
535
        $output .= ' <li>'. l(t('Track your forum discussions.'), "tracker/$user->uid") .'</li>';
Dries's avatar
 
Dries committed
536 537
      }

538
      $output .= ' <li>'. l(t('Track active forum discussions.'), 'tracker') .'</li>';
Dries's avatar
 
Dries committed
539 540 541
    }

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

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

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

Dries's avatar
 
Dries committed
564
  print theme('page', $output, $title, $breadcrumb);
Dries's avatar
 
Dries committed
565 566
}

Dries's avatar
 
Dries committed
567
/**
Dries's avatar
 
Dries committed
568 569 570 571 572 573 574 575
 * Format the forum listing.
 *
 * @param forums
 * @param parents
 * @param tid
 *
 * @return output for the forum listing.
 */
Dries's avatar
 
Dries committed
576
function theme_forum_list($forums, $parents, $tid) {
Dries's avatar
 
Dries committed
577 578
  global $user;

Dries's avatar
 
Dries committed
579 580
  if ($forums) {

Dries's avatar
 
Dries committed
581
    $header = array(t('Forum'), t('Topics'), t('Posts'), t('Last post'));
Dries's avatar
 
Dries committed
582 583

    foreach ($forums as $forum) {
Dries's avatar
 
Dries committed
584
      if ($forum->container) {
585 586
        $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
587 588 589 590 591 592

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

Dries's avatar
 
Dries committed
593
        $rows[] = array(array('data' => $description, 'class' => 'container', 'colspan' => 4));
594
      }
Dries's avatar
 
Dries committed
595
      else {
596
        $forum->old_topics = _forum_topics_read($forum->tid, $user->uid);
Dries's avatar
 
Dries committed
597 598 599
        if ($user->uid) {
          $new_topics = $forum->num_topics - $forum->old_topics;
        }
Dries's avatar
 
Dries committed
600 601 602
        else {
          $new_topics = 0;
        }
Dries's avatar
 
Dries committed
603

Dries's avatar
 
Dries committed
604
        $links = array();
Dries's avatar
 
Dries committed
605

606 607
        $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
608

Dries's avatar
 
Dries committed
609 610 611 612
        if ($forum->description) {
          $description .= " <div class=\"description\">$forum->description</div>\n";
        }
        if ($links) {
613
          $description .= ' <div class="links">'. t('Jump to: %links', array('%links' => implode(', ', $links))) .".</div>\n";
Dries's avatar
 
Dries committed
614 615
        }
        $description .= "</div>\n";
Dries's avatar
 
Dries committed
616

Dries's avatar
 
Dries committed
617
        $rows[] = array(
Dries's avatar
 
Dries committed
618
          array('data' => $description, 'class' => 'forum'),
619
          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
620 621
          array('data' => $forum->num_posts, 'class' => 'posts'),
          array('data' => _forum_format($forum->last_post), 'class' => 'last-reply'));
Dries's avatar
 
Dries committed
622
      }
Dries's avatar
 
Dries committed
623 624 625
    }
  }

Dries's avatar
 
Dries committed
626
  return theme('table', $header, $rows);
Dries's avatar
 
Dries committed
627 628
}

Dries's avatar
 
Dries committed
629
/**
Dries's avatar
 
Dries committed
630 631 632 633 634 635 636 637 638 639
 * Format the topic listing.
 *
 * @param tid
 * @param topics
 * @param sortby
 * @param forum_per_page
 * @param offset
 *
 * @return output for the topic list.
 */
Dries's avatar
 
Dries committed
640
function theme_forum_topic_list($tid, $topics, $sortby, $forum_per_page, $offset) {
Dries's avatar
 
Dries committed
641
  global $id, $status, $pager_total, $forum_topic_list_header;
Dries's avatar
 
Dries committed
642 643

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

Dries's avatar
 
Dries committed
645 646
    foreach ($topics as $topic) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
Dries committed
647
      if ($topic->tid != $tid) {
Dries's avatar
 
Dries committed
648
        $rows[] = array(
Dries's avatar
 
Dries committed
649 650 651
          array('data' => _forum_icon($topic->new, $topic->num_comments, $topic->comment_mode), 'class' => 'icon'),
          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
652
        );
Dries's avatar
 
Dries committed
653 654
      }
      else {
Dries's avatar
 
Dries committed
655
        $rows[] = array(
Dries's avatar
 
Dries committed
656 657
          array('data' => _forum_icon($topic->new, $topic->num_comments, $topic->comment_mode), 'class' => 'icon'),
          array('data' => l($topic->title, "node/view/$topic->nid"), 'class' => 'topic'),
658
          array('data' => $topic->num_comments . ($topic->new_replies ? '<br />'. l(t('%a new', array('%a' => $topic->new_replies)), "node/view/$topic->nid", NULL, NULL, 'new') : ''), 'class' => 'replies'),
Dries's avatar
 
Dries committed
659 660
          array('data' => _forum_format($topic), 'class' => 'created'),
          array('data' => _forum_format($topic->last_reply), 'class' => 'last-reply')
Dries's avatar
 
Dries committed
661
        );
Dries's avatar
 
Dries committed
662 663 664
      }
    }

Dries's avatar
 
Dries committed
665 666
    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
667 668
    }
  }
Dries's avatar
 
Dries committed
669

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

Dries's avatar
 
Dries committed
672 673 674
  return $output;
}

Dries's avatar
 
Dries committed
675
/** @} End of addtogroup themeable */
Dries's avatar
 
Dries committed
676

Dries's avatar
 
Dries committed
677
function _forum_icon($new_posts, $num_posts = 0, $comment_mode = 0) {
Dries's avatar
 
Dries committed
678

Dries's avatar
 
Dries committed
679
  $base_path = variable_get('forum_icon_path', '');
Dries's avatar
 
Dries committed
680
  if ($base_path) {
Dries's avatar
 
Dries committed
681 682
    if ($num_posts > variable_get('forum_hot_topic', 15)) {
      $icon = $new_posts ? 'hot-new' : 'hot';
Dries's avatar
 
Dries committed
683 684
    }
    else {
Dries's avatar
 
Dries committed
685
      $icon = $new_posts ? 'new' : 'default';
Dries's avatar
 
Dries committed
686 687 688
    }

    if ($comment_mode == 1) {
Dries's avatar
 
Dries committed
689
      $icon = 'closed';
Dries's avatar
 
Dries committed
690 691
    }

Dries's avatar
 
Dries committed
692
    // default
Dries's avatar
 
Dries committed
693
    $file = $base_path ."/forum-$icon.gif";
Dries's avatar
 
Dries committed
694

Dries's avatar
 
Dries committed
695
    $output = "<img src=\"$file\" alt=\"\" title=\"\" />";
Dries's avatar
 
Dries committed
696 697
  }
  else {
Dries's avatar
 
Dries committed
698
    $output = '&nbsp;';
Dries's avatar
 
Dries committed
699
  }
Dries's avatar
 
Dries committed
700 701 702 703 704 705

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

  return $output;
Dries's avatar
 
Dries committed
706 707 708 709
}

function _forum_user_last_visit($nid) {
  global $user;
710 711 712
  static $history = array();

  if (empty($history)) {
Dries's avatar
 
Dries committed
713
    $result = db_query('SELECT nid, timestamp FROM {history} WHERE uid = %d', $user->uid);
Dries's avatar
 
Dries committed
714
    while ($t = db_fetch_object($result)) {
715
      $history[$t->nid] = $t->timestamp > NODE_NEW_LIMIT ? $t->timestamp : NODE_NEW_LIMIT;
Dries's avatar
 
Dries committed
716 717
    }
  }
718
  return $history[$nid] ? $history[$nid] : NODE_NEW_LIMIT;
Dries's avatar
 
Dries committed
719 720 721 722 723
}

function _forum_get_topic_order($sortby) {
  switch ($sortby) {
    case 1:
Dries's avatar
 
Dries committed
724
      return 'date_sort DESC';
Dries's avatar
 
Dries committed
725 726
      break;
    case 2:
Dries's avatar
 
Dries committed
727
      return 'date_sort ASC';
Dries's avatar
 
Dries committed
728 729
      break;
    case 3:
Dries's avatar
 
Dries committed
730
      return 'num_comments DESC';
Dries's avatar
 
Dries committed
731 732
      break;
    case 4:
Dries's avatar
 
Dries committed
733
      return 'num_comments ASC';
Dries's avatar
 
Dries committed
734 735 736 737
      break;
  }
}

Dries's avatar
 
Dries committed
738
?>