book.module 43.4 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

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

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

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

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

Dries's avatar
 
Dries committed
87
/**
Dries's avatar
Dries committed
88
 * Inject links into $node as needed.
Dries's avatar
 
Dries committed
89
 */
90
function book_node_view_link($node, $view_mode) {
Dries's avatar
 
Dries committed
91
  $links = array();
Dries's avatar
Dries committed
92

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

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

114
  if (!empty($links)) {
115
    $node->content['links']['#links'] = array_merge($node->content['links']['#links'], $links);
116
  }
Dries's avatar
 
Dries committed
117 118
}

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

Dries's avatar
 
Dries committed
189 190 191
  return $items;
}

Dries's avatar
Dries committed
192 193 194
/**
 * Menu item access callback - determine if the outline tab is accessible.
 */
195
function _book_outline_access($node) {
Dries's avatar
Dries committed
196 197 198 199 200 201
  return user_access('administer book outlines') && node_access('view', $node);
}

/**
 * Menu item access callback - determine if the user can remove nodes from the outline.
 */
202
function _book_outline_remove_access($node) {
Dries's avatar
Dries committed
203
  return isset($node->book) && ($node->book['bid'] != $node->nid) && _book_outline_access($node);
204 205
}

206 207 208 209 210 211 212 213 214 215 216
/**
 * Implements hook_admin_paths().
 */
function book_admin_paths() {
  $paths = array(
    'node/*/outline' => TRUE,
    'node/*/outline/remove' => TRUE,
  );
  return $paths;
}

217
/**
218
 * Implements hook_entity_info_alter().
219
 */
220 221 222 223 224
function book_entity_info_alter(&$info) {
  // Add the 'Print' view mode for nodes.
  $info['node']['view modes'] += array(
    'print' => array(
      'label' => t('Print'),
225
      'custom settings' => FALSE,
226 227
    ),
  );
228 229
}

230
/**
231
 * Implements hook_block_info().
232
 */
233
function book_block_info() {
234 235
  $block = array();
  $block['navigation']['info'] = t('Book navigation');
236
  $block['navigation']['cache'] = DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE;
237 238 239 240 241

  return $block;
}

/**
242
 * Implements hook_block_view().
243
 *
Dries's avatar
 
Dries committed
244 245
 * Displays the book table of contents in a block when the current page is a
 * single-node view of a book node.
246
 */
247
function book_block_view($delta = '') {
Dries's avatar
 
Dries committed
248
  $block = array();
249 250 251 252
  $current_bid = 0;
  if ($node = menu_get_object()) {
    $current_bid = empty($node->book['bid']) ? 0 : $node->book['bid'];
  }
253

254 255 256 257 258 259 260 261 262
  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
263
      }
264 265 266 267 268 269
      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;
        $pseudo_tree[0]['link'] = $book;
        $book_menus[$book_id] = menu_tree_output($pseudo_tree);
Dries's avatar
Dries committed
270
      }
271
    }
272 273
    $book_menus['#theme'] = 'book_all_books_block';
    $block['content'] = $book_menus;
274 275 276 277 278 279 280 281 282 283 284 285 286
  }
  elseif ($current_bid) {
    // Only display this block when the user is browsing a book.
    $select = db_select('node');
    $select->addField('node', 'title');
    $select->condition('nid', $node->book['bid']);
    $select->addTag('node_access');
    $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);
287
      $block['subject'] = theme('book_title_link', array('link' => $data['link']));
288 289 290
      $block['content'] = ($data['below']) ? menu_tree_output($data['below']) : '';
    }
  }
291

292 293
  return $block;
}
294

295
/**
296
 * Implements hook_block_configure().
297 298 299 300 301 302 303 304 305 306 307 308 309 310
 */
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."),
    );
311

312 313
  return $form;
}
314

315
/**
316
 * Implements hook_block_save().
317 318 319 320
 */
function book_block_save($delta = '', $edit = array()) {
  $block = array();
  variable_set('book_block_mode', $edit['book_block_mode']);
Dries's avatar
Dries committed
321
}
Dries's avatar
 
Dries committed
322

323
/**
324 325 326 327 328
 * 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
329 330
 *
 * @ingroup themeable
331
 */
332 333 334
function theme_book_title_link($variables) {
  $link = $variables['link'];

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

Dries's avatar
Dries committed
337
  return l($link['title'], $link['href'], $link['options']);
Dries's avatar
 
Dries committed
338
}
Dries's avatar
 
Dries committed
339

340
/**
Dries's avatar
Dries committed
341 342 343 344
 * 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.
345
 */
Dries's avatar
Dries committed
346
function book_get_books() {
347
  $all_books = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
348 349 350

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

Dries's avatar
Dries committed
353
    if ($nids) {
354
      $query = db_select('book', 'b', array('fetch' => PDO::FETCH_ASSOC));
355 356
      $query->join('node', 'n', 'b.nid = n.nid');
      $query->join('menu_links', 'ml', 'b.mlid = ml.mlid');
357 358 359
      $query->addField('n', 'type', 'type');
      $query->addField('n', 'title', 'title');
      $query->fields('b');
360
      $query->fields('ml');
361 362 363 364 365 366 367
      $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
368 369
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
370
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
371 372
      }
    }
373
  }
374

Dries's avatar
Dries committed
375
  return $all_books;
376
}
377

Dries's avatar
Dries committed
378
/**
379
 * Implements hook_form_alter().
380 381
 *
 * Adds the book fieldset to the node form.
Dries's avatar
Dries committed
382
 */
383
function book_form_alter(&$form, &$form_state, $form_id) {
384
  if (!empty($form['#node_edit_form'])) {
385
    // Add elements to the node form.
Dries's avatar
Dries committed
386 387 388 389 390
    $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))) {
391
        // Already in the book hierarchy, or this node type is allowed.
Dries's avatar
Dries committed
392 393 394 395 396
        $access = TRUE;
      }
    }

    if ($access) {
397
      _book_add_form_elements($form, $form_state, $node);
398 399 400
      // Since the "Book" dropdown can't trigger a form submission when
      // JavaScript is disabled, add a submit button to do that. book.css hides
      // this button when JavaScript is enabled.
Dries's avatar
Dries committed
401 402 403
      $form['book']['pick-book'] = array(
        '#type' => 'submit',
        '#value' => t('Change book (update list of parents)'),
404
        '#submit' => array('book_pick_book_nojs_submit'),
Dries's avatar
Dries committed
405 406 407
        '#weight' => 20,
      );
    }
408
  }
Dries's avatar
Dries committed
409
}
410

411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
/**
 * Submit handler to change a node's book.
 *
 * 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
 * book_form_update() AJAX callback instead.
 *
 * @see book_form_update()
 */
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
427
/**
428
 * Build the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
429 430 431 432 433 434
 *
 * This function is also called when generating a new set of options during the
 * AJAX callback, so an array is returned that can be used to replace an existing
 * form element.
 */
function _book_parent_select($book_link) {
435 436 437
  if (variable_get('menu_override_parent_selector', FALSE)) {
    return array();
  }
Dries's avatar
Dries committed
438 439 440 441 442 443 444
  // 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>',
  );
445

Dries's avatar
Dries committed
446 447 448
  if ($book_link['nid'] === $book_link['bid']) {
    // This is a book - at the top level.
    if ($book_link['original_bid'] === $book_link['bid']) {
449
      $form['#prefix'] .= '<em>' . t('This is the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
450 451
    }
    else {
452
      $form['#prefix'] .= '<em>' . t('This will be the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
453 454 455
    }
  }
  elseif (!$book_link['bid']) {
456
    $form['#prefix'] .= '<em>' . t('No book selected.') . '</em>';
457 458
  }
  else {
Dries's avatar
Dries committed
459 460 461 462
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
463
      '#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)),
464
      '#options' => book_toc($book_link['bid'], $book_link['parent_depth_limit'], array($book_link['mlid'])),
465
      '#attributes' => array('class' => array('book-title-select')),
466 467
      '#prefix' => '<div id="edit-book-plid-wrapper">',
      '#suffix' => '</div>',
468
    );
Dries's avatar
 
Dries committed
469
  }
470

471
  return $form;
Dries's avatar
 
Dries committed
472 473
}

474
/**
Dries's avatar
Dries committed
475
 * Build the common elements of the book form for the node and outline forms.
476
 */
477
function _book_add_form_elements(&$form, &$form_state, $node) {
478 479 480 481 482
  // If the form is being processed during the AJAX callback of our book bid
  // 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
483 484 485 486 487 488 489

  $form['book'] = array(
    '#type' => 'fieldset',
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
490
    '#group' => 'additional_settings',
491 492 493
    '#attached' => array(
      'js' => array(drupal_get_path('module', 'book') . '/book.js'),
    ),
Dries's avatar
Dries committed
494
    '#tree' => TRUE,
495
    '#attributes' => array('class' => array('book-outline-form')),
496
  );
497
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
498 499 500 501 502 503 504 505 506 507
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

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

  $form['book']['weight'] = array(
    '#type' => 'weight',
508
    '#title' => t('Weight'),
Dries's avatar
Dries committed
509
    '#default_value' => $node->book['weight'],
510
    '#delta' => 15,
Dries's avatar
Dries committed
511
    '#weight' => 5,
512 513
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
514 515
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
516

517
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
518
    // This is the top level node in a maximum depth book and thus cannot be moved.
519
    $options[$node->nid] = $node->title;
520 521 522 523 524 525 526
  }
  else {
    foreach (book_get_books() as $book) {
      $options[$book['nid']] = $book['title'];
    }
  }

Dries's avatar
Dries committed
527 528
  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.
529
    $options = array($nid => '<' . t('create a new book') . '>') + $options;
Dries's avatar
Dries committed
530 531
  }
  if (!$node->book['mlid']) {
532
    // The node is not currently in the hierarchy.
533
    $options = array(0 => '<' . t('none') . '>') + $options;
Dries's avatar
Dries committed
534 535 536 537 538 539 540 541
  }

  // 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,
542
    '#access' => (bool) $options,
Dries's avatar
Dries committed
543 544
    '#description' => t('Your page will be a part of the selected book.'),
    '#weight' => -5,
545
    '#attributes' => array('class' => array('book-title-select')),
546
    '#ajax' => array(
547
      'callback' => 'book_form_update',
548
      'wrapper' => 'edit-book-plid-wrapper',
549 550
      'effect' => 'fade',
      'speed' => 'fast',
551
    ),
552
  );
Dries's avatar
Dries committed
553
}
Dries's avatar
 
Dries committed
554

555 556 557 558 559 560 561 562 563 564 565 566 567
/**
 * Renders a new parent page select element when the book selection changes.
 *
 * This function is called via AJAX when the selected book is changed on a node
 * or book outline form.
 *
 * @return
 *   The rendered parent page select element.
 */
function book_form_update($form, $form_state) {
  return $form['book']['plid'];
}

568
/**
Dries's avatar
Dries committed
569
 * Common helper function to handles additions and updates to the book outline.
Dries's avatar
Dries committed
570
 *
Dries's avatar
Dries committed
571 572 573
 * Performs all additions and updates to the book outline through node addition,
 * node editing, node deletion, or the outline tab.
 */
574
function _book_update_outline($node) {
Dries's avatar
Dries committed
575 576 577 578 579
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

580
  $node->book['link_path'] = 'node/' . $node->nid;
581
  $node->book['link_title'] = $node->title;
Dries's avatar
Dries committed
582 583 584 585 586 587 588 589 590
  $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'])) {
591 592 593
      $parent = db_query("SELECT * FROM {book} WHERE mlid = :mlid", array(
        ':mlid' => $node->book['plid'],
      ))->fetchAssoc();
Dries's avatar
Dries committed
594 595
    }
    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {
596 597 598
      $node->book['plid'] = db_query("SELECT mlid FROM {book} WHERE nid = :nid", array(
        ':nid' => $node->book['bid'],
      ))->fetchField();
Dries's avatar
Dries committed
599 600 601
      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.
    }
  }
602

Dries's avatar
Dries committed
603 604 605
  if (menu_link_save($node->book)) {
    if ($new) {
      // Insert new.
606 607 608 609 610 611 612
      db_insert('book')
        ->fields(array(
          'nid' => $node->nid,
          'mlid' => $node->book['mlid'],
          'bid' => $node->book['bid'],
        ))
        ->execute();
Dries's avatar
Dries committed
613 614
    }
    else {
615 616 617
      if ($node->book['bid'] != db_query("SELECT bid FROM {book} WHERE nid = :nid", array(
          ':nid' => $node->nid,
        ))->fetchField()) {
Dries's avatar
Dries committed
618 619 620 621
        // Update the bid for this page and all children.
        book_update_bid($node->book);
      }
    }
622

Dries's avatar
Dries committed
623 624
    return TRUE;
  }
625 626

  // Failed to save the menu link.
Dries's avatar
Dries committed
627 628 629
  return FALSE;
}

630
/**
Dries's avatar
Dries committed
631
 * Update the bid for a page and its children when it is moved to a new book.
632
 *
Dries's avatar
Dries committed
633 634 635 636
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 */
function book_update_bid($book_link) {
637 638
  $query = db_select('menu_links');
  $query->addField('menu_links', 'mlid');
Dries's avatar
Dries committed
639
  for ($i = 1; $i <= MENU_MAX_DEPTH && $book_link["p$i"]; $i++) {
640
    $query->condition("p$i", $book_link["p$i"]);
Dries's avatar
Dries committed
641
  }
642
  $mlids = $query->execute()->fetchCol();
643

Dries's avatar
Dries committed
644
  if ($mlids) {
645
    db_update('book')
646
      ->fields(array('bid' => $book_link['bid']))
647 648
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
649 650 651 652 653
  }
}

/**
 * Get the book menu tree for a page, and return it as a linear array.
654
 *
Dries's avatar
Dries committed
655 656
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
657
 * @return
Dries's avatar
Dries committed
658 659
 *   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
660
 *   element corresponding to $node. The children of $node (if any) will come
661 662
 *   immediately after it in the array, and links will only be fetched as deep
 *   as one level deeper than $book_link.
663
 */
Dries's avatar
Dries committed
664
function book_get_flat_menu($book_link) {
665
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
666 667

  if (!isset($flat[$book_link['mlid']])) {
668
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
669
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
Dries's avatar
Dries committed
670 671
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
 
Dries committed
672
  }
673

Dries's avatar
Dries committed
674
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
675 676
}

677
/**
Dries's avatar
Dries committed
678
 * Recursive helper function for book_get_flat_menu().
679
 */
Dries's avatar
Dries committed
680 681 682 683 684 685 686 687
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
688
  }
Dries's avatar
Dries committed
689
}
Dries's avatar
 
Dries committed
690

Dries's avatar
Dries committed
691 692 693 694 695 696 697
/**
 * Fetches the menu link for the previous page of the book.
 */
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
698
  }
Dries's avatar
Dries committed
699 700 701 702 703 704 705 706 707 708 709 710
  $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.
711 712
      $tree = book_menu_subtree_data($prev);
      $data = array_shift($tree);
Dries's avatar
Dries committed
713 714 715 716
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
717

Dries's avatar
Dries committed
718 719 720 721 722
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
723 724 725
  }
}

726
/**
Dries's avatar
Dries committed
727
 * Fetches the menu link for the next page of the book.
728
 */
Dries's avatar
Dries committed
729 730 731 732 733
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);
734 735 736
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
737 738
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
739
  }
Dries's avatar
Dries committed
740
}
Dries's avatar
 
Dries committed
741

Dries's avatar
Dries committed
742 743 744 745 746
/**
 * Format the menu links for the child pages of the current page.
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
747

Dries's avatar
Dries committed
748 749 750 751 752 753
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
754 755
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
756 757 758 759 760
    // 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
761 762
    }
  }
763

764 765 766 767 768
  if ($children) {
    $elements = menu_tree_output($children);
    return drupal_render($elements);
  }
  return '';
Dries's avatar
 
Dries committed
769 770
}

771
/**
Dries's avatar
Dries committed
772
 * Generate the corresponding menu name from a book ID.
773
 */
Dries's avatar
Dries committed
774
function book_menu_name($bid) {
775
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
776 777
}

778
/**
779
 * Implements hook_node_load().
780
 */
781
function book_node_load($nodes, $types) {
782
  $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));
783 784 785 786 787
  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']);
788 789
  }
}
790

791
/**
792
 * Implements hook_node_view().
793
 */
794 795
function book_node_view($node, $view_mode) {
  if ($view_mode == 'full') {
796
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
797
      $node->content['book_navigation'] = array(
798
        '#markup' => theme('book_navigation', array('book_link' => $node->book)),
799 800 801 802
        '#weight' => 100,
      );
    }
  }
Dries's avatar
Dries committed
803

804 805
  if ($view_mode != 'rss') {
    book_node_view_link($node, $view_mode);
806
  }
807 808 809
}

/**
810
 * Implements hook_page_alter().
811 812 813 814 815 816 817 818 819 820
 *
 * Add the book menu to the list of menus used to build the active trail when
 * 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);
  }
821
}
822

823
/**
824
 * Implements hook_node_presave().
825
 */
826
function book_node_presave($node) {
827 828 829
  // Always save a revision for non-administrators.
  if (!empty($node->book['bid']) && !user_access('administer nodes')) {
    $node->revision = 1;
830 831 832 833
    // The database schema requires a log message for every revision.
    if (!isset($node->log)) {
      $node->log = '';
    }
834 835 836 837 838 839
  }
  // Make sure a new node gets a new menu link.
  if (empty($node->nid)) {
    $node->book['mlid'] = NULL;
  }
}
840

841
/**
842
 * Implements hook_node_insert().
843
 */
844
function book_node_insert($node) {
845 846 847 848 849 850 851 852 853 854
  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);
  }
}
855

856
/**
857
 * Implements hook_node_update().
858
 */
859
function book_node_update($node) {
860 861 862 863 864 865 866 867 868 869
  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);
  }
}
870

871
/**
872
 * Implements hook_node_delete().
873
 */
874
function book_node_delete($node) {