book.module 31.2 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\Core\Entity\EntityInterface;
9
use Drupal\node\NodeTypeInterface;
10
use Drupal\Core\Language\Language;
11
use Drupal\entity\Entity\EntityDisplay;
12
use Drupal\Core\Template\Attribute;
13
use Drupal\menu_link\Entity\MenuLink;
14
use Drupal\menu_link\MenuLinkStorageController;
15
use Drupal\node\NodeInterface;
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 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
/**
 * Implements hook_entity_bundle_info().
 */
function book_entity_bundle_info() {
  $bundles['menu_link']['book-toc'] = array(
    'label' => t('Book'),
    'translatable' => FALSE,
  );
  return $bundles;
}

/**
 * Implements hook_TYPE_load().
 */
function book_menu_link_load($entities) {
  foreach ($entities as $entity) {
    // Change the bundle of menu links related to a book.
    if (strpos($entity->menu_name, 'book-toc-') === 0) {
      $entity->bundle = 'book-toc';
    }
  }
}

67
/**
68
 * Implements hook_theme().
69 70 71 72
 */
function book_theme() {
  return array(
    'book_navigation' => array(
73
      'variables' => array('book_link' => NULL),
74
      'template' => 'book-navigation',
75 76
    ),
    'book_export_html' => array(
77
      'variables' => array('title' => NULL, 'contents' => NULL, 'depth' => NULL),
78
      'template' => 'book-export-html',
79 80
    ),
    'book_admin_table' => array(
81
      'render element' => 'form',
82
      'file' => 'book.admin.inc',
83
    ),
Dries's avatar
Dries committed
84
    'book_all_books_block' => array(
85
      'render element' => 'book_menus',
86 87 88
      'template' => 'book-all-books-block',
    ),
    'book_node_export_html' => array(
89
      'variables' => array('node' => NULL, 'children' => NULL),
90
      'template' => 'book-node-export-html',
Dries's avatar
Dries committed
91
    ),
92 93 94
  );
}

95
/**
96
 * Implements hook_permission().
97
 */
98
function book_permission() {
99
  return array(
100 101 102 103 104 105 106
    'administer book outlines' => array(
      'title' => t('Administer book outlines'),
    ),
    'create new books' => array(
      'title' => t('Create new books'),
    ),
    'add content to books' => array(
107
      'title' => t('Add content and child pages to books'),
108 109
    ),
    'access printer-friendly version' => array(
110
      'title' => t('View printer-friendly books'),
111 112
      'description' => t('View a book page and all of its sub-pages as a single document for ease of printing. Can be performance heavy.'),
    ),
113
  );
Dries's avatar
 
Dries committed
114 115
}

116 117 118 119 120 121 122
/**
 * Implements hook_entity_info().
 */
function book_entity_info(&$entity_info) {
  $entity_info['node']['controllers']['form']['book_outline'] = '\Drupal\book\Form\BookOutlineForm';
}

Dries's avatar
 
Dries committed
123
/**
124 125
 * Adds relevant book links to the node's links.
 *
126
 * @param \Drupal\Core\Entity\EntityInterface $node
127 128 129
 *   The book page node to add links to.
 * @param $view_mode
 *   The view mode of the node.
Dries's avatar
 
Dries committed
130
 */
131
function book_node_view_link(NodeInterface $node, $view_mode) {
Dries's avatar
 
Dries committed
132
  $links = array();
133
  $account = \Drupal::currentUser();
Dries's avatar
Dries committed
134

135
  if (isset($node->book['depth'])) {
136
    if ($view_mode == 'full' && node_is_page($node)) {
137
      $child_type = \Drupal::config('book.settings')->get('child_type');
138 139
      $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) {
140
        $links['book_add_child'] = array(
141
          'title' => t('Add child page'),
142
          'href' => 'node/add/' . $child_type,
143
          'query' => array('parent' => $node->book['mlid']),
144
        );
Dries's avatar
 
Dries committed
145
      }
146

147
      if ($account->hasPermission('access printer-friendly version')) {
148
        $links['book_printer'] = array(
149
          'title' => t('Printer-friendly version'),
150
          'href' => 'book/export/html/' . $node->id(),
151
          'attributes' => array('title' => t('Show a printer-friendly version of this book page and its sub-pages.'))
152
        );
153
      }
Dries's avatar
 
Dries committed
154
    }
Dries's avatar
 
Dries committed
155
  }
156

157
  if (!empty($links)) {
158 159 160 161 162
    $node->content['links']['book'] = array(
      '#theme' => 'links__node__book',
      '#links' => $links,
      '#attributes' => array('class' => array('links', 'inline')),
    );
163
  }
Dries's avatar
 
Dries committed
164 165
}

Dries's avatar
 
Dries committed
166
/**
167
 * Implements hook_menu().
Dries's avatar
 
Dries committed
168
 */
169
function book_menu() {
170
  $items['admin/structure/book'] = array(
171
    'title' => 'Books',
172
    'description' => "Manage your site's book outlines.",
173
    'route_name' => 'book.admin',
174 175
  );
  $items['book'] = array(
176
    'title' => 'Books',
177
    'route_name' => 'book.render',
178 179
    'type' => MENU_SUGGESTED_ITEM,
  );
Dries's avatar
Dries committed
180 181
  $items['node/%node/outline/remove'] = array(
    'title' => 'Remove from outline',
182
    'route_name' => 'book.remove',
Dries's avatar
Dries committed
183
  );
184

Dries's avatar
 
Dries committed
185 186 187
  return $items;
}

Dries's avatar
Dries committed
188
/**
189 190 191
 * Access callback: Determines if the outline tab is accessible.
 *
 * Path:
192
 * - admin/structure/book/%node
193 194
 * - node/%node/outline
 *
195
 * @param \Drupal\Core\Entity\EntityInterface $node
196 197 198
 *   The node whose outline tab is to be viewed.
 *
 * @see book_menu()
Dries's avatar
Dries committed
199
 */
200
function _book_outline_access(EntityInterface $node) {
201
  return \Drupal::currentUser()->hasPermission('administer book outlines') && $node->access('view');
Dries's avatar
Dries committed
202 203 204
}

/**
205 206
 * Access callback: Determines if the user can remove nodes from the outline.
 *
207
 * @param \Drupal\Core\Entity\EntityInterface $node
208 209 210
 *   The node to remove from the outline.
 *
 * @see book_menu()
Dries's avatar
Dries committed
211
 */
212
function _book_outline_remove_access(EntityInterface $node) {
213
  return \Drupal::service('book.manager')->checkNodeIsRemovable($node)
214
    && _book_outline_access($node);
215 216
}

217 218 219 220
/**
 * Implements hook_admin_paths().
 */
function book_admin_paths() {
221
  if (\Drupal::config('node.settings')->get('use_admin_theme')) {
222 223 224 225 226 227
    $paths = array(
      'node/*/outline' => TRUE,
      'node/*/outline/remove' => TRUE,
    );
    return $paths;
  }
228 229
}

230
/**
Dries's avatar
Dries committed
231 232
 * Returns an array of all books.
 *
233 234
 * @todo Remove in favor of BookManager Service. http://drupal.org/node/1963894
 *
Dries's avatar
Dries committed
235 236
 * This list may be used for generating a list of all the books, or for building
 * the options for a form select.
237 238 239
 *
 * @return
 *   An array of all books.
240
 */
Dries's avatar
Dries committed
241
function book_get_books() {
242
  return \Drupal::service('book.manager')->getAllBooks();
243
}
244

Dries's avatar
Dries committed
245
/**
246
 * Implements hook_form_BASE_FORM_ID_alter() for node_form().
247
 *
248
 * Adds the book form element to the node form.
249 250
 *
 * @see book_pick_book_nojs_submit()
Dries's avatar
Dries committed
251
 */
252
function book_form_node_form_alter(&$form, &$form_state, $form_id) {
253
  $node = $form_state['controller']->getEntity();
254
  $account = \Drupal::currentUser();
255
  $access = $account->hasPermission('administer book outlines');
256
  if (!$access) {
257
    if ($account->hasPermission('add content to books') && ((!empty($node->book['mlid']) && !$node->isNew()) || book_type_is_allowed($node->getType()))) {
258 259
      // Already in the book hierarchy, or this node type is allowed.
      $access = TRUE;
Dries's avatar
Dries committed
260
    }
261
  }
Dries's avatar
Dries committed
262

263
  if ($access) {
264
    $form = \Drupal::service('book.manager')->addFormElements($form, $form_state, $node, $account);
265
    // Since the "Book" dropdown can't trigger a form submission when
266
    // JavaScript is disabled, add a submit button to do that. book.admin.css hides
267 268 269 270 271 272
    // 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,
273
      '#attached' => array(
274
        'css' => array(drupal_get_path('module', 'book') . '/css/book.admin.css'),
275
      ),
276
    );
277
    $form['#entity_builders'][] = 'book_node_builder';
278
  }
Dries's avatar
Dries committed
279
}
280

281 282 283 284 285 286 287 288 289
/**
 * 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'];
}

290
/**
291
 * Form submission handler for node_form().
292 293 294 295 296
 *
 * 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
297
 * book_form_update() Ajax callback instead.
298 299
 *
 * @see book_form_update()
300
 * @see book_form_node_form_alter()
301 302
 */
function book_pick_book_nojs_submit($form, &$form_state) {
303
  $node = $form_state['controller']->getEntity();
304
  $node->book = $form_state['values']['book'];
305 306 307
  $form_state['rebuild'] = TRUE;
}

308 309 310
/**
 * Renders a new parent page select element when the book selection changes.
 *
311
 * This function is called via Ajax when the selected book is changed on a node
312 313 314 315 316 317 318 319 320
 * or book outline form.
 *
 * @return
 *   The rendered parent page select element.
 */
function book_form_update($form, $form_state) {
  return $form['book']['plid'];
}

Dries's avatar
Dries committed
321
/**
322
 * Gets the book menu tree for a page and returns it as a linear array.
323
 *
Dries's avatar
Dries committed
324 325
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
326
 *
327
 * @return
Dries's avatar
Dries committed
328 329
 *   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
330 331 332
 *   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.
333
 */
Dries's avatar
Dries committed
334
function book_get_flat_menu($book_link) {
335
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
336 337

  if (!isset($flat[$book_link['mlid']])) {
338
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
339
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
Dries's avatar
Dries committed
340 341
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
 
Dries committed
342
  }
343

Dries's avatar
Dries committed
344
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
345 346
}

347
/**
348 349 350 351 352
 * Recursively converts a tree of menu links to a flat array.
 *
 * @param $tree
 *   A tree of menu links in an array.
 * @param $flat
353
 *   A flat array of the menu links from $tree, passed by reference.
354 355
 *
 * @see book_get_flat_menu().
356
 */
Dries's avatar
Dries committed
357 358 359 360 361 362 363 364
function _book_flatten_menu($tree, &$flat) {
  foreach ($tree as $data) {
    if (!$data['link']['hidden']) {
      $flat[$data['link']['mlid']] = $data['link'];
      if ($data['below']) {
        _book_flatten_menu($data['below'], $flat);
      }
    }
Dries's avatar
 
Dries committed
365
  }
Dries's avatar
Dries committed
366
}
Dries's avatar
 
Dries committed
367

Dries's avatar
Dries committed
368 369
/**
 * Fetches the menu link for the previous page of the book.
370 371 372 373 374 375 376
 *
 * @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
377 378 379 380 381
 */
function book_prev($book_link) {
  // If the parent is zero, we are at the start of a book.
  if ($book_link['plid'] == 0) {
    return NULL;
Dries's avatar
 
Dries committed
382
  }
Dries's avatar
Dries committed
383 384 385 386 387 388 389 390 391 392 393 394
  $flat = book_get_flat_menu($book_link);
  // Assigning the array to $flat resets the array pointer for use with each().
  $curr = NULL;
  do {
    $prev = $curr;
    list($key, $curr) = each($flat);
  } while ($key && $key != $book_link['mlid']);

  if ($key == $book_link['mlid']) {
    // The previous page in the book may be a child of the previous visible link.
    if ($prev['depth'] == $book_link['depth'] && $prev['has_children']) {
      // The subtree will have only one link at the top level - get its data.
395 396
      $tree = book_menu_subtree_data($prev);
      $data = array_shift($tree);
Dries's avatar
Dries committed
397 398 399 400
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
401

Dries's avatar
Dries committed
402 403 404 405 406
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
407 408 409
  }
}

410
/**
Dries's avatar
Dries committed
411
 * Fetches the menu link for the next page of the book.
412 413 414 415 416 417 418
 *
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 *
 * @return
 *   A fully loaded menu link for the page after the one represented in
 *   $book_link.
419
 */
Dries's avatar
Dries committed
420 421 422 423 424
function book_next($book_link) {
  $flat = book_get_flat_menu($book_link);
  // Assigning the array to $flat resets the array pointer for use with each().
  do {
    list($key, $curr) = each($flat);
425 426 427
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
428 429
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
430
  }
Dries's avatar
Dries committed
431
}
Dries's avatar
 
Dries committed
432

Dries's avatar
Dries committed
433
/**
434 435 436 437 438 439 440
 * 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
441 442 443
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
444

Dries's avatar
Dries committed
445 446 447 448 449 450
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
451 452
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
453 454 455 456 457
    // Continue though the array and collect the links whose parent is this page.
    while (($link = array_shift($flat)) && $link['plid'] == $book_link['mlid']) {
      $data['link'] = $link;
      $data['below'] = '';
      $children[] = $data;
Dries's avatar
 
Dries committed
458 459
    }
  }
460

461 462 463 464 465
  if ($children) {
    $elements = menu_tree_output($children);
    return drupal_render($elements);
  }
  return '';
Dries's avatar
 
Dries committed
466 467
}

468
/**
469
 * Implements hook_node_load().
470
 */
471
function book_node_load($nodes, $types) {
472
  $result = db_query("SELECT * FROM {book} b INNER JOIN {menu_links} ml ON b.mlid = ml.mlid WHERE b.nid IN (:nids)", array(':nids' =>  array_keys($nodes)), array('fetch' => PDO::FETCH_ASSOC));
473 474 475 476 477
  foreach ($result as $record) {
    $nodes[$record['nid']]->book = $record;
    $nodes[$record['nid']]->book['href'] = $record['link_path'];
    $nodes[$record['nid']]->book['title'] = $record['link_title'];
    $nodes[$record['nid']]->book['options'] = unserialize($record['options']);
478 479
  }
}
480

481
/**
482
 * Implements hook_node_view().
483
 */
484
function book_node_view(EntityInterface $node, EntityDisplay $display, $view_mode) {
485
  if ($view_mode == 'full') {
486
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
487
      $book_navigation = array( '#theme' => 'book_navigation', '#book_link' => $node->book);
488
      $node->content['book_navigation'] = array(
489
        '#markup' => drupal_render($book_navigation),
490
        '#weight' => 100,
491 492 493 494 495
        '#attached' => array(
          'css' => array(
            drupal_get_path('module', 'book') . '/css/book.theme.css',
          ),
        ),
496 497 498
      );
    }
  }
Dries's avatar
Dries committed
499

500 501
  if ($view_mode != 'rss') {
    book_node_view_link($node, $view_mode);
502
  }
503 504 505
}

/**
506
 * Implements hook_page_alter().
507
 *
508
 * Adds the book menu to the list of menus used to build the active trail when
509 510 511 512 513 514 515 516
 * viewing a book page.
 */
function book_page_alter(&$page) {
  if (($node = menu_get_object()) && !empty($node->book['bid'])) {
    $active_menus = menu_get_active_menu_names();
    $active_menus[] = $node->book['menu_name'];
    menu_set_active_menu_names($active_menus);
  }
517
}
518

519
/**
520
 * Implements hook_node_presave().
521
 */
522
function book_node_presave(EntityInterface $node) {
523
  // Always save a revision for non-administrators.
524
  if (!empty($node->book['bid']) && !\Drupal::currentUser()->hasPermission('administer nodes')) {
525
    $node->setNewRevision();
526 527
  }
  // Make sure a new node gets a new menu link.
528
  if ($node->isNew()) {
529 530 531
    $node->book['mlid'] = NULL;
  }
}
532

533
/**
534
 * Implements hook_node_insert().
535
 */
536
function book_node_insert(EntityInterface $node) {
537
  $book_manager = \Drupal::service('book.manager');
538 539 540
  if (!empty($node->book['bid'])) {
    if ($node->book['bid'] == 'new') {
      // New nodes that are their own book.
541
      $node->book['bid'] = $node->id();
542
    }
543
    $node->book['nid'] = $node->id();
544 545
    $node->book['menu_name'] = $book_manager->createMenuName($node->book['bid']);
    $book_manager->updateOutline($node);
546 547
  }
}
548

549
/**
550
 * Implements hook_node_update().
551
 */
552
function book_node_update(EntityInterface $node) {
553
  $book_manager = \Drupal::service('book.manager');
554 555 556
  if (!empty($node->book['bid'])) {
    if ($node->book['bid'] == 'new') {
      // New nodes that are their own book.
557
      $node->book['bid'] = $node->id();
558
    }
559
    $node->book['nid'] = $node->id();
560 561
    $node->book['menu_name'] = $book_manager->createMenuName($node->book['bid']);
    $book_manager->updateOutline($node);
562 563
  }
}
564

565
/**
566
 * Implements hook_node_predelete().
567
 */
568
function book_node_predelete(EntityInterface $node) {
569
  if (!empty($node->book['bid'])) {
570
    if ($node->id() == $node->book['bid']) {
571
      // Handle deletion of a top-level post.
572 573 574 575
      $result = db_query("SELECT b.nid FROM {menu_links} ml INNER JOIN {book} b on b.mlid = ml.mlid WHERE ml.plid = :plid", array(
        ':plid' => $node->book['mlid']
      ));
      foreach ($result as $child) {
576 577
        $child_node = node_load($child->id());
        $child_node->book['bid'] = $child_node->id();
578
        \Drupal::service('book.manager')->updateOutline($child_node);
Dries's avatar
Dries committed
579
      }
580 581
    }
    menu_link_delete($node->book['mlid']);
582 583 584
    db_delete('book')
      ->condition('mlid', $node->book['mlid'])
      ->execute();
585
    drupal_static_reset('book_get_books');
586 587 588 589
  }
}

/**
590
 * Implements hook_node_prepare_form().
591
 */
592
function book_node_prepare_form(NodeInterface $node, $form_display, $operation, array &$form_state) {
593
  // Get BookManager service
594
  $book_manager = \Drupal::service('book.manager');
595

596
  // Prepare defaults for the add/edit form.
597
  $account = \Drupal::currentUser();
598
  if (empty($node->book) && ($account->hasPermission('add content to books') || $account->hasPermission('administer book outlines'))) {
599 600
    $node->book = array();

601
    $query = \Drupal::request()->query;
602
    if ($node->isNew() && !is_null($query->get('parent')) && is_numeric($query->get('parent'))) {
603
      // Handle "Add child page" links:
604
      $parent = book_link_load($query->get('parent'));
605 606 607 608 609

      if ($parent && $parent['access']) {
        $node->book['bid'] = $parent['bid'];
        $node->book['plid'] = $parent['mlid'];
        $node->book['menu_name'] = $parent['menu_name'];
610
      }
611 612
    }
    // Set defaults.
613 614
    $node_ref = !$node->isNew() ? $node->id() : 'new';
    $node->book += $book_manager->getLinkDefaults($node_ref);
615 616 617 618 619 620 621 622
  }
  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'])) {
623
    $node->book['parent_depth_limit'] = $book_manager->getParentDepthLimit($node->book);
Dries's avatar
Dries committed
624 625 626 627
  }
}

/**
628
 * Implements hook_form_FORM_ID_alter() for node_delete_confirm().
629 630 631 632
 *
 * Alters the confirm form for a single node deletion.
 *
 * @see node_delete_confirm()
Dries's avatar
Dries committed
633 634 635 636 637 638
 */
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(
639
      '#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
640 641
      '#weight' => -10,
    );
Dries's avatar
 
Dries committed
642
  }
Dries's avatar
 
Dries committed
643
}
Dries's avatar
 
Dries committed
644

645
/**
646
 * Implements hook_preprocess_HOOK() for block templates.
647 648
 */
function book_preprocess_block(&$variables) {
649
  if ($variables['configuration']['module'] == 'book') {
650
    $variables['attributes']['role'] = 'navigation';
651 652 653
  }
}

654
/**
655 656 657
 * Prepares variables for book listing block templates.
 *
 * Default template: book-all-books-block.html.twig.
658
 *
659 660 661
 * 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).
662
 *
663 664
 * @param array $variables
 *   An associative array containing the following key:
665 666
 *   - book_menus: An associative array containing renderable menu links for all
 *     book menus.
667 668 669 670 671 672 673 674 675 676
 */
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
677
/**
678 679 680
 * Prepares variables for book navigation templates.
 *
 * Default template: book-navigation.html.twig.
Dries's avatar
Dries committed
681
 *
682 683
 * @param array $variables
 *   An associative array containing the following key:
684 685
 *   - book_link: An associative array of book link properties.
 *     Properties used: bid, link_title, depth, plid, mlid.
686
 */
687 688 689 690 691 692
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'];
  $variables['book_title'] = check_plain($book_link['link_title']);
693
  $variables['book_url'] = 'node/' . $book_link['bid'];
694 695
  $variables['current_depth'] = $book_link['depth'];
  $variables['tree'] = '';
696

Dries's avatar
Dries committed
697
  if ($book_link['mlid']) {
698
    $variables['tree'] = book_children($book_link);
Dries's avatar
 
Dries committed
699

700 701
    $build = array();

Dries's avatar
Dries committed
702
    if ($prev = book_prev($book_link)) {
703
      $prev_href = url($prev['href']);
704 705 706 707
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'prev',
        'href' => $prev_href,
      );
708 709
      $variables['prev_url'] = $prev_href;
      $variables['prev_title'] = check_plain($prev['title']);
Dries's avatar
 
Dries committed
710
    }
711

Dries's avatar
Dries committed
712
    if ($book_link['plid'] && $parent = book_link_load($book_link['plid'])) {
713
      $parent_href = url($parent['link_path']);
714 715 716 717
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'up',
        'href' => $parent_href,
      );
718 719
      $variables['parent_url'] = $parent_href;
      $variables['parent_title'] = check_plain($parent['title']);
Dries's avatar
 
Dries committed
720
    }
721

Dries's avatar
Dries committed
722
    if ($next = book_next($book_link)) {
723
      $next_href = url($next['href']);
724 725 726 727
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'next',
        'href' => $next_href,
      );
728 729
      $variables['next_url'] = $next_href;
      $variables['next_title'] = check_plain($next['title']);
Dries's avatar
 
Dries committed
730
    }
731
  }
Dries's avatar
 
Dries committed
732

733 734 735 736
  if (!empty($build)) {
    drupal_render($build);
  }

737 738 739 740 741 742 743 744 745 746 747
  $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] = '';
748
    }
Dries's avatar
 
Dries committed
749
  }
Dries's avatar
 
Dries committed
750
}
Dries's avatar
 
Dries committed
751

752
/**
753
 * Prepares variables for book export templates.
754
 *
755
 * Default template: book-export-html.html.twig.
756
 *
757 758 759 760 761
 * @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.
762 763
 */
function template_preprocess_book_export_html(&$variables) {
764
  global $base_url;
765
  $language_interface = language(Language::TYPE_INTERFACE);
766 767 768

  $variables['title'] = check_plain($variables['title']);
  $variables['base_url'] = $base_url;
769
  $variables['language'] = $language_interface;
770
  $variables['language_rtl'] = ($language_interface->direction == Language::DIRECTION_RTL);
771
  $variables['head'] = drupal_get_html_head();
772 773

  // HTML element attributes.
774
  $attributes = array();
775
  $attributes['lang'] = $language_interface->id;
776 777
  $attributes['dir'] = $language_interface->direction ? 'rtl' : 'ltr';
  $variables['html_attributes'] = new Attribute($attributes);
778 779
}

780
/**
781 782 783
 * Prepares variables for single node export templates.
 *
 * Default template: book-node-export-html.html.twig.
Dries's avatar
Dries committed
784
 *
785 786
 * @param array $variables
 *   An associative array containing the following keys:
787 788 789
 *   - node: The node that will be output.
 *   - children: All the rendered child nodes within the current node. Defaults
 *     to an empty string.
790
 */
791 792
function template_preprocess_book_node_export_html(&$variables) {
  $variables['depth'] = $variables['node']->book['depth'];
793
  $variables['title'] = check_plain($variables['node']->label());
794
  $variables['content'] = $variables['node']->rendered;
795 796
}

797
/**
798
 * Determines if a given node type is in the list of types allowed for books.
799 800 801 802 803 804
 *
 * @param string $type
 *   A node type.
 *
 * @return bool
 *   A Boolean TRUE if the node type can be included in books; otherwise, FALSE.
805
 */
Dries's avatar
Dries committed
806
function book_type_is_allowed($type) {
807
  return in_array($type, \Drupal::config('book.settings')->get('allowed_types'));
808 809
}

Dries's avatar
Dries committed
810
/**
811
 * Implements hook_node_type_update().
Dries's avatar
Dries committed
812
 *
813 814
 * Updates book.settings configuration object if the machine-readable name of a
 * node type is changed.