book.module 44.8 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
  $all_books = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
272 273 274

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

Dries's avatar
Dries committed
277
    if ($nids) {
278
      $query = db_select('book', 'b', array('fetch' => PDO::FETCH_ASSOC));
279 280
      $query->join('node', 'n', 'b.nid = n.nid');
      $query->join('menu_links', 'ml', 'b.mlid = ml.mlid');
281 282 283
      $query->addField('n', 'type', 'type');
      $query->addField('n', 'title', 'title');
      $query->fields('b');
284
      $query->fields('ml');
285 286 287 288 289 290 291
      $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
292 293
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
294
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
295 296
      }
    }
297
  }
298

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

775
/**
776
 * Implements hook_node_view().
777
 */
778