book.module 39.8 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
 * Implement hook_theme().
11 12 13 14
 */
function book_theme() {
  return array(
    'book_navigation' => array(
Dries's avatar
Dries committed
15
      'arguments' => array('book_link' => NULL),
16
      'template' => 'book-navigation',
17 18
    ),
    'book_export_html' => array(
19 20
      'arguments' => array('title' => NULL, 'contents' => NULL, 'depth' => NULL),
      'template' => 'book-export-html',
21 22 23 24
    ),
    'book_admin_table' => array(
      'arguments' => array('form' => NULL),
    ),
Dries's avatar
Dries committed
25 26 27 28 29
    'book_title_link' => array(
      'arguments' => array('link' => NULL),
    ),
    'book_all_books_block' => array(
      'arguments' => array('book_menus' => array()),
30 31 32 33 34
      'template' => 'book-all-books-block',
    ),
    'book_node_export_html' => array(
      'arguments' => array('node' => NULL, 'children' => NULL),
      'template' => 'book-node-export-html',
Dries's avatar
Dries committed
35
    ),
36 37 38
  );
}

39
/**
40
 * Implement hook_permission().
41
 */
42
function book_permission() {
43
  return array(
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
    '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.'),
    ),
60
  );
Dries's avatar
 
Dries committed
61 62
}

Dries's avatar
 
Dries committed
63
/**
Dries's avatar
Dries committed
64
 * Inject links into $node as needed.
Dries's avatar
 
Dries committed
65
 */
66
function book_node_view_link($node, $build_mode) {
Dries's avatar
 
Dries committed
67
  $links = array();
Dries's avatar
Dries committed
68

69
  if (isset($node->book['depth'])) {
70
    if ($build_mode == 'full') {
Dries's avatar
Dries committed
71 72
      $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) {
73
        $links['book_add_child'] = array(
74
          'title' => t('Add child page'),
75 76
          'href' => 'node/add/' . str_replace('_', '-', $child_type),
          'query' => 'parent=' . $node->book['mlid'],
77
        );
Dries's avatar
 
Dries committed
78
      }
79

Dries's avatar
Dries committed
80
      if (user_access('access printer-friendly version')) {
81
        $links['book_printer'] = array(
82
          'title' => t('Printer-friendly version'),
83
          'href' => 'book/export/html/' . $node->nid,
84
          'attributes' => array('title' => t('Show a printer-friendly version of this book page and its sub-pages.'))
85
        );
86
      }
Dries's avatar
 
Dries committed
87
    }
Dries's avatar
 
Dries committed
88
  }
89

90 91
  if (!empty($links)) {
    $node->content['links']['book'] = array(
92 93 94
      '#theme' => 'links',
      '#links' => $links,
      '#attributes' => array('class' => 'links inline'),
95 96
    );
  }
Dries's avatar
 
Dries committed
97 98
}

Dries's avatar
 
Dries committed
99
/**
100
 * Implement hook_menu().
Dries's avatar
 
Dries committed
101
 */
102 103
function book_menu() {
  $items['admin/content/book'] = array(
104
    'title' => 'Books',
Dries's avatar
Dries committed
105 106 107
    'description' => "Manage your site's book outlines.",
    'page callback' => 'book_admin_overview',
    'access arguments' => array('administer book outlines'),
108 109
  );
  $items['admin/content/book/list'] = array(
110
    'title' => 'List',
111 112
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
Dries's avatar
Dries committed
113 114
  $items['admin/content/book/settings'] = array(
    'title' => 'Settings',
115
    'page callback' => 'drupal_get_form',
Dries's avatar
Dries committed
116 117
    'page arguments' => array('book_admin_settings'),
    'access arguments' => array('administer site configuration'),
118 119 120
    'type' => MENU_LOCAL_TASK,
    'weight' => 8,
  );
Dries's avatar
Dries committed
121 122 123 124 125 126 127 128
  $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,
  );
129
  $items['book'] = array(
130
    'title' => 'Books',
131 132 133 134 135 136 137
    'page callback' => 'book_render',
    'access arguments' => array('access content'),
    'type' => MENU_SUGGESTED_ITEM,
  );
  $items['book/export/%/%'] = array(
    'page callback' => 'book_export',
    'page arguments' => array(2, 3),
Dries's avatar
Dries committed
138
    'access arguments' => array('access printer-friendly version'),
139 140
    'type' => MENU_CALLBACK,
  );
141
  $items['node/%node/outline'] = array(
142
    'title' => 'Outline',
Dries's avatar
Dries committed
143 144
    'page callback' => 'book_outline',
    'page arguments' => array(1),
145 146 147 148 149
    'access callback' => '_book_outline_access',
    'access arguments' => array(1),
    'type' => MENU_LOCAL_TASK,
    'weight' => 2,
  );
Dries's avatar
Dries committed
150 151 152 153 154 155 156 157
  $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,
  );
158
  $items['book/js/form'] = array(
Dries's avatar
Dries committed
159 160 161 162
    'page callback' => 'book_form_update',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
  );
163

Dries's avatar
 
Dries committed
164 165 166
  return $items;
}

Dries's avatar
Dries committed
167 168 169
/**
 * Menu item access callback - determine if the outline tab is accessible.
 */
170
function _book_outline_access($node) {
Dries's avatar
Dries committed
171 172 173 174 175 176 177 178
  return user_access('administer book outlines') && node_access('view', $node);
}

/**
 * Menu item access callback - determine if the user can remove nodes from the outline.
 */
function _book_outline_remove_access($node) {
  return isset($node->book) && ($node->book['bid'] != $node->nid) && _book_outline_access($node);
179 180
}

Dries's avatar
Dries committed
181
/**
182
 * Implement hook_init().
Dries's avatar
Dries committed
183
 */
184
function book_init() {
185
  drupal_add_css(drupal_get_path('module', 'book') . '/book.css');
186 187
}

188 189 190 191 192 193 194 195 196 197 198 199 200
/**
 * 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;
}

201
/**
202
 * Implement hook_block_list().
203 204 205 206 207 208 209 210 211 212
 */
function book_block_list() {
  $block = array();
  $block['navigation']['info'] = t('Book navigation');
  $block['navigation']['cache'] = BLOCK_CACHE_PER_PAGE | BLOCK_CACHE_PER_ROLE;

  return $block;
}

/**
213
 * Implement hook_block_view().
214
 *
Dries's avatar
 
Dries committed
215 216
 * Displays the book table of contents in a block when the current page is a
 * single-node view of a book node.
217
 */
218
function book_block_view($delta = '') {
Dries's avatar
 
Dries committed
219
  $block = array();
220 221 222 223
  $current_bid = 0;
  if ($node = menu_get_object()) {
    $current_bid = empty($node->book['bid']) ? 0 : $node->book['bid'];
  }
224

225 226 227 228 229 230 231 232 233
  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
234
      }
235 236 237 238 239 240
      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
241
      }
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
    }
    $block['content'] = theme('book_all_books_block', $book_menus);
  }
  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);
      $block['subject'] = theme('book_title_link', $data['link']);
      $block['content'] = ($data['below']) ? menu_tree_output($data['below']) : '';
    }
  }
261

262 263
  return $block;
}
264

265
/**
266
 * Implement hook_block_configure().
267 268 269 270 271 272 273 274 275 276 277 278 279 280
 */
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."),
    );
281

282 283
  return $form;
}
284

285
/**
286
 * Implement hook_block_save().
287 288 289 290
 */
function book_block_save($delta = '', $edit = array()) {
  $block = array();
  variable_set('book_block_mode', $edit['book_block_mode']);
Dries's avatar
Dries committed
291
}
Dries's avatar
 
Dries committed
292

293
/**
Dries's avatar
Dries committed
294 295 296
 * Generate the HTML output for a link to a book title when used as a block title.
 *
 * @ingroup themeable
297
 */
Dries's avatar
Dries committed
298 299
function theme_book_title_link($link) {
  $link['options']['attributes']['class'] =  'book-title';
300

Dries's avatar
Dries committed
301
  return l($link['title'], $link['href'], $link['options']);
Dries's avatar
 
Dries committed
302
}
Dries's avatar
 
Dries committed
303

304
/**
Dries's avatar
Dries committed
305 306 307 308
 * 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.
309
 */
Dries's avatar
Dries committed
310
function book_get_books() {
311
  $all_books = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
312 313 314

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

Dries's avatar
Dries committed
317
    if ($nids) {
318 319 320 321 322 323 324 325 326 327 328 329 330 331
      $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
332 333
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
334
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
335 336
      }
    }
337
  }
338

Dries's avatar
Dries committed
339
  return $all_books;
340
}
341

Dries's avatar
Dries committed
342
/**
343
 * Implement hook_form_alter().
344 345
 *
 * Adds the book fieldset to the node form.
Dries's avatar
Dries committed
346 347 348 349 350 351
 *
 * @see book_pick_book_submit()
 * @see book_submit()
 */
function book_form_alter(&$form, $form_state, $form_id) {

352
  if (!empty($form['#node_edit_form'])) {
353
    // Add elements to the node form.
Dries's avatar
Dries committed
354 355 356 357 358
    $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))) {
359
        // Already in the book hierarchy, or this node type is allowed.
Dries's avatar
Dries committed
360 361 362 363 364 365 366 367 368
        $access = TRUE;
      }
    }

    if ($access) {
      _book_add_form_elements($form, $node);
      $form['book']['pick-book'] = array(
        '#type' => 'submit',
        '#value' => t('Change book (update list of parents)'),
369
         // Submit the node form so the parent select options get updated.
370
         // This is typically only used when JS is disabled. Since the parent options
371 372
         // 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
373
         // selected book. This is similar to what happens during a node preview.
374
        '#submit' => array('node_form_submit_build_node'),
Dries's avatar
Dries committed
375 376 377
        '#weight' => 20,
      );
    }
378
  }
Dries's avatar
Dries committed
379
}
380

Dries's avatar
Dries committed
381
/**
382
 * Build the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
383 384 385 386 387 388
 *
 * 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) {
389 390 391
  if (variable_get('menu_override_parent_selector', FALSE)) {
    return array();
  }
Dries's avatar
Dries committed
392 393 394 395 396 397 398
  // 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>',
  );
399

Dries's avatar
Dries committed
400 401 402
  if ($book_link['nid'] === $book_link['bid']) {
    // This is a book - at the top level.
    if ($book_link['original_bid'] === $book_link['bid']) {
403
      $form['#prefix'] .= '<em>' . t('This is the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
404 405
    }
    else {
406
      $form['#prefix'] .= '<em>' . t('This will be the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
407 408 409
    }
  }
  elseif (!$book_link['bid']) {
410
    $form['#prefix'] .= '<em>' . t('No book selected.') . '</em>';
411 412
  }
  else {
Dries's avatar
Dries committed
413 414 415 416
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
417
      '#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)),
418
      '#options' => book_toc($book_link['bid'], $book_link['parent_depth_limit'], array($book_link['mlid'])),
419
      '#attributes' => array('class' => 'book-title-select'),
420
    );
Dries's avatar
 
Dries committed
421
  }
422

423
  return $form;
Dries's avatar
 
Dries committed
424 425
}

426
/**
Dries's avatar
Dries committed
427
 * Build the common elements of the book form for the node and outline forms.
428
 */
Dries's avatar
Dries committed
429 430 431 432 433 434 435 436 437 438
function _book_add_form_elements(&$form, $node) {
  // Need this for AJAX.
  $form['#cache'] = TRUE;

  $form['book'] = array(
    '#type' => 'fieldset',
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
439 440
    '#group' => 'additional_settings',
    '#attached_js' => array(drupal_get_path('module', 'book') . '/book.js'),
Dries's avatar
Dries committed
441
    '#tree' => TRUE,
442
    '#attributes' => array('class' => 'book-outline-form'),
443
  );
444
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
445 446 447 448 449 450 451 452 453 454
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

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

  $form['book']['weight'] = array(
    '#type' => 'weight',
455
    '#title' => t('Weight'),
Dries's avatar
Dries committed
456
    '#default_value' => $node->book['weight'],
457
    '#delta' => 15,
Dries's avatar
Dries committed
458
    '#weight' => 5,
459 460
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
461 462
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
463

464
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
465 466 467 468 469 470 471 472 473
    // This is the top level node in a maximum depth book and thus cannot be moved.
    $options[$node->nid] = $node->title;
  }
  else {
    foreach (book_get_books() as $book) {
      $options[$book['nid']] = $book['title'];
    }
  }

Dries's avatar
Dries committed
474 475
  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.
476
    $options = array($nid => '<' . t('create a new book') . '>') + $options;
Dries's avatar
Dries committed
477 478
  }
  if (!$node->book['mlid']) {
479
    // The node is not currently in the hierarchy.
480
    $options = array(0 => '<' . t('none') . '>') + $options;
Dries's avatar
Dries committed
481 482 483 484 485 486 487 488 489 490 491
  }

  // 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,
492
    '#attributes' => array('class' => 'book-title-select'),
493 494 495 496 497
    '#ahah' => array(
      'path' => 'book/js/form',
      'wrapper' => 'edit-book-plid-wrapper',
      'effect' => 'slide',
    ),
498
  );
Dries's avatar
Dries committed
499
}
Dries's avatar
 
Dries committed
500

501
/**
Dries's avatar
Dries committed
502
 * Common helper function to handles additions and updates to the book outline.
Dries's avatar
Dries committed
503
 *
Dries's avatar
Dries committed
504 505 506
 * Performs all additions and updates to the book outline through node addition,
 * node editing, node deletion, or the outline tab.
 */
507
function _book_update_outline($node) {
Dries's avatar
Dries committed
508 509 510 511 512
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

513
  $node->book['link_path'] = 'node/' . $node->nid;
Dries's avatar
Dries committed
514 515 516 517 518 519 520 521 522 523
  $node->book['link_title'] = $node->title;
  $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'])) {
524 525 526
      $parent = db_query("SELECT * FROM {book} WHERE mlid = :mlid", array(
        ':mlid' => $node->book['plid'],
      ))->fetchAssoc();
Dries's avatar
Dries committed
527 528
    }
    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {
529 530 531
      $node->book['plid'] = db_query("SELECT mlid FROM {book} WHERE nid = :nid", array(
        ':nid' => $node->book['bid'],
      ))->fetchField();
Dries's avatar
Dries committed
532 533 534
      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.
    }
  }
535

Dries's avatar
Dries committed
536 537 538
  if (menu_link_save($node->book)) {
    if ($new) {
      // Insert new.
539 540 541 542 543 544 545
      db_insert('book')
        ->fields(array(
          'nid' => $node->nid,
          'mlid' => $node->book['mlid'],
          'bid' => $node->book['bid'],
        ))
        ->execute();
Dries's avatar
Dries committed
546 547
    }
    else {
548 549 550
      if ($node->book['bid'] != db_query("SELECT bid FROM {book} WHERE nid = :nid", array(
          ':nid' => $node->nid,
        ))->fetchField()) {
Dries's avatar
Dries committed
551 552 553 554
        // Update the bid for this page and all children.
        book_update_bid($node->book);
      }
    }
555

Dries's avatar
Dries committed
556 557
    return TRUE;
  }
558 559

  // Failed to save the menu link.
Dries's avatar
Dries committed
560 561 562
  return FALSE;
}

563
/**
Dries's avatar
Dries committed
564
 * Update the bid for a page and its children when it is moved to a new book.
565
 *
Dries's avatar
Dries committed
566 567 568 569
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 */
function book_update_bid($book_link) {
570 571
  $query = db_select('menu_links');
  $query->addField('menu_links', 'mlid');
Dries's avatar
Dries committed
572
  for ($i = 1; $i <= MENU_MAX_DEPTH && $book_link["p$i"]; $i++) {
573
    $query->condition("p$i", $book_link["p$i"]);
Dries's avatar
Dries committed
574
  }
575
  $mlids = $query->execute()->fetchCol();
576

Dries's avatar
Dries committed
577
  if ($mlids) {
578
    db_update('book')
579
      ->fields(array('bid' => $book_link['bid']))
580 581
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
582 583 584 585 586
  }
}

/**
 * Get the book menu tree for a page, and return it as a linear array.
587
 *
Dries's avatar
Dries committed
588 589
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
590
 * @return
Dries's avatar
Dries committed
591 592
 *   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
593
 *   element corresponding to $node. The children of $node (if any) will come
Dries's avatar
Dries committed
594
 *   immediately after it in the array.
595
 */
Dries's avatar
Dries committed
596
function book_get_flat_menu($book_link) {
597
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
598 599

  if (!isset($flat[$book_link['mlid']])) {
600
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
Dries's avatar
Dries committed
601 602 603
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link);
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
 
Dries committed
604
  }
605

Dries's avatar
Dries committed
606
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
607 608
}

609
/**
Dries's avatar
Dries committed
610
 * Recursive helper function for book_get_flat_menu().
611
 */
Dries's avatar
Dries committed
612 613 614 615 616 617 618 619
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
620
  }
Dries's avatar
Dries committed
621
}
Dries's avatar
 
Dries committed
622

Dries's avatar
Dries committed
623 624 625 626 627 628 629
/**
 * 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
630
  }
Dries's avatar
Dries committed
631 632 633 634 635 636 637 638 639 640 641 642
  $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.
643 644
      $tree = book_menu_subtree_data($prev);
      $data = array_shift($tree);
Dries's avatar
Dries committed
645 646 647 648
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
649

Dries's avatar
Dries committed
650 651 652 653 654
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
655 656 657
  }
}

658
/**
Dries's avatar
Dries committed
659
 * Fetches the menu link for the next page of the book.
660
 */
Dries's avatar
Dries committed
661 662 663 664 665
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);
666 667 668
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
669 670
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
671
  }
Dries's avatar
Dries committed
672
}
Dries's avatar
 
Dries committed
673

Dries's avatar
Dries committed
674 675 676 677 678
/**
 * Format the menu links for the child pages of the current page.
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
679

Dries's avatar
Dries committed
680 681 682 683 684 685
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
686 687
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
688 689 690 691 692
    // 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
693 694
    }
  }
695

Dries's avatar
Dries committed
696
  return $children ? menu_tree_output($children) : '';
Dries's avatar
 
Dries committed
697 698
}

699
/**
Dries's avatar
Dries committed
700
 * Generate the corresponding menu name from a book ID.
701
 */
Dries's avatar
Dries committed
702
function book_menu_name($bid) {
703
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
704 705
}

706
/**
707
 * Implement hook_node_load().
708
 */
709
function book_node_load($nodes, $types) {
710
  $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));
711 712 713 714 715
  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']);
716 717
  }
}
718

719
/**
720
 * Implement hook_node_view().
721
 */
722 723 724
function book_node_view($node, $build_mode) {
  if ($build_mode == 'full') {
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
725 726 727 728 729 730
      $node->content['book_navigation'] = array(
        '#markup' => theme('book_navigation', $node->book),
        '#weight' => 100,
      );
    }
  }
Dries's avatar
Dries committed
731

732 733
  if ($build_mode != 'rss') {
    book_node_view_link($node, $build_mode);
734
  }
735 736 737
}

/**
738
 * Implement hook_page_alter().
739 740 741 742 743 744 745 746 747 748
 *
 * 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);
  }
749
}
750

751
/**
752
 * Implement hook_node_presave().
753
 */
754
function book_node_presave($node) {
755 756 757
  // Always save a revision for non-administrators.
  if (!empty($node->book['bid']) && !user_access('administer nodes')) {
    $node->revision = 1;
758 759 760 761
    // The database schema requires a log message for every revision.
    if (!isset($node->log)) {
      $node->log = '';
    }
762 763 764 765 766 767
  }
  // Make sure a new node gets a new menu link.
  if (empty($node->nid)) {
    $node->book['mlid'] = NULL;
  }
}
768

769
/**
770
 * Implement hook_node_insert().
771
 */
772
function book_node_insert($node) {
773 774 775 776 777 778 779 780 781 782
  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);
  }
}
783

784
/**
785
 * Implement hook_node_update().
786
 */
787
function book_node_update($node) {
788 789 790 791 792 793 794 795 796 797
  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);
  }
}
798

799
/**
800
 * Implement hook_node_delete().
801
 */
802
function book_node_delete($node) {
803 804 805
  if (!empty($node->book['bid'])) {
    if ($node->nid == $node->book['bid']) {
      // Handle deletion of a top-level post.
806 807 808 809 810
      $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);
811 812
        $child_node->book['bid'] = $child_node->nid;
        _book_update_outline($child_node);
Dries's avatar
Dries committed
813
      }
814 815
    }
    menu_link_delete($node->book['mlid']);
816 817 818
    db_delete('book')
      ->condition('mlid', $node->book['mlid'])
      ->execute();
819 820 821 822
  }
}

/**
823
 * Implement hook_node_prepare().
824
 */
825
function book_node_prepare($node) {
826 827 828 829 830 831 832 833 834 835 836 837
  // 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'];
838
      }
839 840 841 842 843 844 845 846 847 848 849 850
    }
    // Set defaults.
    $node->book += _book_link_defaults(!empty($node->nid) ? $node->nid : 'new');
  }
  else {
    if (isset($node->book['bid']) && !isset($node->book['original_bid'])) {
      $node->book['original_bid'] = $node->book['bid'];
    }
  }
  // Find the depth limit for the parent select.
  if (isset($node->book['bid']) && !isset($node->book['parent_depth_limit'])) {
    $node->book['parent_depth_limit'] = _book_parent_depth_limit($node->book);
Dries's avatar
Dries committed
851 852 853
  }
}

854 855 856 857 858 859 860
/**
 * Find the depth limit for items in the parent select.
 */
function _book_parent_depth_limit($book_link) {
  return MENU_MAX_DEPTH - 1 - (($book_link['mlid'] && $book_link['has_children']) ? menu_link_children_relative_depth($book_link) : 0);
}

Dries's avatar
Dries committed
861 862 863 864 865 866 867 868
/**
 * Form altering function for the confirm form for a single node deletion.
 */
function book_form_node_delete_confirm_alter(&$form, $form_state) {
  $node = node_load($form['nid']['#value']);

  if (isset($node->book) && $node->book['has_children']) {
    $form['book_warning'] = array(
869
      '#markup' => '<p>' . t('%title is part of a book outline, and has associated child pages. If you proceed with deletion, the child pages will be relocated automatically.', array('%title' => $node->title)) . '</p>',
Dries's avatar
Dries committed
870 871
      '#weight' => -10,
    );
Dries's avatar
 
Dries committed
872
  }
Dries's avatar
 
Dries committed
873
}
Dries's avatar
 
Dries committed
874

875
/**
Dries's avatar
Dries committed
876 877 878 879 880 881 882
 * Return an array with default values for a book link.
 */
function _book_link_defaults($nid) {
  return array('original_bid' => 0, 'menu_name' => '', 'nid' => $nid, 'bid' => 0, 'router_path' => 'node/%', 'plid' => 0, 'mlid' => 0, 'has_children' => 0, 'weight' => 0, 'module' => 'book', 'options' => array());
}

/**
883
 * Process variables for book-navigation.tpl.php.
Dries's avatar
Dries committed
884
 *
885 886
 * The $variables array contains the following arguments:
 * - $book_link
887
 *
888
 * @see book-navigation.tpl.php
889
 */
890 891 892 893 894 895
function template_preprocess_book_navigation(&$variables) {
  $book_link = $variables['book_link'];

  // Provide extra variables for themers. Not needed by default.
  $variables['book_id'] = $book_link['bid'];
  $variables['book_title'] = check_plain($book_link['link_title']);
896
  $variables['book_url'] = 'node/' . $book_link['bid'];
897 898
  $variables['current_depth'] = $book_link['depth'];
  $variables['tree'] = '';
899

Dries's avatar
Dries committed
900
  if ($book_link['mlid']) {
901
    $variables['tree'] = book_children($book_link);
Dries's avatar
 
Dries committed
902

Dries's avatar
Dries committed
903
    if ($prev = book_prev($book_link)) {
904 905 906 907
      $prev_href = url($prev['href']);
      drupal_add_link(array('rel' => 'prev', 'href' => $prev_href));
      $variables['prev_url'] = $prev_href;
      $variables['prev_title'] = check_plain($prev['title']);
Dries's avatar
 
Dries committed
908
    }
909

Dries's avatar
Dries committed
910
    if ($book_link['plid'] && $parent = book_link_load($book_link['plid'])) {
911 912 913 914
      $parent_href = url($parent['href']);
      drupal_add_link(array('rel' => 'up', 'href' => $parent_href));
      $variables['parent_url'] = $parent_href;
      $variables['parent_title'] = check_plain($parent['title']);
Dries's avatar
 
Dries committed
915
    }
916

Dries's avatar
Dries committed
917
    if ($next = book_next($book_link)) {
918 919 920 921
      $next_href = url($next['href']);
      drupal_add_link(array('rel' => 'next', 'href' => $next_href));
      $variables['next_url'] = $next_href;
      $variables['next_title'] = check_plain($next['title']);
Dries's avatar
 
Dries committed
922
    }
923
  }
Dries's avatar
 
Dries committed
924

925 926 927 928 929 930 931 932 933 934 935
  $variables['has_links'] = FALSE;
  // Link variables to filter for values and set state of the flag variable.
  $links = array('prev_url', 'prev_title', 'parent_url', 'parent_title', 'next_url', 'next_title');
  foreach ($links as $link) {
    if (isset($variables[$link])) {
      // Flag when there is a value.
      $variables['has_links'] = TRUE;
    }
    else {
      // Set empty to prevent notices.
      $variables[$link] = '';
936
    }
Dries's avatar
 
Dries committed
937
  }
Dries's avatar
 
Dries committed
938
}
Dries's avatar
 
Dries committed
939

940
/**
Dries's avatar
Dries committed
941
 * A recursive helper function for book_toc().
942
 */