book.module 43.6 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 116 117 118 119
    $node->content['links']['book'] = array(
      '#theme' => 'links__node__book',
      '#links' => $links,
      '#attributes' => array('class' => array('links', 'inline')),
    );
120
  }
Dries's avatar
 
Dries committed
121 122
}

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

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

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

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

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

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

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

  return $block;
}

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

257 258 259 260 261 262 263 264 265
  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
266
      }
267 268 269 270
      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;
271 272 273
        // Check whether user can access the book link.
        $book_node = node_load($book['nid']);
        $book['access'] = node_access('view', $book_node);
274 275
        $pseudo_tree[0]['link'] = $book;
        $book_menus[$book_id] = menu_tree_output($pseudo_tree);
Dries's avatar
Dries committed
276
      }
277
    }
278 279
    $book_menus['#theme'] = 'book_all_books_block';
    $block['content'] = $book_menus;
280 281 282 283 284 285 286 287 288 289 290 291 292
  }
  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);
293
      $block['subject'] = theme('book_title_link', array('link' => $data['link']));
294 295 296
      $block['content'] = ($data['below']) ? menu_tree_output($data['below']) : '';
    }
  }
297

298 299
  return $block;
}
300

301
/**
302
 * Implements hook_block_configure().
303 304 305 306 307 308 309 310 311 312 313 314 315 316
 */
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."),
    );
317

318 319
  return $form;
}
320

321
/**
322
 * Implements hook_block_save().
323 324 325 326
 */
function book_block_save($delta = '', $edit = array()) {
  $block = array();
  variable_set('book_block_mode', $edit['book_block_mode']);
Dries's avatar
Dries committed
327
}
Dries's avatar
 
Dries committed
328

329
/**
330 331 332 333 334
 * 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
335 336
 *
 * @ingroup themeable
337
 */
338 339 340
function theme_book_title_link($variables) {
  $link = $variables['link'];

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

Dries's avatar
Dries committed
343
  return l($link['title'], $link['href'], $link['options']);
Dries's avatar
 
Dries committed
344
}
Dries's avatar
 
Dries committed
345

346
/**
Dries's avatar
Dries committed
347 348 349 350
 * 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.
351
 */
Dries's avatar
Dries committed
352
function book_get_books() {
353
  $all_books = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
354 355 356

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

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

Dries's avatar
Dries committed
381
  return $all_books;
382
}
383

Dries's avatar
Dries committed
384
/**
385
 * Implements hook_form_BASE_FORM_ID_alter().
386 387
 *
 * Adds the book fieldset to the node form.
388 389
 *
 * @see book_pick_book_nojs_submit()
Dries's avatar
Dries committed
390
 */
391 392 393 394 395 396 397
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
398
    }
399
  }
Dries's avatar
Dries committed
400

401 402 403 404 405 406 407 408 409 410 411
  if ($access) {
    _book_add_form_elements($form, $form_state, $node);
    // 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.
    $form['book']['pick-book'] = array(
      '#type' => 'submit',
      '#value' => t('Change book (update list of parents)'),
      '#submit' => array('book_pick_book_nojs_submit'),
      '#weight' => 20,
    );
412
  }
Dries's avatar
Dries committed
413
}
414

415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
/**
 * 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
431
/**
432
 * Build the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
433 434 435 436 437 438
 *
 * 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) {
439 440 441
  if (variable_get('menu_override_parent_selector', FALSE)) {
    return array();
  }
Dries's avatar
Dries committed
442 443 444 445 446 447 448
  // 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>',
  );
449

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

475
  return $form;
Dries's avatar
 
Dries committed
476 477
}

478
/**
Dries's avatar
Dries committed
479
 * Build the common elements of the book form for the node and outline forms.
480
 */
481
function _book_add_form_elements(&$form, &$form_state, $node) {
482 483 484 485 486
  // 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
487 488 489 490 491 492 493

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

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

  $form['book']['weight'] = array(
    '#type' => 'weight',
515
    '#title' => t('Weight'),
Dries's avatar
Dries committed
516
    '#default_value' => $node->book['weight'],
517
    '#delta' => 15,
Dries's avatar
Dries committed
518
    '#weight' => 5,
519 520
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
521 522
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
523

524
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
525
    // This is the top level node in a maximum depth book and thus cannot be moved.
526
    $options[$node->nid] = $node->title;
527 528 529 530 531 532 533
  }
  else {
    foreach (book_get_books() as $book) {
      $options[$book['nid']] = $book['title'];
    }
  }

Dries's avatar
Dries committed
534 535
  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.
536
    $options = array($nid => '<' . t('create a new book') . '>') + $options;
Dries's avatar
Dries committed
537 538
  }
  if (!$node->book['mlid']) {
539
    // The node is not currently in the hierarchy.
540
    $options = array(0 => '<' . t('none') . '>') + $options;
Dries's avatar
Dries committed
541 542 543 544 545 546 547 548
  }

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

562 563 564 565 566 567 568 569 570 571 572 573 574
/**
 * 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'];
}

575
/**
Dries's avatar
Dries committed
576
 * Common helper function to handles additions and updates to the book outline.
Dries's avatar
Dries committed
577
 *
Dries's avatar
Dries committed
578 579 580
 * Performs all additions and updates to the book outline through node addition,
 * node editing, node deletion, or the outline tab.
 */
581
function _book_update_outline($node) {
Dries's avatar
Dries committed
582 583 584 585 586
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

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

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

Dries's avatar
Dries committed
630 631
    return TRUE;
  }
632 633

  // Failed to save the menu link.
Dries's avatar
Dries committed
634 635 636
  return FALSE;
}

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

Dries's avatar
Dries committed
651
  if ($mlids) {
652
    db_update('book')
653
      ->fields(array('bid' => $book_link['bid']))
654 655
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
656 657 658 659 660
  }
}

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

  if (!isset($flat[$book_link['mlid']])) {
675
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
676
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
Dries's avatar
Dries committed
677 678
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
 
Dries committed
679
  }
680

Dries's avatar
Dries committed
681
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
682 683
}

684
/**
Dries's avatar
Dries committed
685
 * Recursive helper function for book_get_flat_menu().
686
 */
Dries's avatar
Dries committed
687 688 689 690 691 692 693 694
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
695
  }
Dries's avatar
Dries committed
696
}
Dries's avatar
 
Dries committed
697

Dries's avatar
Dries committed
698 699 700 701 702 703 704
/**
 * 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
705
  }
Dries's avatar
Dries committed
706 707 708 709 710 711 712 713 714 715 716 717
  $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.
718 719
      $tree = book_menu_subtree_data($prev);
      $data = array_shift($tree);
Dries's avatar
Dries committed
720 721 722 723
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
724

Dries's avatar
Dries committed
725 726 727 728 729
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
730 731 732
  }
}

733
/**
Dries's avatar
Dries committed
734
 * Fetches the menu link for the next page of the book.
735
 */
Dries's avatar
Dries committed
736 737 738 739 740
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);
741 742 743
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
744 745
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
746
  }
Dries's avatar
Dries committed
747
}
Dries's avatar
 
Dries committed
748

Dries's avatar
Dries committed
749 750 751 752 753
/**
 * Format the menu links for the child pages of the current page.
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
754

Dries's avatar
Dries committed
755 756 757 758 759 760
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
761 762
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
763 764 765 766 767
    // 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
768 769
    }
  }
770

771 772 773 774 775
  if ($children) {
    $elements = menu_tree_output($children);
    return drupal_render($elements);
  }
  return '';
Dries's avatar
 
Dries committed
776 777
}

778
/**
Dries's avatar
Dries committed
779
 * Generate the corresponding menu name from a book ID.
780
 */
Dries's avatar
Dries committed
781
function book_menu_name($bid) {
782
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
783 784
}

785
/**
786
 * Implements hook_node_load().
787
 */
788
function book_node_load($nodes, $types) {
789
  $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));
790 791 792 793 794
  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']);
795 796
  }
}
797

798
/**
799
 * Implements hook_node_view().
800
 */
801 802
function book_node_view($node, $view_mode) {
  if ($view_mode == 'full') {
803
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
804
      $node->content['book_navigation'] = array(
805
        '#markup' => theme('book_navigation', array('book_link' => $node->book)),
806 807 808 809
        '#weight' => 100,
      );
    }
  }
Dries's avatar
Dries committed
810

811 812
  if ($view_mode != 'rss') {
    book_node_view_link($node, $view_mode);
813
  }
814 815 816
}

/**
817
 * Implements hook_page_alter().
818 819 820 821 822 823 824 825 826 827
 *
 * 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);
  }
828
}
829

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

848
/**
849
 * Implements hook_node_insert().
850
 */
851
function book_node_insert($node) {
852 853 854 855 856 857 858 859 860 861
  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);
  }
}
862

863
/**
864
 * Implements hook_node_update().
865
 */
866
function book_node_update($node) {
867 868 869 870 871 872 873 874 875 876
  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);
  }
}
877

878
/**
879
 * Implements hook_node_delete().
880
 */
881
function book_node_delete($node) {
882 883 884
  if (!empty($node->book['bid'])) {
    if ($node->nid == $node->book['bid']) {
      // Handle deletion of a top-level post.
Dries's avatar