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') {
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 115
  if (!empty($links)) {
    $node->content['links']['book'] = array(
116
      '#theme' => 'links__book_node',
117
      '#links' => $links,
118
      '#attributes' => array('class' => array('links', 'inline')),
119 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
    'access callback' => '_book_outline_access',
    'access arguments' => array(1),
177
    'theme callback' => '_node_custom_theme',
178 179
    'type' => MENU_LOCAL_TASK,
    'weight' => 2,
180
    'file' => 'book.pages.inc',
181
  );
Dries's avatar
Dries committed
182 183 184 185 186 187
  $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),
188
    'theme callback' => '_node_custom_theme',
Dries's avatar
Dries committed
189
    'type' => MENU_CALLBACK,
190
    'file' => 'book.pages.inc',
Dries's avatar
Dries committed
191
  );
192

Dries's avatar
 
Dries committed
193 194 195
  return $items;
}

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

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

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

Dries's avatar
Dries committed
221
/**
222
 * Implements hook_init().
Dries's avatar
Dries committed
223
 */
224
function book_init() {
225
  drupal_add_css(drupal_get_path('module', 'book') . '/book.css', array('preprocess' => TRUE));
226 227
}

228
/**
229
 * Implements hook_entity_info_alter().
230
 */
231 232 233 234 235
function book_entity_info_alter(&$info) {
  // Add the 'Print' view mode for nodes.
  $info['node']['view modes'] += array(
    'print' => array(
      'label' => t('Print'),
236
      'custom settings' => FALSE,
237 238
    ),
  );
239 240
}

241
/**
242
 * Implements hook_block_info().
243
 */
244
function book_block_info() {
245 246
  $block = array();
  $block['navigation']['info'] = t('Book navigation');
247
  $block['navigation']['cache'] = DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE;
248 249 250 251 252

  return $block;
}

/**
253
 * Implements hook_block_view().
254
 *
Dries's avatar
 
Dries committed
255 256
 * Displays the book table of contents in a block when the current page is a
 * single-node view of a book node.
257
 */
258
function book_block_view($delta = '') {
Dries's avatar
 
Dries committed
259
  $block = array();
260 261 262 263
  $current_bid = 0;
  if ($node = menu_get_object()) {
    $current_bid = empty($node->book['bid']) ? 0 : $node->book['bid'];
  }
264

265 266 267 268 269 270 271 272 273
  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
274
      }
275 276 277 278 279 280
      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
281
      }
282
    }
283 284
    $book_menus['#theme'] = 'book_all_books_block';
    $block['content'] = $book_menus;
285 286 287 288 289 290 291 292 293 294 295 296 297
  }
  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);
298
      $block['subject'] = theme('book_title_link', array('link' => $data['link']));
299 300 301
      $block['content'] = ($data['below']) ? menu_tree_output($data['below']) : '';
    }
  }
302

303 304
  return $block;
}
305

306
/**
307
 * Implements hook_block_configure().
308 309 310 311 312 313 314 315 316 317 318 319 320 321
 */
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."),
    );
322

323 324
  return $form;
}
325

326
/**
327
 * Implements hook_block_save().
328 329 330 331
 */
function book_block_save($delta = '', $edit = array()) {
  $block = array();
  variable_set('book_block_mode', $edit['book_block_mode']);
Dries's avatar
Dries committed
332
}
Dries's avatar
 
Dries committed
333

334
/**
335 336 337 338 339
 * 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
340 341
 *
 * @ingroup themeable
342
 */
343 344 345
function theme_book_title_link($variables) {
  $link = $variables['link'];

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

Dries's avatar
Dries committed
348
  return l($link['title'], $link['href'], $link['options']);
Dries's avatar
 
Dries committed
349
}
Dries's avatar
 
Dries committed
350

351
/**
Dries's avatar
Dries committed
352 353 354 355
 * 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.
356
 */
Dries's avatar
Dries committed
357
function book_get_books() {
358
  $all_books = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
359 360 361

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

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

Dries's avatar
Dries committed
386
  return $all_books;
387
}
388

Dries's avatar
Dries committed
389
/**
390
 * Implements hook_form_alter().
391 392
 *
 * Adds the book fieldset to the node form.
Dries's avatar
Dries committed
393
 */
394
function book_form_alter(&$form, &$form_state, $form_id) {
395
  if (!empty($form['#node_edit_form'])) {
396
    // Add elements to the node form.
Dries's avatar
Dries committed
397 398 399 400 401
    $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))) {
402
        // Already in the book hierarchy, or this node type is allowed.
Dries's avatar
Dries committed
403 404 405 406 407
        $access = TRUE;
      }
    }

    if ($access) {
408
      _book_add_form_elements($form, $form_state, $node);
409 410 411
      // 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
412 413 414
      $form['book']['pick-book'] = array(
        '#type' => 'submit',
        '#value' => t('Change book (update list of parents)'),
415
        '#submit' => array('book_pick_book_nojs_submit'),
Dries's avatar
Dries committed
416 417 418
        '#weight' => 20,
      );
    }
419
  }
Dries's avatar
Dries committed
420
}
421

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

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

482
  return $form;
Dries's avatar
 
Dries committed
483 484
}

485
/**
Dries's avatar
Dries committed
486
 * Build the common elements of the book form for the node and outline forms.
487
 */
488
function _book_add_form_elements(&$form, &$form_state, $node) {
489 490 491 492 493
  // 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
494 495 496 497 498 499 500

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

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

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

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

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

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

566 567 568 569 570 571 572 573 574 575 576 577 578
/**
 * 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'];
}

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

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

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

Dries's avatar
Dries committed
634 635
    return TRUE;
  }
636 637

  // Failed to save the menu link.
Dries's avatar
Dries committed
638 639 640
  return FALSE;
}

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

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

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

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

Dries's avatar
Dries committed
685
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
686 687
}

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

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

Dries's avatar
Dries committed
729 730 731 732 733
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
734 735 736
  }
}

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

Dries's avatar
Dries committed
748 749
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
750
  }
Dries's avatar
Dries committed
751
}
Dries's avatar
 
Dries committed
752

Dries's avatar
Dries committed
753 754 755 756 757
/**
 * Format the menu links for the child pages of the current page.
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
758

Dries's avatar
Dries committed
759 760 761 762 763 764
  $children = array();

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

775 776 777 778 779
  if ($children) {
    $elements = menu_tree_output($children);
    return drupal_render($elements);
  }
  return '';
Dries's avatar
 
Dries committed
780 781
}

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

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

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

815 816
  if ($view_mode != 'rss') {
    book_node_view_link($node, $view_mode);
817
  }
818 819 820
}

/**
821
 * Implements hook_page_alter().
822 823 824 825 826 827 828 829 830 831
 *
 * 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);
  }
832
}
833

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

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

867
/**
868
 * Implements hook_node_update().
869
 */
870
function book_node_update($node) {
Dries's avatar