book.module 27.7 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\Component\Utility\String;
9
use Drupal\Core\Entity\EntityInterface;
10
use Drupal\node\NodeInterface;
11
use Drupal\node\NodeTypeInterface;
12
use Drupal\Core\Language\Language;
13
use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
14
use Drupal\Core\Template\Attribute;
15

16
/**
17
 * Implements hook_help().
18 19 20 21 22
 */
function book_help($path, $arg) {
  switch ($path) {
    case 'admin/help#book':
      $output = '<h3>' . t('About') . '</h3>';
23
      $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>';
24 25 26
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Adding and managing book content') . '</dt>';
27
      $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>';
28
      $output .= '<dt>' . t('Book navigation') . '</dt>';
29
      $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>';
30 31 32
      $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>';
33
      $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>';
34 35
      $output .= '</dl>';
      return $output;
36
    case 'admin/structure/book':
37 38
      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':
39
      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>';
40 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
/**
 * 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';
    }
  }
}

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

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

115
/**
116
 * Implements hook_entity_type_build().
117
 */
118 119 120
function book_entity_type_build(array &$entity_types) {
  /** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */
  $entity_types['node']
121 122 123
    ->setFormClass('book_outline', 'Drupal\book\Form\BookOutlineForm')
    ->setLinkTemplate('book-outline-form', 'book.outline')
    ->setLinkTemplate('book-remove-form', 'book.remove');
124 125
}

Dries's avatar
 
Dries committed
126
/**
127
 * Implements hook_node_links_alter().
Dries's avatar
 
Dries committed
128
 */
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
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,
            'query' => array('parent' => $node->book['mlid']),
          );
        }

        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.'))
          );
        }
152
      }
Dries's avatar
 
Dries committed
153
    }
154

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

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

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

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
/**
 * 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;
}

207 208 209 210
/**
 * Implements hook_admin_paths().
 */
function book_admin_paths() {
211
  if (\Drupal::config('node.settings')->get('use_admin_theme')) {
212 213 214 215 216 217
    $paths = array(
      'node/*/outline' => TRUE,
      'node/*/outline/remove' => TRUE,
    );
    return $paths;
  }
218 219
}

220
/**
Dries's avatar
Dries committed
221 222
 * Returns an array of all books.
 *
223 224
 * @todo Remove in favor of BookManager Service. http://drupal.org/node/1963894
 *
Dries's avatar
Dries committed
225 226
 * This list may be used for generating a list of all the books, or for building
 * the options for a form select.
227 228 229
 *
 * @return
 *   An array of all books.
230
 */
Dries's avatar
Dries committed
231
function book_get_books() {
232
  return \Drupal::service('book.manager')->getAllBooks();
233
}
234

Dries's avatar
Dries committed
235
/**
236
 * Implements hook_form_BASE_FORM_ID_alter() for node_form().
237
 *
238
 * Adds the book form element to the node form.
239 240
 *
 * @see book_pick_book_nojs_submit()
Dries's avatar
Dries committed
241
 */
242
function book_form_node_form_alter(&$form, &$form_state, $form_id) {
243
  $node = $form_state['controller']->getEntity();
244
  $account = \Drupal::currentUser();
245
  $access = $account->hasPermission('administer book outlines');
246
  if (!$access) {
247
    if ($account->hasPermission('add content to books') && ((!empty($node->book['mlid']) && !$node->isNew()) || book_type_is_allowed($node->getType()))) {
248 249
      // Already in the book hierarchy, or this node type is allowed.
      $access = TRUE;
Dries's avatar
Dries committed
250
    }
251
  }
Dries's avatar
Dries committed
252

253
  if ($access) {
254
    $form = \Drupal::service('book.manager')->addFormElements($form, $form_state, $node, $account);
255
    // Since the "Book" dropdown can't trigger a form submission when
256
    // JavaScript is disabled, add a submit button to do that. book.admin.css hides
257 258 259 260 261 262
    // 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,
263
      '#attached' => array(
264
        'css' => array(drupal_get_path('module', 'book') . '/css/book.admin.css'),
265
      ),
266
    );
267
    $form['#entity_builders'][] = 'book_node_builder';
268
  }
Dries's avatar
Dries committed
269
}
270

271 272 273 274 275 276 277 278 279
/**
 * 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'];
}

280
/**
281
 * Form submission handler for node_form().
282 283 284 285 286
 *
 * 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
287
 * book_form_update() Ajax callback instead.
288 289
 *
 * @see book_form_update()
290
 * @see book_form_node_form_alter()
291 292
 */
function book_pick_book_nojs_submit($form, &$form_state) {
293
  $node = $form_state['controller']->getEntity();
294
  $node->book = $form_state['values']['book'];
295 296 297
  $form_state['rebuild'] = TRUE;
}

298 299 300
/**
 * Renders a new parent page select element when the book selection changes.
 *
301
 * This function is called via Ajax when the selected book is changed on a node
302 303 304 305 306 307 308 309 310
 * 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
311
/**
312
 * Gets the book menu tree for a page and returns it as a linear array.
313
 *
Dries's avatar
Dries committed
314 315
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
316
 *
317
 * @return
Dries's avatar
Dries committed
318 319
 *   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
320 321 322
 *   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.
323
 */
Dries's avatar
Dries committed
324
function book_get_flat_menu($book_link) {
325
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
326 327

  if (!isset($flat[$book_link['mlid']])) {
328 329
    // Call bookTreeAllData() to take advantage of the menu system's caching.
    $tree = \Drupal::service('book.manager')->bookTreeAllData($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
Dries's avatar
Dries committed
330 331
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
 
Dries committed
332
  }
333

Dries's avatar
Dries committed
334
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
335 336
}

337
/**
338 339 340 341 342
 * Recursively converts a tree of menu links to a flat array.
 *
 * @param $tree
 *   A tree of menu links in an array.
 * @param $flat
343
 *   A flat array of the menu links from $tree, passed by reference.
344 345
 *
 * @see book_get_flat_menu().
346
 */
Dries's avatar
Dries committed
347 348 349 350 351 352 353 354
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
355
  }
Dries's avatar
Dries committed
356
}
Dries's avatar
 
Dries committed
357

Dries's avatar
Dries committed
358 359
/**
 * Fetches the menu link for the previous page of the book.
360 361 362 363 364 365 366
 *
 * @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
367 368 369 370 371
 */
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
372
  }
Dries's avatar
Dries committed
373 374 375 376 377 378 379 380 381 382 383 384
  $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.
385
      $tree = \Drupal::service('book.manager')->bookMenuSubtreeData($prev);
386
      $data = array_shift($tree);
Dries's avatar
Dries committed
387 388 389 390
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
391

Dries's avatar
Dries committed
392 393 394 395 396
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
397 398 399
  }
}

400
/**
Dries's avatar
Dries committed
401
 * Fetches the menu link for the next page of the book.
402 403 404 405 406 407 408
 *
 * @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.
409
 */
Dries's avatar
Dries committed
410 411 412 413
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 {
414
    list($key, ) = each($flat);
415 416 417
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
418 419
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
420
  }
Dries's avatar
Dries committed
421
}
Dries's avatar
 
Dries committed
422

Dries's avatar
Dries committed
423
/**
424 425 426 427 428 429 430
 * 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
431 432 433
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
434

Dries's avatar
Dries committed
435 436 437 438 439 440
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
441 442
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
443 444 445 446 447
    // 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
448 449
    }
  }
450

451
  if ($children) {
452
    $elements = \Drupal::service('book.manager')->bookTreeOutput($children);
453 454 455
    return drupal_render($elements);
  }
  return '';
Dries's avatar
 
Dries committed
456 457
}

458
/**
459
 * Implements hook_node_load().
460
 */
461
function book_node_load($nodes) {
462
  $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));
463 464 465 466 467
  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']);
468 469
  }
}
470

471
/**
472
 * Implements hook_node_view().
473
 */
474
function book_node_view(EntityInterface $node, EntityViewDisplayInterface $display, $view_mode) {
475
  if ($view_mode == 'full') {
476
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
477
      $book_navigation = array( '#theme' => 'book_navigation', '#book_link' => $node->book);
478
      $node->content['book_navigation'] = array(
479
        '#markup' => drupal_render($book_navigation),
480
        '#weight' => 100,
481 482 483 484 485
        '#attached' => array(
          'css' => array(
            drupal_get_path('module', 'book') . '/css/book.theme.css',
          ),
        ),
486 487 488
      );
    }
  }
489 490
}

491
/**
492
 * Implements hook_node_presave().
493
 */
494
function book_node_presave(EntityInterface $node) {
495
  // Always save a revision for non-administrators.
496
  if (!empty($node->book['bid']) && !\Drupal::currentUser()->hasPermission('administer nodes')) {
497
    $node->setNewRevision();
498 499
  }
  // Make sure a new node gets a new menu link.
500
  if ($node->isNew()) {
501 502 503
    $node->book['mlid'] = NULL;
  }
}
504

505
/**
506
 * Implements hook_node_insert().
507
 */
508
function book_node_insert(EntityInterface $node) {
509
  $book_manager = \Drupal::service('book.manager');
510 511 512
  if (!empty($node->book['bid'])) {
    if ($node->book['bid'] == 'new') {
      // New nodes that are their own book.
513
      $node->book['bid'] = $node->id();
514
    }
515
    $node->book['nid'] = $node->id();
516 517
    $node->book['menu_name'] = $book_manager->createMenuName($node->book['bid']);
    $book_manager->updateOutline($node);
518 519
  }
}
520

521
/**
522
 * Implements hook_node_update().
523
 */
524
function book_node_update(EntityInterface $node) {
525
  $book_manager = \Drupal::service('book.manager');
526 527 528
  if (!empty($node->book['bid'])) {
    if ($node->book['bid'] == 'new') {
      // New nodes that are their own book.
529
      $node->book['bid'] = $node->id();
530
    }
531
    $node->book['nid'] = $node->id();
532 533
    $node->book['menu_name'] = $book_manager->createMenuName($node->book['bid']);
    $book_manager->updateOutline($node);
534 535
  }
}
536

537
/**
538
 * Implements hook_node_predelete().
539
 */
540
function book_node_predelete(EntityInterface $node) {
541
  if (!empty($node->book['bid'])) {
542
    if ($node->id() == $node->book['bid']) {
543
      // Handle deletion of a top-level post.
544 545 546 547
      $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) {
548 549
        $child_node = node_load($child->id());
        $child_node->book['bid'] = $child_node->id();
550
        \Drupal::service('book.manager')->updateOutline($child_node);
Dries's avatar
Dries committed
551
      }
552
    }
553
    // @todo - remove this call when we change the schema.
554
    menu_link_delete($node->book['mlid']);
555 556 557
    db_delete('book')
      ->condition('mlid', $node->book['mlid'])
      ->execute();
558
    drupal_static_reset('book_get_books');
559 560 561 562
  }
}

/**
563
 * Implements hook_node_prepare_form().
564
 */
565
function book_node_prepare_form(NodeInterface $node, $form_display, $operation, array &$form_state) {
566
  // Get BookManager service
567
  $book_manager = \Drupal::service('book.manager');
568

569
  // Prepare defaults for the add/edit form.
570
  $account = \Drupal::currentUser();
571
  if (empty($node->book) && ($account->hasPermission('add content to books') || $account->hasPermission('administer book outlines'))) {
572 573
    $node->book = array();

574
    $query = \Drupal::request()->query;
575
    if ($node->isNew() && !is_null($query->get('parent')) && is_numeric($query->get('parent'))) {
576
      // Handle "Add child page" links:
577
      $parent = book_link_load($query->get('parent'));
578 579 580 581 582

      if ($parent && $parent['access']) {
        $node->book['bid'] = $parent['bid'];
        $node->book['plid'] = $parent['mlid'];
        $node->book['menu_name'] = $parent['menu_name'];
583
      }
584 585
    }
    // Set defaults.
586 587
    $node_ref = !$node->isNew() ? $node->id() : 'new';
    $node->book += $book_manager->getLinkDefaults($node_ref);
588 589 590 591 592 593 594 595
  }
  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'])) {
596
    $node->book['parent_depth_limit'] = $book_manager->getParentDepthLimit($node->book);
Dries's avatar
Dries committed
597 598 599 600
  }
}

/**
601
 * Implements hook_form_FORM_ID_alter() for node_delete_confirm().
602 603 604 605
 *
 * Alters the confirm form for a single node deletion.
 *
 * @see node_delete_confirm()
Dries's avatar
Dries committed
606 607 608 609 610 611
 */
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(
612
      '#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
613 614
      '#weight' => -10,
    );
Dries's avatar
 
Dries committed
615
  }
Dries's avatar
 
Dries committed
616
}
Dries's avatar
 
Dries committed
617

618
/**
619
 * Implements hook_preprocess_HOOK() for block templates.
620 621
 */
function book_preprocess_block(&$variables) {
622
  if ($variables['configuration']['module'] == 'book') {
623
    $variables['attributes']['role'] = 'navigation';
624 625 626
  }
}

627
/**
628 629 630
 * Prepares variables for book listing block templates.
 *
 * Default template: book-all-books-block.html.twig.
631
 *
632 633 634
 * 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).
635
 *
636 637
 * @param array $variables
 *   An associative array containing the following key:
638 639
 *   - book_menus: An associative array containing renderable menu links for all
 *     book menus.
640 641 642 643 644 645 646 647 648 649
 */
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
650
/**
651 652 653
 * Prepares variables for book navigation templates.
 *
 * Default template: book-navigation.html.twig.
Dries's avatar
Dries committed
654
 *
655 656
 * @param array $variables
 *   An associative array containing the following key:
657 658
 *   - book_link: An associative array of book link properties.
 *     Properties used: bid, link_title, depth, plid, mlid.
659
 */
660 661 662 663 664
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'];
665
  $variables['book_title'] = String::checkPlain($book_link['link_title']);
666
  $variables['book_url'] = 'node/' . $book_link['bid'];
667 668
  $variables['current_depth'] = $book_link['depth'];
  $variables['tree'] = '';
669

Dries's avatar
Dries committed
670
  if ($book_link['mlid']) {
671
    $variables['tree'] = book_children($book_link);
Dries's avatar
 
Dries committed
672

673 674
    $build = array();

Dries's avatar
Dries committed
675
    if ($prev = book_prev($book_link)) {
676
      $prev_href = url($prev['link_path']);
677 678 679 680
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'prev',
        'href' => $prev_href,
      );
681
      $variables['prev_url'] = $prev_href;
682
      $variables['prev_title'] = String::checkPlain($prev['title']);
Dries's avatar
 
Dries committed
683
    }
684

Dries's avatar
Dries committed
685
    if ($book_link['plid'] && $parent = book_link_load($book_link['plid'])) {
686
      $parent_href = url($parent['link_path']);
687 688 689 690
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'up',
        'href' => $parent_href,
      );
691
      $variables['parent_url'] = $parent_href;
692
      $variables['parent_title'] = String::checkPlain($parent['title']);
Dries's avatar
 
Dries committed
693
    }
694

Dries's avatar
Dries committed
695
    if ($next = book_next($book_link)) {
696
      $next_href = url($next['link_path']);
697 698 699 700
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'next',
        'href' => $next_href,
      );
701
      $variables['next_url'] = $next_href;
702
      $variables['next_title'] = String::checkPlain($next['title']);
Dries's avatar
 
Dries committed
703
    }
704
  }
Dries's avatar
 
Dries committed
705

706 707 708 709
  if (!empty($build)) {
    drupal_render($build);
  }

710 711 712 713 714 715 716 717 718 719 720
  $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] = '';
721
    }
Dries's avatar
 
Dries committed
722
  }
Dries's avatar
 
Dries committed
723
}
Dries's avatar
 
Dries committed
724

725
/**
726
 * Prepares variables for book export templates.
727
 *
728
 * Default template: book-export-html.html.twig.
729
 *
730 731 732 733 734
 * @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.
735 736
 */
function template_preprocess_book_export_html(&$variables) {
737
  global $base_url;
738
  $language_interface = language(Language::TYPE_INTERFACE);
739

740
  $variables['title'] = String::checkPlain($variables['title']);
741
  $variables['base_url'] = $base_url;
742
  $variables['language'] = $language_interface;
743
  $variables['language_rtl'] = ($language_interface->direction == Language::DIRECTION_RTL);
744
  $variables['head'] = drupal_get_html_head();
745 746

  // HTML element attributes.
747
  $attributes = array();
748
  $attributes['lang'] = $language_interface->id;
749 750
  $attributes['dir'] = $language_interface->direction ? 'rtl' : 'ltr';
  $variables['html_attributes'] = new Attribute($attributes);
751 752
}

753
/**
754 755 756
 * Prepares variables for single node export templates.
 *
 * Default template: book-node-export-html.html.twig.
Dries's avatar
Dries committed
757
 *
758 759
 * @param array $variables
 *   An associative array containing the following keys:
760 761 762
 *   - node: The node that will be output.
 *   - children: All the rendered child nodes within the current node. Defaults
 *     to an empty string.
763
 */
764 765
function template_preprocess_book_node_export_html(&$variables) {
  $variables['depth'] = $variables['node']->book['depth'];
766
  $variables['title'] = String::checkPlain($variables['node']->label());
767
  $variables['content'] = $variables['node']->rendered;
768 769
}

770
/**
771
 * Determines if a given node type is in the list of types allowed for books.
772 773 774 775 776 777
 *
 * @param string $type
 *   A node type.
 *
 * @return bool
 *   A Boolean TRUE if the node type can be included in books; otherwise, FALSE.
778
 */
Dries's avatar
Dries committed
779
function book_type_is_allowed($type) {
780
  return in_array($type, \Drupal::config('book.settings')->get('allowed_types'));
781 782
}

Dries's avatar
Dries committed
783
/**
784
 * Implements hook_node_type_update().
Dries's avatar
Dries committed
785
 *
786 787
 * Updates book.settings configuration object if the machine-readable name of a
 * node type is changed.
Dries's avatar
Dries committed
788
 */
789
function book_node_type_update(NodeTypeInterface $type) {
790
  if ($type->getOriginalId() != $type->id()) {
791
    $config = \Drupal::config('book.settings');
792
    // Update the list of node types that are allowed to be added to books.
793
    $allowed_types = $config->get('allowed_types');
794
    $old_key = array_search($type->getOriginalId(), $allowed_types);
795

796
    if ($old_key !== FALSE) {
797
      $allowed_types[$old_key] = $type->id();
798
      // Ensure that the allowed_types array is sorted consistently.
799
      // @see BookSettingsForm::submitForm()
800
      sort($allowed_types);
801
      $config->set('allowed_types', $allowed_types);
802 803 804
    }

    // Update the setting for the "Add child page" link.
805
    if ($config->get('child_type') == $type->getOriginalId()) {
806
      $config->set('child_type', $type->id());
807
    }
808
    $config->save();
Dries's avatar
Dries committed
809
  }
Dries's avatar
 
Dries committed
810 811
}

Dries's avatar
Dries committed
812
/**
813 814
 * Gets a book menu link by its menu link ID.
 *
Dries's avatar
Dries committed
815 816 817
 * Like menu_link_load(), but adds additional data from the {book} table.
 *
 * Do not call when loading a node, since this function may call node_load().
818 819 820 821 822 823
 *
 * @param $mlid
 *   The menu link ID of the menu item.
 *
 * @return
 *   A menu link, with the link translated for rendering and data added from the
824
 *   {book} table. FALSE if there is an error.
Dries's avatar
Dries committed
825 826
 */
function book_link_load($mlid) {
827
  return entity_load('menu_link', $mlid);
Dries's avatar
Dries committed
828
}