book.module 28 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
  /** @var $entity_info \Drupal\Core\Entity\EntityTypeInterface[] */
119 120 121 122
  $entity_info['node']
    ->setFormClass('book_outline', 'Drupal\book\Form\BookOutlineForm')
    ->setLinkTemplate('book-outline-form', 'book.outline')
    ->setLinkTemplate('book-remove-form', 'book.remove');
123 124
}

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

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

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

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

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

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

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

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

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

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

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

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

  if (!isset($flat[$book_link['mlid']])) {
327 328
    // 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
329 330
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
 
Dries committed
331
  }
332

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

672 673
    $build = array();

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

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

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

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

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

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

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

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

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

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

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

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

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

Dries's avatar
Dries committed
811
/**
812 813
 * Gets a book menu link by its menu link ID.
 *
Dries's avatar
Dries committed
814 815 816
 * 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().
817 818 819 820 821 822
 *
 * @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
823
 *   {book} table. FALSE if there is an error.
Dries's avatar
Dries committed
824 825
 */
function book_link_load($mlid) {
826
  return entity_load('menu_link', $mlid);
Dries's avatar
Dries committed
827 828
}

829 830 831 832 833 834
/**
 * Implements hook_library_info().
 */
function book_library_info() {
  $libraries['drupal.book'] = array(
    'title' => 'Book',
835
    'version' => \Drupal::VERSION,
836 837 838 839 840 841 842 843 844 845 846 847
    'js' => array(
      drupal_get_path('module', 'book') . '/book.js' => array(),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'drupal.form'),
    ),
  );

  return $libraries;
}