book.module 38 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
Dries's avatar
Dries committed
6
 * Allows users to structure the pages of a site in a hierarchy or outline.
Dries's avatar
 
Dries committed
7 8
 */

9 10 11 12 13 14
/**
 * Implementation of hook_theme()
 */
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 41
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
42
function book_perm() {
Dries's avatar
Dries committed
43
  return array('add content to books', 'administer book outlines', 'create new books', 'access printer-friendly version');
Dries's avatar
 
Dries committed
44 45
}

Dries's avatar
 
Dries committed
46 47 48
/**
 * Implementation of hook_link().
 */
49
function book_link($type, $node = NULL, $teaser = FALSE) {
Dries's avatar
 
Dries committed
50 51
  $links = array();

Dries's avatar
Dries committed
52
  if ($type == 'node' && isset($node->book)) {
53
    if (!$teaser) {
Dries's avatar
Dries committed
54 55
      $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) {
56
        $links['book_add_child'] = array(
57
          'title' => t('Add child page'),
Dries's avatar
Dries committed
58 59
          'href' => "node/add/". str_replace('_', '-', $child_type),
          'query' => "parent=". $node->book['mlid'],
60
        );
Dries's avatar
 
Dries committed
61
      }
Dries's avatar
Dries committed
62
      if (user_access('access printer-friendly version')) {
63
        $links['book_printer'] = array(
64
          'title' => t('Printer-friendly version'),
65 66
          'href' => 'book/export/html/'. $node->nid,
          'attributes' => array('title' => t('Show a printer-friendly version of this book page and its sub-pages.'))
67
        );
68
      }
Dries's avatar
 
Dries committed
69
    }
Dries's avatar
 
Dries committed
70
  }
Dries's avatar
 
Dries committed
71
  return $links;
Dries's avatar
 
Dries committed
72 73
}

Dries's avatar
 
Dries committed
74 75 76
/**
 * Implementation of hook_menu().
 */
77 78
function book_menu() {
  $items['admin/content/book'] = array(
79
    'title' => 'Books',
Dries's avatar
Dries committed
80 81 82
    'description' => "Manage your site's book outlines.",
    'page callback' => 'book_admin_overview',
    'access arguments' => array('administer book outlines'),
83
    'file' => 'book.admin.inc',
84 85
  );
  $items['admin/content/book/list'] = array(
86
    'title' => 'List',
87 88
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
Dries's avatar
Dries committed
89 90
  $items['admin/content/book/settings'] = array(
    'title' => 'Settings',
91
    'page callback' => 'drupal_get_form',
Dries's avatar
Dries committed
92 93
    'page arguments' => array('book_admin_settings'),
    'access arguments' => array('administer site configuration'),
94 95
    'type' => MENU_LOCAL_TASK,
    'weight' => 8,
96
    'file' => 'book.admin.inc',
97
  );
Dries's avatar
Dries committed
98 99 100 101 102 103 104
  $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,
105
    'file' => 'book.admin.inc',
Dries's avatar
Dries committed
106
  );
107
  $items['book'] = array(
108
    'title' => 'Books',
109 110 111
    'page callback' => 'book_render',
    'access arguments' => array('access content'),
    'type' => MENU_SUGGESTED_ITEM,
112
    'file' => 'book.pages.inc',
113 114 115 116
  );
  $items['book/export/%/%'] = array(
    'page callback' => 'book_export',
    'page arguments' => array(2, 3),
Dries's avatar
Dries committed
117
    'access arguments' => array('access printer-friendly version'),
118
    'type' => MENU_CALLBACK,
119
    'file' => 'book.pages.inc',
120
  );
121
  $items['node/%node/outline'] = array(
122
    'title' => 'Outline',
Dries's avatar
Dries committed
123 124
    'page callback' => 'book_outline',
    'page arguments' => array(1),
125 126 127 128
    'access callback' => '_book_outline_access',
    'access arguments' => array(1),
    'type' => MENU_LOCAL_TASK,
    'weight' => 2,
129
    'file' => 'book.pages.inc',
130
  );
Dries's avatar
Dries committed
131 132 133 134 135 136 137
  $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,
138
    'file' => 'book.pages.inc',
Dries's avatar
Dries committed
139
  );
140
  $items['book/js/form'] = array(
Dries's avatar
Dries committed
141 142 143
    'page callback' => 'book_form_update',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
144
    'file' => 'book.pages.inc',
Dries's avatar
Dries committed
145
  );
Dries's avatar
 
Dries committed
146 147 148
  return $items;
}

Dries's avatar
Dries committed
149 150 151
/**
 * Menu item access callback - determine if the outline tab is accessible.
 */
152
function _book_outline_access($node) {
Dries's avatar
Dries committed
153 154 155 156 157 158 159 160
  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);
161 162
}

Dries's avatar
Dries committed
163 164 165
/**
 * Implementation of hook_init(). Add's the book module's CSS.
 */
166 167 168 169
function book_init() {
  drupal_add_css(drupal_get_path('module', 'book') .'/book.css');
}

170 171 172
/**
 * Implementation of hook_block().
 *
Dries's avatar
 
Dries committed
173 174
 * Displays the book table of contents in a block when the current page is a
 * single-node view of a book node.
175
 */
Dries's avatar
Dries committed
176
function book_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
 
Dries committed
177
  $block = array();
Dries's avatar
Dries committed
178 179 180
  switch ($op) {
    case 'list':
      $block[0]['info'] = t('Book navigation');
181
      $block[0]['cache'] = BLOCK_CACHE_PER_PAGE | BLOCK_CACHE_PER_ROLE;
Dries's avatar
Dries committed
182 183
      return $block;
    case 'view':
184 185 186
      $current_bid = 0;
      if ($node = menu_get_object()) {
        $current_bid = empty($node->book['bid']) ? 0 : $node->book['bid'];
187
      }
188
      if (variable_get('book_block_mode', 'all pages') == 'all pages') {
Dries's avatar
Dries committed
189 190
        $block['subject'] = t('Book navigation');
        $book_menus = array();
191
        $pseudo_tree = array(0 => array('below' => FALSE));
192
        foreach (book_get_books() as $book_id => $book) {
193 194 195
          if ($book['bid'] == $current_bid) {
            // If the current page is a node associated with a book, the menu
            // needs to be retrieved.
196
            $book_menus[$book_id] = menu_tree_output(menu_tree_all_data($node->book['menu_name'], $node->book));
197 198 199 200 201 202
          }
          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;
203
            $book_menus[$book_id] = menu_tree_output($pseudo_tree);
204
          }
Dries's avatar
 
Dries committed
205
        }
Dries's avatar
Dries committed
206
        $block['content'] = theme('book_all_books_block', $book_menus);
Dries's avatar
 
Dries committed
207
      }
208
      elseif ($current_bid) {
Dries's avatar
Dries committed
209
        // Only display this block when the user is browsing a book.
210 211 212 213 214 215 216 217
        $title = db_result(db_query(db_rewrite_sql('SELECT n.title FROM {node} n WHERE n.nid = %d'), $node->book['bid']));
        // 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']) : '';
Dries's avatar
Dries committed
218 219 220 221 222 223 224 225 226 227 228 229 230
        }
      }
      return $block;
    case 'configure':
      $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'),
231
        '#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."),
Dries's avatar
Dries committed
232 233 234 235 236 237 238
        );
      return $form;
    case 'save':
      variable_set('book_block_mode', $edit['book_block_mode']);
      break;
  }
}
Dries's avatar
 
Dries committed
239

240
/**
Dries's avatar
Dries committed
241 242 243
 * Generate the HTML output for a link to a book title when used as a block title.
 *
 * @ingroup themeable
244
 */
Dries's avatar
Dries committed
245 246 247
function theme_book_title_link($link) {
  $link['options']['attributes']['class'] =  'book-title';
  return l($link['title'], $link['href'], $link['options']);
Dries's avatar
 
Dries committed
248
}
Dries's avatar
 
Dries committed
249

250
/**
Dries's avatar
Dries committed
251 252 253 254
 * 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.
255
 */
Dries's avatar
Dries committed
256 257 258 259 260 261 262 263 264 265 266
function book_get_books() {
  static $all_books;

  if (!isset($all_books)) {
    $all_books = array();
    $result = db_query("SELECT DISTINCT(bid) FROM {book}");
    $nids = array();
    while ($book = db_fetch_array($result)) {
      $nids[] = $book['bid'];
    }
    if ($nids) {
267
      $result2 = db_query(db_rewrite_sql("SELECT n.type, n.title, b.*, ml.* FROM {book} b INNER JOIN {node} n on b.nid = n.nid INNER JOIN {menu_links} ml ON b.mlid = ml.mlid WHERE n.nid IN (". implode(',', $nids) .") AND n.status = 1 ORDER BY ml.weight, ml.link_title"));
Dries's avatar
Dries committed
268 269 270
      while ($link = db_fetch_array($result2)) {
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
271
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
272 273
      }
    }
274
  }
Dries's avatar
Dries committed
275
  return $all_books;
276
}
277

Dries's avatar
Dries committed
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
/**
 * Implementation of hook_form_alter(). Adds the book fieldset to the node form.
 *
 * @see book_pick_book_submit()
 * @see book_submit()
 */
function book_form_alter(&$form, $form_state, $form_id) {

  if (isset($form['type']) && isset($form['#node']) && $form['type']['#value'] .'_node_form' == $form_id) {
    // Add elements to the node form
    $node = $form['#node'];

    $access = user_access('administer book outlines');
    if (!$access) {
      if (user_access('add content to books') && ((!empty($node->book['mlid']) && !empty($node->nid)) || book_type_is_allowed($node->type))) {
        // Already in the book hierarchy or this node type is allowed
        $access = TRUE;
      }
    }

    if ($access) {
      _book_add_form_elements($form, $node);
      $form['book']['pick-book'] = array(
        '#type' => 'submit',
        '#value' => t('Change book (update list of parents)'),
303 304 305 306 307 308
         // Submit the node form so the parent select options get updated.
         // This is typically only used when JS is disabled.  Since the parent options
         // 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
         // selected book.  This is similar to what happens during a node preview.
        '#submit' => array('node_form_submit_build_node'),
Dries's avatar
Dries committed
309 310 311
        '#weight' => 20,
      );
    }
312
  }
Dries's avatar
Dries committed
313
}
314

Dries's avatar
Dries committed
315 316 317 318 319 320 321 322
/**
 * Build the parent selection form element for the node form or outline tab
 *
 * 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) {
323 324 325
  if (variable_get('menu_override_parent_selector', FALSE)) {
    return array();
  }
Dries's avatar
Dries committed
326 327 328 329 330 331 332
  // 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>',
  );
333

Dries's avatar
Dries committed
334 335 336 337 338 339 340 341 342 343 344
  if ($book_link['nid'] === $book_link['bid']) {
    // This is a book - at the top level.
    if ($book_link['original_bid'] === $book_link['bid']) {
      $form['#prefix'] .= '<em>'. t('This is the top-level page in this book.') .'</em>';
    }
    else {
      $form['#prefix'] .= '<em>'. t('This will be the top-level page in this book.') .'</em>';
    }
  }
  elseif (!$book_link['bid']) {
    $form['#prefix'] .= '<em>'. t('No book selected.') .'</em>';
345 346
  }
  else {
Dries's avatar
Dries committed
347 348 349 350
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
351
      '#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)),
352
      '#options' => book_toc($book_link['bid'], array($book_link['mlid']), $book_link['parent_depth_limit']),
353
      '#attributes' => array('class' => 'book-title-select'),
354
    );
Dries's avatar
 
Dries committed
355
  }
356
  return $form;
Dries's avatar
 
Dries committed
357 358
}

359
/**
Dries's avatar
Dries committed
360
 * Build the common elements of the book form for the node and outline forms.
361
 */
Dries's avatar
Dries committed
362 363 364
function _book_add_form_elements(&$form, $node) {
  // Need this for AJAX.
  $form['#cache'] = TRUE;
365
  drupal_add_js("if (Drupal.jsEnabled) { $(document).ready(function() { $('#edit-book-pick-book').css('display', 'none'); }); }", 'inline');
Dries's avatar
Dries committed
366 367 368 369 370 371 372 373

  $form['book'] = array(
    '#type' => 'fieldset',
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#tree' => TRUE,
374
    '#attributes' => array('class' => 'book-outline-form'),
375
  );
376
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
377 378 379 380 381 382 383 384 385 386
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

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

  $form['book']['weight'] = array(
    '#type' => 'weight',
387
    '#title' => t('Weight'),
Dries's avatar
Dries committed
388
    '#default_value' => $node->book['weight'],
389
    '#delta' => 15,
Dries's avatar
Dries committed
390
    '#weight' => 5,
391 392
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
393 394
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
395

396
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
397 398 399 400 401 402 403 404 405
    // 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
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
  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.
    $options = array($nid => '<'. t('create a new book') .'>') + $options;
  }
  if (!$node->book['mlid']) {
    // The node is not currently in a the hierarchy.
    $options = array(0 => '<'. t('none') .'>') + $options;
  }

  // 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,
424
    '#attributes' => array('class' => 'book-title-select'),
425 426 427 428 429
    '#ahah' => array(
      'path' => 'book/js/form',
      'wrapper' => 'edit-book-plid-wrapper',
      'effect' => 'slide',
    ),
430
  );
Dries's avatar
Dries committed
431
}
Dries's avatar
 
Dries committed
432

433
/**
Dries's avatar
Dries committed
434
 * Common helper function to handles additions and updates to the book outline.
Dries's avatar
Dries committed
435
 *
Dries's avatar
Dries committed
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
 * Performs all additions and updates to the book outline through node addition,
 * node editing, node deletion, or the outline tab.
 */
function _book_update_outline(&$node) {
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

  $node->book['link_path'] = 'node/'. $node->nid;
  $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'])) {
      $parent = db_fetch_array(db_query("SELECT * FROM {book} WHERE mlid = %d", $node->book['plid']));
    }
    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {
      $node->book['plid'] = db_result(db_query("SELECT mlid FROM {book} WHERE nid = %d", $node->book['bid']));
      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.
    }
  }
  if (menu_link_save($node->book)) {
    if ($new) {
      // Insert new.
      db_query("INSERT INTO {book} (nid, mlid, bid) VALUES (%d, %d, %d)", $node->nid, $node->book['mlid'], $node->book['bid']);
    }
    else {
      if ($node->book['bid'] != db_result(db_query("SELECT bid FROM {book} WHERE nid = %d", $node->nid))) {
        // Update the bid for this page and all children.
        book_update_bid($node->book);
      }
    }
    return TRUE;
  }
  // Failed to save the menu link
  return FALSE;
}

480
/**
Dries's avatar
Dries committed
481
 * Update the bid for a page and its children when it is moved to a new book.
482
 *
Dries's avatar
Dries committed
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 */
function book_update_bid($book_link) {

  for ($i = 1; $i <= MENU_MAX_DEPTH && $book_link["p$i"]; $i++) {
    $match[] = "p$i = %d";
    $args[] = $book_link["p$i"];
  }
  $result = db_query("SELECT mlid FROM {menu_links} WHERE ". implode(' AND ', $match), $args);

  $mlids = array();
  while ($a = db_fetch_array($result)) {
    $mlids[] = $a['mlid'];
  }
  if ($mlids) {
    db_query("UPDATE {book} SET bid = %d WHERE mlid IN (". implode(',', $mlids) .")", $book_link['bid']);
  }
}

/**
 * Get the book menu tree for a page, and return it as a linear array.
505
 *
Dries's avatar
Dries committed
506 507
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
508
 * @return
Dries's avatar
Dries committed
509 510 511 512
 *   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
 *   element corresponding to $node.  The children of $node (if any) will come
 *   immediately after it in the array.
513
 */
Dries's avatar
Dries committed
514 515 516 517 518 519 520 521
function book_get_flat_menu($book_link) {
  static $flat = array();

  if (!isset($flat[$book_link['mlid']])) {
    // Call menu_tree_full_data() to take advantage of the menu system's caching.
    $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
522
  }
Dries's avatar
Dries committed
523
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
524 525
}

526
/**
Dries's avatar
Dries committed
527
 * Recursive helper function for book_get_flat_menu().
528
 */
Dries's avatar
Dries committed
529 530 531 532 533 534 535 536
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
537
  }
Dries's avatar
Dries committed
538
}
Dries's avatar
 
Dries committed
539

Dries's avatar
Dries committed
540 541 542 543 544 545 546
/**
 * 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
547
  }
Dries's avatar
Dries committed
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
  $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.
      $data = array_shift(book_menu_subtree_data($prev));
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
570 571 572
  }
}

573
/**
Dries's avatar
Dries committed
574
 * Fetches the menu link for the next page of the book.
575
 */
Dries's avatar
Dries committed
576 577 578 579 580 581 582 583
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);
  } while ($key && $key != $book_link['mlid']);
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
584
  }
Dries's avatar
Dries committed
585
}
Dries's avatar
 
Dries committed
586

Dries's avatar
Dries committed
587 588 589 590 591
/**
 * Format the menu links for the child pages of the current page.
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
592

Dries's avatar
Dries committed
593 594 595 596 597 598 599 600 601 602 603 604
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
    } while ($link && ($link['mlid'] != $book_link['mlid']));
    // 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
605 606
    }
  }
Dries's avatar
Dries committed
607
  return $children ? menu_tree_output($children) : '';
Dries's avatar
 
Dries committed
608 609
}

610
/**
Dries's avatar
Dries committed
611
 * Generate the corresponding menu name from a book ID.
612
 */
Dries's avatar
Dries committed
613 614 615 616 617 618 619 620 621 622 623 624
function book_menu_name($bid) {
  return 'book-toc-'. $bid;
}

/**
 * Build an active trail to show in the breadcrumb.
 */
function book_build_active_trail($book_link) {
  static $trail;

  if (!isset($trail)) {
    $trail = array();
625
    $trail[] = array('title' => t('Home'), 'href' => '<front>', 'localized_options' => array());
Dries's avatar
Dries committed
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644

    $tree = menu_tree_all_data($book_link['menu_name'], $book_link);
    $curr = array_shift($tree);

    while ($curr) {
      if ($curr['link']['href'] == $book_link['href']) {
        $trail[] = $curr['link'];
        $curr = FALSE;
      }
      else {
        if ($curr['below'] && $curr['link']['in_active_trail']) {
          $trail[] = $curr['link'];
          $tree = $curr['below'];
        }
        $curr = array_shift($tree);
      }
    }
  }
  return $trail;
Dries's avatar
 
Dries committed
645 646
}

647
/**
Dries's avatar
 
Dries committed
648 649
 * Implementation of hook_nodeapi().
 *
Dries's avatar
Dries committed
650 651
 * Appends book navigation to all nodes in the book, and handles book outline
 * insertions and updates via the node form.
652
 */
Dries's avatar
 
Dries committed
653 654
function book_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
655
    case 'load':
Dries's avatar
Dries committed
656 657 658 659 660 661 662 663
      // Note - we cannot use book_link_load() because it will call node_load()
      $info['book'] = db_fetch_array(db_query('SELECT * FROM {book} b INNER JOIN {menu_links} ml ON b.mlid = ml.mlid WHERE b.nid = %d', $node->nid));
      if ($info['book']) {
        $info['book']['href'] = $info['book']['link_path'];
        $info['book']['title'] = $info['book']['link_title'];
        $info['book']['options'] = unserialize($info['book']['options']);
        return $info;
      }
664
      break;
Dries's avatar
 
Dries committed
665
    case 'view':
Dries's avatar
Dries committed
666 667
    if (!$teaser) {
        if (!empty($node->book['bid']) && $node->build_mode == NODE_BUILD_NORMAL) {
668

669
          $node->content['book_navigation'] = array(
Dries's avatar
Dries committed
670
            '#value' => theme('book_navigation', $node->book),
671 672
            '#weight' => 100,
          );
673

674
          if ($page) {
Dries's avatar
Dries committed
675 676
            menu_set_active_trail(book_build_active_trail($node->book));
            menu_set_active_menu_name($node->book['menu_name']);
677
          }
Dries's avatar
 
Dries committed
678
        }
Dries's avatar
 
Dries committed
679
      }
Dries's avatar
 
Dries committed
680
      break;
Dries's avatar
Dries committed
681 682 683 684 685
    case 'presave':
      // Always save a revision for non-administrators.
      if (!empty($node->book['bid']) && !user_access('administer nodes')) {
        $node->revision = 1;
      }
686 687 688 689
      // Make sure a new node gets a new menu link.
      if (empty($node->nid)) {
        $node->book['mlid'] = NULL;
      }
Dries's avatar
Dries committed
690 691
      break;
    case 'insert':
692
    case 'update':
Dries's avatar
Dries committed
693 694 695 696
      if (!empty($node->book['bid'])) {
        if ($node->book['bid'] == 'new') {
          // New nodes that are their own book.
          $node->book['bid'] = $node->nid;
697
        }
Dries's avatar
Dries committed
698 699 700
        $node->book['nid'] = $node->nid;
        $node->book['menu_name'] = book_menu_name($node->book['bid']);
        _book_update_outline($node);
701 702
      }
      break;
703
    case 'delete':
Dries's avatar
Dries committed
704 705 706 707 708 709 710 711 712 713 714 715 716
      if (!empty($node->book['bid'])) {
        if ($node->nid == $node->book['bid']) {
          // Handle deletion of a top-level post.
          $result = db_query("SELECT b.nid FROM {menu_links} ml INNER JOIN {book} b on b.mlid = ml.mlid WHERE ml.plid = %d", $node->book['mlid']);
          while ($child = db_fetch_array($result)) {
            $child_node = node_load($child['nid']);
            $child_node->book['bid'] = $child_node->nid;
            _book_update_outline($child_node);
          }
        }
        menu_link_delete($node->book['mlid']);
        db_query('DELETE FROM {book} WHERE mlid = %d', $node->book['mlid']);
      }
717
      break;
Dries's avatar
Dries committed
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
    case 'prepare':
      // 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'];
          }
        }
        // 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'];
        }
      }
739 740 741 742
      // 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
743 744 745 746
      break;
  }
}

747 748 749 750 751 752 753
/**
 * 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
754 755 756 757 758 759 760 761 762 763 764 765
/**
 * 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(
      '#value' => '<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>',
      '#weight' => -10,
    );
Dries's avatar
 
Dries committed
766
  }
Dries's avatar
 
Dries committed
767
}
Dries's avatar
 
Dries committed
768

769
/**
Dries's avatar
Dries committed
770 771 772 773 774 775 776
 * 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());
}

/**
777
 * Process variables for book-navigation.tpl.php.
Dries's avatar
Dries committed
778
 *
779 780
 * The $variables array contains the following arguments:
 * - $book_link
781
 *
782
 * @see book-navigation.tpl.php
783
 */
784 785 786 787 788 789 790 791
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']);
  $variables['book_url'] = 'node/'. $book_link['bid'];
  $variables['current_depth'] = $book_link['depth'];
792

793
  $variables['tree'] = '';
Dries's avatar
Dries committed
794
  if ($book_link['mlid']) {
795
    $variables['tree'] = book_children($book_link);
Dries's avatar
 
Dries committed
796

Dries's avatar
Dries committed
797
    if ($prev = book_prev($book_link)) {
798 799 800 801
      $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
802
    }
Dries's avatar
Dries committed
803
    if ($book_link['plid'] && $parent = book_link_load($book_link['plid'])) {
804 805 806 807
      $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
808
    }
Dries's avatar
Dries committed
809
    if ($next = book_next($book_link)) {
810 811 812 813
      $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
814
    }
815
  }
Dries's avatar
 
Dries committed
816

817 818 819 820 821 822 823 824 825 826 827
  $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] = '';
828
    }
Dries's avatar
 
Dries committed
829
  }
Dries's avatar
 
Dries committed
830
}
Dries's avatar
 
Dries committed
831

832
/**
Dries's avatar
Dries committed
833
 * A recursive helper function for book_toc().
834
 */
835
function _book_toc_recurse($tree, $indent, &$toc, $exclude, $depth_limit) {
Dries's avatar
Dries committed
836
  foreach ($tree as $data) {
837 838 839 840
    if ($data['link']['depth'] > $depth_limit) {
      // Don't iterate through any links on this level.
      break;
    }
Dries's avatar
Dries committed
841 842
    if (!in_array($data['link']['mlid'], $exclude)) {
      $toc[$data['link']['mlid']] = $indent .' '. truncate_utf8($data['link']['title'], 30, TRUE, TRUE);
843 844
      if ($data['below']) {
        _book_toc_recurse($data['below'], $indent .'--', $toc, $exclude, $depth_limit);
845
      }
Dries's avatar
 
Dries committed
846 847 848 849
    }
  }
}

850
/**
Dries's avatar
Dries committed
851 852 853 854 855 856 857
 * Returns an array of book pages in table of contents order.
 *
 * @param $bid
 *   The ID of the book whose pages are to be listed.
 * @param $exclude
 *   Optional array of mlid values.  Any link whose mlid is in this array
 *   will be excluded (along with its children).
858 859
 * @param $depth_limit
 *   Any link deeper than this value will be excluded (along with its children).
Dries's avatar
Dries committed
860 861
 * @return
 *   An array of mlid, title pairs for use as options for selecting a book page.
862
 */
863
function book_toc($bid, $exclude = array(), $depth_limit) {
Dries's avatar
 
Dries committed
864

Dries's avatar
Dries committed
865
  $tree = menu_tree_all_data(book_menu_name($bid));
866
  $toc = array();
867
  _book_toc_recurse($tree, '', $toc, $exclude, $depth_limit);
Dries's avatar
 
Dries committed
868

Dries's avatar
 
Dries committed
869 870 871
  return $toc;
}

872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
/**
 * Process variables for book-export-html.tpl.php.
 *
 * The $variables array contains the following arguments:
 * - $title
 * - $contents
 * - $depth
 *
 * @see book-export-html.tpl.php
 */
function template_preprocess_book_export_html(&$variables) {
  global $base_url, $language;

  $variables['title'] = check_plain($variables['title']);
  $variables['base_url'] = $base_url;
  $variables['language'] = $language;
  $variables['language_rtl'] = (defined('LANGUAGE_RTL') && $language->direction == LANGUAGE_RTL) ? TRUE : FALSE;
  $variables['head'] = drupal_get_html_head();
}

892
/**
Dries's avatar
Dries committed
893
 * Traverse the book tree to build printable or exportable output.
894
 *
895
 * During the traversal, the $visit_func() callback is applied to each
Dries's avatar
Dries committed
896
 * node, and is called recursively for each child of the node (in weight,
897
 * title order).
898
 *
Dries's avatar
Dries committed
899 900
 * @param $tree
 *   A subtree of the book menu hierarchy, rooted at the current page.
901
 * @param $visit_func
Dries's avatar
Dries committed
902
 *   A function callback to be called upon visiting a node in the tree.
903
 * @return
Dries's avatar
Dries committed
904
 *   The output generated in visiting each node.
905
 */
906
function book_export_traverse($tree, $visit_func) {
907
  $output = '';
Dries's avatar
Dries committed
908 909 910

  foreach ($tree as $data) {
    // Note- access checking is already performed when building the tree.
911 912
    if ($node = node_load($data['link']['nid'], FALSE)) {
      $children = '';
Dries's avatar
Dries committed
913
      if ($data['below']) {
914
        $children = book_export_traverse($data['below'], $visit_func);
915
      }
Dries's avatar
Dries committed
916

917 918
      if (function_exists($visit_func)) {
        $output .= call_user_func($visit_func, $node, $children);
919
      }
920
      else {
Dries's avatar
Dries committed
921
        // Use the default function.
922
        $output .= book_node_export($node, $children);
923
      }
Dries's avatar
 
Dries committed
924
    }
Dries's avatar
 
Dries committed
925 926 927
  }
  return $output;
}
Dries's avatar
 
Dries committed
928

929
/**
Dries's avatar
Dries committed
930 931
 * Generates printer-friendly HTML for a node.
 *
932
 * @see book_export_traverse()
933 934
 *
 * @param $node
Dries's avatar
Dries committed
935
 *   The node to generate output for.
936 937
 * @param $children
 *   All the rendered child nodes within the current node.
938
 * @return
Dries's avatar
Dries committed
939
 *   The HTML generated for the given node.
940
 */
941
function book_node_export($node, $children = '') {
942

Dries's avatar
Dries committed
943 944
  $node->build_mode = NODE_BUILD_PRINT;
  $node = node_build_content($node, FALSE, FALSE);
945
  $node->body = drupal_render($node->content);
946

947
  return theme('book_node_export_html', $node, $children);
948 949 950
}

/**
951
 * Process variables for book-node-export-html.tpl.php.
Dries's avatar
Dries committed
952
 *
953 954 955
 * The $variables array contains the following arguments:
 * - $node
 * - $children
Dries's avatar
Dries committed
956
 *
957
 * @see book-node-export-html.tpl.php
958
 */
959 960 961 962
function template_preprocess_book_node_export_html(&$variables) {
  $variables['depth'] = $variables['node']->book['depth'];
  $variables['title'] = check_plain($variables['node']->title);
  $variables['content'] = $variables['node']->body;
963 964
}

965
/**
Dries's avatar
Dries committed
966
 * Determine if a given node type is in the list of types allowed for books.
967
 */
Dries's avatar
Dries committed
968 969
function book_type_is_allowed($type) {
  return in_array($type, variable_get('book_allowed_types', array('book')));
970 971
}

Dries's avatar
Dries committed
972 973 974 975 976 977 978 979
/**
 * Implementation of hook_node_type().
 *
 * Update book module's persistent variables if the machine-readable name of a
 * node type is changed.
 */
function book_node_type($op, $type) {

980
  switch ($op) {
Dries's avatar
Dries committed
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
    case 'update':
      if (!empty($type->old_type) && $type->old_type != $type->type) {
        // Update the list of node types that are allowed to be added to books.
        $allowed_types = variable_get('book_allowed_types', array('book'));
        $key = array_search($type->old_type, $allowed_types);
        if ($key !== FALSE) {
          $allowed_types[$type->type] = $allowed_types[$key] ? $type->type : 0;
          unset($allowed_types[$key]);
          variable_set('book_allowed_types', $allowed_types);
        }
        // Update the setting for the "Add child page" link.
        if (variable_get('book_child_type', 'book') == $type->old_type) {
          variable_set('book_child_type', $type->type);
        }
      }
      break;
  }
Dries's avatar
 
Dries committed
998 999
}

1000 1001 1002
/**
 * Implementation of hook_help().
 */
1003 1004
function book_help($path, $arg) {
  switch ($path) {
Dries's avatar
 
Dries committed
1005
    case 'admin/help#book':
1006
      $output = '<p>'. t('The book module is suited for creating structured, multi-page hypertexts such as site resource guides, manuals, and Frequently Asked Questions (FAQs). It permits a document to have chapters, sections, subsections, etc. Authors with suitable permissions can add pages to a collaborative book, placing them into the existing document by adding them to a table of contents menu.') .'</p>';
1007
      $output .= '<p>'. t('Pages in the book hierarchy have navigation elements at the bottom of the page for moving through the text. These links lead to the previous and next pages in the book, and to the level above the current page in the book\'s structure. More comprehensive navigation may be provided by enabling the <em>book navigation block</em> on the <a href="@admin-block">blocks administration page</a>.', array('@admin-block' => url('admin/build/block'))) .'</p>';
1008
      $output .= '<p>'. t('Users can select the <em>printer-friendly version</em> link visible at the bottom of a book page to generate a printer-friendly display of the page and all of its subsections. ') .'</p>';
1009 1010
      $output .= '<p>'. t("Users with the <em>administer book outlines</em> permission can add a post of any content type to a book, by selecting the appropriate book while editing the post or by using the interface available on the post's <em>outline</em> tab.") .'</p>';
      $output .= '<p>'. t('Administrators can view a list of all books on the <a href="@admin-node-book">book administration page</a>. The <em>Outline</em> page for each book allows section titles to be edited or rearranged.', array('@admin-node-book' => url('admin/content/book'))) .'</p>';
1011
      $output .= '<p>'. t('For more information, see the online handbook entry for <a href="@book">Book module</a>.', array('@book' => 'http://drupal.org/handbook/modules/book/')) .'</p>';
1012
      return $output;
1013
    case 'admin/content/book':
Gábor Hojtsy's avatar