book.module 41.9 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 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
/**
 * Implement hook_help().
 */
function book_help($path, $arg) {
  switch ($path) {
    case 'admin/help#book':
      $output = '<h3>' . t('About') . '</h3>';
      $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>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Adding and managing book content') . '</dt>';
      $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>';
      $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>';
      $output .= '<dd>' . t("Users with the <em>access printer-friendly version</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>';
      $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
 * Implement 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
 * Implement hook_permission().
68
 */
69
function book_permission() {
70
  return array(
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
    'administer book outlines' => array(
      'title' => t('Administer book outlines'),
      'description' => t('Manage books through the administration panel.'),
    ),
    'create new books' => array(
      'title' => t('Create new books'),
      'description' => t('Add new top-level books.'),
    ),
    'add content to books' => array(
      'title' => t('Add content to books'),
      'description' => t('Add new content and child pages to books.'),
    ),
    'access printer-friendly version' => array(
      'title' => t('Access printer-friendly version'),
      'description' => t('View a book page and all of its sub-pages as a single document for ease of printing. Can be performance heavy.'),
    ),
87
  );
Dries's avatar
 
Dries committed
88 89
}

Dries's avatar
 
Dries committed
90
/**
Dries's avatar
Dries committed
91
 * Inject links into $node as needed.
Dries's avatar
 
Dries committed
92
 */
93
function book_node_view_link($node, $build_mode) {
Dries's avatar
 
Dries committed
94
  $links = array();
Dries's avatar
Dries committed
95

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

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

117 118
  if (!empty($links)) {
    $node->content['links']['book'] = array(
119 120
      '#theme' => 'links',
      '#links' => $links,
121
      '#attributes' => array('class' => array('links', 'inline')),
122 123
    );
  }
Dries's avatar
 
Dries committed
124 125
}

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

Dries's avatar
 
Dries committed
201 202 203
  return $items;
}

Dries's avatar
Dries committed
204 205 206
/**
 * Menu item access callback - determine if the outline tab is accessible.
 */
207
function _book_outline_access($node) {
Dries's avatar
Dries committed
208 209 210 211 212 213
  return user_access('administer book outlines') && node_access('view', $node);
}

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

Dries's avatar
Dries committed
218
/**
219
 * Implement hook_init().
Dries's avatar
Dries committed
220
 */
221
function book_init() {
222
  drupal_add_css(drupal_get_path('module', 'book') . '/book.css');
223 224
}

225 226 227 228 229 230 231 232 233 234 235 236 237
/**
 * Implement hook_field_build_modes().
 */
function book_field_build_modes($obj_type) {
  $modes = array();
  if ($obj_type == 'node') {
    $modes = array(
      'print' => t('Print'),
    );
  }
  return $modes;
}

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

  return $block;
}

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

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

300 301
  return $block;
}
302

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

320 321
  return $form;
}
322

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

331
/**
Dries's avatar
Dries committed
332 333 334
 * Generate the HTML output for a link to a book title when used as a block title.
 *
 * @ingroup themeable
335
 */
336 337 338
function theme_book_title_link($variables) {
  $link = $variables['link'];

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

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

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

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

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

Dries's avatar
Dries committed
379
  return $all_books;
380
}
381

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

    if ($access) {
404
      _book_add_form_elements($form, $form_state, $node);
Dries's avatar
Dries committed
405 406 407
      $form['book']['pick-book'] = array(
        '#type' => 'submit',
        '#value' => t('Change book (update list of parents)'),
408
         // Submit the node form so the parent select options get updated.
409
         // This is typically only used when JS is disabled. Since the parent options
410 411
         // won't be changed via AJAX, a button is provided in the node form to submit
         // the form and generate options in the parent select corresponding to the
412
         // selected book. This is similar to what happens during a node preview.
413
        '#submit' => array('node_form_submit_build_node'),
Dries's avatar
Dries committed
414 415 416
        '#weight' => 20,
      );
    }
417
  }
Dries's avatar
Dries committed
418
}
419

Dries's avatar
Dries committed
420
/**
421
 * Build the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
422 423 424 425 426 427
 *
 * 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) {
428 429 430
  if (variable_get('menu_override_parent_selector', FALSE)) {
    return array();
  }
Dries's avatar
Dries committed
431 432 433 434 435 436 437
  // 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>',
  );
438

Dries's avatar
Dries committed
439 440 441
  if ($book_link['nid'] === $book_link['bid']) {
    // This is a book - at the top level.
    if ($book_link['original_bid'] === $book_link['bid']) {
442
      $form['#prefix'] .= '<em>' . t('This is the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
443 444
    }
    else {
445
      $form['#prefix'] .= '<em>' . t('This will be the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
446 447 448
    }
  }
  elseif (!$book_link['bid']) {
449
    $form['#prefix'] .= '<em>' . t('No book selected.') . '</em>';
450 451
  }
  else {
Dries's avatar
Dries committed
452 453 454 455
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
456
      '#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)),
457
      '#options' => book_toc($book_link['bid'], $book_link['parent_depth_limit'], array($book_link['mlid'])),
458
      '#attributes' => array('class' => array('book-title-select')),
459
    );
Dries's avatar
 
Dries committed
460
  }
461

462
  return $form;
Dries's avatar
 
Dries committed
463 464
}

465
/**
Dries's avatar
Dries committed
466
 * Build the common elements of the book form for the node and outline forms.
467
 */
468
function _book_add_form_elements(&$form, &$form_state, $node) {
Dries's avatar
Dries committed
469
  // Need this for AJAX.
470
  $form_state['cache'] = TRUE;
Dries's avatar
Dries committed
471 472 473 474 475 476 477

  $form['book'] = array(
    '#type' => 'fieldset',
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
478
    '#group' => 'additional_settings',
479 480 481
    '#attached' => array(
      'js' => array(drupal_get_path('module', 'book') . '/book.js'),
    ),
Dries's avatar
Dries committed
482
    '#tree' => TRUE,
483
    '#attributes' => array('class' => array('book-outline-form')),
484
  );
485
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
486 487 488 489 490 491 492 493 494 495
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

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

  $form['book']['weight'] = array(
    '#type' => 'weight',
496
    '#title' => t('Weight'),
Dries's avatar
Dries committed
497
    '#default_value' => $node->book['weight'],
498
    '#delta' => 15,
Dries's avatar
Dries committed
499
    '#weight' => 5,
500 501
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
502 503
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
504

505
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
506
    // This is the top level node in a maximum depth book and thus cannot be moved.
507
    $options[$node->nid] = $node->title[FIELD_LANGUAGE_NONE][0]['value'];
508 509 510 511 512 513 514
  }
  else {
    foreach (book_get_books() as $book) {
      $options[$book['nid']] = $book['title'];
    }
  }

Dries's avatar
Dries committed
515 516
  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.
517
    $options = array($nid => '<' . t('create a new book') . '>') + $options;
Dries's avatar
Dries committed
518 519
  }
  if (!$node->book['mlid']) {
520
    // The node is not currently in the hierarchy.
521
    $options = array(0 => '<' . t('none') . '>') + $options;
Dries's avatar
Dries committed
522 523 524 525 526 527 528 529 530 531 532
  }

  // 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,
    '#access' => (bool)$options,
    '#description' => t('Your page will be a part of the selected book.'),
    '#weight' => -5,
533
    '#attributes' => array('class' => array('book-title-select')),
534
    '#ajax' => array(
535 536
      'path' => 'book/js/form',
      'wrapper' => 'edit-book-plid-wrapper',
537 538
      'effect' => 'fade',
      'speed' => 'fast',
539
    ),
540
  );
Dries's avatar
Dries committed
541
}
Dries's avatar
 
Dries committed
542

543
/**
Dries's avatar
Dries committed
544
 * Common helper function to handles additions and updates to the book outline.
Dries's avatar
Dries committed
545
 *
Dries's avatar
Dries committed
546 547 548
 * Performs all additions and updates to the book outline through node addition,
 * node editing, node deletion, or the outline tab.
 */
549
function _book_update_outline($node) {
Dries's avatar
Dries committed
550 551 552 553 554
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

555
  $node->book['link_path'] = 'node/' . $node->nid;
556
  $node->book['link_title'] = $node->title[FIELD_LANGUAGE_NONE][0]['value'];
Dries's avatar
Dries committed
557 558 559 560 561 562 563 564 565
  $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'])) {
566 567 568
      $parent = db_query("SELECT * FROM {book} WHERE mlid = :mlid", array(
        ':mlid' => $node->book['plid'],
      ))->fetchAssoc();
Dries's avatar
Dries committed
569 570
    }
    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {
571 572 573
      $node->book['plid'] = db_query("SELECT mlid FROM {book} WHERE nid = :nid", array(
        ':nid' => $node->book['bid'],
      ))->fetchField();
Dries's avatar
Dries committed
574 575 576
      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.
    }
  }
577

Dries's avatar
Dries committed
578 579 580
  if (menu_link_save($node->book)) {
    if ($new) {
      // Insert new.
581 582 583 584 585 586 587
      db_insert('book')
        ->fields(array(
          'nid' => $node->nid,
          'mlid' => $node->book['mlid'],
          'bid' => $node->book['bid'],
        ))
        ->execute();
Dries's avatar
Dries committed
588 589
    }
    else {
590 591 592
      if ($node->book['bid'] != db_query("SELECT bid FROM {book} WHERE nid = :nid", array(
          ':nid' => $node->nid,
        ))->fetchField()) {
Dries's avatar
Dries committed
593 594 595 596
        // Update the bid for this page and all children.
        book_update_bid($node->book);
      }
    }
597

Dries's avatar
Dries committed
598 599
    return TRUE;
  }
600 601

  // Failed to save the menu link.
Dries's avatar
Dries committed
602 603 604
  return FALSE;
}

605
/**
Dries's avatar
Dries committed
606
 * Update the bid for a page and its children when it is moved to a new book.
607
 *
Dries's avatar
Dries committed
608 609 610 611
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 */
function book_update_bid($book_link) {
612 613
  $query = db_select('menu_links');
  $query->addField('menu_links', 'mlid');
Dries's avatar
Dries committed
614
  for ($i = 1; $i <= MENU_MAX_DEPTH && $book_link["p$i"]; $i++) {
615
    $query->condition("p$i", $book_link["p$i"]);
Dries's avatar
Dries committed
616
  }
617
  $mlids = $query->execute()->fetchCol();
618

Dries's avatar
Dries committed
619
  if ($mlids) {
620
    db_update('book')
621
      ->fields(array('bid' => $book_link['bid']))
622 623
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
624 625 626 627 628
  }
}

/**
 * Get the book menu tree for a page, and return it as a linear array.
629
 *
Dries's avatar
Dries committed
630 631
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
632
 * @return
Dries's avatar
Dries committed
633 634
 *   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
635
 *   element corresponding to $node. The children of $node (if any) will come
636 637
 *   immediately after it in the array, and links will only be fetched as deep
 *   as one level deeper than $book_link.
638
 */
Dries's avatar
Dries committed
639
function book_get_flat_menu($book_link) {
640
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
641 642

  if (!isset($flat[$book_link['mlid']])) {
643
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
644
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
Dries's avatar
Dries committed
645 646
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
 
Dries committed
647
  }
648

Dries's avatar
Dries committed
649
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
650 651
}

652
/**
Dries's avatar
Dries committed
653
 * Recursive helper function for book_get_flat_menu().
654
 */
Dries's avatar
Dries committed
655 656 657 658 659 660 661 662
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
663
  }
Dries's avatar
Dries committed
664
}
Dries's avatar
 
Dries committed
665

Dries's avatar
Dries committed
666 667 668 669 670 671 672
/**
 * 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
673
  }
Dries's avatar
Dries committed
674 675 676 677 678 679 680 681 682 683 684 685
  $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.
686 687
      $tree = book_menu_subtree_data($prev);
      $data = array_shift($tree);
Dries's avatar
Dries committed
688 689 690 691
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
692

Dries's avatar
Dries committed
693 694 695 696 697
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
698 699 700
  }
}

701
/**
Dries's avatar
Dries committed
702
 * Fetches the menu link for the next page of the book.
703
 */
Dries's avatar
Dries committed
704 705 706 707 708
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);
709 710 711
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
712 713
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
714
  }
Dries's avatar
Dries committed
715
}
Dries's avatar
 
Dries committed
716

Dries's avatar
Dries committed
717 718 719 720 721
/**
 * Format the menu links for the child pages of the current page.
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
722

Dries's avatar
Dries committed
723 724 725 726 727 728
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
729 730
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
731 732 733 734 735
    // 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
736 737
    }
  }
738

739
  return $children ? drupal_render(menu_tree_output($children)) : '';
Dries's avatar
 
Dries committed
740 741
}

742
/**
Dries's avatar
Dries committed
743
 * Generate the corresponding menu name from a book ID.
744
 */
Dries's avatar
Dries committed
745
function book_menu_name($bid) {
746
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
747 748
}

749
/**
750
 * Implement hook_node_load().
751
 */
752
function book_node_load($nodes, $types) {
753
  $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));
754 755 756 757 758
  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']);
759 760
  }
}
761

762
/**
763
 * Implement hook_node_view().
764
 */
765
function book_node_view($node, $build_mode) {
766 767
  if ($build_mode == 'full') {
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
768
      $node->content['book_navigation'] = array(
769
        '#markup' => theme('book_navigation', array('book_link' => $node->book)),
770 771 772 773
        '#weight' => 100,
      );
    }
  }
Dries's avatar
Dries committed
774

775 776
  if ($build_mode != 'rss') {
    book_node_view_link($node, $build_mode);
777
  }
778 779 780
}

/**
781
 * Implement hook_page_alter().
782 783 784 785 786 787 788 789 790 791
 *
 * 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);
  }
792
}
793

794
/**
795
 * Implement hook_node_presave().
796
 */
797
function book_node_presave($node) {
798 799 800
  // Always save a revision for non-administrators.
  if (!empty($node->book['bid']) && !user_access('administer nodes')) {
    $node->revision = 1;
801 802 803 804
    // The database schema requires a log message for every revision.
    if (!isset($node->log)) {
      $node->log = '';
    }
805 806 807 808 809 810
  }
  // Make sure a new node gets a new menu link.
  if (empty($node->nid)) {
    $node->book['mlid'] = NULL;
  }
}
811

812
/**
813
 * Implement hook_node_insert().
814
 */
815
function book_node_insert($node) {
816 817 818 819 820 821 822 823 824 825
  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);
  }
}
826

827
/**
828
 * Implement hook_node_update().
829
 */
830
function book_node_update($node) {
831 832 833 834 835 836 837 838 839 840
  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);
  }
}
841

842
/**
843
 * Implement hook_node_delete().
844
 */
845
function book_node_delete($node) {
846 847 848
  if (!empty($node->book['bid'])) {
    if ($node->nid == $node->book['bid']) {
      // Handle deletion of a top-level post.
849 850 851 852 853
      $result = db_query("SELECT b.nid FROM {menu_links} ml INNER JOIN {book} b on b.mlid = ml.mlid WHERE ml.plid = :plid", array(
        ':plid' => $node->book['mlid']
      ));
      foreach ($result as $child) {
        $child_node = node_load($child->nid);
854 855
        $child_node->book['bid'] = $child_node->nid;
        _book_update_outline($child_node);
Dries's avatar
Dries committed
856
      }
857 858
    }
    menu_link_delete($node->book['mlid']);
859 860 861
    db_delete('book')
      ->condition('mlid', $node->book['mlid'])
      ->execute();
862 863 864 865
  }
}

/**
866
 * Implement hook_node_prepare().
867
 */
868
function book_node_prepare($node) {
869 870 871 872 873 874 875 876 877 878 879 880
  // Prepare defaults for the add/edit form.
  if (empty($node->book) && (user_access('add content to books') || user_access('administer book outlines'))) {
    $node->book = array();

    if (empty($node->nid) && isset($_GET['parent']) && is_numeric($_GET['parent'])) {
      // Handle "Add child page" links:
      $parent = book_link_load($_GET['parent']);

      if ($parent && $parent['access']) {
        $node->book['bid'] = $parent['bid'];
        $node->book['plid'] = $parent['mlid'];
        $node->book['menu_name'] = $parent['menu_name'];
881
      }