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

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

9 10 11 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 157 158 159
    while ($node = db_fetch_object($results)) {
      $edit['nid'] = $node->nid;
      $edit['confirm'] = TRUE;
      node_delete($edit);
Dries's avatar
 
Dries committed
160
    }
161
  }
162 163 164
  elseif ($op == 'delete' && $type == 'vocabulary' && $object->vid == _forum_get_vid())  {
    variable_del('forum_nav_vocabulary');
  }
165
}
Dries's avatar
 
Dries committed
166

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

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

  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'));
179 180 181 182 183 184 185 186
}

/**
 * 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()) {
187 188 189
  $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;
190
  $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'container');
191
  $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.'));
192

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

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

/**
 * 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()) {
209 210 211
  $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;
212
  $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'forum');
213
  $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.'));
214

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

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

/**
 * 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
230
 * @param $child_type Whether the child is forum or container
231
 */
232
function _forum_parent_select($tid, $title, $child_type) {
233 234

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

243 244 245 246 247 248 249 250 251 252 253 254 255
  $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)) {
256
        $options[$term->tid] = _taxonomy_depth($term->depth) . $term->name;
257
      }
Dries's avatar
 
Dries committed
258 259
    }
  }
260 261 262 263 264 265
  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
266

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

270
/**
271
 * Returns an overview list of existing forums and containers
272
 */
273 274 275 276 277 278 279
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()))) {
280
        $rows[] = array(_taxonomy_depth($term->depth) .' '. check_plain($term->name), l(t('edit container'), "admin/forum/edit/container/$term->tid"));
281 282
      }
      else {
283
        $rows[] = array(_taxonomy_depth($term->depth) .' '. check_plain($term->name), l(t('edit forum'), "admin/forum/edit/forum/$term->tid"));
284 285
       }

Dries's avatar
Dries committed
286 287
    }
  }
288
  else {
289
    $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));
290 291
  }
  return theme('table', $header, $rows);
Dries's avatar
Dries committed
292 293
}

294 295 296 297 298 299 300
/**
 * 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
301
    $vid = db_result(db_query("SELECT vid FROM {vocabulary} WHERE module = '%s'", 'forum'));
302
    if (!$vid) {
303
      $edit = array('name' => 'Forums', 'multiple' => 0, 'required' => 1, 'hierarchy' => 1, 'relations' => 0, 'module' => 'forum', 'nodes' => array('forum' => 1));
304 305
      taxonomy_save_vocabulary($edit);
      $vid = $edit['vid'];
306 307 308 309 310 311 312 313 314 315
    }
    variable_set('forum_nav_vocabulary', $vid);
  }

  return $vid;
}

/**
 * Implementation of hook_settings
 */
316
function forum_admin_configure() {
317

318
  $form = array();
319
  $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. '));
320
  $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 10000));
321
  $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.'));
322
  $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
323
  $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.'));
324
  $forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4=> t('Posts - least active first'));
325
  $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.'));
326

327
  return system_settings_form('forum_admin_configure', $form);
328 329
}

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

  return $forum;
}

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

352
    case 'configure':
353
      $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)));
354
      return $form;
Dries's avatar
 
Dries committed
355

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

360 361
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
362 363
        switch ($delta) {
          case 0:
364
            $title = t('Active forum topics');
365
            $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");
366 367 368 369
            $result = db_query_range($sql, 0, variable_get('forum_block_num_0', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
370
            break;
Dries's avatar
 
Dries committed
371 372

          case 1:
373 374
            $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");
375 376 377 378
            $result = db_query_range($sql, 0, variable_get('forum_block_num_1', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
379
            break;
Dries's avatar
 
Dries committed
380
        }
Dries's avatar
 
Dries committed
381

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

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

        return $block;
      }
  }
Dries's avatar
 
Dries committed
392 393
}

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

Dries's avatar
 
Dries committed
400 401
  $links = array();

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

Steven Wittens's avatar
Steven Wittens committed
405
    $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));
406
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
407
    $result = db_query($sql, $node->tid);
Dries's avatar
 
Dries committed
408 409 410

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

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

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

Dries's avatar
 
Dries committed
435
  return $links;
Dries's avatar
 
Dries committed
436 437
}

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

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

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

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

    $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);
471 472 473 474
    $items[] = array('path' => 'admin/forum/configure', 'title' => t('configure'),
      'callback' => 'forum_admin_configure',
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
475 476 477 478 479 480 481

    $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
482
  }
Dries's avatar
 
Dries committed
483 484 485 486

  return $items;
}

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

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

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

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

520 521
  node_validate_title($node,t('You have to specify a subject.'));

Dries's avatar
 
Dries committed
522 523
  if ($node->taxonomy) {
    // Extract the node's proper topic ID.
Dries's avatar
 
Dries committed
524
    $vocabulary = variable_get('forum_nav_vocabulary', '');
525
    $containers = variable_get('forum_containers', array());
Dries's avatar
 
Dries committed
526
    foreach ($node->taxonomy as $term) {
Dries's avatar
 
Dries committed
527
      if (db_result(db_query('SELECT COUNT(*) FROM {term_data} WHERE tid = %d AND vid = %d', $term, $vocabulary))) {
528 529
        if (in_array($term, $containers)) {
          $term = taxonomy_get_term($term);
530
          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))));
531 532 533 534
        }
        else {
          $node->tid = $term;
        }
Dries's avatar
 
Dries committed
535
      }
536
    }
Dries's avatar
 
Dries committed
537 538 539 540 541 542 543
    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
544 545 546
  }
}

Dries's avatar
 
Dries committed
547 548 549 550
/**
 * Implementation of hook_update().
 */
function forum_update($node) {
551 552 553 554 555 556
  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
557 558
}

559 560 561
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
562
function forum_form(&$node) {
563
  $form['title'] = array('#type' => 'textfield', '#title' => t('Subject'), '#default_value' => $node->title, '#size' => 60, '#maxlength' => 128, '#required' => TRUE);
564

Dries's avatar
 
Dries committed
565
  if (!$node->nid) {
Dries's avatar
Dries committed
566
    // new topic
Dries's avatar
 
Dries committed
567
    $node->taxonomy[] = arg(3);
568
  }
Dries's avatar
 
Dries committed
569 570 571
  else {
    $node->taxonomy = array($node->tid);
  }
572

Dries's avatar
Dries committed
573 574
  if ($node->nid) {
    // if editing, give option to leave shadows
Dries's avatar
 
Dries committed
575
    $shadow = (count(taxonomy_node_get_terms($node->nid)) > 1);
576
    $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
577
  }
Dries's avatar
 
Dries committed
578

579
  $form['body'] = array('#type' => 'textarea', '#title' => t('Body'), '#default_value' => $node->body, '#required' => TRUE
580 581
  );
  $form = array_merge($form, filter_form($node->format));
Dries's avatar
 
Dries committed
582

583
  return $form;
Dries's avatar
 
Dries committed
584 585
}

586 587 588
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
589
function forum_insert($node) {
590
  db_query('INSERT INTO {forum} (nid, vid, tid) VALUES (%d, %d, %d)', $node->nid, $node->vid, $node->tid);
Dries's avatar
 
Dries committed
591 592
}

593 594 595
/**
 * Implementation of hook_delete().
 */
Dries's avatar
 
Dries committed
596
function forum_delete(&$node) {
Dries's avatar
 
Dries committed
597
  db_query('DELETE FROM {forum} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
598
}
Dries's avatar
 
Dries committed
599

Dries's avatar
 
Dries committed
600 601 602
/**
 * Formats a topic for display
 *
603
 * @TODO Give a better description. Not sure where this function is used yet.
Dries's avatar
 
Dries committed
604
 */
Dries's avatar
 
Dries committed
605
function _forum_format($topic) {
606
  if ($topic && $topic->timestamp) {
607
    return t('%time ago<br />by %author', array('%time' => format_interval(time() - $topic->timestamp), '%author' => theme('username', $topic)));
Dries's avatar
 
Dries committed
608 609 610 611 612 613
  }
  else {
    return message_na();
  }
}

Dries's avatar
 
Dries committed
614 615 616
/**
 * Returns a list of all forums for a given taxonomy id
 *
617
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
618 619 620 621 622 623 624 625 626
 * -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
627
function forum_get_forums($tid = 0) {
628

Dries's avatar
 
Dries committed
629 630 631 632
  if (!$tid) {
    $tid = 0;
  }

Dries's avatar
 
Dries committed
633 634
  $forums = array();
  $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
Dries's avatar
 
Dries committed
635

Dries's avatar
 
Dries committed
636
  if (count($_forums)) {
Dries's avatar
 
Dries committed
637

Dries's avatar
 
Dries committed
638 639
    $counts = array();

Dries's avatar
 
Dries committed
640
    $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";
641
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
642
    $_counts = db_query($sql, $forum->tid);
Dries's avatar
 
Dries committed
643 644 645
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
646
  }
Dries's avatar
 
Dries committed
647

Dries's avatar
 
Dries committed
648 649 650 651
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
652

Dries's avatar
 
Dries committed
653 654 655 656 657 658 659 660 661 662 663
    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
664
    // used to join node_comment_statistics to users.
665
    $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";
666
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
667
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
668 669

    $last_post = new StdClass();
Dries's avatar
 
Dries committed
670 671 672 673
    $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
674

Dries's avatar
 
Dries committed
675 676 677 678
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
679 680
}

681 682 683 684
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
685
  $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'";
686
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
687 688
  $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";
689
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
690
  $recent = db_result(db_query($sql, $uid, $term, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
691

692
  return $ancient + $recent;
Dries's avatar
 
Dries committed
693 694
}

Dries's avatar
Dries committed
695
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
696
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
697

Dries's avatar
 
Dries committed
698
  $forum_topic_list_header = array(
Dries's avatar
 
Dries committed
699 700
    array('data' => '&nbsp;'),
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
701
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
702
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
703
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
704
  );
Dries's avatar
 
Dries committed
705

Dries's avatar
 
Dries committed
706
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
707
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
708 709
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
710 711 712 713
    }
  }

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

715
  $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
716
  $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
717
  $sql .= ', n.created DESC';  // Always add a secondary sort order so that the news forum topics are on top.
Dries's avatar
Dries committed
718

719
  $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
720

Steven Wittens's avatar
Steven Wittens committed
721
  $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
Dries's avatar
 
Dries committed
722 723

  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
724 725
    if ($user->uid) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
 
Dries committed
726
      if ($topic->tid != $tid) {
Dries's avatar
Dries committed
727
        $topic->new = 0;
Dries's avatar
 
Dries committed
728 729
      }
      else {
Dries's avatar
 
Dries committed
730
        $history = _forum_user_last_visit($topic->nid);
Dries's avatar
 
Dries committed
731
        $topic->new_replies = comment_num_new($topic->nid, $history);
732
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
733
      }
734 735
    }
    else {
736
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
737 738
      $topic->new_replies = 0;
      $topic->new = 0;
739
    }
Dries's avatar
 
Dries committed
740

Dries's avatar
 
Dries committed
741
    if ($topic->num_comments > 0) {
742
      $last_reply = new StdClass();
Dries's avatar
 
Dries committed
743 744 745 746 747
      $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
748 749 750
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
751
  return $topics;
Dries's avatar
 
Dries committed
752 753
}

Dries's avatar
 
Dries committed
754 755 756
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
757
function _forum_new($tid) {
Dries's avatar
 
Dries committed
758 759
  global $user;

Dries's avatar
 
Dries committed
760
  $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";
761
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
762
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
763 764 765 766

  return $nid ? $nid : 0;
}

767
/**
Dries's avatar
Dries committed
768
 * Menu callback; prints a forum listing.
769
 */
Dries's avatar
Dries committed
770
function forum_page($tid = 0) {
Dries's avatar
 
Dries committed
771
  global $user;
Dries's avatar
 
Dries committed
772

773
  if (module_exist('taxonomy') && module_exist('comment')) {
Dries's avatar
Dries committed
774 775
    $forum_per_page = variable_get('forum_per_page', 25);
    $sortby = variable_get('forum_order', 1);
Dries's avatar
 
Dries committed
776

Dries's avatar
Dries committed
777 778 779 780
    $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
781
    }
Dries's avatar
Dries committed
782

Dries's avatar
 
Dries committed
783
    return theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
784 785
  }
  else {
786 787
    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
788 789 790
  }
}

Dries's avatar
 
Dries committed
791
/**
Dries's avatar
 
Dries committed
792 793
 * Format the forum body.
 *
Dries's avatar
 
Dries committed
794
 * @ingroup themeable
Dries's avatar
 
Dries committed
795
 */
Dries's avatar
 
Dries committed
796
function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
797
  global $user;
Dries's avatar
 
Dries committed
798
  // forum list, topics list, topic browser and 'add new topic' link
Dries's avatar
 
Dries committed
799

Dries's avatar
 
Dries committed
800
  $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
801
  $title = $vocabulary->name;
Dries's avatar
 
Dries committed
802

Dries's avatar
 
Dries committed
803 804
  // Breadcrumb navigation:
  $breadcrumb = array();
Dries's avatar
 
Dries committed
805
  if ($tid) {
Dries's avatar
 
Dries committed
806
    $breadcrumb[] = array('path' => 'forum', 'title' => $title);
Dries's avatar
 
Dries committed
807
  }
Dries's avatar
 
Dries committed
808 809

  if ($parents) {
Dries's avatar
 
Dries committed
810 811
    $parents = array_reverse($parents);
    foreach ($parents as $p) {
812 813
      if ($p->tid == $tid) {
        $title = $p->name;
Dries's avatar
 
Dries committed
814 815
      }
      else {
Dries's avatar