forum.module 40.7 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 26 27
      $output = '';
      $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. In a forum, users post topics and threads in nested hierarchies, allowing discussions to be categorized and grouped. The forum hierarchy consists of:') . '</p>';
      $output .= '<ul>';
      $output .= '<li>' . t('Optional containers (for example, <em>Support</em>), which can hold:') . '</li>';
      $output .= '<ul><li>' . t('Forums (for example, <em>Installing Drupal</em>), which can hold:') . '</li>';
      $output .= '<ul><li>' . t('Forum topics submitted by users (for example, <em>How to start a Drupal 6 Multisite</em>), which start discussions and are starting points for:') . '</li>';
      $output .= '<ul><li>' . t('Threaded comments submitted by users (for example, <em>You have these options...</em>).') . '</li>';
      $output .= '</ul>';
      $output .= '</ul>';
      $output .= '</ul>';
      $output .= '</ul>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@forum">Forum module</a>.', array('@forum' => 'http://drupal.org/handbook/modules/forum')) . '</p>';
28 29
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
30 31 32 33
      $output .= '<dt>' . t('Setting up forum structure') . '</dt>';
      $output .= '<dd>' . t('Visit the <a href="@forums">Forums page</a> to set up containers and forums to hold your discussion topics.', array('@forums' => url('admin/structure/forum'))) . '</dd>';
      $output .= '<dt>' . t('Starting a discussion') . '</dt>';
      $output .= '<dd>' . t('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.', array('@create-topic' => url('node/add/forum'), '@content-add' => url('node/add'))) . '</dd>';
34
      $output .= '<dt>' . t('Navigation') . '</dt>';
35
      $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">Forums page</a>.', array('@forums' => url('forum'))) . '</dd>';
36 37 38
      $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>';
39
      $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>Hidden</em> under <em>Comment settings</em> while editing a forum topic will hide all existing comments on the thread, and prevent new ones.') . '</dd>';
40
      $output .= '</dl>';
41
      return $output;
42
    case 'admin/structure/forum':
43
      return '<p>' . t('Forums contain forum topics. Use containers to group related forums.') . '</p>';
44
    case 'admin/structure/forum/add/container':
45
      return '<p>' . t('Use containers to group related forums.') . '</p>';
46
    case 'admin/structure/forum/add/forum':
47
      return '<p>' . t('A forum holds related forum topics.') . '</p>';
48
    case 'admin/structure/forum/settings':
49
      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
50 51 52
  }
}

53
/**
54
 * Implements hook_theme().
55 56 57
 */
function forum_theme() {
  return array(
58
    'forums' => array(
59
      'template' => 'forums',
60
      'variables' => array('forums' => NULL, 'topics' => NULL, 'parents' => NULL, 'tid' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),
61 62
    ),
    'forum_list' => array(
63
      'template' => 'forum-list',
64
      'variables' => array('forums' => NULL, 'parents' => NULL, 'tid' => NULL),
65 66
    ),
    'forum_topic_list' => array(
67
      'template' => 'forum-topic-list',
68
      'variables' => array('tid' => NULL, 'topics' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),
69 70
    ),
    'forum_icon' => array(
71
      'template' => 'forum-icon',
72
      'variables' => array('new_posts' => NULL, 'num_posts' => 0, 'comment_mode' => 0, 'sticky' => 0),
73
    ),
74
    'forum_submitted' => array(
75
      'template' => 'forum-submitted',
76
      'variables' => array('topic' => NULL),
77
    ),
78
    'forum_form' => array(
79
      'render element' => 'form',
80 81
      'file' => 'forum.admin.inc',
    ),
82 83 84
  );
}

85
/**
86
 * Implements hook_menu().
87
 */
88 89
function forum_menu() {
  $items['forum'] = array(
90
    'title' => 'Forums',
91 92
    'page callback' => 'forum_page',
    'access arguments' => array('access content'),
93
    'file' => 'forum.pages.inc',
94
  );
95
  $items['admin/structure/forum'] = array(
96
    'title' => 'Forums',
97
    'description' => 'Control forum hierarchy settings.',
98 99
    'page callback' => 'drupal_get_form',
    'page arguments' => array('forum_overview'),
100
    'access arguments' => array('administer forums'),
101
    'file' => 'forum.admin.inc',
102
  );
103
  $items['admin/structure/forum/list'] = array(
104
    'title' => 'List',
105 106 107
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
108
  $items['admin/structure/forum/add/container'] = array(
109
    'title' => 'Add container',
110 111
    'page callback' => 'forum_form_main',
    'page arguments' => array('container'),
112
    'access arguments' => array('administer forums'),
113
    'type' => MENU_LOCAL_ACTION,
114
    'parent' => 'admin/structure/forum',
115
    'file' => 'forum.admin.inc',
116
  );
117
  $items['admin/structure/forum/add/forum'] = array(
118
    'title' => 'Add forum',
119 120
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum'),
121
    'access arguments' => array('administer forums'),
122
    'type' => MENU_LOCAL_ACTION,
123
    'parent' => 'admin/structure/forum',
124
    'file' => 'forum.admin.inc',
125
  );
126
  $items['admin/structure/forum/settings'] = array(
127
    'title' => 'Settings',
128 129
    'page callback' => 'drupal_get_form',
    'page arguments' => array('forum_admin_settings'),
130
    'access arguments' => array('administer forums'),
131 132
    'weight' => 5,
    'type' => MENU_LOCAL_TASK,
133
    'parent' => 'admin/structure/forum',
134
    'file' => 'forum.admin.inc',
135
  );
136
  $items['admin/structure/forum/edit/container/%taxonomy_term'] = array(
137
    'title' => 'Edit container',
138
    'page callback' => 'forum_form_main',
139
    'page arguments' => array('container', 5),
140
    'access arguments' => array('administer forums'),
141
    'type' => MENU_CALLBACK,
142
    'file' => 'forum.admin.inc',
143
  );
144
  $items['admin/structure/forum/edit/forum/%taxonomy_term'] = array(
145
    'title' => 'Edit forum',
146 147
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum', 5),
148
    'access arguments' => array('administer forums'),
149
    'type' => MENU_CALLBACK,
150
    'file' => 'forum.admin.inc',
151 152 153
  );
  return $items;
}
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 196 197 198
/**
 * 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(
199
              'title' => t('<a href="@login">Log in</a> to post new content in the forum.', array(
200 201 202 203 204 205 206 207 208 209 210
                '@login' => url('user/login', array('query' => drupal_get_destination())),
              )),
              'localized_options' => array('html' => TRUE),
            ),
          );
        }
      }
      $data['actions']['output'] = array_merge($data['actions']['output'], $links);
    }
  }
}
211 212

/**
213
 * Implements hook_init().
214
 */
215
function forum_init() {
216
  drupal_add_css(drupal_get_path('module', 'forum') . '/forum.css');
217
}
218

219
/**
220 221 222 223
 * Check whether a content type can be used in a forum.
 *
 * @param $node
 *   A node object.
224
 *
225 226
 * @return
 *   Boolean indicating if the node can be assigned to a forum.
227
 */
228
function _forum_node_check_node_type($node) {
229
  // Fetch information about the forum field.
230
  $field = field_info_instance('node', 'taxonomy_forums', $node->type);
231

232
  return is_array($field);
233
}
234

235
/**
236
 * Implements hook_node_view().
237
 */
238
function forum_node_view($node, $view_mode) {
239
  $vid = variable_get('forum_nav_vocabulary', 0);
240
  $vocabulary = taxonomy_vocabulary_load($vid);
241
  if (_forum_node_check_node_type($node)) {
242
    if (node_is_page($node)) {
243 244 245
      // Breadcrumb navigation
      $breadcrumb[] = l(t('Home'), NULL);
      $breadcrumb[] = l($vocabulary->name, 'forum');
246
      if ($parents = taxonomy_get_parents_all($node->forum_tid)) {
247
        $parents = array_reverse($parents);
248 249
        foreach ($parents as $parent) {
          $breadcrumb[] = l($parent->name, 'forum/' . $parent->tid);
250 251 252
        }
      }
      drupal_set_breadcrumb($breadcrumb);
253

254 255 256
    }
  }
}
257

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

284
/**
285
 * Implements hook_node_presave().
286 287 288
 *
 * Assign forum taxonomy when adding a topic from within a forum.
 */
289
function forum_node_presave($node) {
290
  if (_forum_node_check_node_type($node)) {
291 292
    // Make sure all fields are set properly:
    $node->icon = !empty($node->icon) ? $node->icon : '';
293 294
    $langcode = array_shift(array_keys($node->taxonomy_forums));
    if (!empty($node->taxonomy_forums[$langcode])) {
295
      $node->forum_tid = $node->taxonomy_forums[$langcode][0]['tid'];
296
      $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();
297
      if ($old_tid && isset($node->forum_tid) && ($node->forum_tid != $old_tid) && !empty($node->shadow)) {
298
        // A shadow copy needs to be created. Retain new term and add old term.
299
        $node->taxonomy_forums[$langcode][] = array('tid' => $old_tid);
300 301 302 303
      }
    }
  }
}
304

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

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

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

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

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

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

432
/**
433
 * Implements hook_taxonomy_term_delete().
434
 */
435 436 437 438 439 440 441 442 443
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);
}
444

445
/**
446
 * Implements hook_comment_publish().
447 448 449 450 451 452 453 454 455
 *
 * 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);
}

/**
456
 * Implements hook_comment_update().
457 458 459 460 461 462 463 464 465 466 467 468 469
 *
 * 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);
  }
}

/**
470
 * Implements hook_comment_unpublish().
471 472 473 474 475 476
 */
function forum_comment_unpublish($comment) {
  _forum_update_forum_index($comment->nid);
}

/**
477
 * Implements hook_comment_delete().
478 479 480 481 482 483
 */
function forum_comment_delete($comment) {
  _forum_update_forum_index($comment->nid);
}

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

/**
507
 * Implements hook_field_storage_pre_update().
508
 */
509
function forum_field_storage_pre_update($entity_type, $entity, &$skip_fields) {
510 511
  $first_call = &drupal_static(__FUNCTION__, array());

512
  if ($entity_type == 'node' && $entity->status && _forum_node_check_node_type($entity)) {
513 514 515
    // 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.
516 517 518
    if (!isset($first_call[$entity->nid])) {
      $first_call[$entity->nid] = FALSE;
      db_delete('forum_index')->condition('nid', $entity->nid)->execute();
519 520
    }
    // Only save data to the table if the node is published.
521
    if ($entity->status) {
522
      $query = db_insert('forum_index')->fields(array('nid', 'title', 'tid', 'sticky', 'created', 'comment_count', 'last_comment_timestamp'));
523
      foreach ($entity->taxonomy_forums as $language) {
524
        foreach ($language as $item) {
525
          $query->values(array(
526 527
            'nid' => $entity->nid,
            'title' => $entity->title,
528
            'tid' => $item['tid'],
529 530
            'sticky' => $entity->sticky,
            'created' => $entity->created,
531
            'comment_count' => 0,
532
            'last_comment_timestamp' => $entity->created,
533
          ));
534
        }
535 536 537 538
      }
      $query->execute();
      // The logic for determining last_comment_count is fairly complex, so
      // call _forum_update_forum_index() too.
539
      _forum_update_forum_index($entity->nid);
Dries's avatar
 
Dries committed
540
    }
541 542
  }
}
Dries's avatar
 
Dries committed
543

544
/**
545
 * Implements hook_form_alter().
546
 */
547
function forum_form_alter(&$form, $form_state, $form_id) {
548
  $vid = variable_get('forum_nav_vocabulary', 0);
549 550 551
  if (isset($form['vid']) && $form['vid']['#value'] == $vid) {
    // Hide critical options from forum vocabulary.
    if ($form_id == 'taxonomy_form_vocabulary') {
552
      $form['help_forum_vocab'] = array(
553
        '#markup' => t('This is the designated forum vocabulary. Some of the normal vocabulary options have been removed.'),
554 555 556
        '#weight' => -1,
      );
      $form['hierarchy'] = array('#type' => 'value', '#value' => 1);
557
      $form['delete']['#access'] = FALSE;
558
    }
559 560 561
    // Hide multiple parents select from forum terms.
    elseif ($form_id == 'taxonomy_form_term') {
      $form['advanced']['parent']['#access'] = FALSE;
562
    }
563
  }
564
  if ($form_id == 'forum_node_form') {
565
    $langcode = $form['taxonomy_forums']['#language'];
566
    // Make the vocabulary required for 'real' forum-nodes.
567 568
    $form['taxonomy_forums'][$langcode]['#required'] = TRUE;
    $form['taxonomy_forums'][$langcode]['#multiple'] = FALSE;
569 570 571 572 573 574 575
    if (empty($form['taxonomy_forums'][$langcode]['#default_value'])) {
      // If there is no default forum already selected, try to get the forum
      // ID from the URL (e.g., if we are on a page like node/add/forum/3, we
      // expect "3" to be the ID of the forum that was requested).
      $requested_forum_id = arg(3);
      $form['taxonomy_forums'][$langcode]['#default_value'] = is_numeric($requested_forum_id) ? $requested_forum_id : NULL;
    }
576
  }
577 578
}

579
/**
580
 * Implements hook_block_info().
581
 */
582
function forum_block_info() {
583 584 585 586 587 588 589 590
  $blocks['active'] = array(
    'info' => t('Active forum topics'),
    'cache' => DRUPAL_CACHE_CUSTOM,
  );
  $blocks['new'] = array(
    'info' => t('New forum topics'),
    'cache' => DRUPAL_CACHE_CUSTOM,
  );
591 592 593 594
  return $blocks;
}

/**
595
 * Implements hook_block_configure().
596 597 598 599 600 601 602
 */
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;
}

/**
603
 * Implements hook_block_save().
604 605 606 607 608 609
 */
function forum_block_save($delta = '', $edit = array()) {
  variable_set('forum_block_num_' . $delta, $edit['forum_block_num_' . $delta]);
}

/**
610
 * Implements hook_block_view().
611 612 613 614
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
615
function forum_block_view($delta = '') {
616 617
  $query = db_select('forum_index', 'f')
    ->fields('f')
618 619 620 621 622
    ->addTag('node_access');
  switch ($delta) {
    case 'active':
      $title = t('Active forum topics');
      $query
623
        ->orderBy('f.last_comment_timestamp', 'DESC')
624 625 626 627 628 629
        ->range(0, variable_get('forum_block_num_active', '5'));
      break;

    case 'new':
      $title = t('New forum topics');
      $query
630
        ->orderBy('f.created', 'DESC')
631 632 633
        ->range(0, variable_get('forum_block_num_new', '5'));
      break;
  }
Dries's avatar
 
Dries committed
634

635
  $block['subject'] = $title;
636 637 638
  // Cache based on the altered query. Enables us to cache with node access enabled.
  $block['content'] = drupal_render_cache_by_query($query, 'forum_block_view');
  $block['content']['#access'] = user_access('access content');
639
  return $block;
640
}
641

642 643 644 645 646 647 648 649 650 651 652 653
/**
* 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);
654
    $elements['forum_more'] = array('#markup' => theme('more_link', array('url' => url('forum'), 'title' => t('Read the latest forum topics.'))));
655
  }
656
  return $elements;
Dries's avatar
 
Dries committed
657 658
}

659
/**
660
 * Implements hook_form().
661
 */
662
function forum_form($node, $form_state) {
663
  $type = node_type_get_type($node);
664 665 666 667 668 669
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => check_plain($type->title_label),
    '#default_value' => !empty($node->title) ? $node->title : '',
    '#required' => TRUE, '#weight' => -5
  );
670

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

679
  return $form;
Dries's avatar
 
Dries committed
680 681
}

682
/**
683
 * Implements hook_url_outbound_alter().
684
 */
685 686 687 688 689 690 691
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];
    }
  }
692 693
}

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

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

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

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

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

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

747 748
    $query = db_select('node', 'n');
    $query->join('users', 'u1', 'n.uid = u1.uid');
749
    $query->join('forum', 'f', 'n.vid = f.vid AND f.tid = :tid', array(':tid' => $forum->tid));
750 751 752
    $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');
753

754 755 756 757 758 759 760 761
    $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();
762

763
    $last_post = new stdClass();
764
    if (!empty($topic->last_comment_timestamp)) {
765
      $last_post->created = $topic->last_comment_timestamp;