book.module 43.9 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\Core\Language\Language;
10
use Drupal\entity\Plugin\Core\Entity\EntityDisplay;
11
use Drupal\Core\Template\Attribute;
12 13
use Drupal\menu_link\Plugin\Core\Entity\MenuLink;
use Drupal\menu_link\MenuLinkStorageController;
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 online handbook entry for <a href="@book">Book module</a>.', array('@book' => 'http://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</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>';
27 28 29 30 31
      $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>';
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' => url('book'), '@book-admin' => url('admin/structure/book'))) . '</p>';
39 40 41
  }
}

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

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

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

101
  if (isset($node->book['depth'])) {
102
    if ($view_mode == 'full' && node_is_page($node)) {
103
      $child_type = config('book.settings')->get('child_type');
Dries's avatar
Dries committed
104
      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) {
105
        $links['book_add_child'] = array(
106
          'title' => t('Add child page'),
107
          'href' => 'node/add/' . $child_type,
108
          'query' => array('parent' => $node->book['mlid']),
109
        );
Dries's avatar
 
Dries committed
110
      }
111

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

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

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

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

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

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

/**
222 223
 * Access callback: Determines if the user can remove nodes from the outline.
 *
224
 * @param \Drupal\Core\Entity\EntityInterface $node
225 226 227
 *   The node to remove from the outline.
 *
 * @see book_menu()
Dries's avatar
Dries committed
228
 */
229
function _book_outline_remove_access(EntityInterface $node) {
230 231 232 233 234 235 236 237
  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.
238
 *
239
 * @param \Drupal\Core\Entity\EntityInterface $node
240
 *   The node to remove from the outline.
241
 */
242
function _book_node_is_removable(EntityInterface $node) {
243
  return (!empty($node->book['bid']) && (($node->book['bid'] != $node->nid) || !$node->book['has_children']));
244 245
}

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

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

Dries's avatar
Dries committed
274
/**
275
 * Implements hook_form_BASE_FORM_ID_alter() for node_form().
276
 *
277
 * Adds the book form element to the node form.
278 279
 *
 * @see book_pick_book_nojs_submit()
Dries's avatar
Dries committed
280
 */
281
function book_form_node_form_alter(&$form, &$form_state, $form_id) {
282
  $node = $form_state['controller']->getEntity();
283 284 285 286 287
  $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
288
    }
289
  }
Dries's avatar
Dries committed
290

291 292 293
  if ($access) {
    _book_add_form_elements($form, $form_state, $node);
    // Since the "Book" dropdown can't trigger a form submission when
294
    // JavaScript is disabled, add a submit button to do that. book.admin.css hides
295 296 297 298 299 300
    // 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,
301 302 303
      '#attached' => array(
        'css' => array(drupal_get_path('module', 'book') . '/book.admin.css'),
      ),
304
    );
305
  }
Dries's avatar
Dries committed
306
}
307

308
/**
309
 * Form submission handler for node_form().
310 311 312 313 314
 *
 * 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
315
 * book_form_update() Ajax callback instead.
316 317
 *
 * @see book_form_update()
318
 * @see book_form_node_form_alter()
319 320
 */
function book_pick_book_nojs_submit($form, &$form_state) {
321
  $node = $form_state['controller']->getEntity();
322
  $node->book = $form_state['values']['book'];
323 324 325
  $form_state['rebuild'] = TRUE;
}

Dries's avatar
Dries committed
326
/**
327
 * Builds the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
328 329
 *
 * This function is also called when generating a new set of options during the
330 331 332 333 334 335 336 337
 * 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
338 339
 */
function _book_parent_select($book_link) {
340
  if (config('menu.settings')->get('override_parent_selector')) {
341 342
    return array();
  }
Dries's avatar
Dries committed
343 344 345 346 347 348 349
  // 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>',
  );
350

Dries's avatar
Dries committed
351 352 353
  if ($book_link['nid'] === $book_link['bid']) {
    // This is a book - at the top level.
    if ($book_link['original_bid'] === $book_link['bid']) {
354
      $form['#prefix'] .= '<em>' . t('This is the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
355 356
    }
    else {
357
      $form['#prefix'] .= '<em>' . t('This will be the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
358 359 360
    }
  }
  elseif (!$book_link['bid']) {
361
    $form['#prefix'] .= '<em>' . t('No book selected.') . '</em>';
362 363
  }
  else {
Dries's avatar
Dries committed
364 365 366 367
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
368
      '#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)),
369
      '#options' => book_toc($book_link['bid'], $book_link['parent_depth_limit'], array($book_link['mlid'])),
370
      '#attributes' => array('class' => array('book-title-select')),
371 372
      '#prefix' => '<div id="edit-book-plid-wrapper">',
      '#suffix' => '</div>',
373
    );
Dries's avatar
 
Dries committed
374
  }
375

376
  return $form;
Dries's avatar
 
Dries committed
377 378
}

379
/**
380 381
 * Builds the common elements of the book form for the node and outline forms.
 *
382
 * @param \Drupal\Core\Entity\EntityInterface $node
383
 *   The node whose form is being viewed.
384
 */
385
function _book_add_form_elements(&$form, &$form_state, EntityInterface $node) {
386
  // If the form is being processed during the Ajax callback of our book bid
387 388 389 390
  // 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
391 392

  $form['book'] = array(
393
    '#type' => 'details',
Dries's avatar
Dries committed
394 395 396
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsed' => TRUE,
397
    '#group' => 'advanced',
398
    '#attributes' => array(
399
      'class' => array('book-outline-form'),
400
    ),
401
    '#attached' => array(
402
      'library' => array(array('book', 'drupal.book')),
403
    ),
Dries's avatar
Dries committed
404
    '#tree' => TRUE,
405
  );
406
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
407 408 409 410 411 412 413 414
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

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

415
  // @see _book_admin_table_tree(). The weight may be larger than 15.
Dries's avatar
Dries committed
416
  $form['book']['weight'] = array(
417
    '#type' => 'weight',
418
    '#title' => t('Weight'),
Dries's avatar
Dries committed
419
    '#default_value' => $node->book['weight'],
420
    '#delta' => max(15, abs($node->book['weight'])),
Dries's avatar
Dries committed
421
    '#weight' => 5,
422 423
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
424 425
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
426

427
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
428
    // This is the top level node in a maximum depth book and thus cannot be moved.
429
    $options[$node->nid] = $node->label();
430 431 432 433 434 435 436
  }
  else {
    foreach (book_get_books() as $book) {
      $options[$book['nid']] = $book['title'];
    }
  }

Dries's avatar
Dries committed
437 438
  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.
439
    $options = array($nid => t('- Create a new book -')) + $options;
Dries's avatar
Dries committed
440 441
  }
  if (!$node->book['mlid']) {
442
    // The node is not currently in the hierarchy.
443
    $options = array(0 => t('- None -')) + $options;
Dries's avatar
Dries committed
444 445 446 447 448 449 450 451
  }

  // 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,
452
    '#access' => (bool) $options,
Dries's avatar
Dries committed
453 454
    '#description' => t('Your page will be a part of the selected book.'),
    '#weight' => -5,
455
    '#attributes' => array('class' => array('book-title-select')),
456
    '#ajax' => array(
457
      'callback' => 'book_form_update',
458
      'wrapper' => 'edit-book-plid-wrapper',
459 460
      'effect' => 'fade',
      'speed' => 'fast',
461
    ),
462
  );
Dries's avatar
Dries committed
463
}
Dries's avatar
 
Dries committed
464

465 466 467
/**
 * Renders a new parent page select element when the book selection changes.
 *
468
 * This function is called via Ajax when the selected book is changed on a node
469 470 471 472 473 474 475 476 477
 * or book outline form.
 *
 * @return
 *   The rendered parent page select element.
 */
function book_form_update($form, $form_state) {
  return $form['book']['plid'];
}

478
/**
479 480 481 482 483
 * 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
484
 *
485
 * @param \Drupal\Core\Entity\EntityInterface $node
486 487 488 489
 *   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
490
 */
491
function _book_update_outline(EntityInterface $node) {
Dries's avatar
Dries committed
492 493 494 495 496
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

497
  $node->book['link_path'] = 'node/' . $node->nid;
498
  $node->book['link_title'] = $node->label();
Dries's avatar
Dries committed
499 500 501 502 503 504 505 506 507
  $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'])) {
508 509 510
      $parent = db_query("SELECT * FROM {book} WHERE mlid = :mlid", array(
        ':mlid' => $node->book['plid'],
      ))->fetchAssoc();
Dries's avatar
Dries committed
511 512
    }
    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {
513 514 515
      $node->book['plid'] = db_query("SELECT mlid FROM {book} WHERE nid = :nid", array(
        ':nid' => $node->book['bid'],
      ))->fetchField();
Dries's avatar
Dries committed
516 517 518
      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.
    }
  }
519

520 521
  $node->book = entity_create('menu_link', $node->book);
  if ($node->book->save()) {
Dries's avatar
Dries committed
522 523
    if ($new) {
      // Insert new.
524 525 526 527 528 529 530
      db_insert('book')
        ->fields(array(
          'nid' => $node->nid,
          'mlid' => $node->book['mlid'],
          'bid' => $node->book['bid'],
        ))
        ->execute();
531 532
      // Reset the cache of stored books.
      drupal_static_reset('book_get_books');
Dries's avatar
Dries committed
533 534
    }
    else {
535 536 537
      if ($node->book['bid'] != db_query("SELECT bid FROM {book} WHERE nid = :nid", array(
          ':nid' => $node->nid,
        ))->fetchField()) {
Dries's avatar
Dries committed
538 539
        // Update the bid for this page and all children.
        book_update_bid($node->book);
540 541
        // Reset the cache of stored books.
        drupal_static_reset('book_get_books');
Dries's avatar
Dries committed
542 543
      }
    }
544

Dries's avatar
Dries committed
545 546
    return TRUE;
  }
547 548

  // Failed to save the menu link.
Dries's avatar
Dries committed
549 550 551
  return FALSE;
}

552
/**
553
 * Updates the book ID of a page and its children when it moves to a new book.
554
 *
Dries's avatar
Dries committed
555 556 557 558
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 */
function book_update_bid($book_link) {
559 560
  $query = db_select('menu_links');
  $query->addField('menu_links', 'mlid');
Dries's avatar
Dries committed
561
  for ($i = 1; $i <= MENU_MAX_DEPTH && $book_link["p$i"]; $i++) {
562
    $query->condition("p$i", $book_link["p$i"]);
Dries's avatar
Dries committed
563
  }
564
  $mlids = $query->execute()->fetchCol();
565

Dries's avatar
Dries committed
566
  if ($mlids) {
567
    db_update('book')
568
      ->fields(array('bid' => $book_link['bid']))
569 570
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
571 572 573 574
  }
}

/**
575
 * Gets the book menu tree for a page and returns it as a linear array.
576
 *
Dries's avatar
Dries committed
577 578
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
579
 *
580
 * @return
Dries's avatar
Dries committed
581 582
 *   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
583 584 585
 *   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.
586
 */
Dries's avatar
Dries committed
587
function book_get_flat_menu($book_link) {
588
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
589 590

  if (!isset($flat[$book_link['mlid']])) {
591
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
592
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
Dries's avatar
Dries committed
593 594
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
 
Dries committed
595
  }
596

Dries's avatar
Dries committed
597
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
598 599
}

600
/**
601 602 603 604 605
 * Recursively converts a tree of menu links to a flat array.
 *
 * @param $tree
 *   A tree of menu links in an array.
 * @param $flat
606
 *   A flat array of the menu links from $tree, passed by reference.
607 608
 *
 * @see book_get_flat_menu().
609
 */
Dries's avatar
Dries committed
610 611 612 613 614 615 616 617
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
618
  }
Dries's avatar
Dries committed
619
}
Dries's avatar
 
Dries committed
620

Dries's avatar
Dries committed
621 622
/**
 * Fetches the menu link for the previous page of the book.
623 624 625 626 627 628 629
 *
 * @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
630 631 632 633 634
 */
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
635
  }
Dries's avatar
Dries committed
636 637 638 639 640 641 642 643 644 645 646 647
  $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.
648 649
      $tree = book_menu_subtree_data($prev);
      $data = array_shift($tree);
Dries's avatar
Dries committed
650 651 652 653
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
654

Dries's avatar
Dries committed
655 656 657 658 659
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
660 661 662
  }
}

663
/**
Dries's avatar
Dries committed
664
 * Fetches the menu link for the next page of the book.
665 666 667 668 669 670 671
 *
 * @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.
672
 */
Dries's avatar
Dries committed
673 674 675 676 677
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);
678 679 680
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
681 682
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
683
  }
Dries's avatar
Dries committed
684
}
Dries's avatar
 
Dries committed
685

Dries's avatar
Dries committed
686
/**
687 688 689 690 691 692 693
 * 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
694 695 696
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
697

Dries's avatar
Dries committed
698 699 700 701 702 703
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
704 705
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
706 707 708 709 710
    // 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
711 712
    }
  }
713

714 715 716 717 718
  if ($children) {
    $elements = menu_tree_output($children);
    return drupal_render($elements);
  }
  return '';
Dries's avatar
 
Dries committed
719 720
}

721
/**
722 723 724 725 726 727 728
 * 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.
729
 */
Dries's avatar
Dries committed
730
function book_menu_name($bid) {
731
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
732 733
}

734
/**
735
 * Implements hook_node_load().
736
 */
737
function book_node_load($nodes, $types) {
738
  $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));
739 740 741 742 743
  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']);
744 745
  }
}
746

747
/**
748
 * Implements hook_node_view().
749
 */
750
function book_node_view(EntityInterface $node, EntityDisplay $display, $view_mode) {
751
  if ($view_mode == 'full') {
752
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
753
      $node->content['book_navigation'] = array(
754
        '#markup' => theme('book_navigation', array('book_link' => $node->book)),
755 756 757 758
        '#weight' => 100,
      );
    }
  }
Dries's avatar
Dries committed
759

760 761
  if ($view_mode != 'rss') {
    book_node_view_link($node, $view_mode);
762
  }
763 764 765
}

/**
766
 * Implements hook_page_alter().
767
 *
768
 * Adds the book menu to the list of menus used to build the active trail when
769 770 771 772 773 774 775 776
 * viewing a book page.
 */
function book_page_alter(&$page) {
  if (($node = menu_get_object()) && !empty($node->book['bid'])) {
    $active_menus = menu_get_active_menu_names();
    $active_menus[] = $node->book['menu_name'];
    menu_set_active_menu_names($active_menus);
  }
777
}
778