book.module 27.4 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\NodeInterface;
10
use Drupal\node\NodeTypeInterface;
11
use Drupal\Core\Language\Language;
12
use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
13
use Drupal\Core\Template\Attribute;
14

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

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

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

114 115 116 117
/**
 * Implements hook_entity_info().
 */
function book_entity_info(&$entity_info) {
118 119
  /** @var $entity_info \Drupal\Core\Entity\EntityTypeInterface[] */
  $entity_info['node']->setForm('book_outline', 'Drupal\book\Form\BookOutlineForm');
120 121
}

Dries's avatar
 
Dries committed
122
/**
123
 * Implements hook_node_links_alter().
Dries's avatar
 
Dries committed
124
 */
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
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.'))
          );
        }
148
      }
Dries's avatar
 
Dries committed
149
    }
150

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

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

Dries's avatar
 
Dries committed
180 181 182
  return $items;
}

183 184 185 186
/**
 * Implements hook_admin_paths().
 */
function book_admin_paths() {
187
  if (\Drupal::config('node.settings')->get('use_admin_theme')) {
188 189 190 191 192 193
    $paths = array(
      'node/*/outline' => TRUE,
      'node/*/outline/remove' => TRUE,
    );
    return $paths;
  }
194 195
}

196
/**
Dries's avatar
Dries committed
197 198
 * Returns an array of all books.
 *
199 200
 * @todo Remove in favor of BookManager Service. http://drupal.org/node/1963894
 *
Dries's avatar
Dries committed
201 202
 * This list may be used for generating a list of all the books, or for building
 * the options for a form select.
203 204 205
 *
 * @return
 *   An array of all books.
206
 */
Dries's avatar
Dries committed
207
function book_get_books() {
208
  return \Drupal::service('book.manager')->getAllBooks();
209
}
210

Dries's avatar
Dries committed
211
/**
212
 * Implements hook_form_BASE_FORM_ID_alter() for node_form().
213
 *
214
 * Adds the book form element to the node form.
215 216
 *
 * @see book_pick_book_nojs_submit()
Dries's avatar
Dries committed
217
 */
218
function book_form_node_form_alter(&$form, &$form_state, $form_id) {
219
  $node = $form_state['controller']->getEntity();
220
  $account = \Drupal::currentUser();
221
  $access = $account->hasPermission('administer book outlines');
222
  if (!$access) {
223
    if ($account->hasPermission('add content to books') && ((!empty($node->book['mlid']) && !$node->isNew()) || book_type_is_allowed($node->getType()))) {
224 225
      // Already in the book hierarchy, or this node type is allowed.
      $access = TRUE;
Dries's avatar
Dries committed
226
    }
227
  }
Dries's avatar
Dries committed
228

229
  if ($access) {
230
    $form = \Drupal::service('book.manager')->addFormElements($form, $form_state, $node, $account);
231
    // Since the "Book" dropdown can't trigger a form submission when
232
    // JavaScript is disabled, add a submit button to do that. book.admin.css hides
233 234 235 236 237 238
    // 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,
239
      '#attached' => array(
240
        'css' => array(drupal_get_path('module', 'book') . '/css/book.admin.css'),
241
      ),
242
    );
243
    $form['#entity_builders'][] = 'book_node_builder';
244
  }
Dries's avatar
Dries committed
245
}
246

247 248 249 250 251 252 253 254 255
/**
 * 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'];
}

256
/**
257
 * Form submission handler for node_form().
258 259 260 261 262
 *
 * 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
263
 * book_form_update() Ajax callback instead.
264 265
 *
 * @see book_form_update()
266
 * @see book_form_node_form_alter()
267 268
 */
function book_pick_book_nojs_submit($form, &$form_state) {
269
  $node = $form_state['controller']->getEntity();
270
  $node->book = $form_state['values']['book'];
271 272 273
  $form_state['rebuild'] = TRUE;
}

274 275 276
/**
 * Renders a new parent page select element when the book selection changes.
 *
277
 * This function is called via Ajax when the selected book is changed on a node
278 279 280 281 282 283 284 285 286
 * 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
287
/**
288
 * Gets the book menu tree for a page and returns it as a linear array.
289
 *
Dries's avatar
Dries committed
290 291
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
292
 *
293
 * @return
Dries's avatar
Dries committed
294 295
 *   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
296 297 298
 *   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.
299
 */
Dries's avatar
Dries committed
300
function book_get_flat_menu($book_link) {
301
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
302 303

  if (!isset($flat[$book_link['mlid']])) {
304 305
    // 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
306 307
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
 
Dries committed
308
  }
309

Dries's avatar
Dries committed
310
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
311 312
}

313
/**
314 315 316 317 318
 * Recursively converts a tree of menu links to a flat array.
 *
 * @param $tree
 *   A tree of menu links in an array.
 * @param $flat
319
 *   A flat array of the menu links from $tree, passed by reference.
320 321
 *
 * @see book_get_flat_menu().
322
 */
Dries's avatar
Dries committed
323 324 325 326 327 328 329 330
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
331
  }
Dries's avatar
Dries committed
332
}
Dries's avatar
 
Dries committed
333

Dries's avatar
Dries committed
334 335
/**
 * Fetches the menu link for the previous page of the book.
336 337 338 339 340 341 342
 *
 * @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
343 344 345 346 347
 */
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
348
  }
Dries's avatar
Dries committed
349 350 351 352 353 354 355 356 357 358 359 360
  $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.
361
      $tree = \Drupal::service('book.manager')->bookMenuSubtreeData($prev);
362
      $data = array_shift($tree);
Dries's avatar
Dries committed
363 364 365 366
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
367

Dries's avatar
Dries committed
368 369 370 371 372
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
373 374 375
  }
}

376
/**
Dries's avatar
Dries committed
377
 * Fetches the menu link for the next page of the book.
378 379 380 381 382 383 384
 *
 * @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.
385
 */
Dries's avatar
Dries committed
386 387 388 389
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 {
390
    list($key, ) = each($flat);
391 392 393
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
394 395
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
396
  }
Dries's avatar
Dries committed
397
}
Dries's avatar
 
Dries committed
398

Dries's avatar
Dries committed
399
/**
400 401 402 403 404 405 406
 * 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
407 408 409
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
410

Dries's avatar
Dries committed
411 412 413 414 415 416
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
417 418
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
419 420 421 422 423
    // 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
424 425
    }
  }
426

427
  if ($children) {
428
    $elements = \Drupal::service('book.manager')->bookTreeOutput($children);
429 430 431
    return drupal_render($elements);
  }
  return '';
Dries's avatar
 
Dries committed
432 433
}

434
/**
435
 * Implements hook_node_load().
436
 */
437
function book_node_load($nodes) {
438
  $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));
439 440 441 442 443
  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']);
444 445
  }
}
446

447
/**
448
 * Implements hook_node_view().
449
 */
450
function book_node_view(EntityInterface $node, EntityViewDisplayInterface $display, $view_mode) {
451
  if ($view_mode == 'full') {
452
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
453
      $book_navigation = array( '#theme' => 'book_navigation', '#book_link' => $node->book);
454
      $node->content['book_navigation'] = array(
455
        '#markup' => drupal_render($book_navigation),
456
        '#weight' => 100,
457 458 459 460 461
        '#attached' => array(
          'css' => array(
            drupal_get_path('module', 'book') . '/css/book.theme.css',
          ),
        ),
462 463 464
      );
    }
  }
465 466
}

467
/**
468
 * Implements hook_node_presave().
469
 */
470
function book_node_presave(EntityInterface $node) {
471
  // Always save a revision for non-administrators.
472
  if (!empty($node->book['bid']) && !\Drupal::currentUser()->hasPermission('administer nodes')) {
473
    $node->setNewRevision();
474 475
  }
  // Make sure a new node gets a new menu link.
476
  if ($node->isNew()) {
477 478 479
    $node->book['mlid'] = NULL;
  }
}
480

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

497
/**
498
 * Implements hook_node_update().
499
 */
500
function book_node_update(EntityInterface $node) {
501
  $book_manager = \Drupal::service('book.manager');
502 503 504
  if (!empty($node->book['bid'])) {
    if ($node->book['bid'] == 'new') {
      // New nodes that are their own book.
505
      $node->book['bid'] = $node->id();
506
    }
507
    $node->book['nid'] = $node->id();
508 509
    $node->book['menu_name'] = $book_manager->createMenuName($node->book['bid']);
    $book_manager->updateOutline($node);
510 511
  }
}
512

513
/**
514
 * Implements hook_node_predelete().
515
 */
516
function book_node_predelete(EntityInterface $node) {
517
  if (!empty($node->book['bid'])) {
518
    if ($node->id() == $node->book['bid']) {
519
      // Handle deletion of a top-level post.
520 521 522 523
      $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) {
524 525
        $child_node = node_load($child->id());
        $child_node->book['bid'] = $child_node->id();
526
        \Drupal::service('book.manager')->updateOutline($child_node);
Dries's avatar
Dries committed
527
      }
528
    }
529
    // @todo - remove this call when we change the schema.
530
    menu_link_delete($node->book['mlid']);
531 532 533
    db_delete('book')
      ->condition('mlid', $node->book['mlid'])
      ->execute();
534
    drupal_static_reset('book_get_books');
535 536 537 538
  }
}

/**
539
 * Implements hook_node_prepare_form().
540
 */
541
function book_node_prepare_form(NodeInterface $node, $form_display, $operation, array &$form_state) {
542
  // Get BookManager service
543
  $book_manager = \Drupal::service('book.manager');
544

545
  // Prepare defaults for the add/edit form.
546
  $account = \Drupal::currentUser();
547
  if (empty($node->book) && ($account->hasPermission('add content to books') || $account->hasPermission('administer book outlines'))) {
548 549
    $node->book = array();

550
    $query = \Drupal::request()->query;
551
    if ($node->isNew() && !is_null($query->get('parent')) && is_numeric($query->get('parent'))) {
552
      // Handle "Add child page" links:
553
      $parent = book_link_load($query->get('parent'));
554 555 556 557 558

      if ($parent && $parent['access']) {
        $node->book['bid'] = $parent['bid'];
        $node->book['plid'] = $parent['mlid'];
        $node->book['menu_name'] = $parent['menu_name'];
559
      }
560 561
    }
    // Set defaults.
562 563
    $node_ref = !$node->isNew() ? $node->id() : 'new';
    $node->book += $book_manager->getLinkDefaults($node_ref);
564 565 566 567 568 569 570 571
  }
  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'])) {
572
    $node->book['parent_depth_limit'] = $book_manager->getParentDepthLimit($node->book);
Dries's avatar
Dries committed
573 574 575 576
  }
}

/**
577
 * Implements hook_form_FORM_ID_alter() for node_delete_confirm().
578 579 580 581
 *
 * Alters the confirm form for a single node deletion.
 *
 * @see node_delete_confirm()
Dries's avatar
Dries committed
582 583 584 585 586 587
 */
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(
588
      '#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
589 590
      '#weight' => -10,
    );
Dries's avatar
 
Dries committed
591
  }
Dries's avatar
 
Dries committed
592
}
Dries's avatar
 
Dries committed
593

594
/**
595
 * Implements hook_preprocess_HOOK() for block templates.
596 597
 */
function book_preprocess_block(&$variables) {
598
  if ($variables['configuration']['module'] == 'book') {
599
    $variables['attributes']['role'] = 'navigation';
600 601 602
  }
}

603
/**
604 605 606
 * Prepares variables for book listing block templates.
 *
 * Default template: book-all-books-block.html.twig.
607
 *
608 609 610
 * 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).
611
 *
612 613
 * @param array $variables
 *   An associative array containing the following key:
614 615
 *   - book_menus: An associative array containing renderable menu links for all
 *     book menus.
616 617 618 619 620 621 622 623 624 625
 */
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
626
/**
627 628 629
 * Prepares variables for book navigation templates.
 *
 * Default template: book-navigation.html.twig.
Dries's avatar
Dries committed
630
 *
631 632
 * @param array $variables
 *   An associative array containing the following key:
633 634
 *   - book_link: An associative array of book link properties.
 *     Properties used: bid, link_title, depth, plid, mlid.
635
 */
636 637 638 639 640 641
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']);
642
  $variables['book_url'] = 'node/' . $book_link['bid'];
643 644
  $variables['current_depth'] = $book_link['depth'];
  $variables['tree'] = '';
645

Dries's avatar
Dries committed
646
  if ($book_link['mlid']) {
647
    $variables['tree'] = book_children($book_link);
Dries's avatar
 
Dries committed
648

649 650
    $build = array();

Dries's avatar
Dries committed
651
    if ($prev = book_prev($book_link)) {
652
      $prev_href = url($prev['href']);
653 654 655 656
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'prev',
        'href' => $prev_href,
      );
657 658
      $variables['prev_url'] = $prev_href;
      $variables['prev_title'] = check_plain($prev['title']);
Dries's avatar
 
Dries committed
659
    }
660

Dries's avatar
Dries committed
661
    if ($book_link['plid'] && $parent = book_link_load($book_link['plid'])) {
662
      $parent_href = url($parent['link_path']);
663 664 665 666
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'up',
        'href' => $parent_href,
      );
667 668
      $variables['parent_url'] = $parent_href;
      $variables['parent_title'] = check_plain($parent['title']);
Dries's avatar
 
Dries committed
669
    }
670

Dries's avatar
Dries committed
671
    if ($next = book_next($book_link)) {
672
      $next_href = url($next['href']);
673 674 675 676
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'next',
        'href' => $next_href,
      );
677 678
      $variables['next_url'] = $next_href;
      $variables['next_title'] = check_plain($next['title']);
Dries's avatar
 
Dries committed
679
    }
680
  }
Dries's avatar
 
Dries committed
681

682 683 684 685
  if (!empty($build)) {
    drupal_render($build);
  }

686 687 688 689 690 691 692 693 694 695 696
  $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] = '';
697
    }
Dries's avatar
 
Dries committed
698
  }
Dries's avatar
 
Dries committed
699
}
Dries's avatar
 
Dries committed
700

701
/**
702
 * Prepares variables for book export templates.
703
 *
704
 * Default template: book-export-html.html.twig.
705
 *
706 707 708 709 710
 * @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.
711 712
 */
function template_preprocess_book_export_html(&$variables) {
713
  global $base_url;
714
  $language_interface = language(Language::TYPE_INTERFACE);
715 716 717

  $variables['title'] = check_plain($variables['title']);
  $variables['base_url'] = $base_url;
718
  $variables['language'] = $language_interface;
719
  $variables['language_rtl'] = ($language_interface->direction == Language::DIRECTION_RTL);
720
  $variables['head'] = drupal_get_html_head();
721 722

  // HTML element attributes.
723
  $attributes = array();
724
  $attributes['lang'] = $language_interface->id;
725 726
  $attributes['dir'] = $language_interface->direction ? 'rtl' : 'ltr';
  $variables['html_attributes'] = new Attribute($attributes);
727 728
}

729
/**
730 731 732
 * Prepares variables for single node export templates.
 *
 * Default template: book-node-export-html.html.twig.
Dries's avatar
Dries committed
733
 *
734 735
 * @param array $variables
 *   An associative array containing the following keys:
736 737 738
 *   - node: The node that will be output.
 *   - children: All the rendered child nodes within the current node. Defaults
 *     to an empty string.
739
 */
740 741
function template_preprocess_book_node_export_html(&$variables) {
  $variables['depth'] = $variables['node']->book['depth'];
742
  $variables['title'] = check_plain($variables['node']->label());
743
  $variables['content'] = $variables['node']->rendered;
744 745
}

746
/**
747
 * Determines if a given node type is in the list of types allowed for books.
748 749 750 751 752 753
 *
 * @param string $type
 *   A node type.
 *
 * @return bool
 *   A Boolean TRUE if the node type can be included in books; otherwise, FALSE.
754
 */
Dries's avatar
Dries committed
755
function book_type_is_allowed($type) {
756
  return in_array($type, \Drupal::config('book.settings')->get('allowed_types'));
757 758
}

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

772
    if ($old_key !== FALSE) {
773
      $allowed_types[$old_key] = $type->id();
774
      // Ensure that the allowed_types array is sorted consistently.
775
      // @see BookSettingsForm::submitForm()
776
      sort($allowed_types);
777
      $config->set('allowed_types', $allowed_types);
778 779 780
    }

    // Update the setting for the "Add child page" link.
781
    if ($config->get('child_type') == $type->getOriginalId()) {
782
      $config->set('child_type', $type->id());
783
    }
784
    $config->save();
Dries's avatar
Dries committed
785
  }
Dries's avatar
 
Dries committed
786 787
}

Dries's avatar
Dries committed
788
/**
789 790
 * Gets a book menu link by its menu link ID.
 *
Dries's avatar
Dries committed
791 792 793
 * 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().
794 795 796 797 798 799
 *
 * @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
800
 *   {book} table. FALSE if there is an error.
Dries's avatar
Dries committed
801 802
 */
function book_link_load($mlid) {
803
  return entity_load('menu_link', $mlid);
Dries's avatar
Dries committed
804 805
}

806 807 808 809 810 811
/**
 * Implements hook_library_info().
 */
function book_library_info() {
  $libraries['drupal.book'] = array(
    'title' => 'Book',
812
    'version' => \Drupal::VERSION,
813 814 815 816 817 818 819 820 821 822 823 824
    'js' => array(
      drupal_get_path('module', 'book') . '/book.js' => array(),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'drupal.form'),
    ),
  );

  return $libraries;
}