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

3 4
/**
 * @file
5
 * Provides discussion forums.
6 7
 */

8
use Drupal\comment\CommentInterface;
9
use Drupal\comment\Plugin\Field\FieldType\CommentItemInterface;
10
use Drupal\Component\Utility\Xss;
11
use Drupal\Core\Entity\EntityInterface;
12
use Drupal\Core\Url;
13
use Drupal\Component\Utility\SafeMarkup;
14
use Drupal\Core\Extension\Extension;
15
use Drupal\Core\Form\FormStateInterface;
16
use Drupal\Core\Routing\RouteMatchInterface;
17 18
use Drupal\taxonomy\Entity\Vocabulary;
use Symfony\Component\Routing\Exception\RouteNotFoundException;
19

20
/**
21
 * Implements hook_help().
22
 */
23
function forum_help($route_name, RouteMatchInterface $route_match) {
24 25
  switch ($route_name) {
    case 'help.page.forum':
26 27 28 29 30 31 32 33 34 35 36 37
      $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>';
38
      $output .= '<p>' . t('For more information, see <a href="!forum">the online documentation for the Forum module</a>.', array('!forum' => 'https://drupal.org/documentation/modules/forum')) . '</p>';
39 40
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
41
      $output .= '<dt>' . t('Setting up forum structure') . '</dt>';
42
      $output .= '<dd>' . t('Visit the <a href="!forums">Forums page</a> to set up containers and forums to hold your discussion topics.', array('!forums' => \Drupal::url('forum.overview'))) . '</dd>';
43
      $output .= '<dt>' . t('Starting a discussion') . '</dt>';
44
      $output .= '<dd>' . t('The <a href="!create-topic">Forum topic</a> link on the <a href="!content-add">Add content</a> page creates the first post of a new threaded discussion, or thread.', array('!create-topic' => \Drupal::url('node.add', array('node_type' => 'forum')), '!content-add' => \Drupal::url('node.add_page'))) . '</dd>';
45 46
      $output .= '<dt>' . t('Navigating in the Forum') . '</dt>';
      $output .= '<dd>' . t('Enabling the Forum module provides a default <em>Forums</em> menu item in the Tools menu that links to the <a href="!forums">Forums page</a>.', array('!forums' => \Drupal::url('forum.index'))) . '</dd>';
47 48 49
      $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>';
50
      $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>';
51
      $output .= '</dl>';
52
      return $output;
53 54

    case 'forum.overview':
55
      $output = '<p>' . t('Forums contain forum topics. Use containers to group related forums.') . '</p>';
56 57
      $more_help_link = array(
        '#type' => 'link',
58
        '#url' => Url::fromRoute('help.page', ['name' => 'forum']),
59 60 61 62 63 64 65 66 67
        '#title' => t('More help'),
      );
      $container = array(
        '#theme' => 'container',
        '#children' => drupal_render($more_help_link),
        '#attributes' => array(
          'class' => array('more-help-link'),
        ),
      );
68
      $output .= drupal_render($container);
69
      return $output;
70 71

    case 'forum.add_container':
72
      return '<p>' . t('Use containers to group related forums.') . '</p>';
73 74

    case 'forum.add_forum':
75
      return '<p>' . t('A forum holds related forum topics.') . '</p>';
76 77

    case 'forum.settings':
78
      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' => \Drupal::url('forum.overview'))) . '</p>';
79 80 81
  }
}

82
/**
83
 * Implements hook_theme().
84 85 86
 */
function forum_theme() {
  return array(
87
    'forums' => array(
88
      'variables' => array('forums' => array(), 'topics' => array(), 'topics_pager' => array(), 'parents' => NULL, 'term' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL, 'header' => array()),
89 90
    ),
    'forum_list' => array(
91
      'variables' => array('forums' => NULL, 'parents' => NULL, 'tid' => NULL),
92 93
    ),
    'forum_icon' => array(
94
      'variables' => array('new_posts' => NULL, 'num_posts' => 0, 'comment_mode' => 0, 'sticky' => 0, 'first_new' => FALSE),
95
    ),
96
    'forum_submitted' => array(
97
      'variables' => array('topic' => NULL),
98
    ),
99 100 101
  );
}

102
/**
103
 * Implements hook_entity_type_build().
104
 */
105 106
function forum_entity_type_build(array &$entity_types) {
  /** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */
107
  // Register forum specific forms.
108
  $entity_types['taxonomy_term']
109 110
    ->setFormClass('forum', 'Drupal\forum\Form\ForumForm')
    ->setFormClass('container', 'Drupal\forum\Form\ContainerForm')
111 112 113
    ->setLinkTemplate('forum-edit-container-form', '/admin/structure/forum/edit/container/{taxonomy_term}')
    ->setLinkTemplate('forum-delete-form', '/admin/structure/forum/delete/forum/{taxonomy_term}')
    ->setLinkTemplate('forum-edit-form', '/admin/structure/forum/edit/forum/{taxonomy_term}');
114 115
}

116
/**
117
 * Implements hook_entity_bundle_info_alter().
118
 */
119
function forum_entity_bundle_info_alter(&$bundles) {
120
  // Take over URI construction for taxonomy terms that are forums.
121
  if ($vid = \Drupal::config('forum.settings')->get('vocabulary')) {
122 123
    if (isset($bundles['taxonomy_term'][$vid])) {
      $bundles['taxonomy_term'][$vid]['uri_callback'] = 'forum_uri';
124 125 126 127 128
    }
  }
}

/**
129
 * Entity URI callback used in forum_entity_bundle_info_alter().
130 131
 */
function forum_uri($forum) {
132
  return Url::fromRoute('forum.page', ['taxonomy_term' => $forum->id()]);
133 134
}

135
/**
136
 * Implements hook_entity_bundle_field_info_alter().
137
 */
138 139 140
function forum_entity_bundle_field_info_alter(&$fields, \Drupal\Core\Entity\EntityTypeInterface $entity_type, $bundle) {
  if ($entity_type->id() == 'node'  && !empty($fields['taxonomy_forums'])) {
    $fields['taxonomy_forums']->addConstraint('ForumLeaf', []);
141 142
  }
}
143

144
/**
145
 * Implements hook_ENTITY_TYPE_presave() for node entities.
146
 *
147
 * Assigns the forum taxonomy when adding a topic from within a forum.
148
 */
149
function forum_node_presave(EntityInterface $node) {
150
  if (\Drupal::service('forum_manager')->checkNodeType($node)) {
151 152
    // Make sure all fields are set properly:
    $node->icon = !empty($node->icon) ? $node->icon : '';
153 154
    if (!$node->taxonomy_forums->isEmpty()) {
      $node->forum_tid = $node->taxonomy_forums->target_id;
155 156
      // Only do a shadow copy check if this is not a new node.
      if (!$node->isNew()) {
157
        $old_tid = \Drupal::service('forum.index_storage')->getOriginalTermId($node);
158 159
        if ($old_tid && isset($node->forum_tid) && ($node->forum_tid != $old_tid) && !empty($node->shadow)) {
          // A shadow copy needs to be created. Retain new term and add old term.
160
          $node->taxonomy_forums[count($node->taxonomy_forums)] = array('target_id' => $old_tid);
161
        }
162 163 164 165
      }
    }
  }
}
166

167
/**
168
 * Implements hook_ENTITY_TYPE_update() for node entities.
169
 */
170
function forum_node_update(EntityInterface $node) {
171
  if (\Drupal::service('forum_manager')->checkNodeType($node)) {
172 173
    // If this is not a new revision and does exist, update the forum record,
    // otherwise insert a new one.
174 175 176
    /** @var \Drupal\forum\ForumIndexStorageInterface $forum_index_storage */
    $forum_index_storage = \Drupal::service('forum.index_storage');
    if ($node->getRevisionId() == $node->original->getRevisionId() && $forum_index_storage->getOriginalTermId($node)) {
177
      if (!empty($node->forum_tid)) {
178
        $forum_index_storage->update($node);
179 180 181
      }
      // The node is removed from the forum.
      else {
182
        $forum_index_storage->delete($node);
183 184 185
      }
    }
    else {
186
      if (!empty($node->forum_tid)) {
187
        $forum_index_storage->create($node);
188
      }
189
    }
190 191
    // If the node has a shadow forum topic, update the record for this
    // revision.
192
    if (!empty($node->shadow)) {
193 194
      $forum_index_storage->deleteRevision($node);
      $forum_index_storage->create($node);
195 196 197 198
    }

    // If the node is published, update the forum index.
    if ($node->isPublished()) {
199 200
      $forum_index_storage->deleteIndex($node);
      $forum_index_storage->createIndex($node);
201 202 203
    }
    // When a forum node is unpublished, remove it from the forum_index table.
    else {
204
      $forum_index_storage->deleteIndex($node);
205
    }
206 207
  }
}
208

209
/**
210
 * Implements hook_ENTITY_TYPE_insert() for node entities.
211
 */
212
function forum_node_insert(EntityInterface $node) {
213
  if (\Drupal::service('forum_manager')->checkNodeType($node)) {
214 215
    /** @var \Drupal\forum\ForumIndexStorageInterface $forum_index_storage */
    $forum_index_storage = \Drupal::service('forum.index_storage');
216
    if (!empty($node->forum_tid)) {
217
      $forum_index_storage->create($node);
218
    }
219 220 221

    // If the node is published, update the forum index.
    if ($node->isPublished()) {
222
      $forum_index_storage->createIndex($node);
223
    }
224 225
  }
}
226

227
/**
228
 * Implements hook_ENTITY_TYPE_predelete() for node entities.
229
 */
230
function forum_node_predelete(EntityInterface $node) {
231
  if (\Drupal::service('forum_manager')->checkNodeType($node)) {
232 233 234 235
    /** @var \Drupal\forum\ForumIndexStorageInterface $forum_index_storage */
    $forum_index_storage = \Drupal::service('forum.index_storage');
    $forum_index_storage->delete($node);
    $forum_index_storage->deleteIndex($node);
236
  }
237
}
238

239
/**
240
 * Implements hook_ENTITY_TYPE_storage_load() for node entities.
241
 */
242
function forum_node_storage_load($nodes) {
243 244
  $node_vids = array();
  foreach ($nodes as $node) {
245
    if (\Drupal::service('forum_manager')->checkNodeType($node)) {
246
      $node_vids[] = $node->getRevisionId();
247 248 249
    }
  }
  if (!empty($node_vids)) {
250
    $result = \Drupal::service('forum.index_storage')->read($node_vids);
251 252 253
    foreach ($result as $record) {
      $nodes[$record->nid]->forum_tid = $record->tid;
    }
254
  }
255 256
}

257
/**
258
 * Implements hook_ENTITY_TYPE_update() for comment entities.
259
 */
260
function forum_comment_update(CommentInterface $comment) {
261
  if ($comment->getCommentedEntityTypeId() == 'node') {
262
    \Drupal::service('forum.index_storage')->updateIndex($comment->getCommentedEntity());
263 264 265 266
  }
}

/**
267
 * Implements hook_ENTITY_TYPE_insert() for comment entities.
268
 */
269
function forum_comment_insert(CommentInterface $comment) {
270
  if ($comment->getCommentedEntityTypeId() == 'node') {
271
    \Drupal::service('forum.index_storage')->updateIndex($comment->getCommentedEntity());
272
  }
273 274 275
}

/**
276
 * Implements hook_ENTITY_TYPE_delete() for comment entities.
277
 */
278
function forum_comment_delete(CommentInterface $comment) {
279
  if ($comment->getCommentedEntityTypeId() == 'node') {
280
    \Drupal::service('forum.index_storage')->updateIndex($comment->getCommentedEntity());
281
  }
282 283
}

284
/**
285
 * Implements hook_form_BASE_FORM_ID_alter().
286
 */
287
function forum_form_taxonomy_vocabulary_form_alter(&$form, FormStateInterface $form_state, $form_id) {
288
  $vid = \Drupal::config('forum.settings')->get('vocabulary');
289
  $vocabulary = $form_state->getFormObject()->getEntity();
290
  if ($vid == $vocabulary->id()) {
291 292 293 294 295 296 297 298 299 300
    $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;
301 302
    // Do not allow to change a vid of forum's vocabulary.
    $form['vid']['#disabled'] = TRUE;
303 304 305 306
  }
}

/**
307
 * Implements hook_form_FORM_ID_alter() for taxonomy_term_form().
308
 */
309
function forum_form_taxonomy_term_form_alter(&$form, FormStateInterface $form_state, $form_id) {
310
  $vid = \Drupal::config('forum.settings')->get('vocabulary');
311
  if (isset($form['vid']['#value']) && $form['vid']['#value'] == $vid) {
312
    // Hide multiple parents select from forum terms.
313
    $form['relations']['parent']['#access'] = FALSE;
314
  }
315 316 317
}

/**
318
 * Implements hook_form_BASE_FORM_ID_alter() for node_form().
319
 */
320
function forum_form_node_form_alter(&$form, FormStateInterface $form_state, $form_id) {
321
  $node = $form_state->getFormObject()->getEntity();
322 323 324 325 326 327 328 329 330 331 332 333 334
  if (isset($node->taxonomy_forums) && !$node->isNew()) {
    $forum_terms = $node->taxonomy_forums;
    // If editing, give option to leave shadows.
    $shadow = (count($forum_terms) > 1);
    $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.'),
    );
    $form['forum_tid'] = array('#type' => 'value', '#value' => $node->forum_tid);
  }

335
  if (isset($form['taxonomy_forums'])) {
336
    $widget =& $form['taxonomy_forums']['widget'];
337
    // Make the vocabulary required for 'real' forum-nodes.
338 339 340
    $widget['#required'] = TRUE;
    $widget['#multiple'] = FALSE;
    if (empty($widget['#default_value'])) {
341
      // If there is no default forum already selected, try to get the forum
342 343
      // 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).
344
      $requested_forum_id = \Drupal::request()->query->get('forum_id');
345
      $widget['#default_value'] = is_numeric($requested_forum_id) ? $requested_forum_id : '';
346
    }
347
  }
348 349
}

350
/**
351
 * Implements hook_preprocess_HOOK() for block templates.
352 353
 */
function forum_preprocess_block(&$variables) {
354
  if ($variables['configuration']['provider'] == 'forum') {
355
    $variables['attributes']['role'] = 'navigation';
356 357 358
  }
}

359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
/**
 * Implements hook_theme_suggestions_HOOK().
 */
function forum_theme_suggestions_forums(array $variables) {
  $suggestions = array();
  $tid = $variables['term']->id();

  // Provide separate template suggestions based on what's being output. Topic
  // ID is also accounted for. Check both variables to be safe then the inverse.
  // Forums with topic IDs take precedence.
  if ($variables['forums'] && !$variables['topics']) {
    $suggestions[] = 'forums__containers';
    $suggestions[] = 'forums__' . $tid;
    $suggestions[] = 'forums__containers__' . $tid;
  }
  elseif (!$variables['forums'] && $variables['topics']) {
    $suggestions[] = 'forums__topics';
    $suggestions[] = 'forums__' . $tid;
    $suggestions[] = 'forums__topics__' . $tid;
  }
  else {
    $suggestions[] = 'forums__' . $tid;
  }

  return $suggestions;
}

386
/**
387
 * Prepares variables for forums templates.
388
 *
389 390 391
 * Default template: forums.html.twig.
 *
 * @param array $variables
392 393 394 395 396 397
 *   An array containing the following elements:
 *   - forums: An array of all forum objects to display for the given taxonomy
 *     term ID. If tid = 0 then all the top-level forums are displayed.
 *   - topics: An array of all the topics in the current forum.
 *   - parents: An array of taxonomy term objects that are ancestors of the
 *     current term ID.
398
 *   - term: Taxonomy term of the current forum.
399 400 401 402 403 404
 *   - sortby: One of the following integers indicating the sort criteria:
 *     - 1: Date - newest first.
 *     - 2: Date - oldest first.
 *     - 3: Posts with the most comments first.
 *     - 4: Posts with the least comments first.
 *   - forum_per_page: The maximum number of topics to display per page.
405
 */
406
function template_preprocess_forums(&$variables) {
407
  $variables['tid'] = $variables['term']->id();
408
  if ($variables['forums_defined'] = count($variables['forums']) || count($variables['parents'])) {
409
    if (!empty($variables['forums'])) {
410 411 412 413 414 415
      $variables['forums'] = array(
        '#theme' => 'forum_list',
        '#forums' => $variables['forums'],
        '#parents' => $variables['parents'],
        '#tid' => $variables['tid'],
      );
416
    }
417

418
    if ($variables['term'] && empty($variables['term']->forum_container->value) && !empty($variables['topics'])) {
419
      $forum_topic_list_header = $variables['header'];
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448

      $table = array(
        '#theme' => 'table__forum_topic_list',
        '#responsive' => FALSE,
        '#attributes' => array('id' => 'forum-topic-' . $variables['tid']),
        '#header' => array(),
        '#rows' => array(),
      );

      if (!empty($forum_topic_list_header)) {
        $table['#header'] = $forum_topic_list_header;
      }

      /** @var \Drupal\node\NodeInterface $topic */
      foreach ($variables['topics'] as $id => $topic) {
        $variables['topics'][$id]->icon = array(
          '#theme' => 'forum_icon',
          '#new_posts' => $topic->new,
          '#num_posts' => $topic->comment_count,
          '#comment_mode' => $topic->comment_mode,
          '#sticky' => $topic->isSticky(),
          '#first_new' => $topic->first_new,
        );

        // We keep the actual tid in forum table, if it's different from the
        // current tid then it means the topic appears in two forums, one of
        // them is a shadow copy.
        if ($variables['tid'] != $topic->forum_tid) {
          $variables['topics'][$id]->moved = TRUE;
449
          $variables['topics'][$id]->title = SafeMarkup::checkPlain($topic->getTitle());
450
          $variables['topics'][$id]->message = \Drupal::l(t('This topic has been moved'), new Url('forum.page', ['taxonomy_term' => $topic->forum_tid]));
451 452 453
        }
        else {
          $variables['topics'][$id]->moved = FALSE;
454
          $variables['topics'][$id]->title_link = \Drupal::l($topic->getTitle(), $topic->urlInfo());
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
          $variables['topics'][$id]->message = '';
        }
        $forum_submitted = array('#theme' => 'forum_submitted', '#topic' => (object) array(
          'uid' => $topic->getOwnerId(),
          'name' => $topic->getOwner()->getUsername(),
          'created' => $topic->getCreatedTime(),
        ));
        $variables['topics'][$id]->submitted = drupal_render($forum_submitted);
        $forum_submitted = array(
          '#theme' => 'forum_submitted',
          '#topic' => isset($topic->last_reply) ? $topic->last_reply : NULL,
        );
        $variables['topics'][$id]->last_reply = drupal_render($forum_submitted);

        $variables['topics'][$id]->new_text = '';
        $variables['topics'][$id]->new_url = '';

        if ($topic->new_replies) {
473 474 475
          $page_number = \Drupal::entityManager()->getStorage('comment')
            ->getNewCommentPageNumber($topic->comment_count, $topic->new_replies, $topic, 'comment_forum');
          $query = $page_number ? array('page' => $page_number) : NULL;
476
          $variables['topics'][$id]->new_text = \Drupal::translation()->formatPlural($topic->new_replies, '1 new post<span class="visually-hidden"> in topic %title</span>', '@count new posts<span class="visually-hidden"> in topic %title</span>', array('%title' => $variables['topics'][$id]->label()));
477
          $variables['topics'][$id]->new_url = \Drupal::url('entity.node.canonical', ['node' => $topic->id()], ['query' => $query, 'fragment' => 'new']);
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
        }

        // Build table rows from topics.
        $row = array();
        $row[] = array(
          'data' => array(
            $topic->icon,
            array(
              '#markup' => '<div class="title"><div>' . $topic->title_link . '</div><div>' . $topic->submitted . '</div></div>',
            ),
          ),
          'class' => array('topic'),
        );

        if ($topic->moved) {
          $row[] = array(
            'data' => $topic->message,
            'colspan' => '2',
          );
        }
        else {
          $new_replies = '';
          if ($topic->new_replies) {
            $new_replies = '<br /><a href="' . $topic->new_url . '">' . $topic->new_text . '</a>';
          }

          $row[] = array(
            'data' => $topic->comment_count . $new_replies,
            'class' => array('replies'),
          );
          $row[] = array(
            'data' => $topic->last_reply,
            'class' => array('last-reply'),
          );
        }
        $table['#rows'][] = $row;
      }

      $variables['topics'] = $table;
      $variables['topics_pager'] = array(
518
        '#type' => 'pager',
519
      );
520
    }
521 522 523
  }
}

524
/**
525
 * Prepares variables for forum list templates.
526
 *
527 528 529
 * Default template: forum-list.html.twig.
 *
 * @param array $variables
530 531 532 533 534 535
 *   An array containing the following elements:
 *   - forums: An array of all forum objects to display for the given taxonomy
 *     term ID. If tid = 0 then all the top-level forums are displayed.
 *   - parents: An array of taxonomy term objects that are ancestors of the
 *     current term ID.
 *   - tid: Taxonomy term ID of the current forum.
536
 */
537
function template_preprocess_forum_list(&$variables) {
538
  $user = \Drupal::currentUser();
539
  $row = 0;
540 541
  // Sanitize each forum so that the template can safely print the data.
  foreach ($variables['forums'] as $id => $forum) {
542
    $variables['forums'][$id]->description = Xss::filterAdmin($forum->description->value);
543
    $variables['forums'][$id]->link = forum_uri($forum);
544
    $variables['forums'][$id]->name = SafeMarkup::checkPlain($forum->label());
545
    $variables['forums'][$id]->is_container = !empty($forum->forum_container->value);
546 547 548 549 550 551 552
    $variables['forums'][$id]->zebra = $row % 2 == 0 ? 'odd' : 'even';
    $row++;

    $variables['forums'][$id]->new_text = '';
    $variables['forums'][$id]->new_url = '';
    $variables['forums'][$id]->new_topics = 0;
    $variables['forums'][$id]->old_topics = $forum->num_topics;
553 554
    $variables['forums'][$id]->icon_class = 'default';
    $variables['forums'][$id]->icon_title = t('No new posts');
555
    if ($user->isAuthenticated()) {
556
      $variables['forums'][$id]->new_topics = \Drupal::service('forum_manager')->unreadTopics($forum->id(), $user->id());
557
      if ($variables['forums'][$id]->new_topics) {
558
        $variables['forums'][$id]->new_text = \Drupal::translation()->formatPlural($variables['forums'][$id]->new_topics, '1 new post<span class="visually-hidden"> in forum %title</span>', '@count new posts<span class="visually-hidden"> in forum %title</span>', array('%title' => $variables['forums'][$id]->label()));
559
        $variables['forums'][$id]->new_url = \Drupal::url('forum.page', ['taxonomy_term' => $forum->id()], ['fragment' => 'new']);
560 561
        $variables['forums'][$id]->icon_class = 'new';
        $variables['forums'][$id]->icon_title = t('New posts');
Dries's avatar
Dries committed
562
      }
563
      $variables['forums'][$id]->old_topics = $forum->num_topics - $variables['forums'][$id]->new_topics;
564
    }
565 566
    $forum_submitted = array('#theme' => 'forum_submitted', '#topic' => $forum->last_post);
    $variables['forums'][$id]->last_reply = drupal_render($forum_submitted);
567
  }
568 569

  $variables['pager'] = array(
570
   '#type' => 'pager',
571 572 573
  );

  // Give meaning to $tid for themers. $tid actually stands for term ID.
574 575
  $variables['forum_id'] = $variables['tid'];
  unset($variables['tid']);
576 577
}

578
/**
579
 * Prepares variables for forum icon templates.
580
 *
581 582 583
 * Default template: forum-icon.html.twig.
 *
 * @param array $variables
584 585 586 587 588 589 590
 *   An array containing the following elements:
 *   - new_posts: Indicates whether or not the topic contains new posts.
 *   - num_posts: The total number of posts in all topics.
 *   - comment_mode: An integer indicating whether comments are open, closed,
 *     or hidden.
 *   - sticky: Indicates whether the topic is sticky.
 *   - first_new: Indicates whether this is the first topic with new posts.
591
 */
592
function template_preprocess_forum_icon(&$variables) {
593
  $variables['hot_threshold'] = \Drupal::config('forum.settings')->get('topics.hot_threshold');
594

595
  if ($variables['num_posts'] > $variables['hot_threshold']) {
596
    $variables['icon_status'] = $variables['new_posts'] ? 'hot-new' : 'hot';
597
    $variables['icon_title'] = $variables['new_posts'] ? t('Hot topic, new comments') : t('Hot topic');
598 599
  }
  else {
600
    $variables['icon_status'] = $variables['new_posts'] ? 'new' : 'default';
601
    $variables['icon_title'] = $variables['new_posts'] ? t('New comments') : t('Normal topic');
602
  }
603

604
  if ($variables['comment_mode'] == CommentItemInterface::CLOSED || $variables['comment_mode'] == CommentItemInterface::HIDDEN) {
605
    $variables['icon_status'] = 'closed';
606
    $variables['icon_title'] = t('Closed topic');
607 608
  }

609
  if ($variables['sticky'] == 1) {
610
    $variables['icon_status'] = 'sticky';
611
    $variables['icon_title'] = t('Sticky topic');
612
  }
613 614

  $variables['attributes']['title'] = $variables['icon_title'];
615 616
}

617
/**
618
 * Prepares variables for forum submission information templates.
619 620 621
 *
 * The submission information will be displayed in the forum list and topic
 * list.
622
 *
623 624 625
 * Default template: forum-submitted.html.twig.
 *
 * @param array $variables
626 627
 *   An array containing the following elements:
 *   - topic: The topic object.
628
 */
629
function template_preprocess_forum_submitted(&$variables) {
630 631 632 633 634
  $variables['author'] = '';
  if (isset($variables['topic']->uid)) {
    $username = array('#theme' => 'username', '#account' => user_load($variables['topic']->uid));
    $variables['author'] = drupal_render($username);
  }
635
  $variables['time'] = isset($variables['topic']->created) ? \Drupal::service('date.formatter')->formatInterval(REQUEST_TIME - $variables['topic']->created) : '';
636
}
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696

/**
 * Implements hook_system_info_alter().
 *
 * Prevents forum module from being uninstalled whilst any forum nodes exist
 * or there are any terms in the forum vocabulary.
 */
function forum_system_info_alter(&$info, Extension $file, $type) {
  // It is not safe use the entity query service during maintenance mode.
  if ($type == 'module' && !defined('MAINTENANCE_MODE') && $file->getName() == 'forum') {
    $factory = \Drupal::service('entity.query');
    $nodes = $factory->get('node')
      ->condition('type', 'forum')
      ->accessCheck(FALSE)
      ->range(0, 1)
      ->execute();
    if (!empty($nodes)) {
      $info['required'] = TRUE;
      $info['explanation'] = t('To uninstall Forum first delete all <em>Forum</em> content.');
    }
    $vid = \Drupal::config('forum.settings')->get('vocabulary');
    $terms = $factory->get('taxonomy_term')
      ->condition('vid', $vid)
      ->accessCheck(FALSE)
      ->range(0, 1)
      ->execute();
    if (!empty($terms)) {
      $vocabulary = Vocabulary::load($vid);
      $info['required'] = TRUE;
      try {
        if (!empty($info['explanation'])) {
          if ($vocabulary->access('view')) {
            $info['explanation'] = t('To uninstall Forum first delete all <em>Forum</em> content and <a href="!url">%vocabulary</a> terms.', [
              '%vocabulary' => $vocabulary->label(),
              '!url' => $vocabulary->url('overview-form'),
            ]);
          }
          else {
            $info['explanation'] = t('To uninstall Forum first delete all <em>Forum</em> content and %vocabulary terms.', [
              '%vocabulary' => $vocabulary->label()
            ]);
          }
        }
        else {
          $info['explanation'] = t('To uninstall Forum first delete all <a href="!url">%vocabulary</a> terms.', [
            '%vocabulary' => $vocabulary->label(),
            '!url' => $vocabulary->url('overview-form'),
          ]);
        }
      }
      catch (RouteNotFoundException $e) {
        // Route rebuilding might not have occurred before this hook is fired.
        // Just use an explanation without a link for the time being.
        $info['explanation'] = t('To uninstall Forum first delete all <em>Forum</em> content and %vocabulary terms.', [
          '%vocabulary' => $vocabulary->label()
        ]);
      }
    }
  }
}