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\node\NodeTypeInterface;
10
use Drupal\Core\Language\Language;
11
use Drupal\entity\Plugin\Core\Entity\EntityDisplay;
12
use Drupal\Core\Template\Attribute;
13 14
use Drupal\menu_link\Plugin\Core\Entity\MenuLink;
use Drupal\menu_link\MenuLinkStorageController;
15

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

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
/**
 * Implements hook_entity_bundle_info().
 */
function book_entity_bundle_info() {
  $bundles['menu_link']['book-toc'] = array(
    'label' => t('Book'),
    'translatable' => FALSE,
  );
  return $bundles;
}

/**
 * Implements hook_TYPE_load().
 */
function book_menu_link_load($entities) {
  foreach ($entities as $entity) {
    // Change the bundle of menu links related to a book.
    if (strpos($entity->menu_name, 'book-toc-') === 0) {
      $entity->bundle = 'book-toc';
    }
  }
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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