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

Dries's avatar
 
Dries committed
4 5
/**
 * @file
6
 * Provides discussion forums.
Dries's avatar
 
Dries committed
7 8
 */

9
/**
10
 * Implements hook_help().
11
 */
12 13
function forum_help($path, $arg) {
  switch ($path) {
14
    case 'admin/help#forum':
15 16 17 18 19 20 21 22 23 24 25
      $output = '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Forum module lets you create threaded discussion forums with functionality similar to other message board systems. Forums are useful because they allow community members to discuss topics with one another while ensuring those conversations are archived for later reference. Forums behave by posting topics and threads in nested hierarchies, which allow many discussions to be categorized in various ways. The <a href="@create-topic">forum topic</a> link on the <a href="@content-add">Add new content</a> page creates the first post of a new threaded discussion, or thread. For more information, see the online handbook entry for <a href="@forum">Forum module</a>.', array('@create-topic' => url('node/add/forum'), '@content-add' => url('node/add'), '@forum' => 'http://drupal.org/handbook/modules/forum/')) . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Navigation') . '</dt>';
      $output .= '<dd>' . t('Enabling the Forum module provides a default <em>Forums</em> menu item in the navigation menu that links to the <a href="@forums">main forums page</a>.', array('@forums' => url('forum'))) . '</dd>';
      $output .= '<dt>' . t('Moving forum topics') . '</dt>';
      $output .= '<dd>' . t('A forum topic (and all of its comments) may be moved between forums by selecting a different forum while editing a forum topic. When moving a forum topic between forums, the <em>Leave shadow copy</em> option creates a link in the original forum pointing to the new location.') . '</dd>';
      $output .= '<dt>' . t('Locking and disabling comments') . '</dt>';
      $output .= '<dd>' . t('Selecting <em>Closed</em> under <em>Comment settings</em> while editing a forum topic will lock (prevent new comments on) the thread. Selecting <em>Disabled</em> under <em>Comment settings</em> while editing a forum topic will hide all existing comments on the thread, and prevent new ones.') . '</dd>';
      $output .= '</dl>';
26
      return $output;
27
    case 'admin/structure/forum':
28
      return '<p>' . t('Forums contain forum topics. Use containers to group related forums.') . '</p>';
29
    case 'admin/structure/forum/add/container':
30
      return '<p>' . t('Use containers to group related forums.') . '</p>';
31
    case 'admin/structure/forum/add/forum':
32
      return '<p>' . t('A forum holds related forum topics.') . '</p>';
33
    case 'admin/structure/forum/settings':
34
      return '<p>' . t('Adjust the display of your forum topics. Organize the forums on the <a href="@forum-structure">forum structure page</a>.', array('@forum-structure' => url('admin/structure/forum'))) . '</p>';
Dries's avatar
 
Dries committed
35 36 37
  }
}

38
/**
39
 * Implements hook_theme().
40 41 42
 */
function forum_theme() {
  return array(
43
    'forums' => array(
44
      'template' => 'forums',
45
      'variables' => array('forums' => NULL, 'topics' => NULL, 'parents' => NULL, 'tid' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),
46 47
    ),
    'forum_list' => array(
48
      'template' => 'forum-list',
49
      'variables' => array('forums' => NULL, 'parents' => NULL, 'tid' => NULL),
50 51
    ),
    'forum_topic_list' => array(
52
      'template' => 'forum-topic-list',
53
      'variables' => array('tid' => NULL, 'topics' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),
54 55
    ),
    'forum_icon' => array(
56
      'template' => 'forum-icon',
57
      'variables' => array('new_posts' => NULL, 'num_posts' => 0, 'comment_mode' => 0, 'sticky' => 0),
58
    ),
59
    'forum_submitted' => array(
60
      'template' => 'forum-submitted',
61
      'variables' => array('topic' => NULL),
62
    ),
63
    'forum_form' => array(
64
      'render element' => 'form',
65 66
      'file' => 'forum.admin.inc',
    ),
67 68 69
  );
}

70
/**
71
 * Implements hook_menu().
72
 */
73 74
function forum_menu() {
  $items['forum'] = array(
75
    'title' => 'Forums',
76 77
    'page callback' => 'forum_page',
    'access arguments' => array('access content'),
78
    'file' => 'forum.pages.inc',
79
  );
80
  $items['admin/structure/forum'] = array(
81
    'title' => 'Forums',
82
    'description' => 'Control forum hierarchy settings.',
83 84
    'page callback' => 'drupal_get_form',
    'page arguments' => array('forum_overview'),
85
    'access arguments' => array('administer forums'),
86
    'file' => 'forum.admin.inc',
87
  );
88
  $items['admin/structure/forum/list'] = array(
89
    'title' => 'List',
90 91 92
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
93
  $items['admin/structure/forum/add/container'] = array(
94
    'title' => 'Add container',
95 96
    'page callback' => 'forum_form_main',
    'page arguments' => array('container'),
97
    'access arguments' => array('administer forums'),
98
    'type' => MENU_LOCAL_ACTION,
99
    'parent' => 'admin/structure/forum',
100
    'file' => 'forum.admin.inc',
101
  );
102
  $items['admin/structure/forum/add/forum'] = array(
103
    'title' => 'Add forum',
104 105
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum'),
106
    'access arguments' => array('administer forums'),
107
    'type' => MENU_LOCAL_ACTION,
108
    'parent' => 'admin/structure/forum',
109
    'file' => 'forum.admin.inc',
110
  );
111
  $items['admin/structure/forum/settings'] = array(
112
    'title' => 'Settings',
113 114
    'page callback' => 'drupal_get_form',
    'page arguments' => array('forum_admin_settings'),
115
    'access arguments' => array('administer forums'),
116 117
    'weight' => 5,
    'type' => MENU_LOCAL_TASK,
118
    'parent' => 'admin/structure/forum',
119
    'file' => 'forum.admin.inc',
120
  );
121
  $items['admin/structure/forum/edit/container/%taxonomy_term'] = array(
122
    'title' => 'Edit container',
123
    'page callback' => 'forum_form_main',
124
    'page arguments' => array('container', 5),
125
    'access arguments' => array('administer forums'),
126
    'type' => MENU_CALLBACK,
127
    'file' => 'forum.admin.inc',
128
  );
129
  $items['admin/structure/forum/edit/forum/%taxonomy_term'] = array(
130
    'title' => 'Edit forum',
131 132
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum', 5),
133
    'access arguments' => array('administer forums'),
134
    'type' => MENU_CALLBACK,
135
    'file' => 'forum.admin.inc',
136 137 138
  );
  return $items;
}
139

140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
/**
 * Implements hook_menu_local_tasks_alter().
 */
function forum_menu_local_tasks_alter(&$data, $router_item, $root_path) {
  global $user;

  // Add action link to 'node/add/forum' on 'forum' page.
  if ($root_path == 'forum') {
    $tid = (isset($router_item['page_arguments'][0]) ? $router_item['page_arguments'][0] : 0);
    $forums = forum_get_forums($tid);
    $parents = taxonomy_get_parents_all($tid);
    if ($forums || $parents) {
      $vid = variable_get('forum_nav_vocabulary', 0);
      $vocabulary = taxonomy_vocabulary_load($vid);

      $links = array();
      // Loop through all bundles for forum taxonomy vocabulary field.
      $field = field_info_field('taxonomy_' . $vocabulary->machine_name);
      foreach ($field['bundles']['node'] as $type) {
        if (node_access('create', $type)) {
          $links[$type] = array(
            '#theme' => 'menu_local_action',
            '#link' => array(
              'title' => t('Add new @node_type', array('@node_type' => node_type_get_name($type))),
              'href' => 'node/add/' . str_replace('_', '-', $type) . '/' . $tid,
            ),
          );
        }
      }
      if (empty($links)) {
        // Authenticated user does not have access to create new topics.
        if ($user->uid) {
          $links['disallowed'] = array(
            '#theme' => 'menu_local_action',
            '#link' => array(
              'title' => t('You are not allowed to post new content in the forum.'),
            ),
          );
        }
        // Anonymous user does not have access to create new topics.
        else {
          $links['login'] = array(
            '#theme' => 'menu_local_action',
            '#link' => array(
              'title' => t('<a href="@login">Login</a> to post new content in the forum.', array(
                '@login' => url('user/login', array('query' => drupal_get_destination())),
              )),
              'localized_options' => array('html' => TRUE),
            ),
          );
        }
      }
      $data['actions']['output'] = array_merge($data['actions']['output'], $links);
    }
  }
}
196 197

/**
198
 * Implements hook_init().
199
 */
200
function forum_init() {
201
  drupal_add_css(drupal_get_path('module', 'forum') . '/forum.css');
202
}
203

204
/**
205 206 207 208
 * Check whether a content type can be used in a forum.
 *
 * @param $node
 *   A node object.
209
 *
210 211
 * @return
 *   Boolean indicating if the node can be assigned to a forum.
212
 */
213
function _forum_node_check_node_type($node) {
214
  // Fetch information about the forum field.
215
  $field = field_info_instance('node', 'taxonomy_forums', $node->type);
216

217
  return is_array($field);
218
}
219

220
/**
221
 * Implements hook_node_view().
222
 */
223
function forum_node_view($node, $build_mode) {
224
  $vid = variable_get('forum_nav_vocabulary', 0);
225
  $vocabulary = taxonomy_vocabulary_load($vid);
226 227
  if (_forum_node_check_node_type($node)) {
    if ((bool)menu_get_object()) {
228 229 230
      // Breadcrumb navigation
      $breadcrumb[] = l(t('Home'), NULL);
      $breadcrumb[] = l($vocabulary->name, 'forum');
231
      if ($parents = taxonomy_get_parents_all($node->forum_tid)) {
232
        $parents = array_reverse($parents);
233 234
        foreach ($parents as $parent) {
          $breadcrumb[] = l($parent->name, 'forum/' . $parent->tid);
235 236 237
        }
      }
      drupal_set_breadcrumb($breadcrumb);
238

239 240 241
    }
  }
}
242

243
/**
244
 * Implements hook_node_prepare().
245
 */
246
function forum_node_prepare($node) {
247
  if (_forum_node_check_node_type($node)) {
248 249
    if (empty($node->nid)) {
      // New topic
250
      $node->taxonomy_forums[0]['tid'] =  arg(3);
251 252 253 254 255
    }
  }
}

/**
256
 * Implements hook_node_validate().
257
 *
258 259
 * Check in particular that only a "leaf" term in the associated taxonomy.
 */
260
function forum_node_validate($node, $form) {
261 262
  if (_forum_node_check_node_type($node)) {
    $langcode = $form['taxonomy_forums']['#language'];
263
    // vocabulary is selected, not a "container" term.
264
    if (!empty($node->taxonomy_forums[$langcode])) {
265 266
      // Extract the node's proper topic ID.
      $containers = variable_get('forum_containers', array());
267 268
      foreach ($node->taxonomy_forums[$langcode] as $item) {
        $term = taxonomy_term_load($item['tid']);
269 270 271
        $used = db_query_range('SELECT 1 FROM {taxonomy_term_data} WHERE tid = :tid AND vid = :vid',0 , 1, array(
          ':tid' => $term->tid,
          ':vid' => $term->vid,
272
        ))->fetchField();
273
        if ($used && in_array($term->tid, $containers)) {
274
          form_set_error('taxonomy_forums', t('The item %forum is only a forum container. Select one of the forums below it.', array('%forum' => $term->name)));
275 276
        }
      }
277 278 279
    }
  }
}
280

281
/**
282
 * Implements hook_node_presave().
283 284 285
 *
 * Assign forum taxonomy when adding a topic from within a forum.
 */
286
function forum_node_presave($node) {
287
  if (_forum_node_check_node_type($node)) {
288 289
    // Make sure all fields are set properly:
    $node->icon = !empty($node->icon) ? $node->icon : '';
290 291
    $langcode = array_shift(array_keys($node->taxonomy_forums));
    if (!empty($node->taxonomy_forums[$langcode])) {
292
      $node->forum_tid = $node->taxonomy_forums[$langcode][0]['tid'];
293
      $old_tid = db_query_range("SELECT f.tid FROM {forum} f INNER JOIN {node} n ON f.vid = n.vid WHERE n.nid = :nid ORDER BY f.vid DESC", 0, 1, array(':nid' => $node->nid))->fetchField();
294
      if ($old_tid && isset($node->forum_tid) && ($node->forum_tid != $old_tid) && !empty($node->shadow)) {
295
        // A shadow copy needs to be created. Retain new term and add old term.
296
        $node->taxonomy_forums[$langcode][] = array('tid' => $old_tid);
297 298 299 300
      }
    }
  }
}
301

302
/**
303
 * Implements hook_node_update().
304
 */
305
function forum_node_update($node) {
306
  if (_forum_node_check_node_type($node)) {
307
    if (empty($node->revision) && db_query('SELECT tid FROM {forum} WHERE nid=:nid', array(':nid' => $node->nid))->fetchField()) {
308
      if (!empty($node->forum_tid)) {
309
        db_update('forum')
310
          ->fields(array('tid' => $node->forum_tid))
311 312
          ->condition('vid', $node->vid)
          ->execute();
313 314 315
      }
      // The node is removed from the forum.
      else {
316 317 318
        db_delete('forum')
          ->condition('nid', $node->nid)
          ->execute();
319 320 321
      }
    }
    else {
322
      if (!empty($node->forum_tid)) {
323 324
        db_insert('forum')
          ->fields(array(
325
            'tid' => $node->forum_tid,
326 327 328 329
            'vid' => $node->vid,
            'nid' => $node->nid,
          ))
          ->execute();
330
      }
331
    }
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
    // If the node has a shadow forum topic, update the record for this
    // revision.
    if ($node->shadow) {
      db_delete('forum')
        ->condition('nid', $node->nid)
        ->condition('vid', $node->vid)
        ->execute();
      db_insert('forum')
        ->fields(array(
          'nid' => $node->nid,
          'vid' => $node->vid,
          'tid' => $node->forum_tid,
        ))
        ->execute();
     }
347 348
  }
}
349

350
/**
351
 * Implements hook_node_insert().
352
 */
353
function forum_node_insert($node) {
354 355
  if (_forum_node_check_node_type($node)) {
    if (!empty($node->forum_tid)) {
356 357
      $nid = db_insert('forum')
        ->fields(array(
358
          'tid' => $node->forum_tid,
359 360 361 362
          'vid' => $node->vid,
          'nid' => $node->nid,
        ))
        ->execute();
363 364 365
    }
  }
}
366

367
/**
368
 * Implements hook_node_delete().
369
 */
370
function forum_node_delete($node) {
371
  if (_forum_node_check_node_type($node)) {
372 373 374
    db_delete('forum')
      ->condition('nid', $node->nid)
      ->execute();
375 376 377
    db_delete('forum_index')
      ->condition('nid', $node->nid)
      ->execute();
378
  }
379
}
380

381
/**
382
 * Implements hook_node_load().
383
 */
384
function forum_node_load($nodes) {
385 386
  $node_vids = array();
  foreach ($nodes as $node) {
387
    if (_forum_node_check_node_type($node)) {
388 389 390 391
      $node_vids[] = $node->vid;
    }
  }
  if (!empty($node_vids)) {
392 393 394 395 396
    $query = db_select('forum', 'f');
    $query
      ->fields('f', array('nid', 'tid'))
      ->condition('f.vid', $node_vids);
    $result = $query->execute();
397 398 399
    foreach ($result as $record) {
      $nodes[$record->nid]->forum_tid = $record->tid;
    }
400
  }
401 402
}

403
/**
404
 * Implements hook_node_info().
405
 */
406
function forum_node_info() {
407 408
  return array(
    'forum' => array(
409
      'name' => t('Forum topic'),
410
      'base' => 'forum',
411
      'description' => t('A <em>forum topic</em> starts a new discussion thread within a forum.'),
412 413 414
      'title_label' => t('Subject'),
    )
  );
Dries's avatar
 
Dries committed
415 416
}

417
/**
418
 * Implements hook_permission().
419
 */
420
function forum_permission() {
421
  $perms = array(
422 423 424
    'administer forums' => array(
      'title' => t('Administer forums'),
    ),
425 426
  );
  return $perms;
Dries's avatar
 
Dries committed
427
}
Dries's avatar
 
Dries committed
428

429
/**
430
 * Implements hook_taxonomy().
431
 */
432 433 434 435 436 437 438 439 440
function forum_taxonomy_term_delete($tid) {
  // For containers, remove the tid from the forum_containers variable.
  $containers = variable_get('forum_containers', array());
  $key = array_search($tid, $containers);
  if ($key !== FALSE) {
    unset($containers[$key]);
  }
  variable_set('forum_containers', $containers);
}
441

442
/**
443
 * Implements hook_comment_publish().
444 445 446 447 448 449 450 451 452
 *
 * This actually handles the insert and update of published nodes since
 * comment_save() calls hook_comment_publish() for all published comments.
 */
function forum_comment_publish($comment) {
  _forum_update_forum_index($comment->nid);
}

/**
453
 * Implements hook_comment_update().
454 455 456 457 458 459 460 461 462 463 464 465 466
 *
 * Comment module doesn't call hook_comment_unpublish() when saving individual
 * comments so we need to check for those here.
 */
function forum_comment_update($comment) {
  // comment_save() calls hook_comment_publish() for all published comments
  // so we to handle all other values here.
  if (!$comment->status) {
    _forum_update_forum_index($comment->nid);
  }
}

/**
467
 * Implements hook_comment_unpublish().
468 469 470 471 472 473
 */
function forum_comment_unpublish($comment) {
  _forum_update_forum_index($comment->nid);
}

/**
474
 * Implements hook_comment_delete().
475 476 477 478 479 480
 */
function forum_comment_delete($comment) {
  _forum_update_forum_index($comment->nid);
}

/**
481
 * Implements hook_field_storage_pre_insert().
482
 */
483
function forum_field_storage_pre_insert($obj_type, $object, &$skip_fields) {
484 485 486
  if ($obj_type == 'node' && $object->status && _forum_node_check_node_type($object)) {
    $query = db_insert('forum_index')->fields(array('nid', 'title', 'tid', 'sticky', 'created', 'comment_count', 'last_comment_timestamp'));
    foreach ($object->taxonomy_forums as $language) {
487
      foreach ($language as $item) {
488 489
        $query->values(array(
          'nid' => $object->nid,
490
          'title' => $object->title[LANGUAGE_NONE][0]['value'],
491
          'tid' => $item['tid'],
492 493 494 495 496 497 498 499 500 501 502 503
          'sticky' => $object->sticky,
          'created' => $object->created,
          'comment_count' => 0,
          'last_comment_timestamp' => $object->created,
        ));
      }
    }
    $query->execute();
  }
}

/**
504
 * Implements hook_field_storage_pre_update().
505
 */
506
function forum_field_storage_pre_update($obj_type, $object, &$skip_fields) {
507 508 509 510 511 512 513 514 515 516 517 518 519 520
  $first_call = &drupal_static(__FUNCTION__, array());

  if ($obj_type == 'node' && $object->status && _forum_node_check_node_type($object)) {
    // We don't maintain data for old revisions, so clear all previous values
    // from the table. Since this hook runs once per field, per object, make
    // sure we only wipe values once.
    if (!isset($first_call[$object->nid])) {
      $first_call[$object->nid] = FALSE;
      db_delete('forum_index')->condition('nid', $object->nid)->execute();
    }
    // Only save data to the table if the node is published.
    if ($object->status) {
      $query = db_insert('forum_index')->fields(array('nid', 'title', 'tid', 'sticky', 'created', 'comment_count', 'last_comment_timestamp'));
      foreach ($object->taxonomy_forums as $language) {
521
        foreach ($language as $item) {
522 523
          $query->values(array(
            'nid' => $object->nid,
524
            'title' => $object->title[LANGUAGE_NONE][0]['value'],
525
            'tid' => $item['tid'],
526 527 528 529 530
            'sticky' => $object->sticky,
            'created' => $object->created,
            'comment_count' => 0,
            'last_comment_timestamp' => $object->created,
          ));
531
        }
532 533 534 535 536
      }
      $query->execute();
      // The logic for determining last_comment_count is fairly complex, so
      // call _forum_update_forum_index() too.
      _forum_update_forum_index($object->nid);
Dries's avatar
 
Dries committed
537
    }
538 539
  }
}
Dries's avatar
 
Dries committed
540

541
/**
542
 * Implements hook_form_alter().
543
 */
544
function forum_form_alter(&$form, $form_state, $form_id) {
545
  $vid = variable_get('forum_nav_vocabulary', 0);
546 547 548
  if (isset($form['vid']) && $form['vid']['#value'] == $vid) {
    // Hide critical options from forum vocabulary.
    if ($form_id == 'taxonomy_form_vocabulary') {
549
      $form['help_forum_vocab'] = array(
550
        '#markup' => t('This is the designated forum vocabulary. Some of the normal vocabulary options have been removed.'),
551 552 553
        '#weight' => -1,
      );
      $form['hierarchy'] = array('#type' => 'value', '#value' => 1);
554
      $form['delete']['#access'] = FALSE;
555
    }
556 557 558
    // Hide multiple parents select from forum terms.
    elseif ($form_id == 'taxonomy_form_term') {
      $form['advanced']['parent']['#access'] = FALSE;
559
    }
560
  }
561
  if ($form_id == 'forum_node_form') {
562
    $langcode = $form['taxonomy_forums']['#language'];
563
    // Make the vocabulary required for 'real' forum-nodes.
564 565
    $form['taxonomy_forums'][$langcode]['#required'] = TRUE;
    $form['taxonomy_forums'][$langcode]['#multiple'] = FALSE;
566
  }
567 568
}

569
/**
570
 * Implements hook_block_info().
571
 */
572
function forum_block_info() {
573 574 575 576 577 578 579 580
  $blocks['active'] = array(
    'info' => t('Active forum topics'),
    'cache' => DRUPAL_CACHE_CUSTOM,
  );
  $blocks['new'] = array(
    'info' => t('New forum topics'),
    'cache' => DRUPAL_CACHE_CUSTOM,
  );
581 582 583 584
  return $blocks;
}

/**
585
 * Implements hook_block_configure().
586 587 588 589 590 591 592
 */
function forum_block_configure($delta = '') {
  $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)));
  return $form;
}

/**
593
 * Implements hook_block_save().
594 595 596 597 598 599
 */
function forum_block_save($delta = '', $edit = array()) {
  variable_set('forum_block_num_' . $delta, $edit['forum_block_num_' . $delta]);
}

/**
600
 * Implements hook_block_view().
601 602 603 604
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
605
function forum_block_view($delta = '') {
606 607
  $query = db_select('forum_index', 'f')
    ->fields('f')
608 609 610 611 612
    ->addTag('node_access');
  switch ($delta) {
    case 'active':
      $title = t('Active forum topics');
      $query
613
        ->orderBy('f.last_comment_timestamp', 'DESC')
614 615 616 617 618 619
        ->range(0, variable_get('forum_block_num_active', '5'));
      break;

    case 'new':
      $title = t('New forum topics');
      $query
620
        ->orderBy('f.created', 'DESC')
621 622 623
        ->range(0, variable_get('forum_block_num_new', '5'));
      break;
  }
Dries's avatar
 
Dries committed
624

625 626 627 628 629 630 631
  $cache_keys = array_merge(array('forum', $delta), drupal_render_cid_parts());
  // Cache based on the altered query. Enables us to cache with node access enabled.
  $query->preExecute();
  $cache_keys[] = md5(serialize(array((string) $query, $query->getArguments())));

  $block['subject'] = $title;
  $block['content'] = array(
632 633 634 635 636 637 638
     '#access' => user_access('access content'),
     '#pre_render' => array('forum_block_view_pre_render'),
     '#cache' => array(
        'keys' => $cache_keys,
        'expire' => CACHE_TEMPORARY,
     ),
     '#query' => $query,
639 640
  );
  return $block;
641
}
642

643 644 645 646 647 648 649 650 651 652 653 654
/**
* A #pre_render callback. Lists nodes based on the element's #query property.
*
* @see forum_block_view().
*
* @return
*   A renderable array.
*/
function forum_block_view_pre_render($elements) {
  $result = $elements['#query']->execute();
  if ($node_title_list = node_title_list($result)) {
    $elements['forum_list'] = array('#markup' => $node_title_list);
655
    $elements['forum_more'] = array('#markup' => theme('more_link', array('url' => url('forum'), 'title' => t('Read the latest forum topics.'))));
656
  }
657
  return $elements;
Dries's avatar
 
Dries committed
658 659
}

660
/**
661
 * Implements hook_form().
662
 */
663
function forum_form($node, $form_state) {
664
  $type = node_type_get_type($node);
665

666
  if (!empty($node->nid)) {
667 668
    $forum_terms = $node->taxonomy_forums;
    // If editing, give option to leave shadows
669
    $shadow = (count($forum_terms) > 1);
670
    $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.'));
671
    $form['forum_tid'] = array('#type' => 'value', '#value' => $node->forum_tid);
Dries's avatar
Dries committed
672
  }
Dries's avatar
 
Dries committed
673

674 675 676
  $form['#submit'][] = 'forum_submit';
  // Assign the forum topic submit handler.

677
  return $form;
Dries's avatar
 
Dries committed
678 679
}

680
/**
681
 * Implements hook_url_outbound_alter().
682
 */
683 684 685 686 687 688 689
function forum_url_outbound_alter(&$path, &$options, $original_path) {
  if (preg_match('!^taxonomy/term/(\d+)!', $path, $matches)) {
    $term = taxonomy_term_load($matches[1]);
    if ($term && $term->vocabulary_machine_name == 'forums') {
      $path = 'forum/' . $matches[1];
    }
  }
690 691
}

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

  if (isset($cache[$tid])) {
    return $cache[$tid];
  }
711

Dries's avatar
 
Dries committed
712
  $forums = array();
713
  $vid = variable_get('forum_nav_vocabulary', 0);
714
  $_forums = taxonomy_get_tree($vid, $tid);
Dries's avatar
 
Dries committed
715

Dries's avatar
 
Dries committed
716
  if (count($_forums)) {
717 718
    $query = db_select('node', 'n');
    $query->join('node_comment_statistics', 'ncs', 'n.nid = ncs.nid');
719
    $query->join('forum', 'f', 'n.vid = f.vid');
720 721 722
    $query->addExpression('COUNT(n.nid)', 'topic_count');
    $query->addExpression('SUM(ncs.comment_count)', 'comment_count');
    $counts = $query
723
      ->fields('f', array('tid'))
724 725 726 727 728
      ->condition('status', 1)
      ->groupBy('tid')
      ->addTag('node_access')
      ->execute()
      ->fetchAllAssoc('tid');
Dries's avatar
 
Dries committed
729
  }
Dries's avatar
 
Dries committed
730

Dries's avatar
 
Dries committed
731 732 733 734
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
735

736
    if (!empty($counts[$forum->tid])) {
Dries's avatar
 
Dries committed
737 738 739 740 741 742 743 744
      $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;
    }

745 746
    $query = db_select('node', 'n');
    $query->join('users', 'u1', 'n.uid = u1.uid');
747
    $query->join('forum', 'f', 'n.vid = f.vid AND f.tid = :tid', array(':tid' => $forum->tid));
748 749 750
    $query->join('node_comment_statistics', 'ncs', 'n.nid = ncs.nid');
    $query->join('users', 'u2', 'ncs.last_comment_uid = u2.uid');
    $query->addExpression('IF (ncs.last_comment_uid != 0, u2.name, ncs.last_comment_name)', 'last_comment_name');
751

752 753 754 755 756 757 758 759
    $topic = $query
      ->fields('ncs', array('last_comment_timestamp', 'last_comment_uid'))
      ->condition('n.status', 1)
      ->orderBy('last_comment_timestamp', 'DESC')
      ->range(0, 1)
      ->addTag('node_access')
      ->execute()
      ->fetchObject();
760

761
    $last_post = new stdClass();
762
    if (!empty($topic->last_comment_timestamp)) {
763
      $last_post->created = $topic->last_comment_timestamp;
764 765 766
      $last_post->name = $topic->last_comment_name;
      $last_post->uid = $topic->last_comment_uid;
    }
Dries's avatar
 
Dries committed
767
    $forum->last_post = $last_post;
Dries's avatar
 
Dries committed
768

Dries's avatar
 
Dries committed
769 770 771
    $forums[$forum->tid] = $forum;
  }

772 773
  $cache[$tid] = $forums;

Dries's avatar
 
Dries committed
774
  return $forums;
Dries's avatar
 
Dries committed
775 776
}

777 778 779 780 781
/**
 * Calculate the number of nodes the user has not yet read and are newer
 * than NODE_NEW_LIMIT.
 */
function _forum_topics_unread($term, $uid) {
782
  $query = db_select('node', 'n');
783
  $query->join('forum', 'f', 'n.vid = f.vid AND f.tid = :tid', array(':tid' => $term));
784 785 786 787 788 789 790 791 792
  $query->join('history', 'h', 'n.nid = h.nid AND h.uid = :uid', array(':uid' => $uid));
  $query->addExpression('COUNT(n.nid)', 'count');
  return $query
    ->condition('status', 1)
    ->condition('n.created', NODE_NEW_LIMIT, '>')
    ->isNull('h.nid')
    ->addTag('node_access')
    ->execute()
    ->fetchField();
Dries's avatar
 
Dries committed
793 794
}

Dries's avatar
Dries committed
795
function forum_get_topics($tid, $sortby, $forum_per_page) {
Dries's avatar
 
Dries committed