forum.module 43.4 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
      $output = '<p>' . t('Forums contain forum topics. Use containers to group related forums.') . '</p>';
44
      $output .= theme('more_help_link', array('url' => 'admin/help/forum'));
45
      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 98 99 100 101 102 103
  $items['forum/%forum_forum'] = array(
    'title' => 'Forums',
    'page callback' => 'forum_page',
    'page arguments' => array(1),
    'access arguments' => array('access content'),
    'file' => 'forum.pages.inc',
  );
104
  $items['admin/structure/forum'] = array(
105
    'title' => 'Forums',
106
    'description' => 'Control forum hierarchy settings.',
107 108
    'page callback' => 'drupal_get_form',
    'page arguments' => array('forum_overview'),
109
    'access arguments' => array('administer forums'),
110
    'file' => 'forum.admin.inc',
111
  );
112
  $items['admin/structure/forum/list'] = array(
113
    'title' => 'List',
114 115 116
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
117
  $items['admin/structure/forum/add/container'] = array(
118
    'title' => 'Add container',
119 120
    'page callback' => 'forum_form_main',
    'page arguments' => array('container'),
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/add/forum'] = array(
127
    'title' => 'Add forum',
128 129
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum'),
130
    'access arguments' => array('administer forums'),
131
    'type' => MENU_LOCAL_ACTION,
132
    'parent' => 'admin/structure/forum',
133
    'file' => 'forum.admin.inc',
134
  );
135
  $items['admin/structure/forum/settings'] = array(
136
    'title' => 'Settings',
137 138
    'page callback' => 'drupal_get_form',
    'page arguments' => array('forum_admin_settings'),
139
    'access arguments' => array('administer forums'),
140 141
    'weight' => 5,
    'type' => MENU_LOCAL_TASK,
142
    'parent' => 'admin/structure/forum',
143
    'file' => 'forum.admin.inc',
144
  );
145
  $items['admin/structure/forum/edit/container/%taxonomy_term'] = array(
146
    'title' => 'Edit container',
147
    'page callback' => 'forum_form_main',
148
    'page arguments' => array('container', 5),
149
    'access arguments' => array('administer forums'),
150
    'file' => 'forum.admin.inc',
151
  );
152
  $items['admin/structure/forum/edit/forum/%taxonomy_term'] = array(
153
    'title' => 'Edit forum',
154 155
    'page callback' => 'forum_form_main',
    'page arguments' => array('forum', 5),
156
    'access arguments' => array('administer forums'),
157
    'file' => 'forum.admin.inc',
158 159 160
  );
  return $items;
}
161

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

168 169 170
  // 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);
171 172
    $forum_term = forum_forum_load($tid);
    if ($forum_term) {
173 174 175 176 177 178 179 180 181 182 183 184
      $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))),
185
              'href' => 'node/add/' . str_replace('_', '-', $type) . '/' . $forum_term->tid,
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
            ),
          );
        }
      }
      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(
205
              'title' => t('<a href="@login">Log in</a> to post new content in the forum.', array(
206 207 208 209 210 211 212 213 214 215 216
                '@login' => url('user/login', array('query' => drupal_get_destination())),
              )),
              'localized_options' => array('html' => TRUE),
            ),
          );
        }
      }
      $data['actions']['output'] = array_merge($data['actions']['output'], $links);
    }
  }
}
217

218 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
/**
 * 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,
  );
}

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

261
  return is_array($field);
262
}
263

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

283 284 285
    }
  }
}
286

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

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

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

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

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

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

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

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

472
/**
473
 * Implements hook_taxonomy_term_delete().
474
 */
475 476 477 478 479 480 481 482 483
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);
}
484

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

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

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

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

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

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

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

584
/**
585
 * Implements hook_form_alter().
586
 */
587
function forum_form_alter(&$form, $form_state, $form_id) {
588
  $vid = variable_get('forum_nav_vocabulary', 0);
589 590 591
  if (isset($form['vid']) && $form['vid']['#value'] == $vid) {
    // Hide critical options from forum vocabulary.
    if ($form_id == 'taxonomy_form_vocabulary') {
592
      $form['help_forum_vocab'] = array(
593
        '#markup' => t('This is the designated forum vocabulary. Some of the normal vocabulary options have been removed.'),
594 595 596
        '#weight' => -1,
      );
      $form['hierarchy'] = array('#type' => 'value', '#value' => 1);
597
      $form['delete']['#access'] = FALSE;
598
    }
599 600 601
    // Hide multiple parents select from forum terms.
    elseif ($form_id == 'taxonomy_form_term') {
      $form['advanced']['parent']['#access'] = FALSE;
602
    }
603
  }
604
  if (!empty($form['#node_edit_form']) && isset($form['taxonomy_forums'])) {
605
    $langcode = $form['taxonomy_forums']['#language'];
606
    // Make the vocabulary required for 'real' forum-nodes.
607 608
    $form['taxonomy_forums'][$langcode]['#required'] = TRUE;
    $form['taxonomy_forums'][$langcode]['#multiple'] = FALSE;
609 610
    if (empty($form['taxonomy_forums'][$langcode]['#default_value'])) {
      // If there is no default forum already selected, try to get the forum
611 612
      // 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).
613 614 615
      $requested_forum_id = arg(3);
      $form['taxonomy_forums'][$langcode]['#default_value'] = is_numeric($requested_forum_id) ? $requested_forum_id : NULL;
    }
616
  }
617 618
}

619
/**
620
 * Implements hook_block_info().
621
 */
622
function forum_block_info() {
623 624 625
  $blocks['active'] = array(
    'info' => t('Active forum topics'),
    'cache' => DRUPAL_CACHE_CUSTOM,
626
    'properties' => array('administrative' => TRUE),
627 628 629 630
  );
  $blocks['new'] = array(
    'info' => t('New forum topics'),
    'cache' => DRUPAL_CACHE_CUSTOM,
631
    'properties' => array('administrative' => TRUE),
632
  );
633 634 635 636
  return $blocks;
}

/**
637
 * Implements hook_block_configure().
638 639 640 641 642 643 644
 */
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;
}

/**
645
 * Implements hook_block_save().
646 647 648 649 650 651
 */
function forum_block_save($delta = '', $edit = array()) {
  variable_set('forum_block_num_' . $delta, $edit['forum_block_num_' . $delta]);
}

/**
652
 * Implements hook_block_view().
653 654 655 656
 *
 * Generates a block containing the currently active forum topics and the
 * most recently added forum topics.
 */
657
function forum_block_view($delta = '') {
658 659
  $query = db_select('forum_index', 'f')
    ->fields('f')
660 661 662 663 664
    ->addTag('node_access');
  switch ($delta) {
    case 'active':
      $title = t('Active forum topics');
      $query
665
        ->orderBy('f.last_comment_timestamp', 'DESC')
666 667 668 669 670 671
        ->range(0, variable_get('forum_block_num_active', '5'));
      break;

    case 'new':
      $title = t('New forum topics');
      $query
672
        ->orderBy('f.created', 'DESC')
673 674 675
        ->range(0, variable_get('forum_block_num_new', '5'));
      break;
  }
Dries's avatar
 
Dries committed
676

677
  $block['subject'] = $title;
678 679 680
  // 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');
681
  return $block;
682
}
683

684 685 686
/**
* A #pre_render callback. Lists nodes based on the element's #query property.
*
687
* @see forum_block_view()
688 689 690 691 692 693 694
*
* @return
*   A renderable array.
*/
function forum_block_view_pre_render($elements) {
  $result = $elements['#query']->execute();
  if ($node_title_list = node_title_list($result)) {
695
    $elements['forum_list'] = $node_title_list;
696
    $elements['forum_more'] = array('#theme' => 'more_link', '#url' => 'forum', '#title' => t('Read the latest forum topics.'));
697
  }
698
  return $elements;
Dries's avatar
 
Dries committed
699 700
}

701
/**
702
 * Implements hook_form().
703
 */
704
function forum_form($node, $form_state) {
705
  $type = node_type_get_type($node);
706 707 708 709 710 711
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => check_plain($type->title_label),
    '#default_value' => !empty($node->title) ? $node->title : '',
    '#required' => TRUE, '#weight' => -5
  );
712

713
  if (!empty($node->nid)) {
714 715
    $forum_terms = $node->taxonomy_forums;
    // If editing, give option to leave shadows
716
    $shadow = (count($forum_terms) > 1);
717
    $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.'));
718
    $form['forum_tid'] = array('#type' => 'value', '#value' => $node->forum_tid);
Dries's avatar
Dries committed
719
  }
Dries's avatar
 
Dries committed
720

721
  return $form;
Dries's avatar
 
Dries committed
722 723
}

Dries's avatar
 
Dries committed
724
/**
725
 * Returns a tree of all forums for a given taxonomy term ID.
Dries's avatar
 
Dries committed
726 727
 *
 * @param $tid
728
 *    (optional) Taxonomy ID of the forum, if not givin all forums will be returned.
Dries's avatar
 
Dries committed
729
 * @return
730 731 732 733 734
 *   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
735
 */
736
function forum_forum_load($tid = NULL) {
737 738
  $cache = &drupal_static(__FUNCTION__, array());

739 740 741 742
  // Return a cached forum tree if available.
  if (!isset($tid)) {
    $tid = 0;
  }
743 744 745
  if (isset($cache[$tid])) {
    return $cache[$tid];
  }
746

747
  $vid = variable_get('forum_nav_vocabulary', 0);
748 749 750 751 752 753 754 755 756

  // 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.
757
  elseif ($tid === 0) {
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
    $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.
  $forum_term->parents = taxonomy_get_parents_all($forum_term->tid);

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

Dries's avatar
 
Dries committed
775
  if (count($_forums)) {
776 777
    $query = db_select('node', 'n');
    $query->join('node_comment_statistics', 'ncs', 'n.nid = ncs.nid');