forum.module 39.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
  switch ($section) {
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
    case 'admin/help#forum':
      $output = '<p>'. t('The forum module lets you create threaded discussion forums for a particular topic on your site. This is similar to a message board system such as phpBB. Forums are very useful because they allow community members to discuss topics with one another, and they are archived for future reference.') .'</p>';
      $output .= '<p>'. t('Forums can be organized under what are called <em>containers</em>. Containers hold forums and, in turn, forums hold threaded discussions. Both containers and forums can be placed inside other containers and forums. By planning the structure of your containers and forums well, you make it easier for users to find a topic area of interest to them.  Forum topics can be moved by selecting a different forum and can be left in the existing forum by selecting <em>leave a shadow copy</em>.  Forum topics can also have their own URL.') .'</p>';
      $output .= '<p>'. t('Forums module <strong>requires Taxonomy and Comments module</strong> be enabled.') .'</p>';
      $output .= t('<p>You can</p>
<ul>
<li>administer forums at <a href="%admin-forum">administer &gt;&gt; forums</a>.</li>
<li>enable the required comment and taxonomy modules at <a href="%admin-modules">administer &gt;&gt; modules</a>.</li>
<li>read about the comment module at <a href="%admin-help-comment">administer &gt;&gt; help &gt;&gt; comment</a>.</li>
<li>read about the taxonomy module at <a href="%admin-help-taxonomy">administer &gt;&gt; help &gt;&gt; taxonomy</a>.</li>
</ul>
', array('%admin-forum' => url('admin/forum'), '%admin-modules' => url('admin/modules'), '%admin-help-comment' => url('admin/help/comment'), '%admin-help-taxonomy' => url('admin/help/taxonomy')));
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="%forum">Forum page</a>.', array('%forum' => 'http://www.drupal.org/handbook/modules/forum/')) .'</p>';
      return $output;
    case 'admin/modules#description':
      return t('Enables threaded discussions about general topics.');
30
    case 'admin/forum':
31
      return t('<p>This is a list of existing containers and forums that you can edit. Containers hold forums and, in turn, forums hold threaded discussions. Both containers and forums can be placed inside other containers and forums. By planning the structure of your containers and forums well, you make it easier for users to find a topic area of interest to them.</p>');
32
    case 'admin/forum/add/container':
33
      return t('<p>Containers help you organize your forums. The job of a container is to hold, or contain, other forums that are related. For example, a container named "Food" might hold two forums named "Fruit" and "Vegetables".</p>');
34
    case 'admin/forum/add/forum':
35
      return t('<p>A forum holds discussion topics that are related. For example, a forum named "Fruit" might contain topics titled "Apples" and "Bananas".</p>');
36 37
    case 'admin/forum/configure':
      return t('This is where you can configure system-wide options for how your forums act and display.');
Dries's avatar
 
Dries committed
38
    case 'node/add#forum':
39
      return t('Create a new topic for discussion in the forums.');
Dries's avatar
 
Dries committed
40 41 42
  }
}

43
/**
44
 * Implementation of hook_node_info().
45
 */
46
function forum_node_info() {
47
  return array('forum' => array('name' => t('forum topic'), 'base' => 'forum'));
Dries's avatar
 
Dries committed
48 49
}

50 51 52
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
53
function forum_access($op, $node) {
Dries's avatar
 
Dries committed
54 55
  global $user;

Dries's avatar
 
Dries committed
56 57
  if ($op == 'create') {
    return user_access('create forum topics');
Dries's avatar
 
Dries committed
58
  }
Dries's avatar
 
Dries committed
59 60 61 62 63 64

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

67 68 69
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
70
function forum_perm() {
71
  return array('create forum topics', 'edit own forum topics', 'administer forums');
Dries's avatar
 
Dries committed
72
}
Dries's avatar
 
Dries committed
73

74
/**
75
 * Administration page which allows maintaining forums
76
 */
77 78 79 80 81 82 83
function forum_admin() {
  $op = $_POST['op'];
  $edit = $_POST['edit'];

  if (empty($op)) {
    $op = arg(2);
  }
Dries's avatar
 
Dries committed
84

85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
  switch ($op) {
    case 'add':
      if (arg(3) == 'forum') {
        $output = forum_form_forum();
      }
      else if (arg(3) == 'container') {
        $output = forum_form_container();
      }
      break;
    case 'edit':
      if (arg(3) == 'forum') {
        $output = forum_form_forum(object2array(taxonomy_get_term(arg(4))));
      }
      else if (arg(3) == 'container') {
         $output = forum_form_container(object2array(taxonomy_get_term(arg(4))));
      }
      break;
    case t('Delete'):
      if (!$edit['confirm']) {
104
        $output = _forum_confirm_delete($edit['tid']);
105 106 107
        break;
      }
      else {
108
        $name = $edit['name'];
109 110 111
        $edit['name'] = 0;
      }
    case t('Submit'):
112
      $status = taxonomy_save_term($edit);
113
      if (arg(3) == 'container') {
114 115 116 117 118 119 120 121 122 123
        switch ($status) {
          case SAVED_NEW:
            $containers = variable_get('forum_containers', array());
            $containers[] = $edit['tid'];
            variable_set('forum_containers', $containers);
            drupal_set_message(t('Created new forum container %term.', array('%term' => theme('placeholder', $edit['name']))));
            break;
          case SAVED_UPDATED:
            drupal_set_message(t('The forum container %term has been updated.', array('%term' => theme('placeholder', $edit['name']))));
            break;
124
          case SAVED_DELETED:
125 126
            drupal_set_message(t('The forum container %term has been deleted.', array('%term' => theme('placeholder', $name))));
            break;
127 128 129
        }
      }
      else {
130 131 132 133 134 135 136 137 138 139
        switch ($status) {
          case SAVED_NEW:
            drupal_set_message(t('Created new forum %term.', array('%term' => theme('placeholder', $edit['name']))));
            break;
          case SAVED_UPDATED:
            drupal_set_message(t('The forum %term has been updated.', array('%term' => theme('placeholder', $edit['name']))));
            break;
          case SAVED_DELETED:
            drupal_set_message(t('The forum %term has been deleted.', array('%term' => theme('placeholder', $name))));
            break;
140 141
        }
      }
142 143 144 145 146
      drupal_goto('admin/forum');
    default:
      $output = forum_overview();
  }

Dries's avatar
 
Dries committed
147
  return $output;
148 149 150 151 152
}

/**
 * Implementation of hook_taxonomy().
 */
153
function forum_taxonomy($op, $type, $object = NULL) {
154
  if ($op == 'delete' && $type == 'term' && $object->vid == _forum_get_vid())  {
Dries's avatar
Dries committed
155
    $results = db_query('SELECT f.nid FROM {forum} f WHERE f.tid = %d', $object->tid);
156
    while ($node = db_fetch_object($results)) {
157
      node_delete($node->nid);
Dries's avatar
 
Dries committed
158
    }
159
  }
160 161 162
  elseif ($op == 'delete' && $type == 'vocabulary' && $object->vid == _forum_get_vid())  {
    variable_del('forum_nav_vocabulary');
  }
163
}
Dries's avatar
 
Dries committed
164

165 166 167 168 169
/**
 * Returns a confirmation page for deleting a forum taxonomy term
 *
 * @param $tid ID of the term to be deleted
 */
170
function _forum_confirm_delete($tid) {
171 172
  $term = taxonomy_get_term($tid);

173
  $form['tid'] = array('#type' => 'hidden', '#value' => $tid);
174 175 176

  return confirm_form('forum_confirm_delete', $form, t('Are you sure you want to delete the forum %name?', array('%name' => theme('placeholder', $term->name))),
                  'admin/forums', t('Deleting a forum or container will delete all sub-forums as well. This action cannot be undone.'), t('Delete'), t('Cancel'));
177 178 179 180 181 182 183 184
}

/**
 * Returns a form for adding a container to the forum vocabulary
 *
 * @param $edit Associative array containing a container term to be added or edited.
 */
function forum_form_container($edit = array()) {
185 186 187
  $form['name'] = array('#title' => t('Container name'), '#type' => 'textfield', '#default_value' => $edit['name'], '#size' => 60, '#maxlength' =>  64, '#description' => t('The container name is used to identify related forums.'), '#required' => TRUE);
  $form['description'] = array('#type' => 'textarea', '#title' => t('Description'), '#default_value' => $edit['description'], '#cols' => 60, '#rows' => 5, '#description' => ('The container description can give users more information about the forums it contains.'));
  $form['parent']['#tree'] = TRUE;
188
  $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'container');
189
  $form['weight'] = array('#type' => 'weight', '#title' => t('Weight'), '#default_value' => $edit['weight'], '#delta' => 10, '#description' => t('When listing containers, those with with light (small) weights get listed before containers with heavier (larger) weights. Containers with equal weights are sorted alphabetically.'));
190

191 192
  $form['vid'] = array('#type' => 'hidden', '#value' => _forum_get_vid());
  $form['submit'] = array('#type' => 'submit', '#value' => t('Submit'));
193
  if ($edit['tid']) {
194 195
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['tid'] = array('#type' => 'hidden', '#value' => $edit['tid']);
196 197
  }

198
  return drupal_get_form('forum_form_container', $form);
199 200 201 202 203 204 205 206
}

/**
 * Returns a form for adding a forum to the forum vocabulary
 *
 * @param $edit Associative array containing a forum term to be added or edited.
 */
function forum_form_forum($edit = array()) {
207 208 209
  $form['name'] = array('#type' => 'textfield', '#title' => t('Forum name'), '#default_value' => $edit['name'], '#size' => 60, '#maxlength' =>  64, '#description' => t('The forum name is used to identify related discussions.'), '#required' => TRUE);
  $form['description'] = array('#type' => 'textarea', '#title' => t('Description'), '#default_value' => $edit['description'], '#cols' => 60, '#rows' => 5, '#description' => ('The forum description can give users more information about the discussion topics it contains.'));
  $form['parent']['#tree'] = TRUE;
210
  $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'forum');
211
  $form['weight'] = array('#type' => 'weight', '#title' => t('Weight'), '#default_value' => $edit['weight'], '#delta' => 10, '#description' => t('When listing forums, those with with light (small) weights get listed before containers with heavier (larger) weights. Forums with equal weights are sorted alphabetically.'));
212

213 214
  $form['vid'] = array('#type' => 'hidden', '#value' => _forum_get_vid());
  $form['submit' ] = array('#type' => 'submit', '#value' => t('Submit'));
215
  if ($edit['tid']) {
216 217
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['tid'] = array('#type' => 'hidden', '#value' => $edit['tid']);
218
  }
219

220
  return drupal_get_form('forum_form_forum', $form);
221 222 223 224 225 226 227
}

/**
 * Returns a select box for available parent terms
 *
 * @param $tid ID of the term which is being added or edited
 * @param $title Title to display the select box with
228
 * @param $child_type Whether the child is forum or container
229
 */
230
function _forum_parent_select($tid, $title, $child_type) {
231 232

  $parents = taxonomy_get_parents($tid);
233 234 235 236 237 238 239 240
  if ($parents) {
    $parent = array_shift($parents);
    $parent = $parent->tid;
  }
  else {
    $parent = 0;
  }

241 242 243 244 245 246 247 248 249 250 251 252 253
  $children = taxonomy_get_tree(_forum_get_vid, $tid);

  // A term can't be the child of itself, nor of its children.
  foreach ($children as $child) {
    $exclude[] = $child->tid;
  }
  $exclude[] = $tid;

  $tree = taxonomy_get_tree(_forum_get_vid());
  $options[0] = '<'. t('root') .'>';
  if ($tree) {
    foreach ($tree as $term) {
      if (!in_array($term->tid, $exclude)) {
254
        $options[$term->tid] = _taxonomy_depth($term->depth) . $term->name;
255
      }
Dries's avatar
 
Dries committed
256 257
    }
  }
258 259 260 261 262 263
  if ($child_type == 'container') {
    $description = t('Containers are usually placed at the top (root) level of your forum but you can also place a container inside a parent container or forum.');
  }
  else if ($child_type == 'forum') {
    $description = t('You may place your forum inside a parent container or forum, or at the top (root) level of your forum.');
  }
Dries's avatar
 
Dries committed
264

265
  return array('#type' => 'select', '#title' => $title, '#default_value' => $parent, '#options' => $options, '#description' => $description, '#required' => TRUE);
Dries's avatar
 
Dries committed
266 267
}

268
/**
269
 * Returns an overview list of existing forums and containers
270
 */
271 272 273 274 275 276 277
function forum_overview() {
  $header = array(t('Name'), t('Operations'));

  $tree = taxonomy_get_tree(_forum_get_vid());
  if ($tree) {
    foreach ($tree as $term) {
      if (in_array($term->tid, variable_get('forum_containers', array()))) {
278
        $rows[] = array(_taxonomy_depth($term->depth) .' '. check_plain($term->name), l(t('edit container'), "admin/forum/edit/container/$term->tid"));
279 280
      }
      else {
281
        $rows[] = array(_taxonomy_depth($term->depth) .' '. check_plain($term->name), l(t('edit forum'), "admin/forum/edit/forum/$term->tid"));
282 283
       }

Dries's avatar
Dries committed
284 285
    }
  }
286
  else {
287
    $rows[] = array(array('data' => '<em>' . t('There are no existing containers or forums. You may add some on the <a href="%container">add container</a> or <a href="%forum">add forum</a> pages.', array('%container' => url('admin/forum/add/container'), '%forum' => url('admin/forum/add/forum'))) . '</em>', 'colspan' => 2));
288 289
  }
  return theme('table', $header, $rows);
Dries's avatar
Dries committed
290 291
}

292 293 294 295 296 297 298
/**
 * Returns the vocabulary id for forum navigation.
 */
function _forum_get_vid() {
  $vid = variable_get('forum_nav_vocabulary', '');
  if (empty($vid)) {
    // Check to see if a forum vocabulary exists
Dries's avatar
Dries committed
299
    $vid = db_result(db_query("SELECT vid FROM {vocabulary} WHERE module = '%s'", 'forum'));
300
    if (!$vid) {
301
      $edit = array('name' => 'Forums', 'multiple' => 0, 'required' => 1, 'hierarchy' => 1, 'relations' => 0, 'module' => 'forum', 'nodes' => array('forum' => 1));
302 303
      taxonomy_save_vocabulary($edit);
      $vid = $edit['vid'];
304 305 306 307 308 309 310 311 312 313
    }
    variable_set('forum_nav_vocabulary', $vid);
  }

  return $vid;
}

/**
 * Implementation of hook_settings
 */
314
function forum_admin_configure() {
315

316
  $form = array();
317
  $form['forum_icon_path'] = array('#type' => 'textfield', '#title' => t('Forum icon path'), '#default_value' => variable_get('forum_icon_path', ''), '#size' => 30, '#maxlength' =>  255, '#description' => 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. You may use images of whatever size you wish, but it is recommended to use 15x15 or 16x16. '));
318
  $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 10000));
319
  $form['forum_hot_topic'] = array('#type' => 'select', '#title' => t('Hot topic threshold'), '#default_value' => variable_get('forum_hot_topic', 15), '#options' => $number, '#description' => t('The number of posts a topic must have to be considered hot.'));
320
  $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
321
  $form['forum_per_page'] = array('#type' => 'select', '#title' => t('Topics per page'), '#default_value' => variable_get('forum_per_page', 25), '#options' => $number, '#description' => t('The default number of topics displayed per page; links to browse older messages are automatically being displayed.'));
322
  $forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4=> t('Posts - least active first'));
323
  $form['forum_order'] = array('#type' => 'radios', '#title' => t('Default order'), '#default_value' => variable_get('forum_order', '1'), '#options' => $forder, '#description' => t('The default display order for topics.'));
324

325
  return system_settings_form('forum_admin_configure', $form);
326 327
}

328 329 330
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
331
function forum_load($node) {
332
  $forum = db_fetch_object(db_query('SELECT * FROM {forum} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
333 334 335 336

  return $forum;
}

337 338 339 340 341 342
/**
 * Implementation of hook_block().
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
343 344 345
function forum_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
Dries's avatar
 
Dries committed
346 347
      $blocks[0]['info'] = t('Active forum topics');
      $blocks[1]['info'] = t('New forum topics');
348
      return $blocks;
Dries's avatar
 
Dries committed
349

350
    case 'configure':
351
      $form['forum_block_num_'. $delta] = array('#type' => 'select', '#title' => t('Number of topics'), '#default_value' => variable_get('forum_block_num_'. $delta, '5'), '#options' => drupal_map_assoc(array(2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20)));
352
      return $form;
Dries's avatar
 
Dries committed
353

354
    case 'save':
355
      variable_set('forum_block_num_'. $delta, $edit['forum_block_num_'. $delta]);
356
      break;
Dries's avatar
 
Dries committed
357

358 359
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
360 361
        switch ($delta) {
          case 0:
362
            $title = t('Active forum topics');
363
            $sql = db_rewrite_sql("SELECT 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 WHERE n.status = 1 AND n.type = 'forum' ORDER BY l.last_comment_timestamp DESC");
364 365 366 367
            $result = db_query_range($sql, 0, variable_get('forum_block_num_0', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
368
            break;
Dries's avatar
 
Dries committed
369 370

          case 1:
371 372
            $title = t('New forum topics');
            $sql = db_rewrite_sql("SELECT n.nid, n.title, l.comment_count FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid WHERE n.type = 'forum' AND n.status = 1 ORDER BY n.nid DESC");
373 374 375 376
            $result = db_query_range($sql, 0, variable_get('forum_block_num_1', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
377
            break;
Dries's avatar
 
Dries committed
378
        }
Dries's avatar
 
Dries committed
379

380
        if ($content) {
Steven Wittens's avatar
Steven Wittens committed
381
          $content .= '<div class="more-link">'. l(t('more'), 'forum', array('#title' => t('Read the latest forum topics.'))) .'</div>';
382 383
        }

Dries's avatar
 
Dries committed
384
        $block['subject'] = $title;
385 386 387 388 389
        $block['content'] = $content;

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

Dries's avatar
 
Dries committed
392 393 394
/**
 * Implementation of hook_link().
 */
395
function forum_link($type, $node = 0, $main = 0) {
Dries's avatar
Dries committed
396
  global $user;
Dries's avatar
 
Dries committed
397

Dries's avatar
 
Dries committed
398 399
  $links = array();

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

Steven Wittens's avatar
Steven Wittens committed
403
    $sql = "SELECT n.nid, n.title, n.sticky, l.comment_count, l.last_comment_timestamp FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.status = 1 AND n.type = 'forum' ORDER BY n.sticky DESC, ". _forum_get_topic_order_sql(variable_get('forum_order', 1));
404
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
405
    $result = db_query($sql, $node->tid);
Dries's avatar
 
Dries committed
406 407 408

    while ($topic = db_fetch_object($result)) {
      if ($stop == 1) {
409
        $next = new StdClass();
Dries's avatar
 
Dries committed
410 411 412 413 414 415 416 417
        $next->nid = $topic->nid;
        $next->title = $topic->title;
        break;
      }
      if ($topic->nid == $node->nid) {
        $stop = 1;
      }
      else {
418
        $prev = new StdClass();
Dries's avatar
 
Dries committed
419 420 421 422 423 424
        $prev->nid = $topic->nid;
        $prev->title = $topic->title;
      }
    }

    if ($prev) {
425
      $links[] = l(t('previous forum topic'), "node/$prev->nid", array('title' => check_plain($prev->title)));
Dries's avatar
 
Dries committed
426 427 428
    }

    if ($next) {
429
      $links[] = l(t('next forum topic'), "node/$next->nid", array('title' => check_plain($next->title)));
Dries's avatar
 
Dries committed
430
    }
Dries's avatar
 
Dries committed
431 432
  }

Dries's avatar
 
Dries committed
433
  return $links;
Dries's avatar
 
Dries committed
434 435
}

436 437 438 439
function forum_term_path($term) {
  return 'forum/'. $term->tid;
}

Dries's avatar
 
Dries committed
440 441 442
/**
 * Implementation of hook_menu().
 */
Dries's avatar
 
Dries committed
443
function forum_menu($may_cache) {
Dries's avatar
 
Dries committed
444 445
  $items = array();

Dries's avatar
 
Dries committed
446 447 448
  if ($may_cache) {
    $items[] = array('path' => 'node/add/forum', 'title' => t('forum topic'),
      'access' => user_access('create forum topics'));
449

Dries's avatar
 
Dries committed
450 451 452
    $items[] = array('path' => 'forum', 'title' => t('forums'),
      'callback' => 'forum_page',
      'access' => user_access('access content'),
453
      'type' => MENU_SUGGESTED_ITEM);
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468

    $items[] = array('path' => 'admin/forum', 'title' => t('forums'),
      'callback' => 'forum_admin',
      'access' => user_access('administer forums'),
      'type' => MENU_NORMAL_ITEM);

    $items[] = array('path' => 'admin/forum/list', 'title' => t('list'),
      'access' => user_access('administer forums'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
    $items[] = array('path' => 'admin/forum/add/container', 'title' => t('add container'),
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
    $items[] = array('path' => 'admin/forum/add/forum', 'title' => t('add forum'),
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
469 470 471 472
    $items[] = array('path' => 'admin/forum/configure', 'title' => t('configure'),
      'callback' => 'forum_admin_configure',
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
473 474 475 476 477 478 479

    $items[] = array('path' => 'admin/forum/edit/container', 'title' => t('edit container'),
      'access' => user_access('administer forums'),
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'admin/forum/edit/forum', 'title' => t('edit forum'),
      'access' => user_access('administer forums'),
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
480
  }
Dries's avatar
 
Dries committed
481 482 483 484

  return $items;
}

485 486 487
/**
 * Implementation of hook_view().
 */
Dries's avatar
 
Dries committed
488
function forum_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
 
Dries committed
489

Dries's avatar
 
Dries committed
490
  if ($page) {
Dries's avatar
 
Dries committed
491
    $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
Dries's avatar
 
Dries committed
492
    // Breadcrumb navigation
Dries's avatar
 
Dries committed
493 494
    $breadcrumb = array();
    $breadcrumb[] = array('path' => 'forum', 'title' => $vocabulary->name);
Dries's avatar
 
Dries committed
495
    if ($parents = taxonomy_get_parents_all($node->tid)) {
Dries's avatar
 
Dries committed
496 497
      $parents = array_reverse($parents);
      foreach ($parents as $p) {
Dries's avatar
 
Dries committed
498
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
499 500
      }
    }
Dries's avatar
 
Dries committed
501 502
    $breadcrumb[] = array('path' => 'node/'. $node->nid);
    menu_set_location($breadcrumb);
503
  }
Dries's avatar
 
Dries committed
504

505
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
506 507
}

508
/**
509
 * Implementation of hook_execute().
510 511 512 513
 *
 * Check in particular that only a "leaf" term in the associated taxonomy
 * vocabulary is selected, not a "container" term.
 */
514
function forum_execute(&$node) {
515
  // Make sure all fields are set properly:
Dries's avatar
 
Dries committed
516
  $node->icon = $node->icon ? $node->icon : '';
Dries's avatar
 
Dries committed
517 518 519

  if ($node->taxonomy) {
    // Extract the node's proper topic ID.
Dries's avatar
 
Dries committed
520
    $vocabulary = variable_get('forum_nav_vocabulary', '');
Dries's avatar
 
Dries committed
521
    foreach ($node->taxonomy as $term) {
Dries's avatar
 
Dries committed
522
      if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
523
        $node->tid = $term;
Dries's avatar
 
Dries committed
524
      }
525
    }
Dries's avatar
 
Dries committed
526 527 528 529 530 531 532
    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
533 534 535
  }
}

536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
/**
 * Implementation of hook_validate().
 *
 * Check in particular that only a "leaf" term in the associated taxonomy
 * vocabulary is selected, not a "container" term.
 */
function forum_validate($node) {
  node_validate_title($node,t('You have to specify a subject.'));

  if ($node->taxonomy) {
    // Extract the node's proper topic ID.
    $vocabulary = variable_get('forum_nav_vocabulary', '');
    $containers = variable_get('forum_containers', array());
    foreach ($node->taxonomy as $term) {
      if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
        if (in_array($term, $containers)) {
          $term = taxonomy_get_term($term);
          form_set_error('taxonomy', t('The item %forum is only a container for forums. Please select one of the forums below it.', array('%forum' => theme('placeholder', $term->name))));
        }
      }
    }
  }
}

Dries's avatar
 
Dries committed
560 561 562 563
/**
 * Implementation of hook_update().
 */
function forum_update($node) {
564 565 566 567 568 569
  if ($node->is_new || $node->revision) {
    db_query("INSERT INTO {forum} (nid, vid, tid) VALUES (%d, %d, %d)", $node->nid, $node->vid, $node->tid);
  }
  else {
    db_query('UPDATE {forum} SET tid = %d WHERE vid = %d', $node->tid, $node->vid);
  }
Dries's avatar
 
Dries committed
570 571
}

572 573 574
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
575
function forum_form(&$node) {
576
  $form['title'] = array('#type' => 'textfield', '#title' => t('Subject'), '#default_value' => $node->title, '#size' => 60, '#maxlength' => 128, '#required' => TRUE);
577

Dries's avatar
 
Dries committed
578
  if (!$node->nid) {
Dries's avatar
Dries committed
579
    // new topic
Dries's avatar
 
Dries committed
580
    $node->taxonomy[] = arg(3);
581
  }
Dries's avatar
 
Dries committed
582 583 584
  else {
    $node->taxonomy = array($node->tid);
  }
585

Dries's avatar
Dries committed
586 587
  if ($node->nid) {
    // if editing, give option to leave shadows
Dries's avatar
 
Dries committed
588
    $shadow = (count(taxonomy_node_get_terms($node->nid)) > 1);
589
    $form['shadow'] = array('#type' => 'checkbox', '#title' => t('Leave shadow copy'), '#default_value' => $shadow, '#description' => t('If you move this topic, you can leave a link in the old forum to the new forum.'));
Dries's avatar
Dries committed
590
  }
Dries's avatar
 
Dries committed
591

592
  $form['body'] = array('#type' => 'textarea', '#title' => t('Body'), '#default_value' => $node->body, '#required' => TRUE
593 594
  );
  $form = array_merge($form, filter_form($node->format));
Dries's avatar
 
Dries committed
595

596
  return $form;
Dries's avatar
 
Dries committed
597 598
}

599 600 601
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
602
function forum_insert($node) {
603
  db_query('INSERT INTO {forum} (nid, vid, tid) VALUES (%d, %d, %d)', $node->nid, $node->vid, $node->tid);
Dries's avatar
 
Dries committed
604 605
}

606 607 608
/**
 * Implementation of hook_delete().
 */
Dries's avatar
 
Dries committed
609
function forum_delete(&$node) {
Dries's avatar
 
Dries committed
610
  db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
611
}
Dries's avatar
 
Dries committed
612

Dries's avatar
 
Dries committed
613 614 615
/**
 * Formats a topic for display
 *
616
 * @TODO Give a better description. Not sure where this function is used yet.
Dries's avatar
 
Dries committed
617
 */
Dries's avatar
 
Dries committed
618
function _forum_format($topic) {
619
  if ($topic && $topic->timestamp) {
620
    return t('%time ago<br />by %author', array('%time' => format_interval(time() - $topic->timestamp), '%author' => theme('username', $topic)));
Dries's avatar
 
Dries committed
621 622 623 624 625 626
  }
  else {
    return message_na();
  }
}

Dries's avatar
 
Dries committed
627 628 629
/**
 * Returns a list of all forums for a given taxonomy id
 *
630
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
631 632 633 634 635 636 637 638 639
 * -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
640
function forum_get_forums($tid = 0) {
641

Dries's avatar
 
Dries committed
642 643 644 645
  if (!$tid) {
    $tid = 0;
  }

Dries's avatar
 
Dries committed
646 647
  $forums = array();
  $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
Dries's avatar
 
Dries committed
648

Dries's avatar
 
Dries committed
649
  if (count($_forums)) {
Dries's avatar
 
Dries committed
650

Dries's avatar
 
Dries committed
651 652
    $counts = array();

Dries's avatar
 
Dries committed
653
    $sql = "SELECT r.tid, COUNT(n.nid) AS topic_count, SUM(l.comment_count) AS comment_count FROM {node} n INNER JOIN {node_comment_statistics} l ON n.nid = l.nid INNER JOIN {term_node} r ON n.nid = r.nid WHERE n.status = 1 AND n.type = 'forum' GROUP BY r.tid";
654
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
655
    $_counts = db_query($sql, $forum->tid);
Dries's avatar
 
Dries committed
656 657 658
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
659
  }
Dries's avatar
 
Dries committed
660

Dries's avatar
 
Dries committed
661 662 663 664
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
665

Dries's avatar
 
Dries committed
666 667 668 669 670 671 672 673 674 675 676
    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
677
    // used to join node_comment_statistics to users.
678
    $sql = "SELECT n.nid, l.last_comment_timestamp, IF(l.last_comment_uid != 0, cu.name, l.last_comment_name) as last_comment_name, l.last_comment_uid FROM {node} n, {node_comment_statistics} l, {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 ORDER BY l.last_comment_timestamp DESC";
679
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
680
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
681 682

    $last_post = new StdClass();
Dries's avatar
 
Dries committed
683 684 685 686
    $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
687

Dries's avatar
 
Dries committed
688 689 690 691
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
692 693
}

694 695 696 697
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
698
  $sql = "SELECT COUNT(n.nid) FROM {node} n INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.created <= %d AND n.status = 1 AND n.type = 'forum'";
699
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
700 701
  $ancient = db_result(db_query($sql, $term, NODE_NEW_LIMIT));
  $sql = "SELECT COUNT(n.nid) FROM {node} n 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";
702
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
703
  $recent = db_result(db_query($sql, $uid, $term, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
704

705
  return $ancient + $recent;
Dries's avatar
 
Dries committed
706 707
}

Dries's avatar
Dries committed
708
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
709
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
710

Dries's avatar
 
Dries committed
711
  $forum_topic_list_header = array(
Dries's avatar
 
Dries committed
712 713
    array('data' => '&nbsp;'),
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
714
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
715
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
716
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
717
  );
Dries's avatar
 
Dries committed
718

Dries's avatar
 
Dries committed
719
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
720
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
721 722
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
723 724 725 726
    }
  }

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

728
  $sql = db_rewrite_sql("SELECT 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 != 0, cu.name, l.last_comment_name) AS last_comment_name, l.last_comment_uid, l.comment_count AS num_comments FROM {node} n, {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 = %d AND n.uid = u.uid AND n.vid = f.vid");
Dries's avatar
 
Dries committed
729
  $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
730
  $sql .= ', n.created DESC';  // Always add a secondary sort order so that the news forum topics are on top.
Dries's avatar
Dries committed
731

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

Steven Wittens's avatar
Steven Wittens committed
734
  $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
Dries's avatar
 
Dries committed
735 736

  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
737 738
    if ($user->uid) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
 
Dries committed
739
      if ($topic->tid != $tid) {
Dries's avatar
Dries committed
740
        $topic->new = 0;
Dries's avatar
 
Dries committed
741 742
      }
      else {
Dries's avatar
 
Dries committed
743
        $history = _forum_user_last_visit($topic->nid);
Dries's avatar
 
Dries committed
744
        $topic->new_replies = comment_num_new($topic->nid, $history);
745
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
746
      }
747 748
    }
    else {
749
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
750 751
      $topic->new_replies = 0;
      $topic->new = 0;
752
    }
Dries's avatar
 
Dries committed
753

Dries's avatar
 
Dries committed
754
    if ($topic->num_comments > 0) {
755
      $last_reply = new StdClass();
Dries's avatar
 
Dries committed
756 757 758 759 760
      $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
761 762 763
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
764
  return $topics;
Dries's avatar
 
Dries committed
765 766
}

Dries's avatar
 
Dries committed
767 768 769
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
770
function _forum_new($tid) {
Dries's avatar
 
Dries committed
771 772
  global $user;

Dries's avatar
 
Dries committed
773
  $sql = "SELECT n.nid FROM {node} n LEFT JOIN {history} h ON n.nid = h.nid AND h.uid = %d INNER JOIN {term_node} r ON n.nid = r.nid AND r.tid = %d WHERE n.status = 1 AND n.type = 'forum' AND h.nid IS NULL AND n.created > %d ORDER BY created";
774
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
775
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
776 777 778 779

  return $nid ? $nid : 0;
}

780
/**
Dries's avatar
Dries committed
781
 * Menu callback; prints a forum listing.
782
 */
Dries's avatar
Dries committed
783
function forum_page($tid = 0) {
Dries's avatar
 
Dries committed
784
  global $user;
Dries's avatar
 
Dries committed
785

786
  if (module_exist('taxonomy') && module_exist('comment')) {
Dries's avatar
Dries committed
787 788
    $forum_per_page = variable_get('forum_per_page', 25);
    $sortby = variable_get('forum_order', 1);
Dries's avatar
 
Dries committed
789

Dries's avatar
Dries committed
790 791 792 793
    $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
794
    }
Dries's avatar
Dries committed
795

Dries's avatar
 
Dries committed
796
    return theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
797 798
  }
  else {
799 800
    drupal_set_message(t('The forum module requires both the taxonomy module and the comment module to be enabled and configured.'), 'error');
    return ' ';
Dries's avatar
 
Dries committed
801 802 803
  }
}

Dries's avatar
 
Dries committed
804
/**
Dries's avatar
 
Dries committed
805 806
 * Format the forum body.
 *
Dries's avatar
 
Dries committed
807
 * @ingroup themeable
Dries's avatar
 
Dries committed
808
 */
Dries's avatar
 
Dries committed
809
function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
810
  global $user;
Dries's avatar
 
Dries committed
811
  // forum list, topics list, topic browser and 'add new topic' link
Dries's avatar
 
Dries committed
812

Dries's avatar
 
Dries committed
813
  $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
814
  $title = $vocabulary->name;
Dries's avatar
 
Dries committed
815

Dries's avatar
 
Dries committed
816 817
  // Breadcrumb navigation:
  $breadcrumb = array();
Dries's avatar
 
Dries committed
818
  if ($tid) {
Dries's avatar
 
Dries committed
819
    $breadcrumb[] = array('path' => 'forum', 'title' => $title);
Dries's avatar
 
Dries committed
820
  }
Dries's avatar
 
Dries committed
821 822

  if ($parents) {
Dries's avatar