book.module 44.1 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
  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.
230
231
232
 *
 * @param Drupal\node\Node $node
 *   The node to remove from the outline.
233
234
235
 */
function _book_node_is_removable($node) {
  return (!empty($node->book['bid']) && (($node->book['bid'] != $node->nid) || !$node->book['has_children']));
236
237
}

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

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

262
/**
Dries's avatar
Dries committed
263
264
265
266
 * 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.
267
268
269
 *
 * @return
 *   An array of all books.
270
 */
Dries's avatar
Dries committed
271
function book_get_books() {
272
  $all_books = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
273
274
275

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

Dries's avatar
Dries committed
278
    if ($nids) {
279
      $query = db_select('book', 'b', array('fetch' => PDO::FETCH_ASSOC));
280
281
      $query->join('node', 'n', 'b.nid = n.nid');
      $query->join('menu_links', 'ml', 'b.mlid = ml.mlid');
282
283
284
      $query->addField('n', 'type', 'type');
      $query->addField('n', 'title', 'title');
      $query->fields('b');
285
      $query->fields('ml');
286
287
288
289
290
291
292
      $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
293
294
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
295
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
296
297
      }
    }
298
  }
299

Dries's avatar
Dries committed
300
  return $all_books;
301
}
302

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

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

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

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

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

405
  return $form;
Dries's avatar
   
Dries committed
406
407
}

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

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

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

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

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

Dries's avatar
Dries committed
467
468
  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.
469
    $options = array($nid => '<' . t('create a new book') . '>') + $options;
Dries's avatar
Dries committed
470
471
  }
  if (!$node->book['mlid']) {
472
    // The node is not currently in the hierarchy.
473
    $options = array(0 => '<' . t('none') . '>') + $options;
Dries's avatar
Dries committed
474
475
476
477
478
479
480
481
  }

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

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

508
/**
509
510
511
512
513
 * 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
514
 *
515
 * @param Drupal\node\Node $node
516
517
518
519
 *   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
520
 */
521
function _book_update_outline(Node $node) {
Dries's avatar
Dries committed
522
523
524
525
526
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

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

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

Dries's avatar
Dries committed
574
575
    return TRUE;
  }
576
577

  // Failed to save the menu link.
Dries's avatar
Dries committed
578
579
580
  return FALSE;
}

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

Dries's avatar
Dries committed
595
  if ($mlids) {
596
    db_update('book')
597
      ->fields(array('bid' => $book_link['bid']))
598
599
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
600
601
602
603
  }
}

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

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

Dries's avatar
Dries committed
626
  return $flat[$book_link['mlid']];
Dries's avatar
   
Dries committed
627
628
}

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

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

Dries's avatar
Dries committed
684
685
686
687
688
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
   
Dries committed
689
690
691
  }
}

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

Dries's avatar
Dries committed
710
711
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
   
Dries committed
712
  }
Dries's avatar
Dries committed
713
}
Dries's avatar
   
Dries committed
714

Dries's avatar
Dries committed
715
/**
716
717
718
719
720
721
722
 * 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
723
724
725
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
726

Dries's avatar
Dries committed
727
728
729
730
731
732
  $children = array();

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

743
744
745
746
747
  if ($children) {
    $elements = menu_tree_output($children);
    return drupal_render($elements);
  }
  return '';
Dries's avatar
   
Dries committed
748
749
}

750
/**
751
752
753
754
755
756
757
 * 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.
758
 */
Dries's avatar
Dries committed
759
function book_menu_name($bid) {
760
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
761
762
}

763
/**
764
 * Implements hook_node_load().
765
 */
766
function book_node_load($nodes, $types) {
767
  $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));
768
769
770
771
772
  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']);
773
774
  }
}
775

776
/**
777
 * Implements hook_node_view().
778
 */
779
function book_node_view(Node $node, $view_mode) {
780
  if ($view_mode == 'full') {
781
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
782
      $node->content['book_navigation'] = array(
783
        '#markup' => theme('book_navigation', array('book_link' => $node->book)),
784
785
786
787
        '#weight' => 100,
      );
    }
  }
Dries's avatar
Dries committed
788

789
790
  if ($view_mode != 'rss') {
    book_node_view_link($node, $view_mode);
791
  }
792
793
794
}

/**
795
 * Implements hook_page_alter().
796
 *
797
 * Adds the book menu to the list of menus used to build the active trail when
798
799
800
801
802
803
804
805
 * 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);
  }
806
}
807

808
/**
809
 * Implements hook_node_presave().
810
 */
811
function book_node_presave(Node $node) {
812
813
  // Always save a revision for non-administrators.
  if (!empty($node->book['bid']) && !user_access('administer nodes')) {
814
    $node->setNewRevision();
815
816
817
818
819
820
  }
  // Make sure a new node gets a new menu link.
  if (empty($node->nid)) {
    $node->book['mlid'] = NULL;
  }
}
821

822
/**
823
 * Implements hook_node_insert().
824
 */
825
function book_node_insert(Node $node) {
826
827
828
829
830
831
832
833
834
835
  if (!empty($node->book['bid'])) {
    if ($node->book['bid'] == 'new') {
      // New nodes that are their own book.
      $node->book['bid'] = $node->nid;
    }
    $node->book['nid'] = $node->nid;
    $node->book['menu_name'] = book_menu_name($node->book['bid']);
    _book_update_outline($node);
  }
}
836

837
/**
838
 * Implements hook_node_update().
839
 */
840
function book_node_update(Node $node) {
841
842
843
844
845
846
847
848
849
850
  if (!empty($node->book['bid'])) {
    if ($node->book['bid'] == 'new') {
      // New nodes that are their own book.
      $node->book['bid'] = $node->nid;
    }
    $node->book['nid'] = $node->nid;
    $node->book['menu_name'] = book_menu_name($node->book['bid']);
    _book_update_outline($node);
  }
}
851

852
/**
853
 * Implements hook_node_predelete().
854
 */
855
function book_node_predelete(Node $node) {
856
857
858
  if (!empty($node->book['bid'])) {
    if ($node->nid == $node->book['bid']) {
      // Handle deletion of a top-level post.
859
860
861
862
863
      $result = db_query("SELECT b.nid FROM {menu_links} ml INNER JOIN {book} b on b.mlid = ml.mlid WHERE ml.plid = :plid", array(
        ':plid' => $node->book['mlid']
      ));
      foreach ($result as $child) {
        $child_node = node_load($child->nid);
864
865
        $child_node->book['bid'] = $child_node->nid;
        _book_update_outline($child_node);
Dries's avatar
Dries committed
866
      }
867
868
    }
    menu_link_delete($node->book['mlid']);
869
870
871
    db_delete('book')
      ->condition('mlid', $node->book['mlid'])
      ->execute();
872
    drupal_static_reset('book_get_books');
873
874
875
876
  }
}

/**
877
 * Implements hook_node_prepare().
878
 */
879
function book_node_prepare(Node $node) {
880
881
882
883
884
885
886
887
888
889
890
891
  // Prepare defaults for the add/edit form.
  if (empty($node->book) && (user_access('add content to books') || user_access('administer book outlines'))) {
    $node->book = array();

    if (empty($node->nid) && isset($_GET['parent']) && is_numeric($_GET['parent'])) {
      // Handle "Add child page" links:
      $parent = book_link_load($_GET['parent']);

      if ($parent && $parent['access']) {
        $node->book['bid'] = $parent['bid'];
        $node->book['plid'] = $parent['mlid'];
        $node->book['menu_name'] = $parent['menu_name'];
892
      }
893
894
895
896
897
898
899
900
901
902
903
904
    }
    // Set defaults.
    $node->book += _book_link_defaults</