book.module 47.8 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
9
use Drupal\node\Node;

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

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

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

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

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

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

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

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

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

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

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

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

250
/**
251
 * Implements hook_entity_info_alter().
252
 */
253
254
255
256
257
function book_entity_info_alter(&$info) {
  // Add the 'Print' view mode for nodes.
  $info['node']['view modes'] += array(
    'print' => array(
      'label' => t('Print'),
258
      'custom settings' => FALSE,
259
260
    ),
  );
261
262
}

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

  return $block;
}

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

287
  if (config('book.settings')->get('block.navigation.mode') == 'all pages') {
288
289
290
291
292
293
294
295
    $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
296
      }
297
298
299
300
      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;
301
302
303
        // Check whether user can access the book link.
        $book_node = node_load($book['nid']);
        $book['access'] = node_access('view', $book_node);
304
305
        $pseudo_tree[0]['link'] = $book;
        $book_menus[$book_id] = menu_tree_output($pseudo_tree);
Dries's avatar
Dries committed
306
      }
307
    }
308
309
310
    if ($block['content'] = $book_menus) {
      $book_menus['#theme'] = 'book_all_books_block';
    }
311
312
313
  }
  elseif ($current_bid) {
    // Only display this block when the user is browsing a book.
314
315
  $select = db_select('node', 'n')
    ->fields('n', array('title'))
316
    ->condition('n.nid', $node->book['bid'])
317
    ->addTag('node_access');
318
319
320
321
322
323
    $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);
324
      $block['subject'] = theme('book_title_link', array('link' => $data['link']));
325
326
327
      $block['content'] = ($data['below']) ? menu_tree_output($data['below']) : '';
    }
  }
328

329
330
  return $block;
}
331

332
/**
333
 * Implements hook_block_configure().
334
335
336
337
338
339
340
341
342
343
344
 */
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,
345
    '#default_value' => config('book.settings')->get('block.navigation.mode'),
346
347
    '#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."),
    );
348

349
350
  return $form;
}
351

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

360
/**
361
362
363
364
365
 * Returns HTML for a link to a book title when used as a block title.
 *
 * @param $variables
 *   An associative array containing:
 *   - link: An array containing title, href and options for the link.
Dries's avatar
Dries committed
366
367
 *
 * @ingroup themeable
368
 */
369
370
371
function theme_book_title_link($variables) {
  $link = $variables['link'];

372
  $link['options']['attributes']['class'] = array('book-title');
373

Dries's avatar
Dries committed
374
  return l($link['title'], $link['href'], $link['options']);
Dries's avatar
   
Dries committed
375
}
Dries's avatar
   
Dries committed
376

377
/**
Dries's avatar
Dries committed
378
379
380
381
 * 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.
382
383
384
 *
 * @return
 *   An array of all books.
385
 */
Dries's avatar
Dries committed
386
function book_get_books() {
387
  $all_books = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
388
389
390

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

Dries's avatar
Dries committed
393
    if ($nids) {
394
      $query = db_select('book', 'b', array('fetch' => PDO::FETCH_ASSOC));
395
396
      $query->join('node', 'n', 'b.nid = n.nid');
      $query->join('menu_links', 'ml', 'b.mlid = ml.mlid');
397
398
399
      $query->addField('n', 'type', 'type');
      $query->addField('n', 'title', 'title');
      $query->fields('b');
400
      $query->fields('ml');
401
402
403
404
405
406
407
      $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
408
409
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
410
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
411
412
      }
    }
413
  }
414

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

Dries's avatar
Dries committed
418
/**
419
 * Implements hook_form_BASE_FORM_ID_alter() for node_form().
420
421
 *
 * Adds the book fieldset to the node form.
422
423
 *
 * @see book_pick_book_nojs_submit()
Dries's avatar
Dries committed
424
 */
425
function book_form_node_form_alter(&$form, &$form_state, $form_id) {
426
  $node = $form_state['controller']->getEntity($form_state);
427
428
429
430
431
  $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
432
    }
433
  }
Dries's avatar
Dries committed
434

435
436
437
  if ($access) {
    _book_add_form_elements($form, $form_state, $node);
    // Since the "Book" dropdown can't trigger a form submission when
438
    // JavaScript is disabled, add a submit button to do that. book.admin.css hides
439
440
441
442
443
444
    // 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,
445
446
447
      '#attached' => array(
        'css' => array(drupal_get_path('module', 'book') . '/book.admin.css'),
      ),
448
    );
449
  }
Dries's avatar
Dries committed
450
}
451

452
/**
453
 * Form submission handler for node_form().
454
455
456
457
458
 *
 * 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
459
 * book_form_update() Ajax callback instead.
460
461
 *
 * @see book_form_update()
462
 * @see book_form_node_form_alter()
463
464
 */
function book_pick_book_nojs_submit($form, &$form_state) {
465
466
  $node = $form_state['controller']->getEntity($form_state);
  $node->book = $form_state['values']['book'];
467
468
469
  $form_state['rebuild'] = TRUE;
}

Dries's avatar
Dries committed
470
/**
471
 * Builds the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
472
473
 *
 * This function is also called when generating a new set of options during the
474
475
476
477
478
479
480
481
 * 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
482
483
 */
function _book_parent_select($book_link) {
484
485
486
  if (variable_get('menu_override_parent_selector', FALSE)) {
    return array();
  }
Dries's avatar
Dries committed
487
488
489
490
491
492
493
  // 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>',
  );
494

Dries's avatar
Dries committed
495
496
497
  if ($book_link['nid'] === $book_link['bid']) {
    // This is a book - at the top level.
    if ($book_link['original_bid'] === $book_link['bid']) {
498
      $form['#prefix'] .= '<em>' . t('This is the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
499
500
    }
    else {
501
      $form['#prefix'] .= '<em>' . t('This will be the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
502
503
504
    }
  }
  elseif (!$book_link['bid']) {
505
    $form['#prefix'] .= '<em>' . t('No book selected.') . '</em>';
506
507
  }
  else {
Dries's avatar
Dries committed
508
509
510
511
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
512
      '#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)),
513
      '#options' => book_toc($book_link['bid'], $book_link['parent_depth_limit'], array($book_link['mlid'])),
514
      '#attributes' => array('class' => array('book-title-select')),
515
516
      '#prefix' => '<div id="edit-book-plid-wrapper">',
      '#suffix' => '</div>',
517
    );
Dries's avatar
   
Dries committed
518
  }
519

520
  return $form;
Dries's avatar
   
Dries committed
521
522
}

523
/**
524
525
 * Builds the common elements of the book form for the node and outline forms.
 *
526
 * @param Drupal\node\Node $node
527
 *   The node whose form is being viewed.
528
 */
529
function _book_add_form_elements(&$form, &$form_state, Node $node) {
530
  // If the form is being processed during the Ajax callback of our book bid
531
532
533
534
  // 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
535
536
537
538
539
540
541

  $form['book'] = array(
    '#type' => 'fieldset',
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
542
    '#group' => 'additional_settings',
543
    '#attributes' => array(
544
      'class' => array('book-outline-form'),
545
    ),
546
    '#attached' => array(
547
      'library' => array(array('book', 'drupal.book')),
548
    ),
Dries's avatar
Dries committed
549
    '#tree' => TRUE,
550
  );
551
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
552
553
554
555
556
557
558
559
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

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

560
  // @see _book_admin_table_tree(). The weight may be larger than 15.
Dries's avatar
Dries committed
561
  $form['book']['weight'] = array(
562
    '#type' => 'weight',
563
    '#title' => t('Weight'),
Dries's avatar
Dries committed
564
    '#default_value' => $node->book['weight'],
565
    '#delta' => max(15, abs($node->book['weight'])),
Dries's avatar
Dries committed
566
    '#weight' => 5,
567
568
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
569
570
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
571

572
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
573
    // This is the top level node in a maximum depth book and thus cannot be moved.
574
    $options[$node->nid] = $node->label();
575
576
577
578
579
580
581
  }
  else {
    foreach (book_get_books() as $book) {
      $options[$book['nid']] = $book['title'];
    }
  }

Dries's avatar
Dries committed
582
583
  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.
584
    $options = array($nid => '<' . t('create a new book') . '>') + $options;
Dries's avatar
Dries committed
585
586
  }
  if (!$node->book['mlid']) {
587
    // The node is not currently in the hierarchy.
588
    $options = array(0 => '<' . t('none') . '>') + $options;
Dries's avatar
Dries committed
589
590
591
592
593
594
595
596
  }

  // 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,
597
    '#access' => (bool) $options,
Dries's avatar
Dries committed
598
599
    '#description' => t('Your page will be a part of the selected book.'),
    '#weight' => -5,
600
    '#attributes' => array('class' => array('book-title-select')),
601
    '#ajax' => array(
602
      'callback' => 'book_form_update',
603
      'wrapper' => 'edit-book-plid-wrapper',
604
605
      'effect' => 'fade',
      'speed' => 'fast',
606
    ),
607
  );
Dries's avatar
Dries committed
608
}
Dries's avatar
   
Dries committed
609

610
611
612
/**
 * Renders a new parent page select element when the book selection changes.
 *
613
 * This function is called via Ajax when the selected book is changed on a node
614
615
616
617
618
619
620
621
622
 * or book outline form.
 *
 * @return
 *   The rendered parent page select element.
 */
function book_form_update($form, $form_state) {
  return $form['book']['plid'];
}

623
/**
624
625
626
627
628
 * 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
629
 *
630
 * @param Drupal\node\Node $node
631
632
633
634
 *   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
635
 */
636
function _book_update_outline(Node $node) {
Dries's avatar
Dries committed
637
638
639
640
641
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

642
  $node->book['link_path'] = 'node/' . $node->nid;
643
  $node->book['link_title'] = $node->label();
Dries's avatar
Dries committed
644
645
646
647
648
649
650
651
652
  $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'])) {
653
654
655
      $parent = db_query("SELECT * FROM {book} WHERE mlid = :mlid", array(
        ':mlid' => $node->book['plid'],
      ))->fetchAssoc();
Dries's avatar
Dries committed
656
657
    }
    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {
658
659
660
      $node->book['plid'] = db_query("SELECT mlid FROM {book} WHERE nid = :nid", array(
        ':nid' => $node->book['bid'],
      ))->fetchField();
Dries's avatar
Dries committed
661
662
663
      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.
    }
  }
664

Dries's avatar
Dries committed
665
666
667
  if (menu_link_save($node->book)) {
    if ($new) {
      // Insert new.
668
669
670
671
672
673
674
      db_insert('book')
        ->fields(array(
          'nid' => $node->nid,
          'mlid' => $node->book['mlid'],
          'bid' => $node->book['bid'],
        ))
        ->execute();
675
676
      // Reset the cache of stored books.
      drupal_static_reset('book_get_books');
Dries's avatar
Dries committed
677
678
    }
    else {
679
680
681
      if ($node->book['bid'] != db_query("SELECT bid FROM {book} WHERE nid = :nid", array(
          ':nid' => $node->nid,
        ))->fetchField()) {
Dries's avatar
Dries committed
682
683
        // Update the bid for this page and all children.
        book_update_bid($node->book);
684
685
        // Reset the cache of stored books.
        drupal_static_reset('book_get_books');
Dries's avatar
Dries committed
686
687
      }
    }
688

Dries's avatar
Dries committed
689
690
    return TRUE;
  }
691
692

  // Failed to save the menu link.
Dries's avatar
Dries committed
693
694
695
  return FALSE;
}

696
/**
697
 * Updates the book ID of a page and its children when it moves to a new book.
698
 *
Dries's avatar
Dries committed
699
700
701
702
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 */
function book_update_bid($book_link) {
703
704
  $query = db_select('menu_links');
  $query->addField('menu_links', 'mlid');
Dries's avatar
Dries committed
705
  for ($i = 1; $i <= MENU_MAX_DEPTH && $book_link["p$i"]; $i++) {
706
    $query->condition("p$i", $book_link["p$i"]);
Dries's avatar
Dries committed
707
  }
708
  $mlids = $query->execute()->fetchCol();
709

Dries's avatar
Dries committed
710
  if ($mlids) {
711
    db_update('book')
712
      ->fields(array('bid' => $book_link['bid']))
713
714
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
715
716
717
718
  }
}

/**
719
 * Gets the book menu tree for a page and returns it as a linear array.
720
 *
Dries's avatar
Dries committed
721
722
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
723
 *
724
 * @return
Dries's avatar
Dries committed
725
726
 *   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
727
728
729
 *   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.
730
 */
Dries's avatar
Dries committed
731
function book_get_flat_menu($book_link) {
732
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
733
734

  if (!isset($flat[$book_link['mlid']])) {
735
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
736
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
Dries's avatar
Dries committed
737
738
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
   
Dries committed
739
  }
740

Dries's avatar
Dries committed
741
  return $flat[$book_link['mlid']];
Dries's avatar
   
Dries committed
742
743
}

744
/**
745
746
747
748
749
750
751
752
 * 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().
753
 */
Dries's avatar
Dries committed
754
755
756
757
758
759
760
761
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
762
  }
Dries's avatar
Dries committed
763
}
Dries's avatar
   
Dries committed
764

Dries's avatar
Dries committed
765
766
/**
 * Fetches the menu link for the previous page of the book.
767
768
769
770
771
772
773
 *
 * @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
774
775
776
777
778
 */
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
779
  }
Dries's avatar
Dries committed
780
781
782
783
784
785
786
787
788
789
790
791
  $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.
792
793
      $tree = book_menu_subtree_data($prev);
      $data = array_shift($tree);
Dries's avatar
Dries committed
794
795
796
797
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
798

Dries's avatar
Dries committed
799
800
801
802
803
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
   
Dries committed
804
805
806
  }
}

807
/**
Dries's avatar
Dries committed
808
 * Fetches the menu link for the next page of the book.
809
810
811
812
813
814
815
 *
 * @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.
816
 */
Dries's avatar
Dries committed
817
818
819
820
821
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);
822
823
824
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
825
826
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
   
Dries committed
827
  }
Dries's avatar
Dries committed
828
}
Dries's avatar
   
Dries committed
829

Dries's avatar
Dries committed
830
/**
831
832
833
834
835
836
837
 * 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
838
839
840
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
841

Dries's avatar
Dries committed
842
843
844
845
846
847
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
848
849
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
850
851
852
853
854
    // 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
855
856
    }
  }
857

858
859
860
861
862
  if ($children) {
    $elements = menu_tree_output($children);
    return drupal_render($elements);
  }
  return '';
Dries's avatar
   
Dries committed
863
864
}

865
/**
866
867
868
869
870
871
872
 * 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.
873
 */
Dries's avatar
Dries committed
874
function book_menu_name($bid) {
875
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
876
877
}

878
/**
879
 * Implements hook_node_load().
880
 */
881
function book_node_load($nodes, $types) {
882
  $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));
883
884
885
886
887
  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']);
888
889
  }
}
890

891
/**
892
 * Implements hook_node_view().
893
 */
894
function book_node_view(Node $node, $view_mode) {
895
  if ($view_mode == 'full') {
896
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
897
      $node->content['book_navigation'] = array(
898
        '#markup' => theme('book_navigation', array('book_link' => $node->book)),
899
900
901
902
        '#weight' => 100,
      );
    }
  }
Dries's avatar
Dries committed
903

904
905
  if ($view_mode != 'rss') {
    book_node_view_link($node, $view_mode);
906
  }
907
908
909
}

/**
910
 * Implements hook_page_alter().
911
 *
912
 * Adds the book menu to the list of menus used to build the active trail when
913
914
915
916
917
918
919
920
 * viewing a book page.
 */
function book_page_alter(&$page) {
  if (($node = menu_get_object()) && !empty($node->book['bid'])) {
    $active_menus = menu_get_active_menu_names();
    $active_menus[] = $node->book['menu_name'];
    menu_set_active_menu_names($active_menus);
  }
921
}
922

923
/**
924
 * Implements hook_node_presave().
925
 */
926
function book_node_presave(Node $node) {
927
928
929
930
931
932
933
934
935
  // Always save a revision for non-administrators.
  if (!empty($node->book