book.module 44.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\entity\Plugin\Core\Entity\EntityDisplay;
10
use Drupal\Core\Template\Attribute;
11 12
use Drupal\menu_link\Plugin\Core\Entity\MenuLink;
use Drupal\menu_link\MenuLinkStorageController;
13

14
/**
15
 * Implements hook_help().
16 17 18 19 20
 */
function book_help($path, $arg) {
  switch ($path) {
    case 'admin/help#book':
      $output = '<h3>' . t('About') . '</h3>';
21
      $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 online handbook entry for <a href="@book">Book module</a>.', array('@book' => 'http://drupal.org/documentation/modules/book')) . '</p>';
22 23 24
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Adding and managing book content') . '</dt>';
25
      $output .= '<dd>' . t('You can assign separate permissions for <em>creating</em>, <em>editing</em>, and <em>deleting</em> book content, as well as <em>adding content to books</em>, and <em>creating new books</em>. 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' => url('admin/structure/book'))) . '</dd>';
26 27 28 29 30
      $output .= '<dt>' . t('Book navigation') . '</dt>';
      $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' => url('admin/structure/block'))) . '</dd>';
      $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>';
31
      $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>';
32 33
      $output .= '</dl>';
      return $output;
34
    case 'admin/structure/book':
35 36
      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':
37
      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' => url('book'), '@book-admin' => url('admin/structure/book'))) . '</p>';
38 39 40
  }
}

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

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

Dries's avatar
 
Dries committed
89
/**
90 91
 * Adds relevant book links to the node's links.
 *
92
 * @param \Drupal\Core\Entity\EntityInterface $node
93 94 95
 *   The book page node to add links to.
 * @param $view_mode
 *   The view mode of the node.
Dries's avatar
 
Dries committed
96
 */
97
function book_node_view_link(EntityInterface $node, $view_mode) {
Dries's avatar
 
Dries committed
98
  $links = array();
Dries's avatar
Dries committed
99

100
  if (isset($node->book['depth'])) {
101
    if ($view_mode == 'full' && node_is_page($node)) {
102
      $child_type = config('book.settings')->get('child_type');
Dries's avatar
Dries committed
103
      if ((user_access('add content to books') || user_access('administer book outlines')) && node_access('create', $child_type) && $node->status == 1 && $node->book['depth'] < MENU_MAX_DEPTH) {
104
        $links['book_add_child'] = array(
105
          'title' => t('Add child page'),
106
          'href' => 'node/add/' . $child_type,
107
          'query' => array('parent' => $node->book['mlid']),
108
        );
Dries's avatar
 
Dries committed
109
      }
110

Dries's avatar
Dries committed
111
      if (user_access('access printer-friendly version')) {
112
        $links['book_printer'] = array(
113
          'title' => t('Printer-friendly version'),
114
          'href' => 'book/export/html/' . $node->nid,
115
          'attributes' => array('title' => t('Show a printer-friendly version of this book page and its sub-pages.'))
116
        );
117
      }
Dries's avatar
 
Dries committed
118
    }
Dries's avatar
 
Dries committed
119
  }
120

121
  if (!empty($links)) {
122 123 124 125 126
    $node->content['links']['book'] = array(
      '#theme' => 'links__node__book',
      '#links' => $links,
      '#attributes' => array('class' => array('links', 'inline')),
    );
127
  }
Dries's avatar
 
Dries committed
128 129
}

Dries's avatar
 
Dries committed
130
/**
131
 * Implements hook_menu().
Dries's avatar
 
Dries committed
132
 */
133
function book_menu() {
134
  $items['admin/structure/book'] = array(
135
    'title' => 'Books',
136
    'description' => "Manage your site's book outlines.",
137
    'route_name' => 'book_admin',
138
  );
139
  $items['admin/structure/book/list'] = array(
140
    'title' => 'List',
141 142
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
143
  $items['admin/structure/book/settings'] = array(
Dries's avatar
Dries committed
144
    'title' => 'Settings',
145
    'route_name' => 'book_settings',
Dries's avatar
Dries committed
146
    'access arguments' => array('administer site configuration'),
147
    'type' => MENU_LOCAL_TASK,
148
    'weight' => 100,
149
  );
150
  $items['admin/structure/book/%node'] = array(
Dries's avatar
Dries committed
151 152 153 154 155 156
    'title' => 'Re-order book pages and change titles',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('book_admin_edit', 3),
    'access callback' => '_book_outline_access',
    'access arguments' => array(3),
    'type' => MENU_CALLBACK,
157
    'file' => 'book.admin.inc',
Dries's avatar
Dries committed
158
  );
159
  $items['book'] = array(
160
    'title' => 'Books',
161
    'route_name' => 'book_render',
162 163
    'type' => MENU_SUGGESTED_ITEM,
  );
164
  $items['book/export/%/%node'] = array(
165 166
    'page callback' => 'book_export',
    'page arguments' => array(2, 3),
167 168
    'access callback' => 'book_export_access',
    'access arguments' => array(3),
169
    'type' => MENU_CALLBACK,
170
    'file' => 'book.pages.inc',
171
  );
172
  $items['node/%node/outline'] = array(
173
    'title' => 'Outline',
Dries's avatar
Dries committed
174 175
    'page callback' => 'book_outline',
    'page arguments' => array(1),
176 177 178 179
    'access callback' => '_book_outline_access',
    'access arguments' => array(1),
    'type' => MENU_LOCAL_TASK,
    'weight' => 2,
180
    'file' => 'book.pages.inc',
181
  );
Dries's avatar
Dries committed
182 183 184 185 186 187
  $items['node/%node/outline/remove'] = array(
    'title' => 'Remove from outline',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('book_remove_form', 1),
    'access callback' => '_book_outline_remove_access',
    'access arguments' => array(1),
188
    'file' => 'book.pages.inc',
Dries's avatar
Dries committed
189
  );
190

Dries's avatar
 
Dries committed
191 192 193
  return $items;
}

194 195 196
/**
 * Access callback: Determines if the book export page is accessible.
 *
197
 * @param \Drupal\node\Plugin\Core\Entity\EntityInterface $node
198 199
 *   The node whose export page is to be viewed.
 */
200
function book_export_access(EntityInterface $node) {
201 202 203
  return user_access('access printer-friendly version') && node_access('view', $node);
}

Dries's avatar
Dries committed
204
/**
205 206 207
 * Access callback: Determines if the outline tab is accessible.
 *
 * Path:
208
 * - admin/structure/book/%node
209 210
 * - node/%node/outline
 *
211
 * @param \Drupal\Core\Entity\EntityInterface $node
212 213 214
 *   The node whose outline tab is to be viewed.
 *
 * @see book_menu()
Dries's avatar
Dries committed
215
 */
216
function _book_outline_access(EntityInterface $node) {
Dries's avatar
Dries committed
217 218 219 220
  return user_access('administer book outlines') && node_access('view', $node);
}

/**
221 222
 * Access callback: Determines if the user can remove nodes from the outline.
 *
223
 * @param \Drupal\Core\Entity\EntityInterface $node
224 225 226
 *   The node to remove from the outline.
 *
 * @see book_menu()
Dries's avatar
Dries committed
227
 */
228
function _book_outline_remove_access(EntityInterface $node) {
229 230 231 232 233 234 235 236
  return _book_node_is_removable($node) && _book_outline_access($node);
}

/**
 * Determines if a node can be removed from the book.
 *
 * A node can be removed from a book if it is actually in a book and it either
 * is not a top-level page or is a top-level page with no children.
237
 *
238
 * @param \Drupal\Core\Entity\EntityInterface $node
239
 *   The node to remove from the outline.
240
 */
241
function _book_node_is_removable(EntityInterface $node) {
242
  return (!empty($node->book['bid']) && (($node->book['bid'] != $node->nid) || !$node->book['has_children']));
243 244
}

245 246 247 248
/**
 * Implements hook_admin_paths().
 */
function book_admin_paths() {
249 250 251 252 253 254 255
  if (variable_get('node_admin_theme')) {
    $paths = array(
      'node/*/outline' => TRUE,
      'node/*/outline/remove' => TRUE,
    );
    return $paths;
  }
256 257
}

258
/**
Dries's avatar
Dries committed
259 260
 * Returns an array of all books.
 *
261 262
 * @todo Remove in favor of BookManager Service. http://drupal.org/node/1963894
 *
Dries's avatar
Dries committed
263 264
 * This list may be used for generating a list of all the books, or for building
 * the options for a form select.
265 266 267
 *
 * @return
 *   An array of all books.
268
 */
Dries's avatar
Dries committed
269
function book_get_books() {
270
  $all_books = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
271 272 273

  if (!isset($all_books)) {
    $all_books = array();
274
    $nids = db_query("SELECT DISTINCT(bid) FROM {book}")->fetchCol();
275

Dries's avatar
Dries committed
276
    if ($nids) {
277
      $query = db_select('book', 'b', array('fetch' => PDO::FETCH_ASSOC));
278 279
      $query->join('node', 'n', 'b.nid = n.nid');
      $query->join('menu_links', 'ml', 'b.mlid = ml.mlid');
280 281 282
      $query->addField('n', 'type', 'type');
      $query->addField('n', 'title', 'title');
      $query->fields('b');
283
      $query->fields('ml');
284 285 286 287 288 289 290
      $query->condition('n.nid', $nids, 'IN');
      $query->condition('n.status', 1);
      $query->orderBy('ml.weight');
      $query->orderBy('ml.link_title');
      $query->addTag('node_access');
      $result2 = $query->execute();
      foreach ($result2 as $link) {
Dries's avatar
Dries committed
291 292
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
293
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
294 295
      }
    }
296
  }
297

Dries's avatar
Dries committed
298
  return $all_books;
299
}
300

Dries's avatar
Dries committed
301
/**
302
 * Implements hook_form_BASE_FORM_ID_alter() for node_form().
303
 *
304
 * Adds the book form element to the node form.
305 306
 *
 * @see book_pick_book_nojs_submit()
Dries's avatar
Dries committed
307
 */
308
function book_form_node_form_alter(&$form, &$form_state, $form_id) {
309
  $node = $form_state['controller']->getEntity();
310 311 312 313 314
  $access = user_access('administer book outlines');
  if (!$access) {
    if (user_access('add content to books') && ((!empty($node->book['mlid']) && !empty($node->nid)) || book_type_is_allowed($node->type))) {
      // Already in the book hierarchy, or this node type is allowed.
      $access = TRUE;
Dries's avatar
Dries committed
315
    }
316
  }
Dries's avatar
Dries committed
317

318 319 320
  if ($access) {
    _book_add_form_elements($form, $form_state, $node);
    // Since the "Book" dropdown can't trigger a form submission when
321
    // JavaScript is disabled, add a submit button to do that. book.admin.css hides
322 323 324 325 326 327
    // 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,
328 329 330
      '#attached' => array(
        'css' => array(drupal_get_path('module', 'book') . '/book.admin.css'),
      ),
331
    );
332
  }
Dries's avatar
Dries committed
333
}
334

335
/**
336
 * Form submission handler for node_form().
337 338 339 340 341
 *
 * 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
342
 * book_form_update() Ajax callback instead.
343 344
 *
 * @see book_form_update()
345
 * @see book_form_node_form_alter()
346 347
 */
function book_pick_book_nojs_submit($form, &$form_state) {
348
  $node = $form_state['controller']->getEntity();
349
  $node->book = $form_state['values']['book'];
350 351 352
  $form_state['rebuild'] = TRUE;
}

Dries's avatar
Dries committed
353
/**
354
 * Builds the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
355 356
 *
 * This function is also called when generating a new set of options during the
357 358 359 360 361 362 363 364
 * Ajax callback, so an array is returned that can be used to replace an
 * existing form element.
 *
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 *
 * @return
 *   A parent selection form element.
Dries's avatar
Dries committed
365 366
 */
function _book_parent_select($book_link) {
367
  if (config('menu.settings')->get('override_parent_selector')) {
368 369
    return array();
  }
Dries's avatar
Dries committed
370 371 372 373 374 375 376
  // Offer a message or a drop-down to choose a different parent page.
  $form = array(
    '#type' => 'hidden',
    '#value' => -1,
    '#prefix' => '<div id="edit-book-plid-wrapper">',
    '#suffix' => '</div>',
  );
377

Dries's avatar
Dries committed
378 379 380
  if ($book_link['nid'] === $book_link['bid']) {
    // This is a book - at the top level.
    if ($book_link['original_bid'] === $book_link['bid']) {
381
      $form['#prefix'] .= '<em>' . t('This is the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
382 383
    }
    else {
384
      $form['#prefix'] .= '<em>' . t('This will be the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
385 386 387
    }
  }
  elseif (!$book_link['bid']) {
388
    $form['#prefix'] .= '<em>' . t('No book selected.') . '</em>';
389 390
  }
  else {
Dries's avatar
Dries committed
391 392 393 394
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
395
      '#description' => t('The parent page in the book. The maximum depth for a book and all child pages is !maxdepth. Some pages in the selected book may not be available as parents if selecting them would exceed this limit.', array('!maxdepth' => MENU_MAX_DEPTH)),
396
      '#options' => book_toc($book_link['bid'], $book_link['parent_depth_limit'], array($book_link['mlid'])),
397
      '#attributes' => array('class' => array('book-title-select')),
398 399
      '#prefix' => '<div id="edit-book-plid-wrapper">',
      '#suffix' => '</div>',
400
    );
Dries's avatar
 
Dries committed
401
  }
402

403
  return $form;
Dries's avatar
 
Dries committed
404 405
}

406
/**
407 408
 * Builds the common elements of the book form for the node and outline forms.
 *
409
 * @param \Drupal\Core\Entity\EntityInterface $node
410
 *   The node whose form is being viewed.
411
 */
412
function _book_add_form_elements(&$form, &$form_state, EntityInterface $node) {
413
  // If the form is being processed during the Ajax callback of our book bid
414 415 416 417
  // dropdown, then $form_state will hold the value that was selected.
  if (isset($form_state['values']['book'])) {
    $node->book = $form_state['values']['book'];
  }
Dries's avatar
Dries committed
418 419

  $form['book'] = array(
420
    '#type' => 'details',
Dries's avatar
Dries committed
421 422 423
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsed' => TRUE,
424
    '#group' => 'advanced',
425
    '#attributes' => array(
426
      'class' => array('book-outline-form'),
427
    ),
428
    '#attached' => array(
429
      'library' => array(array('book', 'drupal.book')),
430
    ),
Dries's avatar
Dries committed
431
    '#tree' => TRUE,
432
  );
433
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
434 435 436 437 438 439 440 441
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

  $form['book']['plid'] = _book_parent_select($node->book);

442
  // @see _book_admin_table_tree(). The weight may be larger than 15.
Dries's avatar
Dries committed
443
  $form['book']['weight'] = array(
444
    '#type' => 'weight',
445
    '#title' => t('Weight'),
Dries's avatar
Dries committed
446
    '#default_value' => $node->book['weight'],
447
    '#delta' => max(15, abs($node->book['weight'])),
Dries's avatar
Dries committed
448
    '#weight' => 5,
449 450
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
451 452
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
453

454
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
455
    // This is the top level node in a maximum depth book and thus cannot be moved.
456
    $options[$node->nid] = $node->label();
457 458 459 460 461 462 463
  }
  else {
    foreach (book_get_books() as $book) {
      $options[$book['nid']] = $book['title'];
    }
  }

Dries's avatar
Dries committed
464 465
  if (user_access('create new books') && ($nid == 'new' || ($nid != $node->book['original_bid']))) {
    // The node can become a new book, if it is not one already.
466
    $options = array($nid => t('- Create a new book -')) + $options;
Dries's avatar
Dries committed
467 468
  }
  if (!$node->book['mlid']) {
469
    // The node is not currently in the hierarchy.
470
    $options = array(0 => t('- None -')) + $options;
Dries's avatar
Dries committed
471 472 473 474 475 476 477 478
  }

  // Add a drop-down to select the destination book.
  $form['book']['bid'] = array(
    '#type' => 'select',
    '#title' => t('Book'),
    '#default_value' => $node->book['bid'],
    '#options' => $options,
479
    '#access' => (bool) $options,
Dries's avatar
Dries committed
480 481
    '#description' => t('Your page will be a part of the selected book.'),
    '#weight' => -5,
482
    '#attributes' => array('class' => array('book-title-select')),
483
    '#ajax' => array(
484
      'callback' => 'book_form_update',
485
      'wrapper' => 'edit-book-plid-wrapper',
486 487
      'effect' => 'fade',
      'speed' => 'fast',
488
    ),
489
  );
Dries's avatar
Dries committed
490
}
Dries's avatar
 
Dries committed
491

492 493 494
/**
 * Renders a new parent page select element when the book selection changes.
 *
495
 * This function is called via Ajax when the selected book is changed on a node
496 497 498 499 500 501 502 503 504
 * or book outline form.
 *
 * @return
 *   The rendered parent page select element.
 */
function book_form_update($form, $form_state) {
  return $form['book']['plid'];
}

505
/**
506 507 508 509 510
 * Handles additions and updates to the book outline.
 *
 * This common helper function performs all additions and updates to the book
 * outline through node addition, node editing, node deletion, or the outline
 * tab.
Dries's avatar
Dries committed
511
 *
512
 * @param \Drupal\Core\Entity\EntityInterface $node
513 514 515 516
 *   The node that is being saved, added, deleted, or moved.
 *
 * @return
 *   TRUE if the menu link was saved; FALSE otherwise.
Dries's avatar
Dries committed
517
 */
518
function _book_update_outline(EntityInterface $node) {
Dries's avatar
Dries committed
519 520 521 522 523
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

524
  $node->book['link_path'] = 'node/' . $node->nid;
525
  $node->book['link_title'] = $node->label();
Dries's avatar
Dries committed
526 527 528 529 530 531 532 533 534
  $node->book['parent_mismatch'] = FALSE; // The normal case.

  if ($node->book['bid'] == $node->nid) {
    $node->book['plid'] = 0;
    $node->book['menu_name'] = book_menu_name($node->nid);
  }
  else {
    // Check in case the parent is not is this book; the book takes precedence.
    if (!empty($node->book['plid'])) {
535 536 537
      $parent = db_query("SELECT * FROM {book} WHERE mlid = :mlid", array(
        ':mlid' => $node->book['plid'],
      ))->fetchAssoc();
Dries's avatar
Dries committed
538 539
    }
    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {
540 541 542
      $node->book['plid'] = db_query("SELECT mlid FROM {book} WHERE nid = :nid", array(
        ':nid' => $node->book['bid'],
      ))->fetchField();
Dries's avatar
Dries committed
543 544 545
      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.
    }
  }
546

547 548
  $node->book = entity_create('menu_link', $node->book);
  if ($node->book->save()) {
Dries's avatar
Dries committed
549 550
    if ($new) {
      // Insert new.
551 552 553 554 555 556 557
      db_insert('book')
        ->fields(array(
          'nid' => $node->nid,
          'mlid' => $node->book['mlid'],
          'bid' => $node->book['bid'],
        ))
        ->execute();
558 559
      // Reset the cache of stored books.
      drupal_static_reset('book_get_books');
Dries's avatar
Dries committed
560 561
    }
    else {
562 563 564
      if ($node->book['bid'] != db_query("SELECT bid FROM {book} WHERE nid = :nid", array(
          ':nid' => $node->nid,
        ))->fetchField()) {
Dries's avatar
Dries committed
565 566
        // Update the bid for this page and all children.
        book_update_bid($node->book);
567 568
        // Reset the cache of stored books.
        drupal_static_reset('book_get_books');
Dries's avatar
Dries committed
569 570
      }
    }
571

Dries's avatar
Dries committed
572 573
    return TRUE;
  }
574 575

  // Failed to save the menu link.
Dries's avatar
Dries committed
576 577 578
  return FALSE;
}

579
/**
580
 * Updates the book ID of a page and its children when it moves to a new book.
581
 *
Dries's avatar
Dries committed
582 583 584 585
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 */
function book_update_bid($book_link) {
586 587
  $query = db_select('menu_links');
  $query->addField('menu_links', 'mlid');
Dries's avatar
Dries committed
588
  for ($i = 1; $i <= MENU_MAX_DEPTH && $book_link["p$i"]; $i++) {
589
    $query->condition("p$i", $book_link["p$i"]);
Dries's avatar
Dries committed
590
  }
591
  $mlids = $query->execute()->fetchCol();
592

Dries's avatar
Dries committed
593
  if ($mlids) {
594
    db_update('book')
595
      ->fields(array('bid' => $book_link['bid']))
596 597
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
598 599 600 601
  }
}

/**
602
 * Gets the book menu tree for a page and returns it as a linear array.
603
 *
Dries's avatar
Dries committed
604 605
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
606
 *
607
 * @return
Dries's avatar
Dries committed
608 609
 *   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
610 611 612
 *   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.
613
 */
Dries's avatar
Dries committed
614
function book_get_flat_menu($book_link) {
615
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
616 617

  if (!isset($flat[$book_link['mlid']])) {
618
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
619
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
Dries's avatar
Dries committed
620 621
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
 
Dries committed
622
  }
623

Dries's avatar
Dries committed
624
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
625 626
}

627
/**
628 629 630 631 632
 * Recursively converts a tree of menu links to a flat array.
 *
 * @param $tree
 *   A tree of menu links in an array.
 * @param $flat
633
 *   A flat array of the menu links from $tree, passed by reference.
634 635
 *
 * @see book_get_flat_menu().
636
 */
Dries's avatar
Dries committed
637 638 639 640 641 642 643 644
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
645
  }
Dries's avatar
Dries committed
646
}
Dries's avatar
 
Dries committed
647

Dries's avatar
Dries committed
648 649
/**
 * Fetches the menu link for the previous page of the book.
650 651 652 653 654 655 656
 *
 * @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
657 658 659 660 661
 */
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
662
  }
Dries's avatar
Dries committed
663 664 665 666 667 668 669 670 671 672 673 674
  $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.
675 676
      $tree = book_menu_subtree_data($prev);
      $data = array_shift($tree);
Dries's avatar
Dries committed
677 678 679 680
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
681

Dries's avatar
Dries committed
682 683 684 685 686
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
687 688 689
  }
}

690
/**
Dries's avatar
Dries committed
691
 * Fetches the menu link for the next page of the book.
692 693 694 695 696 697 698
 *
 * @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.
699
 */
Dries's avatar
Dries committed
700 701 702 703 704
function book_next($book_link) {
  $flat = book_get_flat_menu($book_link);
  // Assigning the array to $flat resets the array pointer for use with each().
  do {
    list($key, $curr) = each($flat);
705 706 707
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
708 709
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
710
  }
Dries's avatar
Dries committed
711
}
Dries's avatar
 
Dries committed
712

Dries's avatar
Dries committed
713
/**
714 715 716 717 718 719 720
 * 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
721 722 723
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
724

Dries's avatar
Dries committed
725 726 727 728 729 730
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
731 732
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
733 734 735 736 737
    // 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
738 739
    }
  }
740

741 742 743 744 745
  if ($children) {
    $elements = menu_tree_output($children);
    return drupal_render($elements);
  }
  return '';
Dries's avatar
 
Dries committed
746 747
}

748
/**
749 750 751 752 753 754 755
 * Generates the corresponding menu name from a book ID.
 *
 * @param $bid
 *   The book ID for which to make a menu name.
 *
 * @return
 *   The menu name.
756
 */
Dries's avatar
Dries committed
757
function book_menu_name($bid) {
758
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
759 760
}

761
/**
762
 * Implements hook_node_load().
763
 */
764
function book_node_load($nodes, $types) {
765
  $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));
766 767 768 769 770
  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']);
771 772
  }
}
773

774
/**
775
 * Implements hook_node_view().
776
 */
777
function book_node_view(EntityInterface $node, EntityDisplay $display, $view_mode) {
778
  if ($view_mode == 'full') {