forum.module 41.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
    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>';
16
      $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>';
17 18 19
      $output .= '<p>'. t('Forums module <strong>requires Taxonomy and Comments module</strong> be enabled.') .'</p>';
      $output .= t('<p>You can</p>
<ul>
20 21 22 23
<li>administer forums at <a href="@admin-forum">administer &gt;&gt; content management &gt;&gt; forums</a>.</li>
<li>enable the required comment and taxonomy modules at <a href="@admin-modules">administer &gt;&gt; site configuration &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>
24
</ul>
25 26
', array('@admin-forum' => url('admin/content/forum'), '@admin-modules' => url('admin/settings/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://drupal.org/handbook/modules/forum/')) .'</p>';
27
      return $output;
28
    case 'admin/content/forum':
29
      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>');
30
    case 'admin/content/forum/add/container':
31
      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>');
32
    case 'admin/content/forum/add/forum':
33
      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>');
Dries's avatar
 
Dries committed
34 35 36
  }
}

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
/**
 * Implementation of hook_menu().
 */
function forum_menu($may_cache) {
  $items = array();

  if ($may_cache) {
    $items[] = array('path' => 'node/add/forum',
      'title' => t('forum topic'),
      'access' => user_access('create forum topics'));
    $items[] = array('path' => 'forum',
      'title' => t('forums'),
      'callback' => 'forum_page',
      'access' => user_access('access content'),
      'type' => MENU_SUGGESTED_ITEM);
52
    $items[] = array('path' => 'admin/content/forum',
53
      'title' => t('forums'),
54
      'description' => t('Control forums and their hierarchy and change forum settings.'),
55 56 57
      'callback' => 'forum_overview',
      'access' => user_access('administer forums'),
      'type' => MENU_NORMAL_ITEM);
58
    $items[] = array('path' => 'admin/content/forum/list',
59 60 61 62
      'title' => t('list'),
      'access' => user_access('administer forums'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -10);
63
    $items[] = array('path' => 'admin/content/forum/add/container',
64
      'title' => t('add container'),
65 66
      'callback' => 'drupal_get_form',
      'callback arguments' => array('forum_form_container'),
67 68
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
69
    $items[] = array('path' => 'admin/content/forum/add/forum',
70
      'title' => t('add forum'),
71 72
      'callback' => 'drupal_get_form',
      'callback arguments' => array('forum_form_forum'),
73 74
      'access' => user_access('administer forums'),
      'type' => MENU_LOCAL_TASK);
75 76
    $items[] = array('path' => 'admin/content/forum/settings',
      'title' => t('settings'),
77 78
      'callback' => 'drupal_get_form',
      'callback arguments' => array('forum_admin_settings'),
79
      'weight' => 5,
80
      'access' => user_access('administer forums'),
81
      'type' => MENU_LOCAL_TASK);
82
  }
83 84
  elseif (is_numeric(arg(5))) {
    $term = taxonomy_get_term(arg(5));
85 86
    // Check if this is a valid term.
    if ($term) {
87
      $items[] = array('path' => 'admin/content/forum/edit/container',
88 89 90 91 92
        'title' => t('edit container'),
        'callback' => 'forum_form_container',
        'callback arguments' => array((array)$term),
        'access' => user_access('administer forums'),
        'type' => MENU_CALLBACK);
93
      $items[] = array('path' => 'admin/content/forum/edit/forum',
94 95 96 97 98 99 100
        'title' => t('edit forum'),
        'callback' => 'forum_form_forum',
        'callback arguments' => array((array)$term),
        'access' => user_access('administer forums'),
        'type' => MENU_CALLBACK);
    }
  }
101 102 103 104 105
  else {
    // Add the CSS for this module
    // We put this in !$may_cache so it's only added once per request
    drupal_add_css(drupal_get_path('module', 'forum') .'/forum.css');
  }
106 107 108 109

  return $items;
}

110
/**
111
 * Implementation of hook_node_info().
112
 */
113
function forum_node_info() {
114 115 116 117 118 119 120 121
  return array(
    'forum' => array(
      'name' => t('forum topic'),
      'module' => 'forum',
      'description' => t('Create a new topic for discussion in the forums.'),
      'title_label' => t('Subject'),
    )
  );
Dries's avatar
 
Dries committed
122 123
}

124 125 126
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
127
function forum_access($op, $node) {
Dries's avatar
 
Dries committed
128 129
  global $user;

Dries's avatar
 
Dries committed
130 131
  if ($op == 'create') {
    return user_access('create forum topics');
Dries's avatar
 
Dries committed
132
  }
Dries's avatar
 
Dries committed
133 134 135 136 137 138

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

141 142 143
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
144
function forum_perm() {
145
  return array('create forum topics', 'edit own forum topics', 'administer forums');
Dries's avatar
 
Dries committed
146
}
Dries's avatar
 
Dries committed
147

148 149 150 151 152
/**
 * Implementation of hook_nodeapi().
 */
function forum_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
153
    case 'delete revision':
154 155 156 157 158
      db_query('DELETE FROM {forum} WHERE vid = %d', $node->vid);
      break;
  }
}

159 160 161
/**
 * Implementation of hook_taxonomy().
 */
162
function forum_taxonomy($op, $type, $term = NULL) {
163
  if ($op == 'delete' && $term['vid'] == _forum_get_vid()) {
164 165
    switch ($type) {
      case 'term':
166
        $results = db_query('SELECT f.nid FROM {forum} f WHERE f.tid = %d', $term['tid']);
167 168 169 170 171 172 173
        while ($node = db_fetch_object($results)) {
          // node_delete will also remove any association with non-forum vocabularies.
          node_delete($node->nid);
        }

        // For containers, remove the tid from the forum_containers variable.
        $containers = variable_get('forum_containers', array());
174 175
        $key = array_search($term['tid'], $containers);
        if ($key !== FALSE) {
176 177 178 179 180 181
          unset($containers[$key]);
        }
        variable_set('forum_containers', $containers);
        break;
      case 'vocabulary':
        variable_del('forum_nav_vocabulary');
Dries's avatar
 
Dries committed
182
    }
183 184
  }
}
Dries's avatar
 
Dries committed
185

Dries's avatar
Dries committed
186
function forum_admin_settings() {
187
  $form = array();
188
  $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 150, 200, 250, 300, 350, 400, 500));
189 190 191 192 193 194
  $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.'),
  );
195
  $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
196 197 198 199 200 201
  $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.'),
  );
202
  $forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4=> t('Posts - least active first'));
203 204 205 206 207 208
  $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.'),
  );
209
  return system_settings_form($form);
210 211
}

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
/**
 * Implementation of hook_form_alter().
 */
function forum_form_alter($form_id, &$form) {
  // hide critical options from forum vocabulary
  if ($form_id == 'taxonomy_form_vocabulary') {
    if ($form['vid']['#value'] == _forum_get_vid()) {
      $form['help_forum_vocab'] = array(
        '#value' => t('This is the designated forum vocabulary. Some of the normal vocabulary options have been removed.'),
        '#weight' => -1,
      );
      $form['nodes']['forum'] = array('#type' => 'checkbox', '#value' => 1, '#title' => t('forum topic'), '#attributes' => array('disabled' => '' ), '#description' => t('forum topic is affixed to the forum vocabulary.'));
      $form['hierarchy'] = array('#type' => 'value', '#value' => 1);
      unset($form['relations']);
      unset($form['tags']);
      unset($form['multiple']);
      $form['required'] = array('#type' => 'value', '#value' => 1);
    }
    else {
      unset($form['nodes']['forum']);
    }
  }
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258

  if ($form_id == 'node_delete_confirm'  && $form['node']['#value']->type == 'forum') {
    $form['#submit']['forum_node_delete_confirm_submit'] = array();
  }
}

/**
 * Check in particular that only a "leaf" term in the associated taxonomy
 * vocabulary is selected, not a "container" term.
 */
function forum_node_validate($form_id, $node) {
  $node = (object)$node;
  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' => $term->name)));
        }
      }
    }
  }
259 260
}

261 262 263
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
264
function forum_load($node) {
265
  $forum = db_fetch_object(db_query('SELECT * FROM {forum} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
266 267 268 269

  return $forum;
}

270 271 272 273 274 275
/**
 * Implementation of hook_block().
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
276 277 278
function forum_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
Dries's avatar
 
Dries committed
279 280
      $blocks[0]['info'] = t('Active forum topics');
      $blocks[1]['info'] = t('New forum topics');
281
      return $blocks;
Dries's avatar
 
Dries committed
282

283
    case 'configure':
284
      $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)));
285
      return $form;
Dries's avatar
 
Dries committed
286

287
    case 'save':
288
      variable_set('forum_block_num_'. $delta, $edit['forum_block_num_'. $delta]);
289
      break;
Dries's avatar
 
Dries committed
290

291 292
    case 'view':
      if (user_access('access content')) {
Dries's avatar
 
Dries committed
293 294
        switch ($delta) {
          case 0:
295
            $title = t('Active forum topics');
296
            $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.status = 1 AND n.type = 'forum' ORDER BY l.last_comment_timestamp DESC");
297 298 299 300
            $result = db_query_range($sql, 0, variable_get('forum_block_num_0', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
301
            break;
Dries's avatar
 
Dries committed
302 303

          case 1:
304 305
            $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");
306 307 308 309
            $result = db_query_range($sql, 0, variable_get('forum_block_num_1', '5'));
            if (db_num_rows($result)) {
              $content = node_title_list($result);
            }
310
            break;
Dries's avatar
 
Dries committed
311
        }
Dries's avatar
 
Dries committed
312

313
        if ($content) {
314
          $content .= '<div class="more-link">'. l(t('more'), 'forum', array('title' => t('Read the latest forum topics.'))) .'</div>';
315 316
        }

Dries's avatar
 
Dries committed
317
        $block['subject'] = $title;
318 319 320 321 322
        $block['content'] = $content;

        return $block;
      }
  }
Dries's avatar
 
Dries committed
323 324
}

325 326 327
/**
 * Implementation of hook_view().
 */
Dries's avatar
 
Dries committed
328
function forum_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
 
Dries committed
329
  if ($page) {
Dries's avatar
 
Dries committed
330
    $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
Dries's avatar
 
Dries committed
331
    // Breadcrumb navigation
Dries's avatar
 
Dries committed
332 333
    $breadcrumb = array();
    $breadcrumb[] = array('path' => 'forum', 'title' => $vocabulary->name);
Dries's avatar
 
Dries committed
334
    if ($parents = taxonomy_get_parents_all($node->tid)) {
Dries's avatar
 
Dries committed
335 336
      $parents = array_reverse($parents);
      foreach ($parents as $p) {
Dries's avatar
 
Dries committed
337
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
338 339
      }
    }
Dries's avatar
 
Dries committed
340 341
    $breadcrumb[] = array('path' => 'node/'. $node->nid);
    menu_set_location($breadcrumb);
342
  }
Dries's avatar
 
Dries committed
343

344
  $node = node_prepare($node, $teaser);
345 346 347 348 349
  $node->content['forum_navigation'] = array(
    '#value' => theme('forum_topic_navigation', $node),
    '#weight' => 100,
  );
  return $node;
Dries's avatar
 
Dries committed
350 351
}

352
/**
353
 * An early submit handler of the forum_node_form. Runs before the node is saved.
354
 */
355 356 357
function forum_node_submit_early($form_id, &$node) {
  $node = (object)$node;

358
  // Make sure all fields are set properly:
Dries's avatar
 
Dries committed
359
  $node->icon = $node->icon ? $node->icon : '';
Dries's avatar
 
Dries committed
360

361
  if (!empty($node->taxonomy)) {
362 363 364 365 366 367 368
    // Get the forum terms from the (cached) tree
    $tree = taxonomy_get_tree(_forum_get_vid());
    if ($tree) {
      foreach ($tree as $term) {
        $forum_terms[] = $term->tid;
      }
    }
Dries's avatar
 
Dries committed
369
    foreach ($node->taxonomy as $term) {
370
      if (in_array($term, $forum_terms)) {
371
        $node->tid = $term;
Dries's avatar
 
Dries committed
372
      }
373
    }
374
    $old_tid = db_result(db_query_range("SELECT tid FROM {forum} WHERE nid = %d ORDER BY vid DESC", $node->nid, 0,1));
375
    if ($old_tid) {
376 377 378
      if (($node->tid != $old_tid) && $node->shadow) {
        // A shadow copy needs to be created. Retain new term and add old term.
        $node->taxonomy[] = $old_tid;
Dries's avatar
 
Dries committed
379 380
      }
    }
Dries's avatar
Dries committed
381 382
  }

383
  $node = (array)$node;
384 385
}

386 387 388
function forum_node_submit($form_id, $node) {
  $node = (object)$node;
  if ($node->is_new) {
389 390 391 392 393
    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
394 395
}

396 397 398
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
399
function forum_form(&$node) {
400 401
  $type = node_get_types('type', $node);
  $form['title'] = array('#type' => 'textfield', '#title' => check_plain($type->title_label), '#default_value' => $node->title, '#required' => TRUE, '#weight' => -5);
402

403
  if ($node->nid) {
404
    $forum_terms = taxonomy_node_get_terms_by_vocabulary(_forum_get_vid(), $node->nid);
Dries's avatar
Dries committed
405
    // if editing, give option to leave shadows
406
    $shadow = (count($forum_terms) > 1);
407
    $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
408
  }
Dries's avatar
 
Dries committed
409

410
  $form['body_filter']['body'] = array('#type' => 'textarea', '#title' => check_plain($type->body_label), '#default_value' => $node->body, '#rows' => 20, '#required' => TRUE);
411
  $form['body_filter']['format'] = filter_form($node->format);
Dries's avatar
 
Dries committed
412

413
  return $form;
Dries's avatar
 
Dries committed
414 415
}

416 417 418 419 420 421
/**
 * Implementation of hook_prepare; assign forum taxonomy when adding a topic from within a forum.
 */
function forum_prepare(&$node) {
  if (!$node->nid) {
    // new topic
422 423
    $node->taxonomy[arg(3)]->vid = _forum_get_vid();
    $node->taxonomy[arg(3)]->tid = arg(3);
424 425 426
  }
}

427 428
function forum_node_delete_confirm_submit($form_id, $form_values) {
  db_query('DELETE FROM {forum} WHERE nid = %d', $form_values['node']->nid);
Dries's avatar
 
Dries committed
429
}
Dries's avatar
 
Dries committed
430

431 432 433 434 435 436 437
/**
 * 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()) {
  // Handle a delete operation.
438
  if ($_POST['op'] == t('Delete') || $_POST['confirm']) {
439
    return forum_confirm_delete($edit['tid']);
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
  }

  $form['name'] = array(
    '#title' => t('Container name'),
    '#type' => 'textfield',
    '#default_value' => $edit['name'],
    '#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'],
    '#description' => t('The container description can give users more information about the forums it contains.')
  );
  $form['parent']['#tree'] = TRUE;
  $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'container');
  $form['weight'] = array('#type' => 'weight',
    '#title' => t('Weight'),
    '#default_value' => $edit['weight'],
    '#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.')
  );

  $form['vid'] = array('#type' => 'hidden',
    '#value' => _forum_get_vid());
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Submit')
  );
  if ($edit['tid']) {
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['tid'] = array('#type' => 'value', '#value' => $edit['tid']);
  }
475
  $form['#base'] = 'forum_form';
476

477
  return $form;
478 479 480 481 482 483 484 485 486
}

/**
 * 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()) {
  // Handle a delete operation.
487
  if ($_POST['op'] == t('Delete') || $_POST['confirm']) {
488
    return forum_confirm_delete($edit['tid']);
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
  }

  $form['name'] = array('#type' => 'textfield',
    '#title' => t('Forum name'),
    '#default_value' => $edit['name'],
    '#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'],
    '#description' => t('The forum description can give users more information about the discussion topics it contains.'),
  );
  $form['parent']['#tree'] = TRUE;
  $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'forum');
  $form['weight'] = array('#type' => 'weight',
    '#title' => t('Weight'),
    '#default_value' => $edit['weight'],
    '#description' => t('When listing forums, those with lighter (smaller) weights get listed before containers with heavier (larger) weights. Forums with equal weights are sorted alphabetically.'),
  );

  $form['vid'] = array('#type' => 'hidden', '#value' => _forum_get_vid());
  $form['submit' ] = array('#type' => 'submit', '#value' => t('Submit'));
  if ($edit['tid']) {
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
    $form['tid'] = array('#type' => 'hidden', '#value' => $edit['tid']);
  }
517
  $form['#base'] = 'forum_form';
518

519
  return $form;
520 521 522 523 524 525 526 527 528 529 530
}

/**
 * Process forum form and container form submissions.
 */
function forum_form_submit($form_id, $form_values) {
  if ($form_id == 'forum_form_container') {
    $container = TRUE;
    $type = t('forum container');
  }
  else {
531
    $container = FALSE;
532 533 534 535 536 537 538 539 540 541 542
    $type = t('forum');
  }

  $status = taxonomy_save_term($form_values);
  switch ($status) {
    case SAVED_NEW:
      if ($container) {
        $containers = variable_get('forum_containers', array());
        $containers[] = $form_values['tid'];
        variable_set('forum_containers', $containers);
      }
543
      drupal_set_message(t('Created new @type %term.', array('%term' => $form_values['name'], '@type' => $type)));
544 545
      break;
    case SAVED_UPDATED:
546
      drupal_set_message(t('The @type %term has been updated.', array('%term' => $form_values['name'], '@type' => $type)));
547 548
      break;
  }
549
  return 'admin/content/forum';
550 551 552 553 554 555 556
}

/**
 * Returns a confirmation page for deleting a forum taxonomy term.
 *
 * @param $tid ID of the term to be deleted
 */
557
function forum_confirm_delete($tid) {
558 559 560 561 562
  $term = taxonomy_get_term($tid);

  $form['tid'] = array('#type' => 'value', '#value' => $tid);
  $form['name'] = array('#type' => 'value', '#value' => $term->name);

563
  return confirm_form($form, t('Are you sure you want to delete the forum %name?', array('%name' => $term->name)), 'admin/content/forums', t('Deleting a forum or container will delete all sub-forums and associated posts as well. This action cannot be undone.'), t('Delete'), t('Cancel'));
564 565 566 567 568 569 570
}

/**
 * Implementation of forms api _submit call. Deletes a forum after confirmation.
 */
function forum_confirm_delete_submit($form_id, $form_values) {
  taxonomy_del_term($form_values['tid']);
571 572
  drupal_set_message(t('The forum %term and all sub-forums and associated posts have been deleted.', array('%term' => $form_values['name'])));
  watchdog('content', t('forum: deleted %term and all its sub-forums and associated posts.', array('%term' => $form_values['name'])));
573

574
  return 'admin/content/forum';
575 576 577 578 579 580 581 582 583 584 585 586
}

/**
 * Returns an overview list of existing forums and containers
 */
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()))) {
drumm's avatar
drumm committed
587
        $rows[] = array(str_repeat(' -- ', $term->depth) .' '. check_plain($term->name), l(t('edit container'), "admin/content/forum/edit/container/$term->tid"));
588 589
      }
      else {
drumm's avatar
drumm committed
590
        $rows[] = array(str_repeat(' -- ', $term->depth) .' '. check_plain($term->name), l(t('edit forum'), "admin/content/forum/edit/forum/$term->tid"));
591 592 593 594 595
       }

    }
  }
  else {
596
    $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/content/forum/add/container'), '@forum' => url('admin/content/forum/add/forum'))) . '</em>', 'colspan' => 2));
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
  }
  return theme('table', $header, $rows);
}

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

  $parents = taxonomy_get_parents($tid);
  if ($parents) {
    $parent = array_shift($parents);
    $parent = $parent->tid;
  }
  else {
    $parent = 0;
  }

  $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)) {
drumm's avatar
drumm committed
632
        $options[$term->tid] = str_repeat(' -- ', $term->depth) . $term->name;
633 634 635 636 637 638 639 640 641 642 643 644 645
      }
    }
  }
  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.');
  }

  return array('#type' => 'select', '#title' => $title, '#default_value' => $parent, '#options' => $options, '#description' => $description, '#required' => TRUE);
}

646
function forum_link_alter(&$node, &$links) {
647
  foreach ($links as $module => $link) {
648
    if (strstr($module, 'taxonomy_term')) {
649 650
      // Link back to the forum and not the taxonomy term page. We'll only
      // do this if the taxonomy term in question belongs to forums.
651
      $tid = str_replace('taxonomy/term/', '', $link['href']);
652 653
      $term = taxonomy_get_term($tid);
      if ($term->vid == _forum_get_vid()) {
654
        $links[$module]['href'] = str_replace('taxonomy/term', 'forum', $link['href']);
655
      }
656 657
    }
  }
658 659 660 661 662 663 664 665 666 667 668
}

/**
 * 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
    $vid = db_result(db_query("SELECT vid FROM {vocabulary} WHERE module = '%s'", 'forum'));
    if (!$vid) {
669 670 671
      // Create the forum vocabulary. Assign the vocabulary a low weight so
      // it will appear first in forum topic create and edit forms.
      $edit = array('name' => 'Forums', 'multiple' => 0, 'required' => 1, 'hierarchy' => 1, 'relations' => 0, 'module' => 'forum', 'weight' => -10, 'nodes' => array('forum' => 1));
672 673 674 675 676 677 678 679 680
      taxonomy_save_vocabulary($edit);
      $vid = $edit['vid'];
    }
    variable_set('forum_nav_vocabulary', $vid);
  }

  return $vid;
}

Dries's avatar
 
Dries committed
681 682 683
/**
 * Formats a topic for display
 *
684
 * @TODO Give a better description. Not sure where this function is used yet.
Dries's avatar
 
Dries committed
685
 */
Dries's avatar
 
Dries committed
686
function _forum_format($topic) {
687
  if ($topic && $topic->timestamp) {
688
    return t('@time ago<br />by !author', array('@time' => format_interval(time() - $topic->timestamp), '!author' => theme('username', $topic)));
Dries's avatar
 
Dries committed
689 690
  }
  else {
691
    return t('n/a');
Dries's avatar
 
Dries committed
692 693 694
  }
}

Dries's avatar
 
Dries committed
695 696 697
/**
 * Returns a list of all forums for a given taxonomy id
 *
698
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
699 700 701 702 703 704 705 706 707
 * -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
708
function forum_get_forums($tid = 0) {
709

Dries's avatar
 
Dries committed
710 711
  $forums = array();
  $_forums = taxonomy_get_tree(variable_get('forum_nav_vocabulary', ''), $tid);
Dries's avatar
 
Dries committed
712

Dries's avatar
 
Dries committed
713
  if (count($_forums)) {
Dries's avatar
 
Dries committed
714

Dries's avatar
 
Dries committed
715 716
    $counts = array();

Dries's avatar
 
Dries committed
717
    $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";
718
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
719
    $_counts = db_query($sql, $forum->tid);
Dries's avatar
 
Dries committed
720 721 722
    while ($count = db_fetch_object($_counts)) {
      $counts[$count->tid] = $count;
    }
Dries's avatar
 
Dries committed
723
  }
Dries's avatar
 
Dries committed
724

Dries's avatar
 
Dries committed
725 726 727 728
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
729

Dries's avatar
 
Dries committed
730 731 732 733 734 735 736 737 738 739 740
    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
741
    // used to join node_comment_statistics to users.
742
    $sql = "SELECT ncs.last_comment_timestamp, IF (ncs.last_comment_uid != 0, u2.name, ncs.last_comment_name) AS last_comment_name, ncs.last_comment_uid FROM {node} n INNER JOIN {users} u1 ON n.uid = u1.uid INNER JOIN {term_node} tn ON n.nid = tn.nid INNER JOIN {node_comment_statistics} ncs ON n.nid = ncs.nid INNER JOIN {users} u2 ON ncs.last_comment_uid=u2.uid WHERE n.status = 1 AND n.type='forum' AND tn.tid = %d ORDER BY ncs.last_comment_timestamp DESC";
743
    $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
744
    $topic = db_fetch_object(db_query_range($sql, $forum->tid, 0, 1));
745 746

    $last_post = new StdClass();
Dries's avatar
 
Dries committed
747 748 749 750
    $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
751

Dries's avatar
 
Dries committed
752 753 754 755
    $forums[$forum->tid] = $forum;
  }

  return $forums;
Dries's avatar
 
Dries committed
756 757
}

758 759 760 761 762
/**
 * Calculate the number of nodes the user has not yet read and are newer
 * than NODE_NEW_LIMIT.
 */
function _forum_topics_unread($term, $uid) {
763
  $sql = "SELECT COUNT(n.nid) FROM {node} n INNER JOIN {term_node} tn ON n.nid = tn.nid AND tn.tid = %d LEFT JOIN {history} h ON n.nid = h.nid AND h.uid = %d WHERE n.status = 1 AND n.type = 'forum' AND n.created > %d AND h.nid IS NULL";
764
  $sql = db_rewrite_sql($sql);
765
  return db_result(db_query($sql, $term, $uid, NODE_NEW_LIMIT));
Dries's avatar
 
Dries committed
766 767
}

Dries's avatar
Dries committed
768
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
769
  global $user, $forum_topic_list_header;
Dries's avatar
 
Dries committed
770

Dries's avatar
 
Dries committed
771
  $forum_topic_list_header = array(
Dries's avatar
 
Dries committed
772 773
    array('data' => '&nbsp;'),
    array('data' => t('Topic'), 'field' => 'n.title'),
Dries's avatar
 
Dries committed
774
    array('data' => t('Replies'), 'field' => 'l.comment_count'),
Dries's avatar
 
Dries committed
775
    array('data' => t('Created'), 'field' => 'n.created'),
Dries's avatar
 
Dries committed
776
    array('data' => t('Last reply'), 'field' => 'l.last_comment_timestamp'),
Dries's avatar
 
Dries committed
777
  );
Dries's avatar
 
Dries committed
778

Dries's avatar
 
Dries committed
779
  $order = _forum_get_topic_order($sortby);
Dries's avatar
 
Dries committed
780
  for ($i = 0; $i < count($forum_topic_list_header); $i++) {
Dries's avatar
 
Dries committed
781 782
    if ($forum_topic_list_header[$i]['field'] == $order['field']) {
      $forum_topic_list_header[$i]['sort'] = $order['sort'];
Dries's avatar
 
Dries committed
783 784 785 786
    }
  }

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

788
  $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_comment_statistics} l, {users} cu, {term_node} r, {users} u, {forum} f, {node} n 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
789
  $sql .= tablesort_sql($forum_topic_list_header, 'n.sticky DESC,');
790
  $sql .= ', n.created DESC';  // Always add a secondary sort order so that the news forum topics are on top.
Dries's avatar
Dries committed
791

792
  $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
793

Steven Wittens's avatar
Steven Wittens committed
794
  $result = pager_query($sql, $forum_per_page, 0, $sql_count, $tid);
Dries's avatar
 
Dries committed
795 796

  while ($topic = db_fetch_object($result)) {
Dries's avatar
Dries committed
797 798
    if ($user->uid) {
      // folder is new if topic is new or there are new comments since last visit
Dries's avatar
 
Dries committed
799
      if ($topic->tid != $tid) {
Dries's avatar
Dries committed
800
        $topic->new = 0;
Dries's avatar
 
Dries committed
801 802
      }
      else {
Dries's avatar
 
Dries committed
803
        $history = _forum_user_last_visit($topic->nid);
Dries's avatar
 
Dries committed
804
        $topic->new_replies = comment_num_new($topic->nid, $history);
805
        $topic->new = $topic->new_replies || ($topic->timestamp > $history);
Dries's avatar
 
Dries committed
806
      }
807 808
    }
    else {
809
      // Do not track "new replies" status for topics if the user is anonymous.
Dries's avatar
Dries committed
810 811
      $topic->new_replies = 0;
      $topic->new = 0;
812
    }
Dries's avatar
 
Dries committed
813

Dries's avatar
 
Dries committed
814
    if ($topic->num_comments > 0) {
815
      $last_reply = new StdClass();
Dries's avatar
 
Dries committed
816 817 818 819 820
      $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
821 822 823
    $topics[] = $topic;
  }

Dries's avatar
Dries committed
824
  return $topics;
Dries's avatar
 
Dries committed
825 826
}

Dries's avatar
 
Dries committed
827 828 829
/**
 * Finds the first unread node for a given forum.
 */
Dries's avatar
Dries committed
830
function _forum_new($tid) {
Dries's avatar
 
Dries committed
831 832
  global $user;

Dries's avatar
 
Dries committed
833
  $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";
834
  $sql = db_rewrite_sql($sql);
Dries's avatar
 
Dries committed
835
  $nid = db_result(db_query_range($sql, $user->uid, $tid, NODE_NEW_LIMIT, 0, 1));
Dries's avatar
 
Dries committed
836 837 838 839

  return $nid ? $nid : 0;
}

840
/**
Dries's avatar
Dries committed
841
 * Menu callback; prints a forum listing.
842
 */
Dries's avatar
Dries committed
843
function forum_page($tid = 0) {
844
  if (module_exists('taxonomy') && module_exists('comment')) {
Dries's avatar
Dries committed
845 846
    $forum_per_page = variable_get('forum_per_page', 25);
    $sortby = variable_get('forum_order', 1);
Dries's avatar
 
Dries committed
847

Dries's avatar
Dries committed
848 849 850 851
    $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
852
    }
Dries's avatar
Dries committed
853

Dries's avatar
 
Dries committed
854
    return theme('forum_display', $forums, $topics, $parents, $tid, $sortby, $forum_per_page);
Dries's avatar
 
Dries committed
855 856
  }
  else {
857 858
    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
859 860 861
  }
}

Dries's avatar
 
Dries committed
862
/**
Dries's avatar
 
Dries committed
863 864
 * Format the forum body.
 *
Dries's avatar
 
Dries committed
865
 * @ingroup themeable
Dries's avatar
 
Dries committed
866
 */
Dries's avatar
 
Dries committed
867
function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed
868
  global $user;
Dries's avatar
 
Dries committed
869
  // forum list, topics list, topic browser and 'add new topic' link
Dries's avatar
 
Dries committed
870

Dries's avatar
 
Dries committed
871
  $vocabulary = taxonomy_get_vocabulary(variable_get('forum_nav_vocabulary', ''));
872
  $title = $vocabulary->name;
Dries's avatar
 
Dries committed
873

Dries's avatar
 
Dries committed
874 875
  // Breadcrumb navigation:
  $breadcrumb = array();
Dries's avatar
 
Dries committed
876
  if ($tid) {
Dries's avatar
 
Dries committed
877
    $breadcrumb[] = array('path' => 'forum', 'title' => $title);
Dries's avatar
 
Dries committed
878
  }
Dries's avatar
 
Dries committed
879 880

  if ($parents) {
Dries's avatar
 
Dries committed
881 882
    $parents = array_reverse($parents);
    foreach ($parents as $p) {
883 884
      if ($p->tid == $tid) {
        $title = $p->name;
Dries's avatar
 
Dries committed
885 886
      }
      else {
Dries's avatar
 
Dries committed
887
        $breadcrumb[] = array('path' => 'forum/'. $p->tid, 'title' => $p->name);
Dries's avatar
 
Dries committed
888 889 890
      }
    }
  }
891 892 893

  drupal_set_title($title);

Dries's avatar
 
Dries committed
894 895
  $breadcrumb[] = array('path' => $_GET['q']);
  menu_set_location($breadcrumb);
Dries's avatar
 
Dries committed
896

Dries's avatar
 
Dries committed
897
  if (count($forums) || count($parents)) {
898 899
    $output  = '<div id="forum">';
    $output .= '<ul>';
Dries's avatar
 
Dries committed
900

901
    if (module_exists('tracker')) {
Dries's avatar
 
Dries committed