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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

783 784
  if ($view_mode != 'rss') {
    book_node_view_link($node, $view_mode);
785
  }
786 787 788
}

/**
789
 * Implements hook_page_alter().