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

35
/**
36
 * Implements hook_theme().
37 38 39 40
 */
function book_theme() {
  return array(
    'book_navigation' => array(
41
      'variables' => array('book_link' => NULL),
42
      'template' => 'book-navigation',
43 44
    ),
    'book_export_html' => array(
45
      'variables' => array('title' => NULL, 'contents' => NULL, 'depth' => NULL),
46
      'template' => 'book-export-html',
47 48
    ),
    'book_admin_table' => array(
49
      'render element' => 'form',
50
    ),
Dries's avatar
Dries committed
51
    'book_title_link' => array(
52
      'variables' => array('link' => NULL),
Dries's avatar
Dries committed
53 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 89 90 91 92
 * Adds relevant book links to the node's links.
 *
 * @param $node
 *   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, $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)) {
Dries's avatar
Dries committed
99 100
      $child_type = variable_get('book_child_type', 'book');
      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/' . str_replace('_', '-', $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 204 205 206 207
 * Access callback: Determines if the outline tab is accessible.
 *
 * Path:
 * - admin/content/book/%node
 * - node/%node/outline
 *
 * @param $node
 *   The node whose outline tab is to be viewed.
 *
 * @see book_menu()
Dries's avatar
Dries committed
208
 */
209
function _book_outline_access($node) {
Dries's avatar
Dries committed
210 211 212 213
  return user_access('administer book outlines') && node_access('view', $node);
}

/**
214 215 216 217 218 219 220 221
 * Access callback: Determines if the user can remove nodes from the outline.
 *
 * Path: node/%node/outline/remove
 *
 * @param $node
 *   The node to remove from the outline.
 *
 * @see book_menu()
Dries's avatar
Dries committed
222
 */
223
function _book_outline_remove_access($node) {
Dries's avatar
Dries committed
224
  return isset($node->book) && ($node->book['bid'] != $node->nid) && _book_outline_access($node);
225 226
}

227 228 229 230
/**
 * Implements hook_admin_paths().
 */
function book_admin_paths() {
231 232 233 234 235 236 237
  if (variable_get('node_admin_theme')) {
    $paths = array(
      'node/*/outline' => TRUE,
      'node/*/outline/remove' => TRUE,
    );
    return $paths;
  }
238 239
}

240
/**
241
 * Implements hook_entity_info_alter().
242
 */
243 244 245 246 247
function book_entity_info_alter(&$info) {
  // Add the 'Print' view mode for nodes.
  $info['node']['view modes'] += array(
    'print' => array(
      'label' => t('Print'),
248
      'custom settings' => FALSE,
249 250
    ),
  );
251 252
}

253
/**
254
 * Implements hook_block_info().
255
 */
256
function book_block_info() {
257 258
  $block = array();
  $block['navigation']['info'] = t('Book navigation');
259
  $block['navigation']['cache'] = DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE;
260 261 262 263 264

  return $block;
}

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

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

319 320
  return $block;
}
321

322
/**
323
 * Implements hook_block_configure().
324 325 326 327 328 329 330 331 332 333 334 335 336 337
 */
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,
    '#default_value' => variable_get('book_block_mode', 'all pages'),
    '#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."),
    );
338

339 340
  return $form;
}
341

342
/**
343
 * Implements hook_block_save().
344 345 346 347
 */
function book_block_save($delta = '', $edit = array()) {
  $block = array();
  variable_set('book_block_mode', $edit['book_block_mode']);
Dries's avatar
Dries committed
348
}
Dries's avatar
 
Dries committed
349

350
/**
351 352 353 354 355
 * 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
356 357
 *
 * @ingroup themeable
358
 */
359 360 361
function theme_book_title_link($variables) {
  $link = $variables['link'];

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

Dries's avatar
Dries committed
364
  return l($link['title'], $link['href'], $link['options']);
Dries's avatar
 
Dries committed
365
}
Dries's avatar
 
Dries committed
366

367
/**
Dries's avatar
Dries committed
368 369 370 371
 * 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.
372 373 374
 *
 * @return
 *   An array of all books.
375
 */
Dries's avatar
Dries committed
376
function book_get_books() {
377
  $all_books = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
378 379 380

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

Dries's avatar
Dries committed
383
    if ($nids) {
384
      $query = db_select('book', 'b', array('fetch' => PDO::FETCH_ASSOC));
385 386
      $query->join('node', 'n', 'b.nid = n.nid');
      $query->join('menu_links', 'ml', 'b.mlid = ml.mlid');
387 388 389
      $query->addField('n', 'type', 'type');
      $query->addField('n', 'title', 'title');
      $query->fields('b');
390
      $query->fields('ml');
391 392 393 394 395 396 397
      $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
398 399
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
400
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
401 402
      }
    }
403
  }
404

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

Dries's avatar
Dries committed
408
/**
409
 * Implements hook_form_BASE_FORM_ID_alter().
410 411
 *
 * Adds the book fieldset to the node form.
412 413
 *
 * @see book_pick_book_nojs_submit()
Dries's avatar
Dries committed
414
 */
415 416 417 418 419 420 421
function book_form_node_form_alter(&$form, &$form_state, $form_id) {
  $node = $form['#node'];
  $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
422
    }
423
  }
Dries's avatar
Dries committed
424

425 426 427
  if ($access) {
    _book_add_form_elements($form, $form_state, $node);
    // Since the "Book" dropdown can't trigger a form submission when
428
    // JavaScript is disabled, add a submit button to do that. book.admin.css hides
429 430 431 432 433 434
    // 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,
435 436 437
      '#attached' => array(
        'css' => array(drupal_get_path('module', 'book') . '/book.admin.css'),
      ),
438
    );
439
  }
Dries's avatar
Dries committed
440
}
441

442
/**
443
 * Form submission handler for node_form().
444 445 446 447 448
 *
 * 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
449
 * book_form_update() Ajax callback instead.
450 451
 *
 * @see book_form_update()
452
 * @see book_form_node_form_alter()
453 454 455 456 457 458
 */
function book_pick_book_nojs_submit($form, &$form_state) {
  $form_state['node']->book = $form_state['values']['book'];
  $form_state['rebuild'] = TRUE;
}

Dries's avatar
Dries committed
459
/**
460
 * Builds the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
461 462
 *
 * This function is also called when generating a new set of options during the
463 464 465 466 467 468 469 470
 * 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
471 472
 */
function _book_parent_select($book_link) {
473 474 475
  if (variable_get('menu_override_parent_selector', FALSE)) {
    return array();
  }
Dries's avatar
Dries committed
476 477 478 479 480 481 482
  // 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>',
  );
483

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

509
  return $form;
Dries's avatar
 
Dries committed
510 511
}

512
/**
513 514 515 516
 * Builds the common elements of the book form for the node and outline forms.
 *
 * @param $node
 *   The node whose form is being viewed.
517
 */
518
function _book_add_form_elements(&$form, &$form_state, $node) {
519
  // If the form is being processed during the Ajax callback of our book bid
520 521 522 523
  // 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
524 525 526 527 528 529 530

  $form['book'] = array(
    '#type' => 'fieldset',
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
531
    '#group' => 'additional_settings',
532 533 534
    '#attributes' => array(
      'class' => array('book-form'),
    ),
535 536 537
    '#attached' => array(
      'js' => array(drupal_get_path('module', 'book') . '/book.js'),
    ),
Dries's avatar
Dries committed
538
    '#tree' => TRUE,
539
    '#attributes' => array('class' => array('book-outline-form')),
540
  );
541
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
542 543 544 545 546 547 548 549
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

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

550
  // @see _book_admin_table_tree(). The weight may be larger than 15.
Dries's avatar
Dries committed
551
  $form['book']['weight'] = array(
552
    '#type' => 'weight',
553
    '#title' => t('Weight'),
Dries's avatar
Dries committed
554
    '#default_value' => $node->book['weight'],
555
    '#delta' => max(15, abs($node->book['weight'])),
Dries's avatar
Dries committed
556
    '#weight' => 5,
557 558
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
559 560
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
561

562
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
563
    // This is the top level node in a maximum depth book and thus cannot be moved.
564
    $options[$node->nid] = $node->title;
565 566 567 568 569 570 571
  }
  else {
    foreach (book_get_books() as $book) {
      $options[$book['nid']] = $book['title'];
    }
  }

Dries's avatar
Dries committed
572 573
  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.
574
    $options = array($nid => '<' . t('create a new book') . '>') + $options;
Dries's avatar
Dries committed
575 576
  }
  if (!$node->book['mlid']) {
577
    // The node is not currently in the hierarchy.
578
    $options = array(0 => '<' . t('none') . '>') + $options;
Dries's avatar
Dries committed
579 580 581 582 583 584 585 586
  }

  // 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,
587
    '#access' => (bool) $options,
Dries's avatar
Dries committed
588 589
    '#description' => t('Your page will be a part of the selected book.'),
    '#weight' => -5,
590
    '#attributes' => array('class' => array('book-title-select')),
591
    '#ajax' => array(
592
      'callback' => 'book_form_update',
593
      'wrapper' => 'edit-book-plid-wrapper',
594 595
      'effect' => 'fade',
      'speed' => 'fast',
596
    ),
597
  );
Dries's avatar
Dries committed
598
}
Dries's avatar
 
Dries committed
599

600 601 602
/**
 * Renders a new parent page select element when the book selection changes.
 *
603
 * This function is called via Ajax when the selected book is changed on a node
604 605 606 607 608 609 610 611 612
 * or book outline form.
 *
 * @return
 *   The rendered parent page select element.
 */
function book_form_update($form, $form_state) {
  return $form['book']['plid'];
}

613
/**
614 615 616 617 618
 * 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
619
 *
620 621 622 623 624
 * @param $node
 *   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
625
 */
626
function _book_update_outline($node) {
Dries's avatar
Dries committed
627 628 629 630 631
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

632
  $node->book['link_path'] = 'node/' . $node->nid;
633
  $node->book['link_title'] = $node->title;
Dries's avatar
Dries committed
634 635 636 637 638 639 640 641 642
  $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'])) {
643 644 645
      $parent = db_query("SELECT * FROM {book} WHERE mlid = :mlid", array(
        ':mlid' => $node->book['plid'],
      ))->fetchAssoc();
Dries's avatar
Dries committed
646 647
    }
    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {
648 649 650
      $node->book['plid'] = db_query("SELECT mlid FROM {book} WHERE nid = :nid", array(
        ':nid' => $node->book['bid'],
      ))->fetchField();
Dries's avatar
Dries committed
651 652 653
      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.
    }
  }
654

Dries's avatar
Dries committed
655 656 657
  if (menu_link_save($node->book)) {
    if ($new) {
      // Insert new.
658 659 660 661 662 663 664
      db_insert('book')
        ->fields(array(
          'nid' => $node->nid,
          'mlid' => $node->book['mlid'],
          'bid' => $node->book['bid'],
        ))
        ->execute();
665 666
      // Reset the cache of stored books.
      drupal_static_reset('book_get_books');
Dries's avatar
Dries committed
667 668
    }
    else {
669 670 671
      if ($node->book['bid'] != db_query("SELECT bid FROM {book} WHERE nid = :nid", array(
          ':nid' => $node->nid,
        ))->fetchField()) {
Dries's avatar
Dries committed
672 673
        // Update the bid for this page and all children.
        book_update_bid($node->book);
674 675
        // Reset the cache of stored books.
        drupal_static_reset('book_get_books');
Dries's avatar
Dries committed
676 677
      }
    }
678

Dries's avatar
Dries committed
679 680
    return TRUE;
  }
681 682

  // Failed to save the menu link.
Dries's avatar
Dries committed
683 684 685
  return FALSE;
}

686
/**
687
 * Updates the book ID of a page and its children when it moves to a new book.
688
 *
Dries's avatar
Dries committed
689 690 691 692
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 */
function book_update_bid($book_link) {
693 694
  $query = db_select('menu_links');
  $query->addField('menu_links', 'mlid');
Dries's avatar
Dries committed
695
  for ($i = 1; $i <= MENU_MAX_DEPTH && $book_link["p$i"]; $i++) {
696
    $query->condition("p$i", $book_link["p$i"]);
Dries's avatar
Dries committed
697
  }
698
  $mlids = $query->execute()->fetchCol();
699

Dries's avatar
Dries committed
700
  if ($mlids) {
701
    db_update('book')
702
      ->fields(array('bid' => $book_link['bid']))
703 704
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
705 706 707 708
  }
}

/**
709
 * Gets the book menu tree for a page and returns it as a linear array.
710
 *
Dries's avatar
Dries committed
711 712
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
713
 *
714
 * @return
Dries's avatar
Dries committed
715 716
 *   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
717 718 719
 *   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.
720
 */
Dries's avatar
Dries committed
721
function book_get_flat_menu($book_link) {
722
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
723 724

  if (!isset($flat[$book_link['mlid']])) {
725
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
726
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
Dries's avatar
Dries committed
727 728
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
 
Dries committed
729
  }
730

Dries's avatar
Dries committed
731
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
732 733
}

734
/**
735 736 737 738 739 740 741 742
 * 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().
743
 */
Dries's avatar
Dries committed
744 745 746 747 748 749 750 751
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
752
  }
Dries's avatar
Dries committed
753
}
Dries's avatar
 
Dries committed
754

Dries's avatar
Dries committed
755 756
/**
 * Fetches the menu link for the previous page of the book.
757 758 759 760 761 762 763
 *
 * @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
764 765 766 767 768
 */
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
769
  }
Dries's avatar
Dries committed
770 771 772 773 774 775 776 777 778 779 780 781
  $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.
782 783
      $tree = book_menu_subtree_data($prev);
      $data = array_shift($tree);
Dries's avatar
Dries committed
784 785 786 787
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
788

Dries's avatar
Dries committed
789 790 791 792 793
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
794 795 796
  }
}

797
/**
Dries's avatar
Dries committed
798
 * Fetches the menu link for the next page of the book.
799 800 801 802 803 804 805
 *
 * @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.
806
 */
Dries's avatar
Dries committed
807 808 809 810 811
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);
812 813 814
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
815 816
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
817
  }
Dries's avatar
Dries committed
818
}
Dries's avatar
 
Dries committed
819

Dries's avatar
Dries committed
820
/**
821 822 823 824 825 826 827
 * 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
828 829 830
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);