book.module 47.9 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\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_title_link' => array(
55
      'variables' => array('link' => NULL),
Dries's avatar
Dries committed
56 57
    ),
    'book_all_books_block' => array(
58
      'render element' => 'book_menus',
59 60 61
      'template' => 'book-all-books-block',
    ),
    'book_node_export_html' => array(
62
      'variables' => array('node' => NULL, 'children' => NULL),
63
      'template' => 'book-node-export-html',
Dries's avatar
Dries committed
64
    ),
65 66 67
  );
}

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

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

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

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

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

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

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

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

/**
217 218
 * Access callback: Determines if the user can remove nodes from the outline.
 *
219
 * @param Drupal\node\Node $node
220 221 222
 *   The node to remove from the outline.
 *
 * @see book_menu()
Dries's avatar
Dries committed
223
 */
224
function _book_outline_remove_access(Node $node) {
225 226 227 228 229 230 231 232 233 234 235
  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']));
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_alter().
253
 */
254 255 256 257 258
function book_entity_info_alter(&$info) {
  // Add the 'Print' view mode for nodes.
  $info['node']['view modes'] += array(
    'print' => array(
      'label' => t('Print'),
259
      'custom settings' => FALSE,
260 261
    ),
  );
262 263
}

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

  return $block;
}

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

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

330 331
  return $block;
}
332

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

350 351
  return $form;
}
352

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

361
/**
362 363 364 365 366
 * 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
367 368
 *
 * @ingroup themeable
369
 */
370 371 372
function theme_book_title_link($variables) {
  $link = $variables['link'];

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Dries's avatar
Dries committed
766 767
/**
 * Fetches the menu link for the previous page of the book.
768 769 770 771 772 773 774
 *
 * @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
775 776 777 778 779
 */
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
780
  }
Dries's avatar
Dries committed
781 782 783 784 785 786 787 788 789 790 791 792
  $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.
793 794
      $tree = book_menu_subtree_data($prev);
      $data = array_shift($tree);