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

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

8
use Drupal\Core\Entity\EntityInterface;
9
use Drupal\entity\Plugin\Core\Entity\EntityDisplay;
10
use Drupal\Core\Template\Attribute;
11 12
use Drupal\menu_link\Plugin\Core\Entity\MenuLink;
use Drupal\menu_link\MenuLinkStorageController;
13

14
/**
15
 * Implements hook_help().
16 17 18 19 20
 */
function book_help($path, $arg) {
  switch ($path) {
    case 'admin/help#book':
      $output = '<h3>' . t('About') . '</h3>';
21
      $output .= '<p>' . t('The Book module is used for creating structured, multi-page content, such as site resource guides, manuals, and wikis. It allows you to create content that has chapters, sections, subsections, or any similarly-tiered structure. For more information, see the online handbook entry for <a href="@book">Book module</a>.', array('@book' => 'http://drupal.org/documentation/modules/book')) . '</p>';
22 23 24
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Adding and managing book content') . '</dt>';
25
      $output .= '<dd>' . t('You can assign separate permissions for <em>creating</em>, <em>editing</em>, and <em>deleting</em> book content, as well as <em>adding content to books</em>, and <em>creating new books</em>. Users with the <em>Administer book outlines</em> permission can add <em>any</em> type of content to a book by selecting the appropriate book outline while editing the content. They can also view a list of all books, and edit and rearrange section titles on the <a href="@admin-book">Book administration page</a>.', array('@admin-book' => url('admin/content/book'))) . '</dd>';
26 27 28 29 30
      $output .= '<dt>' . t('Book navigation') . '</dt>';
      $output .= '<dd>' . t("Book pages have a default book-specific navigation block. This navigation block contains links that lead to the previous and next pages in the book, and to the level above the current page in the book's structure. This block can be enabled on the <a href='@admin-block'>Blocks administration page</a>. For book pages to show up in the book navigation, they must be added to a book outline.", array('@admin-block' => url('admin/structure/block'))) . '</dd>';
      $output .= '<dt>' . t('Collaboration') . '</dt>';
      $output .= '<dd>' . t('Books can be created collaboratively, as they allow users with appropriate permissions to add pages into existing books, and add those pages to a custom table of contents menu.') . '</dd>';
      $output .= '<dt>' . t('Printing books') . '</dt>';
31
      $output .= '<dd>' . t("Users with the <em>View printer-friendly books</em> permission can select the <em>printer-friendly version</em> link visible at the bottom of a book page's content to generate a printer-friendly display of the page and all of its subsections.") . '</dd>';
32 33 34 35 36 37 38 39 40
      $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>';
  }
}

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

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

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

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

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

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

Dries's avatar
 
Dries committed
130
/**
131
 * Implements hook_menu().
Dries's avatar
 
Dries committed
132
 */
133 134
function book_menu() {
  $items['admin/content/book'] = array(
135
    'title' => 'Books',
136
    'description' => "Manage your site's book outlines.",
137
    'route_name' => 'book_admin',
138
    'type' => MENU_LOCAL_TASK,
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
    '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
  );
Dries's avatar
Dries committed
151 152 153 154 155 156 157
  $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,
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 209 210 211
 * Access callback: Determines if the outline tab is accessible.
 *
 * Path:
 * - admin/content/book/%node
 * - 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
/**
260
 * Implements hook_entity_view_mode_info().
261
 */
262
function book_entity_view_mode_info() {
263
  // Add the 'Print' view mode for nodes.
264
  $view_modes['node']['print'] = array(
265
    'label' => t('Print'),
266
  );
267
  return $view_modes;
268 269
}

270
/**
Dries's avatar
Dries committed
271 272
 * Returns an array of all books.
 *
273 274
 * @todo Remove in favor of BookManager Service. http://drupal.org/node/1963894
 *
Dries's avatar
Dries committed
275 276
 * This list may be used for generating a list of all the books, or for building
 * the options for a form select.
277 278 279
 *
 * @return
 *   An array of all books.
280
 */
Dries's avatar
Dries committed
281
function book_get_books() {
282
  $all_books = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
283 284 285

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

Dries's avatar
Dries committed
288
    if ($nids) {
289
      $query = db_select('book', 'b', array('fetch' => PDO::FETCH_ASSOC));
290 291
      $query->join('node', 'n', 'b.nid = n.nid');
      $query->join('menu_links', 'ml', 'b.mlid = ml.mlid');
292 293 294
      $query->addField('n', 'type', 'type');
      $query->addField('n', 'title', 'title');
      $query->fields('b');
295
      $query->fields('ml');
296 297 298 299 300 301 302
      $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
303 304
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
305
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
306 307
      }
    }
308
  }
309

Dries's avatar
Dries committed
310
  return $all_books;
311
}
312

Dries's avatar
Dries committed
313
/**
314
 * Implements hook_form_BASE_FORM_ID_alter() for node_form().
315
 *
316
 * Adds the book form element to the node form.
317 318
 *
 * @see book_pick_book_nojs_submit()
Dries's avatar
Dries committed
319
 */
320
function book_form_node_form_alter(&$form, &$form_state, $form_id) {
321
  $node = $form_state['controller']->getEntity();
322 323 324 325 326
  $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
327
    }
328
  }
Dries's avatar
Dries committed
329

330 331 332
  if ($access) {
    _book_add_form_elements($form, $form_state, $node);
    // Since the "Book" dropdown can't trigger a form submission when
333
    // JavaScript is disabled, add a submit button to do that. book.admin.css hides
334 335 336 337 338 339
    // 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,
340 341 342
      '#attached' => array(
        'css' => array(drupal_get_path('module', 'book') . '/book.admin.css'),
      ),
343
    );
344
  }
Dries's avatar
Dries committed
345
}
346

347
/**
348
 * Form submission handler for node_form().
349 350 351 352 353
 *
 * 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
354
 * book_form_update() Ajax callback instead.
355 356
 *
 * @see book_form_update()
357
 * @see book_form_node_form_alter()
358 359
 */
function book_pick_book_nojs_submit($form, &$form_state) {
360
  $node = $form_state['controller']->getEntity();
361
  $node->book = $form_state['values']['book'];
362 363 364
  $form_state['rebuild'] = TRUE;
}

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

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

415
  return $form;
Dries's avatar
 
Dries committed
416 417
}

418
/**
419 420
 * Builds the common elements of the book form for the node and outline forms.
 *
421
 * @param \Drupal\Core\Entity\EntityInterface $node
422
 *   The node whose form is being viewed.
423
 */
424
function _book_add_form_elements(&$form, &$form_state, EntityInterface $node) {
425
  // If the form is being processed during the Ajax callback of our book bid
426 427 428 429
  // 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
430 431

  $form['book'] = array(
432
    '#type' => 'details',
Dries's avatar
Dries committed
433 434 435
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsed' => TRUE,
436
    '#group' => 'advanced',
437
    '#attributes' => array(
438
      'class' => array('book-outline-form'),
439
    ),
440
    '#attached' => array(
441
      'library' => array(array('book', 'drupal.book')),
442
    ),
Dries's avatar
Dries committed
443
    '#tree' => TRUE,
444
  );
445
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
446 447 448 449 450 451 452 453
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

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

454
  // @see _book_admin_table_tree(). The weight may be larger than 15.
Dries's avatar
Dries committed
455
  $form['book']['weight'] = array(
456
    '#type' => 'weight',
457
    '#title' => t('Weight'),
Dries's avatar
Dries committed
458
    '#default_value' => $node->book['weight'],
459
    '#delta' => max(15, abs($node->book['weight'])),
Dries's avatar
Dries committed
460
    '#weight' => 5,
461 462
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
463 464
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
465

466
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
467
    // This is the top level node in a maximum depth book and thus cannot be moved.
468
    $options[$node->nid] = $node->label();
469 470 471 472 473 474 475
  }
  else {
    foreach (book_get_books() as $book) {
      $options[$book['nid']] = $book['title'];
    }
  }

Dries's avatar
Dries committed
476 477
  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.
478
    $options = array($nid => t('- Create a new book -')) + $options;
Dries's avatar
Dries committed
479 480
  }
  if (!$node->book['mlid']) {
481
    // The node is not currently in the hierarchy.
482
    $options = array(0 => t('- None -')) + $options;
Dries's avatar
Dries committed
483 484 485 486 487 488 489 490
  }

  // 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,
491
    '#access' => (bool) $options,
Dries's avatar
Dries committed
492 493
    '#description' => t('Your page will be a part of the selected book.'),
    '#weight' => -5,
494
    '#attributes' => array('class' => array('book-title-select')),
495
    '#ajax' => array(
496
      'callback' => 'book_form_update',
497
      'wrapper' => 'edit-book-plid-wrapper',
498 499
      'effect' => 'fade',
      'speed' => 'fast',
500
    ),
501
  );
Dries's avatar
Dries committed
502
}
Dries's avatar
 
Dries committed
503

504 505 506
/**
 * Renders a new parent page select element when the book selection changes.
 *
507
 * This function is called via Ajax when the selected book is changed on a node
508 509 510 511 512 513 514 515 516
 * or book outline form.
 *
 * @return
 *   The rendered parent page select element.
 */
function book_form_update($form, $form_state) {
  return $form['book']['plid'];
}

517
/**
518 519 520 521 522
 * 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
523
 *
524
 * @param \Drupal\Core\Entity\EntityInterface $node
525 526 527 528
 *   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
529
 */
530
function _book_update_outline(EntityInterface $node) {
Dries's avatar
Dries committed
531 532 533 534 535
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

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

559 560
  $node->book = entity_create('menu_link', $node->book);
  if ($node->book->save()) {
Dries's avatar
Dries committed
561 562
    if ($new) {
      // Insert new.
563 564 565 566 567 568 569
      db_insert('book')
        ->fields(array(
          'nid' => $node->nid,
          'mlid' => $node->book['mlid'],
          'bid' => $node->book['bid'],
        ))
        ->execute();
570 571
      // Reset the cache of stored books.
      drupal_static_reset('book_get_books');
Dries's avatar
Dries committed
572 573
    }
    else {
574 575 576
      if ($node->book['bid'] != db_query("SELECT bid FROM {book} WHERE nid = :nid", array(
          ':nid' => $node->nid,
        ))->fetchField()) {
Dries's avatar
Dries committed
577 578
        // Update the bid for this page and all children.
        book_update_bid($node->book);
579 580
        // Reset the cache of stored books.
        drupal_static_reset('book_get_books');
Dries's avatar
Dries committed
581 582
      }
    }
583

Dries's avatar
Dries committed
584 585
    return TRUE;
  }
586 587

  // Failed to save the menu link.
Dries's avatar
Dries committed
588 589 590
  return FALSE;
}

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

Dries's avatar
Dries committed
605
  if ($mlids) {
606
    db_update('book')
607
      ->fields(array('bid' => $book_link['bid']))
608 609
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
610 611 612 613
  }
}

/**
614
 * Gets the book menu tree for a page and returns it as a linear array.
615
 *
Dries's avatar
Dries committed
616 617
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
618
 *
619
 * @return
Dries's avatar
Dries committed
620 621
 *   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
622 623 624
 *   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.
625
 */
Dries's avatar
Dries committed
626
function book_get_flat_menu($book_link) {
627
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
628 629

  if (!isset($flat[$book_link['mlid']])) {
630
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
631
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
Dries's avatar
Dries committed
632 633
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
 
Dries committed
634
  }
635

Dries's avatar
Dries committed
636
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
637 638
}

639
/**
640 641 642 643 644
 * Recursively converts a tree of menu links to a flat array.
 *
 * @param $tree
 *   A tree of menu links in an array.
 * @param $flat
645
 *   A flat array of the menu links from $tree, passed by reference.
646 647
 *
 * @see book_get_flat_menu().
648
 */
Dries's avatar
Dries committed
649 650 651 652 653 654 655 656
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
657
  }
Dries's avatar
Dries committed
658
}
Dries's avatar
 
Dries committed
659

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

Dries's avatar
Dries committed
694 695 696 697 698
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
699 700 701
  }
}

702
/**
Dries's avatar
Dries committed
703
 * Fetches the menu link for the next page of the book.
704 705 706 707 708 709 710
 *
 * @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.
711
 */
Dries's avatar
Dries committed
712 713 714 715 716
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);
717 718 719
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
720 721
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
722
  }
Dries's avatar
Dries committed
723
}
Dries's avatar
 
Dries committed
724

Dries's avatar
Dries committed
725
/**
726 727 728 729 730 731 732
 * 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
733 734 735
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
736

Dries's avatar
Dries committed
737 738 739 740 741 742
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
743 744
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
745 746 747 748 749
    // 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
750 751
    }
  }
752

753 754 755 756 757
  if ($children) {
    $elements = menu_tree_output($children);
    return drupal_render($elements);
  }
  return '';
Dries's avatar
 
Dries committed
758 759
}

760
/**
761 762 763 764 765 766 767
 * 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.
768
 */
Dries's avatar
Dries committed
769
function book_menu_name($bid) {
770
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
771 772
}

773
/**
774
 * Implements hook_node_load().
775
 */
776
function book_node_load($nodes, $types) {
777
  $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));
778 779 780 781 782
  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']);
783 784
  }
}
785

786
/**
787