book.module 44.7 KB
Newer Older
Dries's avatar
 
Dries committed
1 2
<?php

Dries's avatar
 
Dries committed
3 4
/**
 * @file
5
 * Allows users to create and organize related content in an outline.
Dries's avatar
 
Dries committed
6 7
 */

8
use Drupal\Core\Entity\EntityInterface;
9
use Drupal\node\NodeTypeInterface;
10
use Drupal\Core\Language\Language;
11
use Drupal\entity\Plugin\Core\Entity\EntityDisplay;
12
use Drupal\Core\Template\Attribute;
13 14
use Drupal\menu_link\Plugin\Core\Entity\MenuLink;
use Drupal\menu_link\MenuLinkStorageController;
15
use Drupal\node\NodeInterface;
16

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

44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
/**
 * 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';
    }
  }
}

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

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

Dries's avatar
 
Dries committed
115
/**
116 117
 * Adds relevant book links to the node's links.
 *
118
 * @param \Drupal\Core\Entity\EntityInterface $node
119 120 121
 *   The book page node to add links to.
 * @param $view_mode
 *   The view mode of the node.
Dries's avatar
 
Dries committed
122
 */
123
function book_node_view_link(EntityInterface $node, $view_mode) {
Dries's avatar
 
Dries committed
124
  $links = array();
Dries's avatar
Dries committed
125

126
  if (isset($node->book['depth'])) {
127
    if ($view_mode == 'full' && node_is_page($node)) {
128
      $child_type = config('book.settings')->get('child_type');
Dries's avatar
Dries committed
129
      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) {
130
        $links['book_add_child'] = array(
131
          'title' => t('Add child page'),
132
          'href' => 'node/add/' . $child_type,
133
          'query' => array('parent' => $node->book['mlid']),
134
        );
Dries's avatar
 
Dries committed
135
      }
136

Dries's avatar
Dries committed
137
      if (user_access('access printer-friendly version')) {
138
        $links['book_printer'] = array(
139
          'title' => t('Printer-friendly version'),
140
          'href' => 'book/export/html/' . $node->nid,
141
          'attributes' => array('title' => t('Show a printer-friendly version of this book page and its sub-pages.'))
142
        );
143
      }
Dries's avatar
 
Dries committed
144
    }
Dries's avatar
 
Dries committed
145
  }
146

147
  if (!empty($links)) {
148 149 150 151 152
    $node->content['links']['book'] = array(
      '#theme' => 'links__node__book',
      '#links' => $links,
      '#attributes' => array('class' => array('links', 'inline')),
    );
153
  }
Dries's avatar
 
Dries committed
154 155
}

Dries's avatar
 
Dries committed
156
/**
157
 * Implements hook_menu().
Dries's avatar
 
Dries committed
158
 */
159
function book_menu() {
160
  $items['admin/structure/book'] = array(
161
    'title' => 'Books',
162
    'description' => "Manage your site's book outlines.",
163
    'route_name' => 'book_admin',
164
  );
165
  $items['admin/structure/book/list'] = array(
166
    'title' => 'List',
167 168
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
169
  $items['admin/structure/book/settings'] = array(
Dries's avatar
Dries committed
170
    'title' => 'Settings',
171
    'route_name' => 'book_settings',
Dries's avatar
Dries committed
172
    'access arguments' => array('administer site configuration'),
173
    'type' => MENU_LOCAL_TASK,
174
    'weight' => 100,
175
  );
176
  $items['admin/structure/book/%node'] = array(
Dries's avatar
Dries committed
177 178 179 180 181 182
    '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,
183
    'file' => 'book.admin.inc',
Dries's avatar
Dries committed
184
  );
185
  $items['book'] = array(
186
    'title' => 'Books',
187
    'route_name' => 'book_render',
188 189
    'type' => MENU_SUGGESTED_ITEM,
  );
190
  $items['book/export/%/%node'] = array(
191 192
    'page callback' => 'book_export',
    'page arguments' => array(2, 3),
193 194
    'access callback' => 'book_export_access',
    'access arguments' => array(3),
195
    'type' => MENU_CALLBACK,
196
    'file' => 'book.pages.inc',
197
  );
198
  $items['node/%node/outline'] = array(
199
    'title' => 'Outline',
Dries's avatar
Dries committed
200 201
    'page callback' => 'book_outline',
    'page arguments' => array(1),
202 203 204 205
    'access callback' => '_book_outline_access',
    'access arguments' => array(1),
    'type' => MENU_LOCAL_TASK,
    'weight' => 2,
206
    'file' => 'book.pages.inc',
207
  );
Dries's avatar
Dries committed
208 209 210 211 212 213
  $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),
214
    'file' => 'book.pages.inc',
Dries's avatar
Dries committed
215
  );
216

Dries's avatar
 
Dries committed
217 218 219
  return $items;
}

220 221 222
/**
 * Access callback: Determines if the book export page is accessible.
 *
223
 * @param \Drupal\node\Plugin\Core\Entity\EntityInterface $node
224 225
 *   The node whose export page is to be viewed.
 */
226
function book_export_access(EntityInterface $node) {
227 228 229
  return user_access('access printer-friendly version') && node_access('view', $node);
}

Dries's avatar
Dries committed
230
/**
231 232 233
 * Access callback: Determines if the outline tab is accessible.
 *
 * Path:
234
 * - admin/structure/book/%node
235 236
 * - node/%node/outline
 *
237
 * @param \Drupal\Core\Entity\EntityInterface $node
238 239 240
 *   The node whose outline tab is to be viewed.
 *
 * @see book_menu()
Dries's avatar
Dries committed
241
 */
242
function _book_outline_access(EntityInterface $node) {
Dries's avatar
Dries committed
243 244 245 246
  return user_access('administer book outlines') && node_access('view', $node);
}

/**
247 248
 * Access callback: Determines if the user can remove nodes from the outline.
 *
249
 * @param \Drupal\Core\Entity\EntityInterface $node
250 251 252
 *   The node to remove from the outline.
 *
 * @see book_menu()
Dries's avatar
Dries committed
253
 */
254
function _book_outline_remove_access(EntityInterface $node) {
255 256 257 258 259 260 261 262
  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.
263
 *
264
 * @param \Drupal\Core\Entity\EntityInterface $node
265
 *   The node to remove from the outline.
266
 */
267
function _book_node_is_removable(EntityInterface $node) {
268
  return (!empty($node->book['bid']) && (($node->book['bid'] != $node->nid) || !$node->book['has_children']));
269 270
}

271 272 273 274
/**
 * Implements hook_admin_paths().
 */
function book_admin_paths() {
275 276 277 278 279 280 281
  if (variable_get('node_admin_theme')) {
    $paths = array(
      'node/*/outline' => TRUE,
      'node/*/outline/remove' => TRUE,
    );
    return $paths;
  }
282 283
}

284
/**
Dries's avatar
Dries committed
285 286
 * Returns an array of all books.
 *
287 288
 * @todo Remove in favor of BookManager Service. http://drupal.org/node/1963894
 *
Dries's avatar
Dries committed
289 290
 * This list may be used for generating a list of all the books, or for building
 * the options for a form select.
291 292 293
 *
 * @return
 *   An array of all books.
294
 */
Dries's avatar
Dries committed
295
function book_get_books() {
296
  return Drupal::service('book.manager')->getAllBooks();
297
}
298

Dries's avatar
Dries committed
299
/**
300
 * Implements hook_form_BASE_FORM_ID_alter() for node_form().
301
 *
302
 * Adds the book form element to the node form.
303 304
 *
 * @see book_pick_book_nojs_submit()
Dries's avatar
Dries committed
305
 */
306
function book_form_node_form_alter(&$form, &$form_state, $form_id) {
307
  $node = $form_state['controller']->getEntity();
308 309 310 311 312
  $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
313
    }
314
  }
Dries's avatar
Dries committed
315

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

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

Dries's avatar
Dries committed
351
/**
352
 * Builds the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
353 354
 *
 * This function is also called when generating a new set of options during the
355 356 357 358 359 360 361 362
 * 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
363 364
 */
function _book_parent_select($book_link) {
365
  if (config('menu.settings')->get('override_parent_selector')) {
366 367
    return array();
  }
Dries's avatar
Dries committed
368 369 370 371 372 373 374
  // 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>',
  );
375

Dries's avatar
Dries committed
376 377 378
  if ($book_link['nid'] === $book_link['bid']) {
    // This is a book - at the top level.
    if ($book_link['original_bid'] === $book_link['bid']) {
379
      $form['#prefix'] .= '<em>' . t('This is the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
380 381
    }
    else {
382
      $form['#prefix'] .= '<em>' . t('This will be the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
383 384 385
    }
  }
  elseif (!$book_link['bid']) {
386
    $form['#prefix'] .= '<em>' . t('No book selected.') . '</em>';
387 388
  }
  else {
Dries's avatar
Dries committed
389 390 391 392
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
393
      '#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)),
394
      '#options' => book_toc($book_link['bid'], $book_link['parent_depth_limit'], array($book_link['mlid'])),
395
      '#attributes' => array('class' => array('book-title-select')),
396 397
      '#prefix' => '<div id="edit-book-plid-wrapper">',
      '#suffix' => '</div>',
398
    );
Dries's avatar
 
Dries committed
399
  }
400

401
  return $form;
Dries's avatar
 
Dries committed
402 403
}

404
/**
405 406
 * Builds the common elements of the book form for the node and outline forms.
 *
407
 * @param \Drupal\Core\Entity\EntityInterface $node
408
 *   The node whose form is being viewed.
409
 */
410
function _book_add_form_elements(&$form, &$form_state, EntityInterface $node) {
411
  // If the form is being processed during the Ajax callback of our book bid
412 413 414 415
  // 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
416 417

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

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

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

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

Dries's avatar
Dries committed
462 463
  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.
464
    $options = array($nid => t('- Create a new book -')) + $options;
Dries's avatar
Dries committed
465 466
  }
  if (!$node->book['mlid']) {
467
    // The node is not currently in the hierarchy.
468
    $options = array(0 => t('- None -')) + $options;
Dries's avatar
Dries committed
469 470 471 472 473 474 475 476
  }

  // 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,
477
    '#access' => (bool) $options,
Dries's avatar
Dries committed
478 479
    '#description' => t('Your page will be a part of the selected book.'),
    '#weight' => -5,
480
    '#attributes' => array('class' => array('book-title-select')),
481
    '#ajax' => array(
482
      'callback' => 'book_form_update',
483
      'wrapper' => 'edit-book-plid-wrapper',
484 485
      'effect' => 'fade',
      'speed' => 'fast',
486
    ),
487
  );
Dries's avatar
Dries committed
488
}
Dries's avatar
 
Dries committed
489

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

503
/**
504 505 506 507 508
 * 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
509
 *
510
 * @param \Drupal\Core\Entity\EntityInterface $node
511 512 513 514
 *   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
515
 */
516
function _book_update_outline(EntityInterface $node) {
Dries's avatar
Dries committed
517 518 519 520 521
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

522
  $node->book['link_path'] = 'node/' . $node->nid;
523
  $node->book['link_title'] = $node->label();
Dries's avatar
Dries committed
524 525 526 527 528 529 530 531 532
  $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'])) {
533 534 535
      $parent = db_query("SELECT * FROM {book} WHERE mlid = :mlid", array(
        ':mlid' => $node->book['plid'],
      ))->fetchAssoc();
Dries's avatar
Dries committed
536 537
    }
    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {
538 539 540
      $node->book['plid'] = db_query("SELECT mlid FROM {book} WHERE nid = :nid", array(
        ':nid' => $node->book['bid'],
      ))->fetchField();
Dries's avatar
Dries committed
541 542 543
      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.
    }
  }
544

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

Dries's avatar
Dries committed
570 571
    return TRUE;
  }
572 573

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

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

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

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

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

Dries's avatar
Dries committed
622
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
623 624
}

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

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

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

688
/**
Dries's avatar
Dries committed
689
 * Fetches the menu link for the next page of the book.
690 691 692 693 694 695 696
 *
 * @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.
697
 */
Dries's avatar
Dries committed
698 699 700 701 702
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);
703 704 705
  }
  while ($key && $key != $book_link['mlid']);

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

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

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

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

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

746
/**
747 748 749 750 751 752 753
 * 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.
754
 */
Dries's avatar
Dries committed
755
function book_menu_name($bid) {
756
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
757 758
}

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

772
/**
773
 * Implements hook_node_view().
774
 */
775
function book_node_view(EntityInterface $node, EntityDisplay $display, $view_mode) {
776
  if ($view_mode == 'full') {
777
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
778
      $book_navigation = array( '#theme' => 'book_navigation', '#book_link' => $node->book);
779
      $node->content['book_navigation'] = array(
780
        '#markup' => drupal_render($book_navigation),
781
        '#weight' => 100,
782 783 784 785 786
        '#attached' => array(
          'css' => array(
            drupal_get_path('module', 'book') . '/css/book.theme.css',
          ),
        ),
Dries's avatar