forum.module 41.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 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 44 45
      $output = '<p>' . t('Forums contain forum topics. Use containers to group related forums.') . '</p>';
      $output .= theme('more_help_link', array('url' => url('admin/help/forum')));
      return $output;
46
    case 'admin/structure/forum/add/container':
47
      return '<p>' . t('Use containers to group related forums.') . '</p>';
48
    case 'admin/structure/forum/add/forum':
49
      return '<p>' . t('A forum holds related forum topics.') . '</p>';
50
    case 'admin/structure/forum/settings':
51
      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
52 53 54
  }
}

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

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

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

221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
/**
 * Implements hook_entity_info_alter().
 */
function forum_entity_info_alter(&$info) {
  // Take over URI constuction for taxonomy terms that are forums.
  if ($vid = variable_get('forum_nav_vocabulary', 0)) {
    // Within hook_entity_info(), we can't invoke entity_load() as that would
    // cause infinite recursion, so we call taxonomy_vocabulary_get_names()
    // instead of taxonomy_vocabulary_load(). All we need is the machine name
    // of $vid, so retrieving and iterating all the vocabulary names is somewhat
    // inefficient, but entity info is cached across page requests, and an
    // iteration of all vocabularies once per cache clearing isn't a big deal,
    // and is done as part of taxonomy_entity_info() anyway.
    foreach (taxonomy_vocabulary_get_names() as $machine_name => $vocabulary) {
      if ($vid == $vocabulary->vid) {
        $info['taxonomy_term']['bundles'][$machine_name]['uri callback'] = 'forum_uri';
      }
    }
  }
}

/**
 * Entity URI callback.
 */
function forum_uri($forum) {
  return array(
    'path' => 'forum/' . $forum->tid,
  );
}

251
/**
252 253 254 255
 * Check whether a content type can be used in a forum.
 *
 * @param $node
 *   A node object.
256
 *
257 258
 * @return
 *   Boolean indicating if the node can be assigned to a forum.
259
 */
260
function _forum_node_check_node_type($node) {
261
  // Fetch information about the forum field.
262
  $field = field_info_instance('node', 'taxonomy_forums', $node->type);
263

264
  return is_array($field);
265
}
266

267
/**
268
 * Implements hook_node_view().
269
 */
270
function forum_node_view($node, $view_mode) {
271
  $vid = variable_get('forum_nav_vocabulary', 0);
272
  $vocabulary = taxonomy_vocabulary_load($vid);
273
  if (_forum_node_check_node_type($node)) {
274
    if (node_is_page($node)) {
275 276 277
      // Breadcrumb navigation
      $breadcrumb[] = l(t('Home'), NULL);
      $breadcrumb[] = l($vocabulary->name, 'forum');
278
      if ($parents = taxonomy_get_parents_all($node->forum_tid)) {
279
        $parents = array_reverse($parents);
280 281
        foreach ($parents as $parent) {
          $breadcrumb[] = l($parent->name, 'forum/' . $parent->tid);
282 283 284
        }
      }
      drupal_set_breadcrumb($breadcrumb);
285

286 287 288
    }
  }
}
289

290
/**
291
 * Implements hook_node_validate().
292
 *
293 294
 * Check in particular that only a "leaf" term in the associated taxonomy.
 */
295
function forum_node_validate($node, $form) {
296 297
  if (_forum_node_check_node_type($node)) {
    $langcode = $form['taxonomy_forums']['#language'];
298
    // vocabulary is selected, not a "container" term.
299
    if (!empty($node->taxonomy_forums[$langcode])) {
300 301
      // Extract the node's proper topic ID.
      $containers = variable_get('forum_containers', array());
302 303
      foreach ($node->taxonomy_forums[$langcode] as $item) {
        $term = taxonomy_term_load($item['tid']);
304 305 306
        $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,
307
        ))->fetchField();
308
        if ($used && in_array($term->tid, $containers)) {
309
          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)));
310 311
        }
      }
312 313 314
    }
  }
}
315

316
/**
317
 * Implements hook_node_presave().
318 319 320
 *
 * Assign forum taxonomy when adding a topic from within a forum.
 */
321
function forum_node_presave($node) {
322
  if (_forum_node_check_node_type($node)) {
323 324
    // Make sure all fields are set properly:
    $node->icon = !empty($node->icon) ? $node->icon : '';
325 326
    $langcode = array_shift(array_keys($node->taxonomy_forums));
    if (!empty($node->taxonomy_forums[$langcode])) {
327
      $node->forum_tid = $node->taxonomy_forums[$langcode][0]['tid'];
328
      $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();
329
      if ($old_tid && isset($node->forum_tid) && ($node->forum_tid != $old_tid) && !empty($node->shadow)) {
330
        // A shadow copy needs to be created. Retain new term and add old term.
331
        $node->taxonomy_forums[$langcode][] = array('tid' => $old_tid);
332 333 334 335
      }
    }
  }
}
336

337
/**
338
 * Implements hook_node_update().
339
 */
340
function forum_node_update($node) {
341
  if (_forum_node_check_node_type($node)) {
342
    if (empty($node->revision) && db_query('SELECT tid FROM {forum} WHERE nid=:nid', array(':nid' => $node->nid))->fetchField()) {
343
      if (!empty($node->forum_tid)) {
344
        db_update('forum')
345
          ->fields(array('tid' => $node->forum_tid))
346 347
          ->condition('vid', $node->vid)
          ->execute();
348 349 350
      }
      // The node is removed from the forum.
      else {
351 352 353
        db_delete('forum')
          ->condition('nid', $node->nid)
          ->execute();
354 355 356
      }
    }
    else {
357
      if (!empty($node->forum_tid)) {
358 359
        db_insert('forum')
          ->fields(array(
360
            'tid' => $node->forum_tid,
361 362 363 364
            'vid' => $node->vid,
            'nid' => $node->nid,
          ))
          ->execute();
365
      }
366
    }
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
    // 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();
     }
382 383
  }
}
384

385
/**
386
 * Implements hook_node_insert().
387
 */
388
function forum_node_insert($node) {
389 390
  if (_forum_node_check_node_type($node)) {
    if (!empty($node->forum_tid)) {
391 392
      $nid = db_insert('forum')
        ->fields(array(
393
          'tid' => $node->forum_tid,
394 395 396 397
          'vid' => $node->vid,
          'nid' => $node->nid,
        ))
        ->execute();
398 399 400
    }
  }
}
401

402
/**
403
 * Implements hook_node_delete().
404
 */
405
function forum_node_delete($node) {
406
  if (_forum_node_check_node_type($node)) {
407 408 409
    db_delete('forum')
      ->condition('nid', $node->nid)
      ->execute();
410 411 412
    db_delete('forum_index')
      ->condition('nid', $node->nid)
      ->execute();
413
  }
414
}
415

416
/**
417
 * Implements hook_node_load().
418
 */
419
function forum_node_load($nodes) {
420 421
  $node_vids = array();
  foreach ($nodes as $node) {
422
    if (_forum_node_check_node_type($node)) {
423 424 425 426
      $node_vids[] = $node->vid;
    }
  }
  if (!empty($node_vids)) {
427 428 429 430 431
    $query = db_select('forum', 'f');
    $query
      ->fields('f', array('nid', 'tid'))
      ->condition('f.vid', $node_vids);
    $result = $query->execute();
432 433 434
    foreach ($result as $record) {
      $nodes[$record->nid]->forum_tid = $record->tid;
    }
435
  }
436 437
}

438
/**
439
 * Implements hook_node_info().
440
 */
441
function forum_node_info() {
442 443
  return array(
    'forum' => array(
444
      'name' => t('Forum topic'),
445
      'base' => 'forum',
446
      'description' => t('A <em>forum topic</em> starts a new discussion thread within a forum.'),
447 448 449
      'title_label' => t('Subject'),
    )
  );
Dries's avatar
 
Dries committed
450 451
}

452
/**
453
 * Implements hook_permission().
454
 */
455
function forum_permission() {
456
  $perms = array(
457 458 459
    'administer forums' => array(
      'title' => t('Administer forums'),
    ),
460 461
  );
  return $perms;
Dries's avatar
 
Dries committed
462
}
Dries's avatar
 
Dries committed
463

464
/**
465
 * Implements hook_taxonomy_term_delete().
466
 */
467 468 469 470 471 472 473 474 475
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);
}
476

477
/**
478
 * Implements hook_comment_publish().
479 480 481 482 483 484 485 486 487
 *
 * 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);
}

/**
488
 * Implements hook_comment_update().
489 490 491 492 493 494 495 496 497 498 499 500 501
 *
 * 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);
  }
}

/**
502
 * Implements hook_comment_unpublish().
503 504 505 506 507 508
 */
function forum_comment_unpublish($comment) {
  _forum_update_forum_index($comment->nid);
}

/**
509
 * Implements hook_comment_delete().
510 511 512 513 514 515
 */
function forum_comment_delete($comment) {
  _forum_update_forum_index($comment->nid);
}

/**
516
 * Implements hook_field_storage_pre_insert().
517
 */
518 519
function forum_field_storage_pre_insert($entity_type, $entity, &$skip_fields) {
  if ($entity_type == 'node' && $entity->status && _forum_node_check_node_type($entity)) {
520
    $query = db_insert('forum_index')->fields(array('nid', 'title', 'tid', 'sticky', 'created', 'comment_count', 'last_comment_timestamp'));
521
    foreach ($entity->taxonomy_forums as $language) {
522
      foreach ($language as $item) {
523
        $query->values(array(
524 525
          'nid' => $entity->nid,
          'title' => $entity->title,
526
          'tid' => $item['tid'],
527 528
          'sticky' => $entity->sticky,
          'created' => $entity->created,
529
          'comment_count' => 0,
530
          'last_comment_timestamp' => $entity->created,
531 532 533 534 535 536 537 538
        ));
      }
    }
    $query->execute();
  }
}

/**
539
 * Implements hook_field_storage_pre_update().
540
 */
541
function forum_field_storage_pre_update($entity_type, $entity, &$skip_fields) {
542 543
  $first_call = &drupal_static(__FUNCTION__, array());

544
  if ($entity_type == 'node' && $entity->status && _forum_node_check_node_type($entity)) {
545 546 547
    // 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.
548 549 550
    if (!isset($first_call[$entity->nid])) {
      $first_call[$entity->nid] = FALSE;
      db_delete('forum_index')->condition('nid', $entity->nid)->execute();
551 552
    }
    // Only save data to the table if the node is published.
553
    if ($entity->status) {
554
      $query = db_insert('forum_index')->fields(array('nid', 'title', 'tid', 'sticky', 'created', 'comment_count', 'last_comment_timestamp'));
555
      foreach ($entity->taxonomy_forums as $language) {
556
        foreach ($language as $item) {
557
          $query->values(array(
558 559
            'nid' => $entity->nid,
            'title' => $entity->title,
560
            'tid' => $item['tid'],
561 562
            'sticky' => $entity->sticky,
            'created' => $entity->created,
563
            'comment_count' => 0,
564
            'last_comment_timestamp' => $entity->created,
565
          ));
566
        }
567 568 569 570
      }
      $query->execute();
      // The logic for determining last_comment_count is fairly complex, so
      // call _forum_update_forum_index() too.
571
      _forum_update_forum_index($entity->nid);
Dries's avatar
 
Dries committed
572
    }
573 574
  }
}
Dries's avatar
 
Dries committed
575

576
/**
577
 * Implements hook_form_alter().
578
 */
579
function forum_form_alter(&$form, $form_state, $form_id) {
580
  $vid = variable_get('forum_nav_vocabulary', 0);
581 582 583
  if (isset($form['vid']) && $form['vid']['#value'] == $vid) {
    // Hide critical options from forum vocabulary.
    if ($form_id == 'taxonomy_form_vocabulary') {
584
      $form['help_forum_vocab'] = array(
585
        '#markup' => t('This is the designated forum vocabulary. Some of the normal vocabulary options have been removed.'),
586 587 588
        '#weight' => -1,
      );
      $form['hierarchy'] = array('#type' => 'value', '#value' => 1);
589
      $form['delete']['#access'] = FALSE;
590
    }
591 592 593
    // Hide multiple parents select from forum terms.
    elseif ($form_id == 'taxonomy_form_term') {
      $form['advanced']['parent']['#access'] = FALSE;
594
    }
595
  }
596
  if ($form_id == 'forum_node_form') {
597
    $langcode = $form['taxonomy_forums']['#language'];
598
    // Make the vocabulary required for 'real' forum-nodes.
599 600
    $form['taxonomy_forums'][$langcode]['#required'] = TRUE;
    $form['taxonomy_forums'][$langcode]['#multiple'] = FALSE;
601 602
    if (empty($form['taxonomy_forums'][$langcode]['#default_value'])) {
      // If there is no default forum already selected, try to get the forum
603 604
      // ID from the URL (e.g., if we are on a page like node/add/forum/2, we
      // expect "2" to be the ID of the forum that was requested).
605 606 607
      $requested_forum_id = arg(3);
      $form['taxonomy_forums'][$langcode]['#default_value'] = is_numeric($requested_forum_id) ? $requested_forum_id : NULL;
    }
608
  }
609 610
}

611
/**
612
 * Implements hook_block_info().
613
 */
614
function forum_block_info() {
615 616 617 618 619 620 621 622
  $blocks['active'] = array(
    'info' => t('Active forum topics'),
    'cache' => DRUPAL_CACHE_CUSTOM,
  );
  $blocks['new'] = array(
    'info' => t('New forum topics'),
    'cache' => DRUPAL_CACHE_CUSTOM,
  );
623 624 625 626
  return $blocks;
}

/**
627
 * Implements hook_block_configure().
628 629 630 631 632 633 634
 */
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;
}

/**
635
 * Implements hook_block_save().
636 637 638 639 640 641
 */
function forum_block_save($delta = '', $edit = array()) {
  variable_set('forum_block_num_' . $delta, $edit['forum_block_num_' . $delta]);
}

/**
642
 * Implements hook_block_view().
643 644 645 646
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
647
function forum_block_view($delta = '') {
648 649
  $query = db_select('forum_index', 'f')
    ->fields('f')
650 651 652 653 654
    ->addTag('node_access');
  switch ($delta) {
    case 'active':
      $title = t('Active forum topics');
      $query
655
        ->orderBy('f.last_comment_timestamp', 'DESC')
656 657 658 659 660 661
        ->range(0, variable_get('forum_block_num_active', '5'));
      break;

    case 'new':
      $title = t('New forum topics');
      $query
662
        ->orderBy('f.created', 'DESC')
663 664 665
        ->range(0, variable_get('forum_block_num_new', '5'));
      break;
  }
Dries's avatar
 
Dries committed
666

667
  $block['subject'] = $title;
668 669 670
  // 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');
671
  return $block;
672
}
673

674 675 676
/**
* A #pre_render callback. Lists nodes based on the element's #query property.
*
677
* @see forum_block_view()
678 679 680 681 682 683 684 685
*
* @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);
686
    $elements['forum_more'] = array('#markup' => theme('more_link', array('url' => url('forum'), 'title' => t('Read the latest forum topics.'))));
687
  }
688
  return $elements;
Dries's avatar
 
Dries committed
689 690
}

691
/**
692
 * Implements hook_form().
693
 */
694
function forum_form($node, $form_state) {
695
  $type = node_type_get_type($node);
696 697 698 699 700 701
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => check_plain($type->title_label),
    '#default_value' => !empty($node->title) ? $node->title : '',
    '#required' => TRUE, '#weight' => -5
  );
702

703
  if (!empty($node->nid)) {
704 705
    $forum_terms = $node->taxonomy_forums;
    // If editing, give option to leave shadows
706
    $shadow = (count($forum_terms) > 1);
707
    $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.'));
708
    $form['forum_tid'] = array('#type' => 'value', '#value' => $node->forum_tid);
Dries's avatar
Dries committed
709
  }
Dries's avatar
 
Dries committed
710

711
  return $form;
Dries's avatar
 
Dries committed
712 713
}

Dries's avatar
 
Dries committed
714 715 716
/**
 * Returns a list of all forums for a given taxonomy id
 *
717
 * Forum objects contain the following fields
Dries's avatar
 
Dries committed
718 719 720 721 722 723 724 725 726
 * -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
727
function forum_get_forums($tid = 0) {
728 729 730 731 732
  $cache = &drupal_static(__FUNCTION__, array());

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

Dries's avatar
 
Dries committed
734
  $forums = array();
735
  $vid = variable_get('forum_nav_vocabulary', 0);
736
  $_forums = taxonomy_get_tree($vid, $tid);
Dries's avatar
 
Dries committed
737

Dries's avatar
 
Dries committed
738
  if (count($_forums)) {
739 740
    $query = db_select('node', 'n');
    $query->join('node_comment_statistics', 'ncs', 'n.nid = ncs.nid');
741
    $query->join('forum', 'f', 'n.vid = f.vid');
742 743 744
    $query->addExpression('COUNT(n.nid)', 'topic_count');
    $query->addExpression('SUM(ncs.comment_count)', 'comment_count');
    $counts = $query
745
      ->fields('f', array('tid'))
746 747 748 749 750
      ->condition('status', 1)
      ->groupBy('tid')
      ->addTag('node_access')
      ->execute()
      ->fetchAllAssoc('tid');
Dries's avatar
 
Dries committed
751
  }
Dries's avatar
 
Dries committed
752

Dries's avatar
 
Dries committed
753 754 755 756
  foreach ($_forums as $forum) {
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
757

758
    if (!empty($counts[$forum->tid])) {
Dries's avatar
 
Dries committed
759 760 761 762 763 764 765 766
      $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;
    }

767 768
    $query = db_select('node', 'n');
    $query->join('users', 'u1', 'n.uid = u1.uid');
769
    $query->join('forum', 'f', 'n.vid = f.vid AND f.tid = :tid', array(':tid' => $forum->tid));
770 771 772
    $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');
773

774 775 776 777 778 779 780 781
    $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();