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

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

8
use Drupal\node\Plugin\Core\Entity\Node;
9
use Drupal\Core\Template\Attribute;
10

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

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

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

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

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

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

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

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

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

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

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

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

248
/**
249
 * Implements hook_entity_info().
250
 */
251
function book_entity_info(&$info) {
252
  // Add the 'Print' view mode for nodes.
253
254
255
  $info['node']['view_modes']['print'] = array(
    'label' => t('Print'),
    'custom_settings' => FALSE,
256
  );
257
258
}

259
/**
260
 * Implements hook_block_info().
261
 */
262
function book_block_info() {
263
264
  $block = array();
  $block['navigation']['info'] = t('Book navigation');
265
  $block['navigation']['cache'] = DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE;
266
267
268
269
270

  return $block;
}

/**
271
 * Implements hook_block_view().
272
 *
Dries's avatar
   
Dries committed
273
274
 * Displays the book table of contents in a block when the current page is a
 * single-node view of a book node.
275
 */
276
function book_block_view($delta = '') {
Dries's avatar
   
Dries committed
277
  $block = array();
278
279
280
281
  $current_bid = 0;
  if ($node = menu_get_object()) {
    $current_bid = empty($node->book['bid']) ? 0 : $node->book['bid'];
  }
282

283
  if (config('book.settings')->get('block.navigation.mode') == 'all pages') {
284
285
286
287
288
289
290
291
    $block['subject'] = t('Book navigation');
    $book_menus = array();
    $pseudo_tree = array(0 => array('below' => FALSE));
    foreach (book_get_books() as $book_id => $book) {
      if ($book['bid'] == $current_bid) {
        // If the current page is a node associated with a book, the menu
        // needs to be retrieved.
        $book_menus[$book_id] = menu_tree_output(menu_tree_all_data($node->book['menu_name'], $node->book));
Dries's avatar
   
Dries committed
292
      }
293
294
295
296
      else {
        // Since we know we will only display a link to the top node, there
        // is no reason to run an additional menu tree query for each book.
        $book['in_active_trail'] = FALSE;
297
298
299
        // Check whether user can access the book link.
        $book_node = node_load($book['nid']);
        $book['access'] = node_access('view', $book_node);
300
301
        $pseudo_tree[0]['link'] = $book;
        $book_menus[$book_id] = menu_tree_output($pseudo_tree);
Dries's avatar
Dries committed
302
      }
303
    }
304
305
306
    if ($block['content'] = $book_menus) {
      $book_menus['#theme'] = 'book_all_books_block';
    }
307
308
309
  }
  elseif ($current_bid) {
    // Only display this block when the user is browsing a book.
310
311
  $select = db_select('node', 'n')
    ->fields('n', array('title'))
312
    ->condition('n.nid', $node->book['bid'])
313
    ->addTag('node_access');
314
315
316
317
318
319
    $title = $select->execute()->fetchField();
    // Only show the block if the user has view access for the top-level node.
    if ($title) {
      $tree = menu_tree_all_data($node->book['menu_name'], $node->book);
      // There should only be one element at the top level.
      $data = array_shift($tree);
320
      $block['subject'] = l($data['link']['title'], $data['link']['href'], $data['link']['options']);
321
322
323
      $block['content'] = ($data['below']) ? menu_tree_output($data['below']) : '';
    }
  }
324

325
326
  return $block;
}
327

328
/**
329
 * Implements hook_block_configure().
330
331
332
333
334
335
336
337
338
339
340
 */
function book_block_configure($delta = '') {
  $block = array();
  $options = array(
    'all pages' => t('Show block on all pages'),
    'book pages' => t('Show block only on book pages'),
  );
  $form['book_block_mode'] = array(
    '#type' => 'radios',
    '#title' => t('Book navigation block display'),
    '#options' => $options,
341
    '#default_value' => config('book.settings')->get('block.navigation.mode'),
342
343
    '#description' => t("If <em>Show block on all pages</em> is selected, the block will contain the automatically generated menus for all of the site's books. If <em>Show block only on book pages</em> is selected, the block will contain only the one menu corresponding to the current page's book. In this case, if the current page is not in a book, no block will be displayed. The <em>Page specific visibility settings</em> or other visibility settings can be used in addition to selectively display this block."),
    );
344

345
346
  return $form;
}
347

348
/**
349
 * Implements hook_block_save().
350
351
352
 */
function book_block_save($delta = '', $edit = array()) {
  $block = array();
353
  config('book.settings')->set('block.navigation.mode', $edit['book_block_mode'])->save();
Dries's avatar
Dries committed
354
}
Dries's avatar
   
Dries committed
355

356
/**
Dries's avatar
Dries committed
357
358
359
360
 * Returns an array of all books.
 *
 * This list may be used for generating a list of all the books, or for building
 * the options for a form select.
361
362
363
 *
 * @return
 *   An array of all books.
364
 */
Dries's avatar
Dries committed
365
function book_get_books() {
366
  $all_books = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
367
368
369

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

Dries's avatar
Dries committed
372
    if ($nids) {
373
      $query = db_select('book', 'b', array('fetch' => PDO::FETCH_ASSOC));
374
375
      $query->join('node', 'n', 'b.nid = n.nid');
      $query->join('menu_links', 'ml', 'b.mlid = ml.mlid');
376
377
378
      $query->addField('n', 'type', 'type');
      $query->addField('n', 'title', 'title');
      $query->fields('b');
379
      $query->fields('ml');
380
381
382
383
384
385
386
      $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
387
388
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
389
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
390
391
      }
    }
392
  }
393

Dries's avatar
Dries committed
394
  return $all_books;
395
}
396

Dries's avatar
Dries committed
397
/**
398
 * Implements hook_form_BASE_FORM_ID_alter() for node_form().
399
 *
400
 * Adds the book form element to the node form.
401
402
 *
 * @see book_pick_book_nojs_submit()
Dries's avatar
Dries committed
403
 */
404
function book_form_node_form_alter(&$form, &$form_state, $form_id) {
405
  $node = $form_state['controller']->getEntity($form_state);
406
407
408
409
410
  $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
411
    }
412
  }
Dries's avatar
Dries committed
413

414
415
416
  if ($access) {
    _book_add_form_elements($form, $form_state, $node);
    // Since the "Book" dropdown can't trigger a form submission when
417
    // JavaScript is disabled, add a submit button to do that. book.admin.css hides
418
419
420
421
422
423
    // 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,
424
425
426
      '#attached' => array(
        'css' => array(drupal_get_path('module', 'book') . '/book.admin.css'),
      ),
427
    );
428
  }
Dries's avatar
Dries committed
429
}
430

431
/**
432
 * Form submission handler for node_form().
433
434
435
436
437
 *
 * 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
438
 * book_form_update() Ajax callback instead.
439
440
 *
 * @see book_form_update()
441
 * @see book_form_node_form_alter()
442
443
 */
function book_pick_book_nojs_submit($form, &$form_state) {
444
445
  $node = $form_state['controller']->getEntity($form_state);
  $node->book = $form_state['values']['book'];
446
447
448
  $form_state['rebuild'] = TRUE;
}

Dries's avatar
Dries committed
449
/**
450
 * Builds the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
451
452
 *
 * This function is also called when generating a new set of options during the
453
454
455
456
457
458
459
460
 * 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
461
462
 */
function _book_parent_select($book_link) {
463
464
465
  if (variable_get('menu_override_parent_selector', FALSE)) {
    return array();
  }
Dries's avatar
Dries committed
466
467
468
469
470
471
472
  // 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>',
  );
473

Dries's avatar
Dries committed
474
475
476
  if ($book_link['nid'] === $book_link['bid']) {
    // This is a book - at the top level.
    if ($book_link['original_bid'] === $book_link['bid']) {
477
      $form['#prefix'] .= '<em>' . t('This is the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
478
479
    }
    else {
480
      $form['#prefix'] .= '<em>' . t('This will be the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
481
482
483
    }
  }
  elseif (!$book_link['bid']) {
484
    $form['#prefix'] .= '<em>' . t('No book selected.') . '</em>';
485
486
  }
  else {
Dries's avatar
Dries committed
487
488
489
490
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
491
      '#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)),
492
      '#options' => book_toc($book_link['bid'], $book_link['parent_depth_limit'], array($book_link['mlid'])),
493
      '#attributes' => array('class' => array('book-title-select')),
494
495
      '#prefix' => '<div id="edit-book-plid-wrapper">',
      '#suffix' => '</div>',
496
    );
Dries's avatar
   
Dries committed
497
  }
498

499
  return $form;
Dries's avatar
   
Dries committed
500
501
}

502
/**
503
504
 * Builds the common elements of the book form for the node and outline forms.
 *
505
 * @param Drupal\node\Node $node
506
 *   The node whose form is being viewed.
507
 */
508
function _book_add_form_elements(&$form, &$form_state, Node $node) {
509
  // If the form is being processed during the Ajax callback of our book bid
510
511
512
513
  // 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
514
515

  $form['book'] = array(
516
    '#type' => 'details',
Dries's avatar
Dries committed
517
518
519
520
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
521
    '#group' => 'additional_settings',
522
    '#attributes' => array(
523
      'class' => array('book-outline-form'),
524
    ),
525
    '#attached' => array(
526
      'library' => array(array('book', 'drupal.book')),
527
    ),
Dries's avatar
Dries committed
528
    '#tree' => TRUE,
529
  );
530
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
531
532
533
534
535
536
537
538
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

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

539
  // @see _book_admin_table_tree(). The weight may be larger than 15.
Dries's avatar
Dries committed
540
  $form['book']['weight'] = array(
541
    '#type' => 'weight',
542
    '#title' => t('Weight'),
Dries's avatar
Dries committed
543
    '#default_value' => $node->book['weight'],
544
    '#delta' => max(15, abs($node->book['weight'])),
Dries's avatar
Dries committed
545
    '#weight' => 5,
546
547
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
548
549
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
550

551
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
552
    // This is the top level node in a maximum depth book and thus cannot be moved.
553
    $options[$node->nid] = $node->label();
554
555
556
557
558
559
560
  }
  else {
    foreach (book_get_books() as $book) {
      $options[$book['nid']] = $book['title'];
    }
  }

Dries's avatar
Dries committed
561
562
  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.
563
    $options = array($nid => '<' . t('create a new book') . '>') + $options;
Dries's avatar
Dries committed
564
565
  }
  if (!$node->book['mlid']) {
566
    // The node is not currently in the hierarchy.
567
    $options = array(0 => '<' . t('none') . '>') + $options;
Dries's avatar
Dries committed
568
569
570
571
572
573
574
575
  }

  // 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,
576
    '#access' => (bool) $options,
Dries's avatar
Dries committed
577
578
    '#description' => t('Your page will be a part of the selected book.'),
    '#weight' => -5,
579
    '#attributes' => array('class' => array('book-title-select')),
580
    '#ajax' => array(
581
      'callback' => 'book_form_update',
582
      'wrapper' => 'edit-book-plid-wrapper',
583
584
      'effect' => 'fade',
      'speed' => 'fast',
585
    ),
586
  );
Dries's avatar
Dries committed
587
}
Dries's avatar
   
Dries committed
588

589
590
591
/**
 * Renders a new parent page select element when the book selection changes.
 *
592
 * This function is called via Ajax when the selected book is changed on a node
593
594
595
596
597
598
599
600
601
 * or book outline form.
 *
 * @return
 *   The rendered parent page select element.
 */
function book_form_update($form, $form_state) {
  return $form['book']['plid'];
}

602
/**
603
604
605
606
607
 * 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
608
 *
609
 * @param Drupal\node\Node $node
610
611
612
613
 *   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
614
 */
615
function _book_update_outline(Node $node) {
Dries's avatar
Dries committed
616
617
618
619
620
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

621
  $node->book['link_path'] = 'node/' . $node->nid;
622
  $node->book['link_title'] = $node->label();
Dries's avatar
Dries committed
623
624
625
626
627
628
629
630
631
  $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'])) {
632
633
634
      $parent = db_query("SELECT * FROM {book} WHERE mlid = :mlid", array(
        ':mlid' => $node->book['plid'],
      ))->fetchAssoc();
Dries's avatar
Dries committed
635
636
    }
    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {
637
638
639
      $node->book['plid'] = db_query("SELECT mlid FROM {book} WHERE nid = :nid", array(
        ':nid' => $node->book['bid'],
      ))->fetchField();
Dries's avatar
Dries committed
640
641
642
      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.
    }
  }
643

Dries's avatar
Dries committed
644
645
646
  if (menu_link_save($node->book)) {
    if ($new) {
      // Insert new.
647
648
649
650
651
652
653
      db_insert('book')
        ->fields(array(
          'nid' => $node->nid,
          'mlid' => $node->book['mlid'],
          'bid' => $node->book['bid'],
        ))
        ->execute();
654
655
      // Reset the cache of stored books.
      drupal_static_reset('book_get_books');
Dries's avatar
Dries committed
656
657
    }
    else {
658
659
660
      if ($node->book['bid'] != db_query("SELECT bid FROM {book} WHERE nid = :nid", array(
          ':nid' => $node->nid,
        ))->fetchField()) {
Dries's avatar
Dries committed
661
662
        // Update the bid for this page and all children.
        book_update_bid($node->book);
663
664
        // Reset the cache of stored books.
        drupal_static_reset('book_get_books');
Dries's avatar
Dries committed
665
666
      }
    }
667

Dries's avatar
Dries committed
668
669
    return TRUE;
  }
670
671

  // Failed to save the menu link.
Dries's avatar
Dries committed
672
673
674
  return FALSE;
}

675
/**
676
 * Updates the book ID of a page and its children when it moves to a new book.
677
 *
Dries's avatar
Dries committed
678
679
680
681
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 */
function book_update_bid($book_link) {
682
683
  $query = db_select('menu_links');
  $query->addField('menu_links', 'mlid');
Dries's avatar
Dries committed
684
  for ($i = 1; $i <= MENU_MAX_DEPTH && $book_link["p$i"]; $i++) {
685
    $query->condition("p$i", $book_link["p$i"]);
Dries's avatar
Dries committed
686
  }
687
  $mlids = $query->execute()->fetchCol();
688

Dries's avatar
Dries committed
689
  if ($mlids) {
690
    db_update('book')
691
      ->fields(array('bid' => $book_link['bid']))
692
693
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
694
695
696
697
  }
}

/**
698
 * Gets the book menu tree for a page and returns it as a linear array.
699
 *
Dries's avatar
Dries committed
700
701
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
702
 *
703
 * @return
Dries's avatar
Dries committed
704
705
 *   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
706
707
708
 *   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.
709
 */
Dries's avatar
Dries committed
710
function book_get_flat_menu($book_link) {
711
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
712
713

  if (!isset($flat[$book_link['mlid']])) {
714
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
715
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
Dries's avatar
Dries committed
716
717
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
   
Dries committed
718
  }
719

Dries's avatar
Dries committed
720
  return $flat[$book_link['mlid']];
Dries's avatar
   
Dries committed
721
722
}

723
/**
724
725
726
727
728
729
730
731
 * Recursively converts a tree of menu links to a flat array.
 *
 * @param $tree
 *   A tree of menu links in an array.
 * @param $flat
 *   A flat array of the menu links from $tree.
 *
 * @see book_get_flat_menu().
732
 */
Dries's avatar
Dries committed
733
734
735
736
737
738
739
740
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
741
  }
Dries's avatar
Dries committed
742
}
Dries's avatar
   
Dries committed
743

Dries's avatar
Dries committed
744
745
/**
 * Fetches the menu link for the previous page of the book.
746
747
748
749
750
751
752
 *
 * @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
753
754
755
756
757
 */
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
758
  }
Dries's avatar
Dries committed
759
760
761
762
763
764
765
766
767
768
769
770
  $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.
771
772
      $tree = book_menu_subtree_data($prev);
      $data = array_shift($tree);
Dries's avatar
Dries committed
773
774
775
776
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
777

Dries's avatar
Dries committed
778
779
780
781
782
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
   
Dries committed
783
784
785
  }
}

786
/**
Dries's avatar
Dries committed
787
 * Fetches the menu link for the next page of the book.
788
789
790
791
792
793
794
 *
 * @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.
795
 */
Dries's avatar
Dries committed
796
797
798
799
800
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);
801
802
803
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
804
805
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
   
Dries committed
806
  }
Dries's avatar
Dries committed
807
}
Dries's avatar
   
Dries committed
808

Dries's avatar
Dries committed
809
/**
810
811
812
813
814
815
816
 * 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
817
818
819
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
820

Dries's avatar
Dries committed
821
822
823
824
825
826
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
827
828
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
829
830
831
832
833
    // 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
834
835
    }
  }
836

837
838
839
840
841
  if ($children) {
    $elements = menu_tree_output($children);
    return drupal_render($elements);
  }
  return '';
Dries's avatar
   
Dries committed
842
843
}

844
/**
845
846
847
848
849
850
851
 * 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.
852
 */
Dries's avatar
Dries committed
853
function book_menu_name($bid) {
854
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
855
856
}

857
/**
858
 * Implements hook_node_load().
859
 */
860
function book_node_load($nodes, $types) {
861
  $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));
862
863
864
865
866
  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']);
867
868
  }
}
869

870
/**
871
 * Implements hook_node_view().
872
 */
873
function book_node_view(Node $node, $view_mode) {
874
  if ($view_mode == 'full') {
875
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
876
      $node->content['book_navigation'] = array(
877
        '#markup' => theme('book_navigation', array('book_link' => $node->book)),
878
879
880
881
        '#weight' => 100,
      );
    }
  }
Dries's avatar
Dries committed
882

883
884
  if ($view_mode != 'rss') {
    book_node_view_link($node, $view_mode);
885
  }
886
887
888
}

/**
889
 * Implements hook_page_alter().
890
 *
891
 * Adds the book menu to the list of menus used to build the active trail when
webchick's avatar