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
 * 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
  $items['book/js/form'] = array(
Dries's avatar
Dries committed
193
    'page callback' => 'book_form_update',
194
    'delivery callback' => 'ajax_deliver',
Dries's avatar
Dries committed
195 196
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
197
    'file' => 'book.pages.inc',
Dries's avatar
Dries committed
198
  );
199

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

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

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

217 218 219 220 221 222 223 224 225 226 227
/**
 * Implements hook_admin_paths().
 */
function book_admin_paths() {
  $paths = array(
    'node/*/outline' => TRUE,
    'node/*/outline/remove' => TRUE,
  );
  return $paths;
}

Dries's avatar
Dries committed
228
/**
229
 * Implements hook_init().
Dries's avatar
Dries committed
230
 */
231
function book_init() {
232
  drupal_add_css(drupal_get_path('module', 'book') . '/book.css');
233 234
}

235
/**
236
 * Implements hook_entity_info_alter().
237
 */
238 239 240 241 242 243 244
function book_entity_info_alter(&$info) {
  // Add the 'Print' view mode for nodes.
  $info['node']['view modes'] += array(
    'print' => array(
      'label' => t('Print'),
    ),
  );
245 246
}

247
/**
248
 * Implements hook_block_info().
249
 */
250
function book_block_info() {
251 252
  $block = array();
  $block['navigation']['info'] = t('Book navigation');
253
  $block['navigation']['cache'] = DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE;
254 255 256 257 258

  return $block;
}

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

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

309 310
  return $block;
}
311

312
/**
313
 * Implements hook_block_configure().
314 315 316 317 318 319 320 321 322 323 324 325 326 327
 */
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."),
    );
328

329 330
  return $form;
}
331

332
/**
333
 * Implements hook_block_save().
334 335 336 337
 */
function book_block_save($delta = '', $edit = array()) {
  $block = array();
  variable_set('book_block_mode', $edit['book_block_mode']);
Dries's avatar
Dries committed
338
}
Dries's avatar
 
Dries committed
339

340
/**
Dries's avatar
Dries committed
341 342 343
 * Generate the HTML output for a link to a book title when used as a block title.
 *
 * @ingroup themeable
344
 */
345 346 347
function theme_book_title_link($variables) {
  $link = $variables['link'];

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

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

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

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

Dries's avatar
Dries committed
366
    if ($nids) {
367 368 369 370 371 372 373 374 375 376 377 378 379 380
      $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
381 382
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
383
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
384 385
      }
    }
386
  }
387

Dries's avatar
Dries committed
388
  return $all_books;
389
}
390

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

    if ($access) {
413
      _book_add_form_elements($form, $form_state, $node);
Dries's avatar
Dries committed
414 415 416
      $form['book']['pick-book'] = array(
        '#type' => 'submit',
        '#value' => t('Change book (update list of parents)'),
417
         // Submit the node form so the parent select options get updated.
418
         // This is typically only used when JS is disabled. Since the parent options
419 420
         // 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
421
         // selected book. This is similar to what happens during a node preview.
422
        '#submit' => array('node_form_submit_build_node'),
Dries's avatar
Dries committed
423 424 425
        '#weight' => 20,
      );
    }
426
  }
Dries's avatar
Dries committed
427
}
428

Dries's avatar
Dries committed
429
/**
430
 * Build the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
431 432 433 434 435 436
 *
 * 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) {
437 438 439
  if (variable_get('menu_override_parent_selector', FALSE)) {
    return array();
  }
Dries's avatar
Dries committed
440 441 442 443 444 445 446
  // 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>',
  );
447

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

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

474
/**
Dries's avatar
Dries committed
475
 * Build the common elements of the book form for the node and outline forms.
476
 */
477
function _book_add_form_elements(&$form, &$form_state, $node) {
Dries's avatar
Dries committed
478
  // Need this for AJAX.
479
  $form_state['cache'] = TRUE;
Dries's avatar
Dries committed
480 481 482 483 484 485 486

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

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

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

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

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

  // Add a drop-down to select the destination book.
  $form['book']['bid'] = array(
    '#type' => 'select',
    '#title' => t('Book'),
    '#default_value' => $node->book['bid'],
    '#options' => $options,
    '#access' => (bool)$options,
    '#description' => t('Your page will be a part of the selected book.'),
    '#weight' => -5,
542
    '#attributes' => array('class' => array('book-title-select')),
543
    '#ajax' => array(
544 545
      'path' => 'book/js/form',
      'wrapper' => 'edit-book-plid-wrapper',
546 547
      'effect' => 'fade',
      'speed' => 'fast',
548
    ),
549
  );
Dries's avatar
Dries committed
550
}
Dries's avatar
 
Dries committed
551

552
/**
Dries's avatar
Dries committed
553
 * Common helper function to handles additions and updates to the book outline.
Dries's avatar
Dries committed
554
 *
Dries's avatar
Dries committed
555 556 557
 * Performs all additions and updates to the book outline through node addition,
 * node editing, node deletion, or the outline tab.
 */
558
function _book_update_outline($node) {
Dries's avatar
Dries committed
559 560 561 562 563
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

564
  $node->book['link_path'] = 'node/' . $node->nid;
565
  $node->book['link_title'] = $node->title;
Dries's avatar
Dries committed
566 567 568 569 570 571 572 573 574
  $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'])) {
575 576 577
      $parent = db_query("SELECT * FROM {book} WHERE mlid = :mlid", array(
        ':mlid' => $node->book['plid'],
      ))->fetchAssoc();
Dries's avatar
Dries committed
578 579
    }
    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {
580 581 582
      $node->book['plid'] = db_query("SELECT mlid FROM {book} WHERE nid = :nid", array(
        ':nid' => $node->book['bid'],
      ))->fetchField();
Dries's avatar
Dries committed
583 584 585
      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.
    }
  }
586

Dries's avatar
Dries committed
587 588 589
  if (menu_link_save($node->book)) {
    if ($new) {
      // Insert new.
590 591 592 593 594 595 596
      db_insert('book')
        ->fields(array(
          'nid' => $node->nid,
          'mlid' => $node->book['mlid'],
          'bid' => $node->book['bid'],
        ))
        ->execute();
Dries's avatar
Dries committed
597 598
    }
    else {
599 600 601
      if ($node->book['bid'] != db_query("SELECT bid FROM {book} WHERE nid = :nid", array(
          ':nid' => $node->nid,
        ))->fetchField()) {
Dries's avatar
Dries committed
602 603 604 605
        // Update the bid for this page and all children.
        book_update_bid($node->book);
      }
    }
606

Dries's avatar
Dries committed
607 608
    return TRUE;
  }
609 610

  // Failed to save the menu link.
Dries's avatar
Dries committed
611 612 613
  return FALSE;
}

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

Dries's avatar
Dries committed
628
  if ($mlids) {
629
    db_update('book')
630
      ->fields(array('bid' => $book_link['bid']))
631 632
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
633 634 635 636 637
  }
}

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

  if (!isset($flat[$book_link['mlid']])) {
652
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
653
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
Dries's avatar
Dries committed
654 655
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
 
Dries committed
656
  }
657

Dries's avatar
Dries committed
658
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
659 660
}

661
/**
Dries's avatar
Dries committed
662
 * Recursive helper function for book_get_flat_menu().
663
 */
Dries's avatar
Dries committed
664 665 666 667 668 669 670 671
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
672
  }
Dries's avatar
Dries committed
673
}
Dries's avatar
 
Dries committed
674

Dries's avatar
Dries committed
675 676 677 678 679 680 681
/**
 * 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
682
  }
Dries's avatar
Dries committed
683 684 685 686 687 688 689 690 691 692 693 694
  $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.
695 696
      $tree = book_menu_subtree_data($prev);
      $data = array_shift($tree);
Dries's avatar
Dries committed
697 698 699 700
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
701

Dries's avatar
Dries committed
702 703 704 705 706
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
707 708 709
  }
}

710
/**
Dries's avatar
Dries committed
711
 * Fetches the menu link for the next page of the book.
712
 */
Dries's avatar
Dries committed
713 714 715 716 717
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);
718 719 720
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
721 722
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
723
  }
Dries's avatar
Dries committed
724
}
Dries's avatar
 
Dries committed
725

Dries's avatar
Dries committed
726 727 728 729 730
/**
 * Format the menu links for the child pages of the current page.
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
731

Dries's avatar
Dries committed
732 733 734 735 736 737
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
738 739
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
740 741 742 743 744
    // 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
745 746
    }
  }
747

748
  return $children ? drupal_render(menu_tree_output($children)) : '';
Dries's avatar
 
Dries committed
749 750
}

751
/**
Dries's avatar
Dries committed
752
 * Generate the corresponding menu name from a book ID.
753
 */
Dries's avatar
Dries committed
754
function book_menu_name($bid) {
755
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
756 757
}

758
/**
759
 * Implements hook_node_load().
760
 */
761
function book_node_load($nodes, $types) {
762
  $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));
763 764 765 766 767
  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']);
768 769
  }
}
770

771
/**
772
 * Implements hook_node_view().
773
 */
774 775
function book_node_view($node, $view_mode) {
  if ($view_mode == 'full') {
776
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
777
      $node->content['book_navigation'] = array(
778
        '#markup' => theme('book_navigation', array('book_link' => $node->book)),
779 780 781 782
        '#weight' => 100,
      );
    }
  }
Dries's avatar
Dries committed
783

784 785
  if ($view_mode != 'rss') {
    book_node_view_link($node, $view_mode);
786
  }
787 788 789
}

/**
790
 * Implements hook_page_alter().
791 792 793 794 795 796 797 798 799 800
 *
 * 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);
  }
801
}
802

803
/**
804
 * Implements hook_node_presave().
805
 */
806
function book_node_presave($node) {
807 808 809
  // Always save a revision for non-administrators.
  if (!empty($node->book['bid']) && !user_access('administer nodes')) {
    $node->revision = 1;
810 811 812 813
    // The database schema requires a log message for every revision.
    if (!isset($node->log)) {
      $node->log = '';
    }
814 815 816 817 818 819
  }
  // Make sure a new node gets a new menu link.
  if (empty($node->nid)) {
    $node->book['mlid'] = NULL;
  }
}
820

821
/**
822
 * Implements hook_node_insert().
823
 */
824
function book_node_insert($node) {
825 826 827 828 829 830 831 832 833 834
  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);
  }
}
835

836
/**
837
 * Implements hook_node_update().
838
 */
839
function book_node_update($node) {
840 841 842 843 844 845 846 847 848 849
  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);
  }
}
850

851
/**
852
 * Implements hook_node_delete().
853
 */
854
function book_node_delete($node) {