forum.module 45.3 KB
Newer Older
Dries's avatar
 
Dries committed
1 2
<?php

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

8 9
use Drupal\node\Node;

10
/**
11
 * Implements hook_help().
12
 */
13 14
function forum_help($path, $arg) {
  switch ($path) {
15
    case 'admin/help#forum':
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>';
28
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@forum">Forum module</a>.', array('@forum' => 'http://drupal.org/documentation/modules/forum')) . '</p>';
29 30
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
31 32 33 34
      $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>';
35
      $output .= '<dt>' . t('Navigation') . '</dt>';
36
      $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>';
37 38 39
      $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>';
40
      $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>';
41
      $output .= '</dl>';
42
      return $output;
43
    case 'admin/structure/forum':
44
      $output = '<p>' . t('Forums contain forum topics. Use containers to group related forums.') . '</p>';
45
      $output .= theme('more_help_link', array('url' => 'admin/help/forum'));
46
      return $output;
47
    case 'admin/structure/forum/add/container':
48
      return '<p>' . t('Use containers to group related forums.') . '</p>';
49
    case 'admin/structure/forum/add/forum':
50
      return '<p>' . t('A forum holds related forum topics.') . '</p>';
51
    case 'admin/structure/forum/settings':
52
      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
53 54 55
  }
}

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

88
/**
89
 * Implements hook_menu().
90
 */
91 92
function forum_menu() {
  $items['forum'] = array(
93
    'title' => 'Forums',
94 95
    'page callback' => 'forum_page',
    'access arguments' => array('access content'),
96
    'file' => 'forum.pages.inc',
97
  );
98 99 100 101 102 103 104
  $items['forum/%forum_forum'] = array(
    'title' => 'Forums',
    'page callback' => 'forum_page',
    'page arguments' => array(1),
    'access arguments' => array('access content'),
    'file' => 'forum.pages.inc',
  );
105
  $items['admin/structure/forum'] = array(
106
    'title' => 'Forums',
107
    'description' => 'Control forum hierarchy settings.',
108 109
    'page callback' => 'drupal_get_form',
    'page arguments' => array('forum_overview'),
110
    'access arguments' => array('administer forums'),
111
    'file' => 'forum.admin.inc',
112
  );
113
  $items['admin/structure/forum/list'] = array(
114
    'title' => 'List',
115 116 117
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
118
  $items['admin/structure/forum/add/container'] = array(
119
    'title' => 'Add container',
120 121
    'page callback' => 'forum_form_main',
    'page arguments' => array('container'),
122
    'access arguments' => array('administer forums'),
123
    'type' => MENU_LOCAL_ACTION,
124
    'parent' => 'admin/structure/forum',
125
    'file' => 'forum.admin.inc',
126
  );
127
  $items['admin/structure/forum/add/forum'] = array(
128
    'title' => 'Add forum',
129 130
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum'),
131
    'access arguments' => array('administer forums'),
132
    'type' => MENU_LOCAL_ACTION,
133
    'parent' => 'admin/structure/forum',
134
    'file' => 'forum.admin.inc',
135
  );
136
  $items['admin/structure/forum/settings'] = array(
137
    'title' => 'Settings',
138 139
    'page callback' => 'drupal_get_form',
    'page arguments' => array('forum_admin_settings'),
140
    'access arguments' => array('administer forums'),
141 142
    'weight' => 5,
    'type' => MENU_LOCAL_TASK,
143
    'parent' => 'admin/structure/forum',
144
    'file' => 'forum.admin.inc',
145
  );
146
  $items['admin/structure/forum/edit/container/%taxonomy_term'] = array(
147
    'title' => 'Edit container',
148
    'page callback' => 'forum_form_main',
149
    'page arguments' => array('container', 5),
150
    'access arguments' => array('administer forums'),
151
    'file' => 'forum.admin.inc',
152
  );
153
  $items['admin/structure/forum/edit/forum/%taxonomy_term'] = array(
154
    'title' => 'Edit forum',
155 156
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum', 5),
157
    'access arguments' => array('administer forums'),
158
    'file' => 'forum.admin.inc',
159 160 161
  );
  return $items;
}
162

163 164 165 166 167 168
/**
 * Implements hook_menu_local_tasks_alter().
 */
function forum_menu_local_tasks_alter(&$data, $router_item, $root_path) {
  global $user;

169 170 171
  // Add action link to 'node/add/forum' on 'forum' sub-pages.
  if ($root_path == 'forum' || $root_path == 'forum/%') {
    $tid = (isset($router_item['page_arguments'][0]) ? $router_item['page_arguments'][0]->tid : 0);
172 173
    $forum_term = forum_forum_load($tid);
    if ($forum_term) {
174 175
      $links = array();
      // Loop through all bundles for forum taxonomy vocabulary field.
176
      $field = field_info_field('taxonomy_forums');
177 178 179 180 181 182
      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))),
183
              'href' => 'node/add/' . str_replace('_', '-', $type) . '/' . $forum_term->tid,
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
            ),
          );
        }
      }
      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(
203
              'title' => t('<a href="@login">Log in</a> to post new content in the forum.', array(
204 205 206 207 208 209 210 211 212 213 214
                '@login' => url('user/login', array('query' => drupal_get_destination())),
              )),
              'localized_options' => array('html' => TRUE),
            ),
          );
        }
      }
      $data['actions']['output'] = array_merge($data['actions']['output'], $links);
    }
  }
}
215

216 217 218 219
/**
 * Implements hook_entity_info_alter().
 */
function forum_entity_info_alter(&$info) {
220
  // Take over URI construction for taxonomy terms that are forums.
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
  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,
  );
}

246
/**
247 248
 * Check whether a content type can be used in a forum.
 *
249 250
 * @param Drupal\node\Node $node
 *   A node entity.
251
 *
252 253
 * @return
 *   Boolean indicating if the node can be assigned to a forum.
254
 */
255
function _forum_node_check_node_type(Node $node) {
256
  // Fetch information about the forum field.
257
  $field = field_info_instance('node', 'taxonomy_forums', $node->type);
258

259
  return is_array($field);
260
}
261

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

281 282 283
    }
  }
}
284

285
/**
286
 * Implements hook_node_validate().
287
 *
288 289
 * Check in particular that only a "leaf" term in the associated taxonomy.
 */
290
function forum_node_validate(Node $node, $form) {
291 292
  if (_forum_node_check_node_type($node)) {
    $langcode = $form['taxonomy_forums']['#language'];
293
    // vocabulary is selected, not a "container" term.
294
    if (!empty($node->taxonomy_forums[$langcode])) {
295 296
      // Extract the node's proper topic ID.
      $containers = variable_get('forum_containers', array());
297 298 299 300 301 302 303
      foreach ($node->taxonomy_forums[$langcode] as $delta => $item) {
        // If no term was selected (e.g. when no terms exist yet), remove the
        // item.
        if (empty($item['tid'])) {
          unset($node->taxonomy_forums[$langcode][$delta]);
          continue;
        }
304
        $term = taxonomy_term_load($item['tid']);
305 306 307 308
        if (!$term) {
          form_set_error('taxonomy_forums', t('Select a forum.'));
          continue;
        }
309 310 311
        $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,
312
        ))->fetchField();
313
        if ($used && in_array($term->tid, $containers)) {
314
          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)));
315 316
        }
      }
317 318 319
    }
  }
}
320

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

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

391
/**
392
 * Implements hook_node_insert().
393
 */
394
function forum_node_insert(Node $node) {
395 396
  if (_forum_node_check_node_type($node)) {
    if (!empty($node->forum_tid)) {
397 398
      $nid = db_insert('forum')
        ->fields(array(
399
          'tid' => $node->forum_tid,
400 401 402 403
          'vid' => $node->vid,
          'nid' => $node->nid,
        ))
        ->execute();
404 405 406
    }
  }
}
407

408
/**
409
 * Implements hook_node_predelete().
410
 */
411
function forum_node_predelete(Node $node) {
412
  if (_forum_node_check_node_type($node)) {
413 414 415
    db_delete('forum')
      ->condition('nid', $node->nid)
      ->execute();
416 417 418
    db_delete('forum_index')
      ->condition('nid', $node->nid)
      ->execute();
419
  }
420
}
421

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

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

458
/**
459
 * Implements hook_permission().
460
 */
461
function forum_permission() {
462
  $perms = array(
463 464 465
    'administer forums' => array(
      'title' => t('Administer forums'),
    ),
466 467
  );
  return $perms;
Dries's avatar
 
Dries committed
468
}
Dries's avatar
 
Dries committed
469

470
/**
471
 * Implements hook_taxonomy_term_delete().
472
 */
473
function forum_taxonomy_term_delete(TaxonomyTerm $term) {
474 475
  // For containers, remove the tid from the forum_containers variable.
  $containers = variable_get('forum_containers', array());
476
  $key = array_search($term->tid, $containers);
477 478 479 480 481
  if ($key !== FALSE) {
    unset($containers[$key]);
  }
  variable_set('forum_containers', $containers);
}
482

483
/**
484
 * Implements hook_comment_publish().
485 486 487 488 489 490 491 492 493
 *
 * 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);
}

/**
494
 * Implements hook_comment_update().
495 496 497 498 499 500 501 502 503 504 505 506 507
 *
 * 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);
  }
}

/**
508
 * Implements hook_comment_unpublish().
509 510 511 512 513 514
 */
function forum_comment_unpublish($comment) {
  _forum_update_forum_index($comment->nid);
}

/**
515
 * Implements hook_comment_delete().
516 517 518 519 520 521
 */
function forum_comment_delete($comment) {
  _forum_update_forum_index($comment->nid);
}

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

/**
545
 * Implements hook_field_storage_pre_update().
546
 */
547
function forum_field_storage_pre_update($entity_type, $entity, &$skip_fields) {
548 549
  $first_call = &drupal_static(__FUNCTION__, array());

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

579
/**
580
 * Implements hook_form_FORM_ID_alter() for taxonomy_form_vocabulary().
581
 */
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
function forum_form_taxonomy_form_vocabulary_alter(&$form, &$form_state, $form_id) {
  $vid = variable_get('forum_nav_vocabulary', 0);
  if (isset($form['vid']['#value']) && $form['vid']['#value'] == $vid) {
    $form['help_forum_vocab'] = array(
      '#markup' => t('This is the designated forum vocabulary. Some of the normal vocabulary options have been removed.'),
      '#weight' => -1,
    );
    // Forum's vocabulary always has single hierarchy. Forums and containers
    // have only one parent or no parent for root items. By default this value
    // is 0.
    $form['hierarchy']['#value'] = TAXONOMY_HIERARCHY_SINGLE;
    // Do not allow to delete forum's vocabulary.
    $form['actions']['delete']['#access'] = FALSE;
  }
}

/**
 * Implements hook_form_FORM_ID_alter() for taxonomy_form_term().
 */
function forum_form_taxonomy_form_term_alter(&$form, &$form_state, $form_id) {
602
  $vid = variable_get('forum_nav_vocabulary', 0);
603
  if (isset($form['vid']['#value']) && $form['vid']['#value'] == $vid) {
604
    // Hide multiple parents select from forum terms.
605
    $form['relations']['parent']['#access'] = FALSE;
606
  }
607 608 609
}

/**
610
 * Implements hook_form_BASE_FORM_ID_alter() for node_form().
611 612 613
 */
function forum_form_node_form_alter(&$form, &$form_state, $form_id) {
  if (isset($form['taxonomy_forums'])) {
614
    $langcode = $form['taxonomy_forums']['#language'];
615
    // Make the vocabulary required for 'real' forum-nodes.
616 617
    $form['taxonomy_forums'][$langcode]['#required'] = TRUE;
    $form['taxonomy_forums'][$langcode]['#multiple'] = FALSE;
618 619
    if (empty($form['taxonomy_forums'][$langcode]['#default_value'])) {
      // If there is no default forum already selected, try to get the forum
620 621
      // 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).
622
      $requested_forum_id = arg(3);
623
      $form['taxonomy_forums'][$langcode]['#default_value'] = is_numeric($requested_forum_id) ? $requested_forum_id : '';
624
    }
625
  }
626 627
}

628
/**
629
 * Implements hook_block_info().
630
 */
631
function forum_block_info() {
632 633 634
  $blocks['active'] = array(
    'info' => t('Active forum topics'),
    'cache' => DRUPAL_CACHE_CUSTOM,
635
    'properties' => array('administrative' => TRUE),
636 637 638 639
  );
  $blocks['new'] = array(
    'info' => t('New forum topics'),
    'cache' => DRUPAL_CACHE_CUSTOM,
640
    'properties' => array('administrative' => TRUE),
641
  );
642 643 644 645
  return $blocks;
}

/**
646
 * Implements hook_block_configure().
647 648 649 650 651 652 653
 */
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;
}

/**
654
 * Implements hook_block_save().
655 656 657 658 659 660
 */
function forum_block_save($delta = '', $edit = array()) {
  variable_set('forum_block_num_' . $delta, $edit['forum_block_num_' . $delta]);
}

/**
661
 * Implements hook_block_view().
662 663 664 665
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
666
function forum_block_view($delta = '') {
667 668
  $query = db_select('forum_index', 'f')
    ->fields('f')
669 670 671 672 673
    ->addTag('node_access');
  switch ($delta) {
    case 'active':
      $title = t('Active forum topics');
      $query
674
        ->orderBy('f.last_comment_timestamp', 'DESC')
675 676 677 678 679 680
        ->range(0, variable_get('forum_block_num_active', '5'));
      break;

    case 'new':
      $title = t('New forum topics');
      $query
681
        ->orderBy('f.created', 'DESC')
682 683 684
        ->range(0, variable_get('forum_block_num_new', '5'));
      break;
  }
Dries's avatar
 
Dries committed
685

686
  $block['subject'] = $title;
687 688 689
  // 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');
690
  return $block;
691
}
692

693 694 695
/**
* A #pre_render callback. Lists nodes based on the element's #query property.
*
696
* @see forum_block_view()
697 698 699 700 701 702 703
*
* @return
*   A renderable array.
*/
function forum_block_view_pre_render($elements) {
  $result = $elements['#query']->execute();
  if ($node_title_list = node_title_list($result)) {
704
    $elements['forum_list'] = $node_title_list;
705
    $elements['forum_more'] = array('#theme' => 'more_link', '#url' => 'forum', '#title' => t('Read the latest forum topics.'));
706
  }
707
  return $elements;
Dries's avatar
 
Dries committed
708 709
}

710
/**
711
 * Implements hook_form().
712
 */
713
function forum_form($node, $form_state) {
714
  $type = node_type_get_type($node);
715 716 717 718 719 720
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => check_plain($type->title_label),
    '#default_value' => !empty($node->title) ? $node->title : '',
    '#required' => TRUE, '#weight' => -5
  );
721

722
  if (!empty($node->nid)) {
723 724
    $forum_terms = $node->taxonomy_forums;
    // If editing, give option to leave shadows
725
    $shadow = (count($forum_terms) > 1);
726
    $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.'));
727
    $form['forum_tid'] = array('#type' => 'value', '#value' => $node->forum_tid);
Dries's avatar
Dries committed
728
  }
Dries's avatar
 
Dries committed
729

730
  return $form;
Dries's avatar
 
Dries committed
731 732
}

Dries's avatar
 
Dries committed
733
/**
734
 * Returns a tree of all forums for a given taxonomy term ID.
Dries's avatar
 
Dries committed
735 736
 *
 * @param $tid
737
 *    (optional) Taxonomy ID of the forum, if not givin all forums will be returned.
Dries's avatar
 
Dries committed
738
 * @return
739 740 741 742 743
 *   A tree of taxonomy objects, with the following additional properties:
 *    - '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
 *    - 'forums': An array of child forums
Dries's avatar
 
Dries committed
744
 */
745
function forum_forum_load($tid = NULL) {
746 747
  $cache = &drupal_static(__FUNCTION__, array());

748 749 750 751
  // Return a cached forum tree if available.
  if (!isset($tid)) {
    $tid = 0;
  }
752 753 754
  if (isset($cache[$tid])) {
    return $cache[$tid];
  }
755

756
  $vid = variable_get('forum_nav_vocabulary', 0);
757 758 759 760 761 762 763 764 765

  // Load and validate the parent term.
  if ($tid) {
    $forum_term = taxonomy_term_load($tid);
    if (!$forum_term || ($forum_term->vid != $vid)) {
      return $cache[$tid] = FALSE;
    }
  }
  // If $tid is 0, create an empty object to hold the child terms.
766
  elseif ($tid === 0) {
767 768 769 770 771 772 773 774 775 776 777
    $forum_term = (object) array(
      'tid' => 0,
    );
  }

  // Determine if the requested term is a container.
  if (!$forum_term->tid || in_array($forum_term->tid, variable_get('forum_containers', array()))) {
    $forum_term->container = 1;
  }

  // Load parent terms.
778
  $forum_term->parents = taxonomy_term_load_parents_all($forum_term->tid);
779 780 781

  // Load the tree below.
  $forums = array();
782
  $_forums = taxonomy_get_tree($vid, $tid);
Dries's avatar
 
Dries committed
783

Dries's avatar
 
Dries committed
784
  if (count($_forums)) {
785 786
    $query = db_select('node', 'n');
    $query->join('node_comment_statistics', 'ncs', 'n.nid = ncs.nid');
787
    $query->join('forum', 'f', 'n.vid = f.vid');
788 789 790
    $query->addExpression('COUNT(n.nid)', 'topic_count');
    $query->addExpression('SUM(ncs.comment_count)', 'comment_count');
    $counts = $query
791
      ->fields('f', array('tid'))
792
      ->condition('n.status', 1)
793 794 795 796
      ->groupBy('tid')
      ->addTag('node_access')
      ->execute()
      ->fetchAllAssoc('tid');
Dries's avatar
 
Dries committed
797
  }
Dries's avatar
 
Dries committed
798

Dries's avatar
 
Dries committed
799
  foreach ($_forums as $forum) {
800
    // Determine if the child term is a container.
Dries's avatar
 
Dries committed
801 802 803
    if (in_array($forum->tid, variable_get('forum_containers', array()))) {
      $forum->container = 1;
    }
Dries's avatar
 
Dries committed
804

805
    // Merge in the topic and post counters.
806
    if (!empty($counts[$forum->tid])) {
Dries's avatar
 
Dries committed
807 808 809 810 811 812 813 814
      $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;
    }

815
    // Query "Last Post" information for this forum.
816 817
    $query = db_select('node', 'n');
    $query->join('users', 'u1', 'n.uid = u1.uid');
818
    $query->join('forum', 'f', 'n.vid = f.vid AND f.tid = :tid', array(':tid' => $forum->tid));
819 820
    $query->join('node_comment_statistics', 'ncs', 'n.nid = ncs.nid');
    $query->join('users', 'u2', 'ncs.last_comment_uid = u2.uid');
821
    $query->addExpression('CASE ncs.last_comment_uid WHEN 0 THEN ncs.last_comment_name ELSE u2.name END', 'last_comment_name');
822

823 824 825 826 827 828 829 830
    $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();
831

832
    // Merge in the "Last Post" information.
833
    $last_post = new stdClass();