book.module 44.1 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\node\Plugin\Core\Entity\Node;
9
use Drupal\entity\Plugin\Core\Entity\EntityDisplay;
10
use Drupal\Core\Template\Attribute;
11

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

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

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

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

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

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

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

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

Dries's avatar
 
Dries committed
195 196 197
  return $items;
}

Dries's avatar
Dries committed
198
/**
199 200 201 202 203 204
 * Access callback: Determines if the outline tab is accessible.
 *
 * Path:
 * - admin/content/book/%node
 * - node/%node/outline
 *
205
 * @param Drupal\node\Node $node
206 207 208
 *   The node whose outline tab is to be viewed.
 *
 * @see book_menu()
Dries's avatar
Dries committed
209
 */
210
function _book_outline_access(Node $node) {
Dries's avatar
Dries committed
211 212 213 214
  return user_access('administer book outlines') && node_access('view', $node);
}

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

239 240 241 242
/**
 * Implements hook_admin_paths().
 */
function book_admin_paths() {
243 244 245 246 247 248 249
  if (variable_get('node_admin_theme')) {
    $paths = array(
      'node/*/outline' => TRUE,
      'node/*/outline/remove' => TRUE,
    );
    return $paths;
  }
250 251
}

252
/**
253
 * Implements hook_entity_view_mode_info().
254
 */
255
function book_entity_view_mode_info() {
256
  // Add the 'Print' view mode for nodes.
257
  $view_modes['node']['print'] = array(
258
    'label' => t('Print'),
259
  );
260
  return $view_modes;
261 262
}

263
/**
Dries's avatar
Dries committed
264 265 266 267
 * Returns an array of all books.
 *
 * This list may be used for generating a list of all the books, or for building
 * the options for a form select.
268 269 270
 *
 * @return
 *   An array of all books.
271
 */
Dries's avatar
Dries committed
272
function book_get_books() {
273
  $all_books = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
274 275 276

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

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

Dries's avatar
Dries committed
301
  return $all_books;
302
}
303

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

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

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

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

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

406
  return $form;
Dries's avatar
 
Dries committed
407 408
}

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

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

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

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

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

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

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

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

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

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

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

Dries's avatar
Dries committed
575 576
    return TRUE;
  }
577 578

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

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

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

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

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

Dries's avatar
Dries committed
627
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
628 629
}

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

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

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

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

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

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

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

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

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

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

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

777
/**
778
 * Implements hook_node_view().
779
 */
780
function book_node_view(Node $node, EntityDisplay $display, $view_mode) {
781
  if ($view_mode == 'full') {
782
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
783
      $node->content['book_navigation'] = array(
784
        '#markup' => theme('book_navigation', array('book_link' => $node->book)),
785 786 787 788
        '#weight' => 100,
      );
    }
  }
Dries's avatar
Dries committed
789

790 791
  if ($view_mode != 'rss') {
    book_node_view_link($node, $view_mode);
792
  }
793 794 795
}

/**
Dries's avatar