book.module 26.6 KB
Newer Older
Dries's avatar
 
Dries committed
1 2
<?php

Dries's avatar
 
Dries committed
3 4
/**
 * @file
5
 * Allows users to create and organize related content in an outline.
Dries's avatar
 
Dries committed
6 7
 */

8
use Drupal\book\BookManagerInterface;
9
use Drupal\Component\Utility\String;
10
use Drupal\Core\Entity\EntityInterface;
11
use Drupal\node\NodeInterface;
12
use Drupal\node\NodeTypeInterface;
13
use Drupal\Core\Language\Language;
14
use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
15
use Drupal\Core\Template\Attribute;
16

17
/**
18
 * Implements hook_help().
19 20 21 22 23
 */
function book_help($path, $arg) {
  switch ($path) {
    case 'admin/help#book':
      $output = '<h3>' . t('About') . '</h3>';
24
      $output .= '<p>' . t('The Book module is used for creating structured, multi-page content, such as site resource guides, manuals, and wikis. It allows you to create content that has chapters, sections, subsections, or any similarly-tiered structure. For more information, see the <a href="!book">online documentation for the Book module</a>.', array('!book' => 'https://drupal.org/documentation/modules/book')) . '</p>';
25 26 27
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Adding and managing book content') . '</dt>';
28
      $output .= '<dd>' . t('You can assign separate permissions for <em>creating new books</em> as well as <em>creating</em>, <em>editing</em> and <em>deleting</em> book content. Users with the <em>Administer book outlines</em> permission can add <em>any</em> type of content to a book by selecting the appropriate book outline while editing the content. They can also view a list of all books, and edit and rearrange section titles on the <a href="!admin-book">Book administration page</a>.', array('!admin-book' => \Drupal::url('book.admin'))) . '</dd>';
29
      $output .= '<dt>' . t('Book navigation') . '</dt>';
30
      $output .= '<dd>' . t("Book pages have a default book-specific navigation block. This navigation block contains links that lead to the previous and next pages in the book, and to the level above the current page in the book's structure. This block can be enabled on the <a href='!admin-block'>Blocks administration page</a>. For book pages to show up in the book navigation, they must be added to a book outline.", array('!admin-block' => \Drupal::url('block.admin_display'))) . '</dd>';
31 32 33
      $output .= '<dt>' . t('Collaboration') . '</dt>';
      $output .= '<dd>' . t('Books can be created collaboratively, as they allow users with appropriate permissions to add pages into existing books, and add those pages to a custom table of contents menu.') . '</dd>';
      $output .= '<dt>' . t('Printing books') . '</dt>';
34
      $output .= '<dd>' . t("Users with the <em>View printer-friendly books</em> permission can select the <em>printer-friendly version</em> link visible at the bottom of a book page's content to generate a printer-friendly display of the page and all of its subsections.") . '</dd>';
35 36
      $output .= '</dl>';
      return $output;
37
    case 'admin/structure/book':
38 39
      return '<p>' . t('The book module offers a means to organize a collection of related content pages, collectively known as a book. When viewed, this content automatically displays links to adjacent book pages, providing a simple navigation system for creating and reviewing structured content.') . '</p>';
    case 'node/%/outline':
40
      return '<p>' . t('The outline feature allows you to include pages in the <a href="!book">Book hierarchy</a>, as well as move them within the hierarchy or to <a href="!book-admin">reorder an entire book</a>.', array('!book' => \Drupal::url('book.render'), '!book-admin' => \Drupal::url('book.admin'))) . '</p>';
41 42 43
  }
}

44
/**
45
 * Implements hook_theme().
46 47 48 49
 */
function book_theme() {
  return array(
    'book_navigation' => array(
50
      'variables' => array('book_link' => NULL),
51
      'template' => 'book-navigation',
52
    ),
53 54 55
    'book_link' => array(
      'render element' => 'element',
    ),
56
    'book_export_html' => array(
57
      'variables' => array('title' => NULL, 'contents' => NULL, 'depth' => NULL),
58
      'template' => 'book-export-html',
59 60
    ),
    'book_admin_table' => array(
61
      'render element' => 'form',
62
      'file' => 'book.admin.inc',
63
    ),
Dries's avatar
Dries committed
64
    'book_all_books_block' => array(
65
      'render element' => 'book_menus',
66 67 68
      'template' => 'book-all-books-block',
    ),
    'book_node_export_html' => array(
69
      'variables' => array('node' => NULL, 'children' => NULL),
70
      'template' => 'book-node-export-html',
Dries's avatar
Dries committed
71
    ),
72 73 74
  );
}

75
/**
76
 * Implements hook_permission().
77
 */
78
function book_permission() {
79
  return array(
80 81 82 83 84 85 86
    'administer book outlines' => array(
      'title' => t('Administer book outlines'),
    ),
    'create new books' => array(
      'title' => t('Create new books'),
    ),
    'add content to books' => array(
87
      'title' => t('Add content and child pages to books'),
88 89
    ),
    'access printer-friendly version' => array(
90
      'title' => t('View printer-friendly books'),
91 92
      'description' => t('View a book page and all of its sub-pages as a single document for ease of printing. Can be performance heavy.'),
    ),
93
  );
Dries's avatar
 
Dries committed
94 95
}

96
/**
97
 * Implements hook_entity_type_build().
98
 */
99 100 101
function book_entity_type_build(array &$entity_types) {
  /** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */
  $entity_types['node']
102 103 104
    ->setFormClass('book_outline', 'Drupal\book\Form\BookOutlineForm')
    ->setLinkTemplate('book-outline-form', 'book.outline')
    ->setLinkTemplate('book-remove-form', 'book.remove');
105 106
}

Dries's avatar
 
Dries committed
107
/**
108
 * Implements hook_node_links_alter().
Dries's avatar
 
Dries committed
109
 */
110 111 112 113 114 115 116 117 118 119 120 121
function book_node_links_alter(array &$node_links, NodeInterface $node, array &$context) {
  if ($context['view_mode'] != 'rss') {
    $account = \Drupal::currentUser();

    if (isset($node->book['depth'])) {
      if ($context['view_mode'] == 'full' && node_is_page($node)) {
        $child_type = \Drupal::config('book.settings')->get('child_type');
        $access_controller = \Drupal::entityManager()->getAccessController('node');
        if (($account->hasPermission('add content to books') || $account->hasPermission('administer book outlines')) && $access_controller->createAccess($child_type) && $node->isPublished() && $node->book['depth'] < MENU_MAX_DEPTH) {
          $links['book_add_child'] = array(
            'title' => t('Add child page'),
            'href' => 'node/add/' . $child_type,
122
            'query' => array('parent' => $node->id()),
123 124 125 126 127 128 129 130 131 132
          );
        }

        if ($account->hasPermission('access printer-friendly version')) {
          $links['book_printer'] = array(
            'title' => t('Printer-friendly version'),
            'href' => 'book/export/html/' . $node->id(),
            'attributes' => array('title' => t('Show a printer-friendly version of this book page and its sub-pages.'))
          );
        }
133
      }
Dries's avatar
 
Dries committed
134
    }
135

136 137 138 139 140 141 142
    if (!empty($links)) {
      $node_links['book'] = array(
        '#theme' => 'links__node__book',
        '#links' => $links,
        '#attributes' => array('class' => array('links', 'inline')),
      );
    }
143
  }
Dries's avatar
 
Dries committed
144 145
}

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
/**
 * Implements hook_menu_link_defaults().
 */
function book_menu_link_defaults() {
  $links['book.admin.outlines'] = array(
    'link_title' => 'Books',
    'description' => "Manage your site's book outlines.",
    'parent' => 'system.admin.structure',
    'route_name' => 'book.admin',
  );
  $links['book'] = array(
    'link_title' => 'Books',
    'route_name' => 'book.render',
    // @todo what to do about MENU_SUGGESTED_ITEM, maybe specify no menu_name?
    'type' => MENU_SUGGESTED_ITEM,
  );

  return $links;
}

166 167 168 169
/**
 * Implements hook_admin_paths().
 */
function book_admin_paths() {
170
  if (\Drupal::config('node.settings')->get('use_admin_theme')) {
171 172 173 174 175 176
    $paths = array(
      'node/*/outline' => TRUE,
      'node/*/outline/remove' => TRUE,
    );
    return $paths;
  }
177 178
}

179
/**
Dries's avatar
Dries committed
180 181
 * Returns an array of all books.
 *
182 183
 * @todo Remove in favor of BookManager Service. http://drupal.org/node/1963894
 *
Dries's avatar
Dries committed
184 185
 * This list may be used for generating a list of all the books, or for building
 * the options for a form select.
186 187 188
 *
 * @return
 *   An array of all books.
189
 */
Dries's avatar
Dries committed
190
function book_get_books() {
191
  return \Drupal::service('book.manager')->getAllBooks();
192
}
193

Dries's avatar
Dries committed
194
/**
195
 * Implements hook_form_BASE_FORM_ID_alter() for node_form().
196
 *
197
 * Adds the book form element to the node form.
198 199
 *
 * @see book_pick_book_nojs_submit()
Dries's avatar
Dries committed
200
 */
201
function book_form_node_form_alter(&$form, &$form_state, $form_id) {
202
  $node = $form_state['controller']->getEntity();
203
  $account = \Drupal::currentUser();
204
  $access = $account->hasPermission('administer book outlines');
205
  if (!$access) {
206
    if ($account->hasPermission('add content to books') && ((!empty($node->book['bid']) && !$node->isNew()) || book_type_is_allowed($node->getType()))) {
207 208
      // Already in the book hierarchy, or this node type is allowed.
      $access = TRUE;
Dries's avatar
Dries committed
209
    }
210
  }
Dries's avatar
Dries committed
211

212
  if ($access) {
213 214
    $collapsed = !($node->isNew() && !empty($node->book['pid']));
    $form = \Drupal::service('book.manager')->addFormElements($form, $form_state, $node, $account, $collapsed);
215
    // Since the "Book" dropdown can't trigger a form submission when
216
    // JavaScript is disabled, add a submit button to do that. book.admin.css hides
217 218 219 220 221 222
    // this button when JavaScript is enabled.
    $form['book']['pick-book'] = array(
      '#type' => 'submit',
      '#value' => t('Change book (update list of parents)'),
      '#submit' => array('book_pick_book_nojs_submit'),
      '#weight' => 20,
223
      '#attached' => array(
224
        'css' => array(drupal_get_path('module', 'book') . '/css/book.admin.css'),
225
      ),
226
    );
227
    $form['#entity_builders'][] = 'book_node_builder';
228
  }
Dries's avatar
Dries committed
229
}
230

231 232 233 234 235 236 237 238 239
/**
 * Entity form builder to add the book information to the node.
 *
 * @todo: Remove this in favor of an entity field.
 */
function book_node_builder($entity_type, $entity, &$form, &$form_state) {
  $entity->book = $form_state['values']['book'];
}

240
/**
241
 * Form submission handler for node_form().
242 243 244 245 246
 *
 * This handler is run when JavaScript is disabled. It triggers the form to
 * rebuild so that the "Parent item" options are changed to reflect the newly
 * selected book. When JavaScript is enabled, the submit button that triggers
 * this handler is hidden, and the "Book" dropdown directly triggers the
247
 * book_form_update() Ajax callback instead.
248 249
 *
 * @see book_form_update()
250
 * @see book_form_node_form_alter()
251 252
 */
function book_pick_book_nojs_submit($form, &$form_state) {
253
  $node = $form_state['controller']->getEntity();
254
  $node->book = $form_state['values']['book'];
255 256 257
  $form_state['rebuild'] = TRUE;
}

258 259 260
/**
 * Renders a new parent page select element when the book selection changes.
 *
261
 * This function is called via Ajax when the selected book is changed on a node
262 263 264 265 266 267
 * or book outline form.
 *
 * @return
 *   The rendered parent page select element.
 */
function book_form_update($form, $form_state) {
268
  return $form['book']['pid'];
269 270
}

Dries's avatar
Dries committed
271
/**
272
 * Gets the book menu tree for a page and returns it as a linear array.
273
 *
Dries's avatar
Dries committed
274 275
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
276
 *
277
 * @return
Dries's avatar
Dries committed
278 279
 *   A linear array of menu links in the order that the links are shown in the
 *   menu, so the previous and next pages are the elements before and after the
280 281 282
 *   element corresponding to the current node. The children of the current node
 *   (if any) will come immediately after it in the array, and links will only
 *   be fetched as deep as one level deeper than $book_link.
283
 */
Dries's avatar
Dries committed
284
function book_get_flat_menu($book_link) {
285
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
286

287 288 289 290 291
  if (!isset($flat[$book_link['nid']])) {
    // Call bookTreeAllData() to take advantage of caching.
    $tree = \Drupal::service('book.manager')->bookTreeAllData($book_link['bid'], $book_link, $book_link['depth'] + 1);
    $flat[$book_link['nid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['nid']]);
Dries's avatar
 
Dries committed
292
  }
293

294
  return $flat[$book_link['nid']];
Dries's avatar
 
Dries committed
295 296
}

297
/**
298 299 300 301 302
 * Recursively converts a tree of menu links to a flat array.
 *
 * @param $tree
 *   A tree of menu links in an array.
 * @param $flat
303
 *   A flat array of the menu links from $tree, passed by reference.
304 305
 *
 * @see book_get_flat_menu().
306
 */
Dries's avatar
Dries committed
307 308
function _book_flatten_menu($tree, &$flat) {
  foreach ($tree as $data) {
309 310 311
    $flat[$data['link']['nid']] = $data['link'];
    if ($data['below']) {
      _book_flatten_menu($data['below'], $flat);
Dries's avatar
Dries committed
312
    }
Dries's avatar
 
Dries committed
313
  }
Dries's avatar
Dries committed
314
}
Dries's avatar
 
Dries committed
315

Dries's avatar
Dries committed
316 317
/**
 * Fetches the menu link for the previous page of the book.
318 319 320 321 322 323 324
 *
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 *
 * @return
 *   A fully loaded menu link for the page before the one represented in
 *   $book_link.
Dries's avatar
Dries committed
325 326 327
 */
function book_prev($book_link) {
  // If the parent is zero, we are at the start of a book.
328
  if ($book_link['pid'] == 0) {
Dries's avatar
Dries committed
329
    return NULL;
Dries's avatar
 
Dries committed
330
  }
Dries's avatar
Dries committed
331
  // Assigning the array to $flat resets the array pointer for use with each().
332
  $flat = book_get_flat_menu($book_link);
Dries's avatar
Dries committed
333 334 335 336
  $curr = NULL;
  do {
    $prev = $curr;
    list($key, $curr) = each($flat);
337
  } while ($key && $key != $book_link['nid']);
Dries's avatar
Dries committed
338

339 340 341
  if ($key == $book_link['nid']) {
    /** @var \Drupal\book\BookManagerInterface $book_manager */
    $book_manager = \Drupal::service('book.manager');
Dries's avatar
Dries committed
342
    // The previous page in the book may be a child of the previous visible link.
343
    if ($prev['depth'] == $book_link['depth']) {
Dries's avatar
Dries committed
344
      // The subtree will have only one link at the top level - get its data.
345
      $tree = $book_manager->bookMenuSubtreeData($prev);
346
      $data = array_shift($tree);
Dries's avatar
Dries committed
347 348 349 350
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
351
      $book_manager->bookLinkTranslate($data['link']);
Dries's avatar
Dries committed
352 353 354
      return $data['link'];
    }
    else {
355
      $book_manager->bookLinkTranslate($prev);
Dries's avatar
Dries committed
356 357
      return $prev;
    }
Dries's avatar
 
Dries committed
358 359 360
  }
}

361
/**
Dries's avatar
Dries committed
362
 * Fetches the menu link for the next page of the book.
363 364 365 366 367
 *
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 *
 * @return
368
 *   A fully loaded book link for the page after the one represented in
369
 *   $book_link.
370
 */
Dries's avatar
Dries committed
371 372
function book_next($book_link) {
  // Assigning the array to $flat resets the array pointer for use with each().
373
  $flat = book_get_flat_menu($book_link);
Dries's avatar
Dries committed
374
  do {
375
    list($key, ) = each($flat);
376
  }
377
  while ($key && $key != $book_link['nid']);
378

379 380 381 382 383 384
  if ($key == $book_link['nid']) {
    $next = current($flat);
    if ($next) {
      \Drupal::service('book.manager')->bookLinkTranslate($next);
    }
    return $next;
Dries's avatar
 
Dries committed
385
  }
Dries's avatar
Dries committed
386
}
Dries's avatar
 
Dries committed
387

Dries's avatar
Dries committed
388
/**
389 390 391 392 393 394 395
 * Formats the menu links for the child pages of the current page.
 *
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 *
 * @return
 *   HTML for the links to the child pages of the current page.
Dries's avatar
Dries committed
396 397 398
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
399

Dries's avatar
Dries committed
400 401 402 403 404 405
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
406
    }
407
    while ($link && ($link['nid'] != $book_link['nid']));
Dries's avatar
Dries committed
408
    // Continue though the array and collect the links whose parent is this page.
409
    while (($link = array_shift($flat)) && $link['pid'] == $book_link['nid']) {
Dries's avatar
Dries committed
410 411 412
      $data['link'] = $link;
      $data['below'] = '';
      $children[] = $data;
Dries's avatar
 
Dries committed
413 414
    }
  }
415

416
  if ($children) {
417
    $elements = \Drupal::service('book.manager')->bookTreeOutput($children);
418 419 420
    return drupal_render($elements);
  }
  return '';
Dries's avatar
 
Dries committed
421 422
}

423
/**
424
 * Implements hook_node_load().
425
 */
426
function book_node_load($nodes) {
427
  $result = db_query("SELECT * FROM {book} WHERE nid IN (:nids)", array(':nids' =>  array_keys($nodes)), array('fetch' => PDO::FETCH_ASSOC));
428 429
  foreach ($result as $record) {
    $nodes[$record['nid']]->book = $record;
430 431
    $nodes[$record['nid']]->book['link_path'] = 'node/' . $record['nid'];
    $nodes[$record['nid']]->book['link_title'] = $nodes[$record['nid']]->label();
432 433
  }
}
434

435
/**
436
 * Implements hook_node_view().
437
 */
438
function book_node_view(EntityInterface $node, EntityViewDisplayInterface $display, $view_mode) {
439
  if ($view_mode == 'full') {
440
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
441
      $book_navigation = array( '#theme' => 'book_navigation', '#book_link' => $node->book);
442
      $node->content['book_navigation'] = array(
443
        '#markup' => drupal_render($book_navigation),
444
        '#weight' => 100,
445 446 447 448 449
        '#attached' => array(
          'css' => array(
            drupal_get_path('module', 'book') . '/css/book.theme.css',
          ),
        ),
450 451 452
      );
    }
  }
453 454
}

455
/**
456
 * Implements hook_node_presave().
457
 */
458
function book_node_presave(EntityInterface $node) {
459
  // Always save a revision for non-administrators.
460
  if (!empty($node->book['bid']) && !\Drupal::currentUser()->hasPermission('administer nodes')) {
461
    $node->setNewRevision();
462 463
  }
  // Make sure a new node gets a new menu link.
464
  if ($node->isNew()) {
465
    $node->book['nid'] = NULL;
466 467
  }
}
468

469
/**
470
 * Implements hook_node_insert().
471
 */
472
function book_node_insert(EntityInterface $node) {
473
  $book_manager = \Drupal::service('book.manager');
474 475 476
  if (!empty($node->book['bid'])) {
    if ($node->book['bid'] == 'new') {
      // New nodes that are their own book.
477
      $node->book['bid'] = $node->id();
478
    }
479
    $book_manager->updateOutline($node);
480 481
  }
}
482

483
/**
484
 * Implements hook_node_update().
485
 */
486
function book_node_update(EntityInterface $node) {
487
  $book_manager = \Drupal::service('book.manager');
488 489 490
  if (!empty($node->book['bid'])) {
    if ($node->book['bid'] == 'new') {
      // New nodes that are their own book.
491
      $node->book['bid'] = $node->id();
492
    }
493
    $book_manager->updateOutline($node);
494 495
  }
}
496

497
/**
498
 * Implements hook_node_predelete().
499
 */
500
function book_node_predelete(EntityInterface $node) {
501
  if (!empty($node->book['bid'])) {
502 503 504
    /** @var \Drupal\book\BookManagerInterface $book_manager */
    $book_manager = \Drupal::service('book.manager');
    $book_manager->deleteFromBook($node->book['nid']);
505 506 507 508
  }
}

/**
509
 * Implements hook_node_prepare_form().
510
 */
511
function book_node_prepare_form(NodeInterface $node, $form_display, $operation, array &$form_state) {
512
  // Get BookManager service
513
  $book_manager = \Drupal::service('book.manager');
514

515
  // Prepare defaults for the add/edit form.
516
  $account = \Drupal::currentUser();
517
  if (empty($node->book) && ($account->hasPermission('add content to books') || $account->hasPermission('administer book outlines'))) {
518 519
    $node->book = array();

520
    $query = \Drupal::request()->query;
521
    if ($node->isNew() && !is_null($query->get('parent')) && is_numeric($query->get('parent'))) {
522
      // Handle "Add child page" links:
523
      $parent = $book_manager->loadBookLink($query->get('parent'), TRUE);
524 525 526

      if ($parent && $parent['access']) {
        $node->book['bid'] = $parent['bid'];
527
        $node->book['pid'] = $parent['nid'];
528
      }
529 530
    }
    // Set defaults.
531 532
    $node_ref = !$node->isNew() ? $node->id() : 'new';
    $node->book += $book_manager->getLinkDefaults($node_ref);
533 534 535 536 537 538 539 540
  }
  else {
    if (isset($node->book['bid']) && !isset($node->book['original_bid'])) {
      $node->book['original_bid'] = $node->book['bid'];
    }
  }
  // Find the depth limit for the parent select.
  if (isset($node->book['bid']) && !isset($node->book['parent_depth_limit'])) {
541
    $node->book['parent_depth_limit'] = $book_manager->getParentDepthLimit($node->book);
Dries's avatar
Dries committed
542 543 544 545
  }
}

/**
546
 * Implements hook_form_FORM_ID_alter() for node_delete_confirm().
547 548 549 550
 *
 * Alters the confirm form for a single node deletion.
 *
 * @see node_delete_confirm()
Dries's avatar
Dries committed
551 552 553 554 555 556
 */
function book_form_node_delete_confirm_alter(&$form, $form_state) {
  $node = node_load($form['nid']['#value']);

  if (isset($node->book) && $node->book['has_children']) {
    $form['book_warning'] = array(
557
      '#markup' => '<p>' . t('%title is part of a book outline, and has associated child pages. If you proceed with deletion, the child pages will be relocated automatically.', array('%title' => $node->label())) . '</p>',
Dries's avatar
Dries committed
558 559
      '#weight' => -10,
    );
Dries's avatar
 
Dries committed
560
  }
Dries's avatar
 
Dries committed
561
}
Dries's avatar
 
Dries committed
562

563
/**
564
 * Implements hook_preprocess_HOOK() for block templates.
565 566
 */
function book_preprocess_block(&$variables) {
567
  if ($variables['configuration']['module'] == 'book') {
568
    $variables['attributes']['role'] = 'navigation';
569 570 571
  }
}

572
/**
573 574 575
 * Prepares variables for book listing block templates.
 *
 * Default template: book-all-books-block.html.twig.
576
 *
577 578 579
 * All non-renderable elements are removed so that the template has full access
 * to the structured data but can also simply iterate over all elements and
 * render them (as in the default template).
580
 *
581 582
 * @param array $variables
 *   An associative array containing the following key:
583 584
 *   - book_menus: An associative array containing renderable menu links for all
 *     book menus.
585 586 587 588 589 590 591 592 593 594
 */
function template_preprocess_book_all_books_block(&$variables) {
  // Remove all non-renderable elements.
  $elements = $variables['book_menus'];
  $variables['book_menus'] = array();
  foreach (element_children($elements) as $index) {
    $variables['book_menus'][$index] = $elements[$index];
  }
}

Dries's avatar
Dries committed
595
/**
596 597 598
 * Prepares variables for book navigation templates.
 *
 * Default template: book-navigation.html.twig.
Dries's avatar
Dries committed
599
 *
600 601
 * @param array $variables
 *   An associative array containing the following key:
602
 *   - book_link: An associative array of book link properties.
603
 *     Properties used: bid, link_title, depth, pid, nid.
604
 */
605 606 607 608 609
function template_preprocess_book_navigation(&$variables) {
  $book_link = $variables['book_link'];

  // Provide extra variables for themers. Not needed by default.
  $variables['book_id'] = $book_link['bid'];
610
  $variables['book_title'] = String::checkPlain($book_link['link_title']);
611
  $variables['book_url'] = \Drupal::url('node.view', array('node' => $book_link['bid']));
612 613
  $variables['current_depth'] = $book_link['depth'];
  $variables['tree'] = '';
614

615
  if ($book_link['nid']) {
616
    $variables['tree'] = book_children($book_link);
Dries's avatar
 
Dries committed
617

618 619
    $build = array();

Dries's avatar
Dries committed
620
    if ($prev = book_prev($book_link)) {
621
      $prev_href = \Drupal::url('node.view', array('node' => $prev['nid']));
622 623 624 625
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'prev',
        'href' => $prev_href,
      );
626
      $variables['prev_url'] = $prev_href;
627
      $variables['prev_title'] = String::checkPlain($prev['title']);
Dries's avatar
 
Dries committed
628
    }
629

630 631 632 633
    /** @var \Drupal\book\BookManagerInterface $book_manager */
    $book_manager = \Drupal::service('book.manager');
    if ($book_link['pid'] && $parent = $book_manager->loadBookLink($book_link['pid'])) {
      $parent_href = \Drupal::url('node.view', array('node' => $book_link['pid']));
634 635 636 637
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'up',
        'href' => $parent_href,
      );
638
      $variables['parent_url'] = $parent_href;
639
      $variables['parent_title'] = String::checkPlain($parent['title']);
Dries's avatar
 
Dries committed
640
    }
641

Dries's avatar
Dries committed
642
    if ($next = book_next($book_link)) {
643
      $next_href = \Drupal::url('node.view', array('node' => $next['nid']));
644 645 646 647
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'next',
        'href' => $next_href,
      );
648
      $variables['next_url'] = $next_href;
649
      $variables['next_title'] = String::checkPlain($next['title']);
Dries's avatar
 
Dries committed
650
    }
651
  }
Dries's avatar
 
Dries committed
652

653 654 655 656
  if (!empty($build)) {
    drupal_render($build);
  }

657 658 659 660 661 662 663 664 665 666 667
  $variables['has_links'] = FALSE;
  // Link variables to filter for values and set state of the flag variable.
  $links = array('prev_url', 'prev_title', 'parent_url', 'parent_title', 'next_url', 'next_title');
  foreach ($links as $link) {
    if (isset($variables[$link])) {
      // Flag when there is a value.
      $variables['has_links'] = TRUE;
    }
    else {
      // Set empty to prevent notices.
      $variables[$link] = '';
668
    }
Dries's avatar
 
Dries committed
669
  }
Dries's avatar
 
Dries committed
670
}
Dries's avatar
 
Dries committed
671

672
/**
673
 * Prepares variables for book export templates.
674
 *
675
 * Default template: book-export-html.html.twig.
676
 *
677 678 679 680 681
 * @param array $variables
 *   An associative array containing:
 *   - title: The title of the book.
 *   - contents: Output of each book page.
 *   - depth: The max depth of the book.
682 683
 */
function template_preprocess_book_export_html(&$variables) {
684
  global $base_url;
685
  $language_interface = \Drupal::languageManager()->getCurrentLanguage();
686

687
  $variables['title'] = String::checkPlain($variables['title']);
688
  $variables['base_url'] = $base_url;
689
  $variables['language'] = $language_interface;
690
  $variables['language_rtl'] = ($language_interface->direction == Language::DIRECTION_RTL);
691
  $variables['head'] = drupal_get_html_head();
692 693

  // HTML element attributes.
694
  $attributes = array();
695
  $attributes['lang'] = $language_interface->id;
696 697
  $attributes['dir'] = $language_interface->direction ? 'rtl' : 'ltr';
  $variables['html_attributes'] = new Attribute($attributes);
698 699
}

700
/**
701 702 703
 * Prepares variables for single node export templates.
 *
 * Default template: book-node-export-html.html.twig.
Dries's avatar
Dries committed
704
 *
705 706
 * @param array $variables
 *   An associative array containing the following keys:
707 708 709
 *   - node: The node that will be output.
 *   - children: All the rendered child nodes within the current node. Defaults
 *     to an empty string.
710
 */
711 712
function template_preprocess_book_node_export_html(&$variables) {
  $variables['depth'] = $variables['node']->book['depth'];
713
  $variables['title'] = String::checkPlain($variables['node']->label());
714
  $variables['content'] = $variables['node']->rendered;
715 716
}

717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
/**
 * Returns HTML for a book link and subtree.
 *
 * @param array $variables
 *   An associative array containing:
 *   - element: Structured array data for a book link.
 *
 * @ingroup themeable
 */
function theme_book_link(array $variables) {
  $element = $variables['element'];
  $sub_menu = '';

  if ($element['#below']) {
    $sub_menu = drupal_render($element['#below']);
  }
  $element['#localized_options']['set_active_class'] = TRUE;
  $output = l($element['#title'], $element['#href'], $element['#localized_options']);
  return '<li' . new Attribute($element['#attributes']) . '>' . $output . $sub_menu . "</li>\n";
}

738
/**
739
 * Determines if a given node type is in the list of types allowed for books.
740 741 742 743 744 745
 *
 * @param string $type
 *   A node type.
 *
 * @return bool
 *   A Boolean TRUE if the node type can be included in books; otherwise, FALSE.
746
 */
Dries's avatar
Dries committed
747
function book_type_is_allowed($type) {
748
  return in_array($type, \Drupal::config('book.settings')->get('allowed_types'));
749 750
}

Dries's avatar
Dries committed
751
/**
752
 * Implements hook_node_type_update().
Dries's avatar
Dries committed
753
 *
754 755
 * Updates book.settings configuration object if the machine-readable name of a
 * node type is changed.
Dries's avatar
Dries committed
756
 */
757
function book_node_type_update(NodeTypeInterface $type) {
758
  if ($type->getOriginalId() != $type->id()) {
759
    $config = \Drupal::config('book.settings');
760
    // Update the list of node types that are allowed to be added to books.
761
    $allowed_types = $config->get('allowed_types');
762
    $old_key = array_search($type->getOriginalId(), $allowed_types);
763

764
    if ($old_key !== FALSE) {
765
      $allowed_types[$old_key] = $type->id();
766
      // Ensure that the allowed_types array is sorted consistently.
767
      // @see BookSettingsForm::submitForm()
768
      sort($allowed_types);
769
      $config->set('allowed_types', $allowed_types);
770 771 772
    }

    // Update the setting for the "Add child page" link.
773
    if ($config->get('child_type') == $type->getOriginalId()) {
774
      $config->set('child_type', $type->id());
775
    }
776
    $config->save();
Dries's avatar
Dries committed
777
  }
Dries's avatar
 
Dries committed
778
}