book.module 38.1 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 17 18
    ),
    'book_export_html' => array(
      'arguments' => array('title' => NULL, 'content' => NULL),
19
      'file' => 'book.pages.inc',
20 21 22 23
    ),
    'book_admin_table' => array(
      'arguments' => array('form' => NULL),
    ),
Dries's avatar
Dries committed
24 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 35
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
36
function book_perm() {
Dries's avatar
Dries committed
37
  return array('add content to books', 'administer book outlines', 'create new books', 'access printer-friendly version');
Dries's avatar
 
Dries committed
38 39
}

Dries's avatar
 
Dries committed
40 41 42
/**
 * Implementation of hook_link().
 */
43
function book_link($type, $node = NULL, $teaser = FALSE) {
Dries's avatar
 
Dries committed
44 45
  $links = array();

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

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

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

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

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

Dries's avatar
Dries committed
242 243 244 245 246 247 248 249 250
/**
 * Generate the HTML output for the block showing all book menus.
 *
 * @ingroup themeable
 */
function theme_book_all_books_block($book_menus) {
  $output = '';
  foreach ($book_menus as $menu) {
    $output .= '<div class="book-block-menu">'. $menu ."</div>\n";
251
  }
Dries's avatar
Dries committed
252
  return $output;
Dries's avatar
 
Dries committed
253 254
}

255
/**
Dries's avatar
Dries committed
256 257 258
 * Generate the HTML output for a link to a book title when used as a block title.
 *
 * @ingroup themeable
259
 */
Dries's avatar
Dries committed
260 261 262
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
263
}
Dries's avatar
 
Dries committed
264

265
/**
Dries's avatar
Dries committed
266 267 268 269
 * 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.
270
 */
Dries's avatar
Dries committed
271 272 273 274 275 276 277 278 279 280 281
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) {
282
      $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
283 284 285 286 287 288
      while ($link = db_fetch_array($result2)) {
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
        $all_books[] = $link;
      }
    }
289
  }
Dries's avatar
Dries committed
290
  return $all_books;
291
}
292

Dries's avatar
Dries committed
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
/**
 * 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)'),
318 319 320 321 322 323
         // 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
324 325 326
        '#weight' => 20,
      );
    }
327
  }
Dries's avatar
Dries committed
328
}
329

Dries's avatar
Dries committed
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
/**
 * 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) {
  // 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>',
  );
345

Dries's avatar
Dries committed
346 347 348 349 350 351 352 353 354 355 356
  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>';
357 358
  }
  else {
Dries's avatar
Dries committed
359 360 361 362
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
363
      '#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)),
364
      '#options' => book_toc($book_link['bid'], array($book_link['mlid']), $book_link['parent_depth_limit']),
365
      '#attributes' => array('class' => 'book-title-select'),
366
    );
Dries's avatar
 
Dries committed
367
  }
368
  return $form;
Dries's avatar
 
Dries committed
369 370
}

371
/**
Dries's avatar
Dries committed
372
 * Build the common elements of the book form for the node and outline forms.
373
 */
Dries's avatar
Dries committed
374 375 376
function _book_add_form_elements(&$form, $node) {
  // Need this for AJAX.
  $form['#cache'] = TRUE;
377
  drupal_add_js("if (Drupal.jsEnabled) { $(document).ready(function() { $('#edit-book-pick-book').css('display', 'none'); }); }", 'inline');
Dries's avatar
Dries committed
378 379 380 381 382 383 384 385

  $form['book'] = array(
    '#type' => 'fieldset',
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#tree' => TRUE,
386
    '#attributes' => array('class' => 'book-outline-form'),
387
  );
388
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
389 390 391 392 393 394 395 396 397 398
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

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

  $form['book']['weight'] = array(
    '#type' => 'weight',
399
    '#title' => t('Weight'),
Dries's avatar
Dries committed
400
    '#default_value' => $node->book['weight'],
401
    '#delta' => 15,
Dries's avatar
Dries committed
402
    '#weight' => 5,
403 404
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
405 406
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
407

408
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
409 410 411 412 413 414 415 416 417
    // 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
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
  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,
436
    '#attributes' => array('class' => 'book-title-select'),
437 438 439 440 441
    '#ahah' => array(
      'path' => 'book/js/form',
      'wrapper' => 'edit-book-plid-wrapper',
      'effect' => 'slide',
    ),
442
  );
Dries's avatar
Dries committed
443
}
Dries's avatar
 
Dries committed
444

445
/**
Dries's avatar
Dries committed
446
 * Common helper function to handles additions and updates to the book outline.
Dries's avatar
Dries committed
447
 *
Dries's avatar
Dries committed
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 480 481 482 483 484 485 486 487 488 489 490 491
 * 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;
}

492
/**
Dries's avatar
Dries committed
493
 * Update the bid for a page and its children when it is moved to a new book.
494
 *
Dries's avatar
Dries committed
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
 * @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.
517
 *
Dries's avatar
Dries committed
518 519
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
520
 * @return
Dries's avatar
Dries committed
521 522 523 524
 *   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.
525
 */
Dries's avatar
Dries committed
526 527 528 529 530 531 532 533
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
534
  }
Dries's avatar
Dries committed
535
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
536 537
}

538
/**
Dries's avatar
Dries committed
539
 * Recursive helper function for book_get_flat_menu().
540
 */
Dries's avatar
Dries committed
541 542 543 544 545 546 547 548
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
549
  }
Dries's avatar
Dries committed
550
}
Dries's avatar
 
Dries committed
551

Dries's avatar
Dries committed
552 553 554 555 556 557 558
/**
 * 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
559
  }
Dries's avatar
Dries committed
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
  $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
582 583 584
  }
}

585
/**
Dries's avatar
Dries committed
586
 * Fetches the menu link for the next page of the book.
587
 */
Dries's avatar
Dries committed
588 589 590 591 592 593 594 595
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
596
  }
Dries's avatar
Dries committed
597
}
Dries's avatar
 
Dries committed
598

Dries's avatar
Dries committed
599 600 601 602 603
/**
 * Format the menu links for the child pages of the current page.
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
604

Dries's avatar
Dries committed
605 606 607 608 609 610 611 612 613 614 615 616
  $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
617 618
    }
  }
Dries's avatar
Dries committed
619
  return $children ? menu_tree_output($children) : '';
Dries's avatar
 
Dries committed
620 621
}

622
/**
Dries's avatar
Dries committed
623
 * Generate the corresponding menu name from a book ID.
624
 */
Dries's avatar
Dries committed
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
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();
    $trail[] = array('title' => t('Home'), 'href' => '<front>', 'options' => array());

    $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
657 658
}

659
/**
Dries's avatar
 
Dries committed
660 661
 * Implementation of hook_nodeapi().
 *
Dries's avatar
Dries committed
662 663
 * Appends book navigation to all nodes in the book, and handles book outline
 * insertions and updates via the node form.
664
 */
Dries's avatar
 
Dries committed
665 666
function book_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
667
    case 'load':
Dries's avatar
Dries committed
668 669 670 671 672 673 674 675
      // 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;
      }
676
      break;
Dries's avatar
 
Dries committed
677
    case 'view':
Dries's avatar
Dries committed
678 679
    if (!$teaser) {
        if (!empty($node->book['bid']) && $node->build_mode == NODE_BUILD_NORMAL) {
680

681
          $node->content['book_navigation'] = array(
Dries's avatar
Dries committed
682
            '#value' => theme('book_navigation', $node->book),
683 684
            '#weight' => 100,
          );
685

686
          if ($page) {
Dries's avatar
Dries committed
687 688
            menu_set_active_trail(book_build_active_trail($node->book));
            menu_set_active_menu_name($node->book['menu_name']);
689
          }
Dries's avatar
 
Dries committed
690
        }
Dries's avatar
 
Dries committed
691
      }
Dries's avatar
 
Dries committed
692
      break;
Dries's avatar
Dries committed
693 694 695 696 697 698 699
    case 'presave':
      // Always save a revision for non-administrators.
      if (!empty($node->book['bid']) && !user_access('administer nodes')) {
        $node->revision = 1;
      }
      break;
    case 'insert':
700
    case 'update':
Dries's avatar
Dries committed
701 702 703 704
      if (!empty($node->book['bid'])) {
        if ($node->book['bid'] == 'new') {
          // New nodes that are their own book.
          $node->book['bid'] = $node->nid;
705
        }
Dries's avatar
Dries committed
706 707 708
        $node->book['nid'] = $node->nid;
        $node->book['menu_name'] = book_menu_name($node->book['bid']);
        _book_update_outline($node);
709 710
      }
      break;
711
    case 'delete':
Dries's avatar
Dries committed
712 713 714 715 716 717 718 719 720 721 722 723 724
      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']);
      }
725
      break;
Dries's avatar
Dries committed
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
    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'];
        }
      }
747 748 749 750
      // 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
751 752 753 754
      break;
  }
}

755 756 757 758 759 760 761
/**
 * 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
762 763 764 765 766 767 768 769 770 771 772 773
/**
 * 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
774
  }
Dries's avatar
 
Dries committed
775
}
Dries's avatar
 
Dries committed
776

777
/**
Dries's avatar
Dries committed
778 779 780 781 782 783 784 785 786 787 788
 * 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());
}

/**
 * Prepares the links to the children of the page and the previous/up/next navigation.
 *
 * These navigation elements are added to the content of a node in the book
 * outline when it is viewed as a page and in similar contexts.
789 790
 *
 * @ingroup themeable
791
 */
Dries's avatar
Dries committed
792
function theme_book_navigation($book_link) {
793
  $output = '';
794
  $links = '';
795

Dries's avatar
Dries committed
796 797
  if ($book_link['mlid']) {
    $tree = book_children($book_link);
Dries's avatar
 
Dries committed
798

Dries's avatar
Dries committed
799 800 801
    if ($prev = book_prev($book_link)) {
      drupal_add_link(array('rel' => 'prev', 'href' => url($prev['href'])));
      $links .= l(t('‹ ') . $prev['title'], $prev['href'], array('attributes' => array('class' => 'page-previous', 'title' => t('Go to previous page'))));
Dries's avatar
 
Dries committed
802
    }
Dries's avatar
Dries committed
803 804 805
    if ($book_link['plid'] && $parent = book_link_load($book_link['plid'])) {
      drupal_add_link(array('rel' => 'up', 'href' => url($parent['href'])));
      $links .= l(t('up'), $parent['href'], array('attributes' => array('class' => 'page-up', 'title' => t('Go to parent page'))));
Dries's avatar
 
Dries committed
806
    }
Dries's avatar
Dries committed
807 808 809
    if ($next = book_next($book_link)) {
      drupal_add_link(array('rel' => 'next', 'href' => url($next['href'])));
      $links .= l($next['title'] . t(' ›'), $next['href'], array('attributes' => array('class' => 'page-next', 'title' => t('Go to next page'))));
Dries's avatar
 
Dries committed
810
    }
Dries's avatar
 
Dries committed
811

812 813 814 815 816 817
    if (isset($tree) || isset($links)) {
      $output = '<div class="book-navigation">';
      if (isset($tree)) {
        $output .= $tree;
      }
      if (isset($links)) {
818
        $output .= '<div class="page-links clear-block">'. $links .'</div>';
819 820 821
      }
      $output .= '</div>';
    }
Dries's avatar
 
Dries committed
822
  }
Dries's avatar
 
Dries committed
823

824
  return $output;
Dries's avatar
 
Dries committed
825
}
Dries's avatar
 
Dries committed
826

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

845
/**
Dries's avatar
Dries committed
846 847 848 849 850 851 852
 * 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).
853 854
 * @param $depth_limit
 *   Any link deeper than this value will be excluded (along with its children).
Dries's avatar
Dries committed
855 856
 * @return
 *   An array of mlid, title pairs for use as options for selecting a book page.
857
 */
858
function book_toc($bid, $exclude = array(), $depth_limit) {
Dries's avatar
 
Dries committed
859

Dries's avatar
Dries committed
860
  $tree = menu_tree_all_data(book_menu_name($bid));
861
  $toc = array();
862
  _book_toc_recurse($tree, '', $toc, $exclude, $depth_limit);
Dries's avatar
 
Dries committed
863

Dries's avatar
 
Dries committed
864 865 866
  return $toc;
}

867
/**
Dries's avatar
Dries committed
868
 * Traverse the book tree to build printable or exportable output.
869
 *
Dries's avatar
Dries committed
870 871 872 873
 * During the traversal, the $visit_pre() callback is applied to each
 * node, and is called recursively for each child of the node (in weight,
 * title order). Finally, the output of the $visit_post() callback is
 * appended before returning the generated output.
874
 *
Dries's avatar
Dries committed
875 876 877 878 879 880 881
 * @param $tree
 *   A subtree of the book menu hierarchy, rooted at the current page.
 * @param $visit_pre
 *   A function callback to be called upon visiting a node in the tree.
 * @param $visit_post
 *   A function callback to be called after visiting a node in the tree,
 *   but before recursively visiting children.
882
 * @return
Dries's avatar
Dries committed
883
 *   The output generated in visiting each node.
884
 */
Dries's avatar
Dries committed
885
function book_export_traverse($tree, $visit_pre, $visit_post) {
886
  $output = '';
Dries's avatar
Dries committed
887 888 889 890

  foreach ($tree as $data) {
    // Note- access checking is already performed when building the tree.
    $node = node_load($data['link']['nid'], FALSE);
Dries's avatar
 
Dries committed
891

Dries's avatar
 
Dries committed
892
    if ($node) {
Dries's avatar
Dries committed
893
      $depth = $node->book['depth'];
894
      if (function_exists($visit_pre)) {
Dries's avatar
Dries committed
895
        $output .= call_user_func($visit_pre, $node, $depth);
Dries's avatar
 
Dries committed
896
      }
897
      else {
Dries's avatar
Dries committed
898 899
        // Use the default function.
        $output .= book_node_visitor_html_pre($node, $depth);
Dries's avatar
 
Dries committed
900
      }
Dries's avatar
 
Dries committed
901

Dries's avatar
Dries committed
902 903
      if ($data['below']) {
        $output .= book_export_traverse($data['below'], $visit_pre, $visit_post);
904
      }
Dries's avatar
Dries committed
905

906
      if (function_exists($visit_post)) {
907
        $output .= call_user_func($visit_post, $node, $depth);
908
      }
909
      else {
Dries's avatar
Dries committed
910
        // Use the default function.
911
        $output .= book_node_visitor_html_post($node, $depth);
912
      }
Dries's avatar
 
Dries committed
913
    }
Dries's avatar
 
Dries committed
914 915 916
  }
  return $output;
}
Dries's avatar
 
Dries committed
917

918
/**
Dries's avatar
Dries committed
919 920 921 922 923
 * Generates printer-friendly HTML for a node.
 *
 * This function is a 'pre-node' visitor function.
 *
 * @see book_export_traverse().
924 925
 *
 * @param $node
Dries's avatar
Dries committed
926
 *   The node to generate output for.
927
 * @param $depth
Dries's avatar
Dries committed
928
 *   The depth of the given node in the hierarchy. This
929 930
 *   is used only for generating output.
 * @return
Dries's avatar
Dries committed
931
 *   The HTML generated for the given node.
932
 */
Dries's avatar
Dries committed
933
function book_node_visitor_html_pre($node, $depth) {
934

Dries's avatar
Dries committed
935 936
  $node->build_mode = NODE_BUILD_PRINT;
  $node = node_build_content($node, FALSE, FALSE);
937

938
  $output = "<div id=\"node-". $node->nid ."\" class=\"section-$depth\">\n";
939
  $output .= "<h1 class=\"book-heading\">". check_plain($node->title) ."</h1>\n";
940
  $output .= drupal_render($node->content);
941 942 943 944 945

  return $output;
}

/**
Dries's avatar
Dries committed
946 947 948 949 950 951 952 953 954 955 956 957 958
 * Finishes up generation of printer-friendly HTML after visiting a node.
 *
 * This function is a 'post-node' visitor function.
 *
 * @see book_export_traverse().
 *
 * @param $node
 *   The node to generate output for.
 * @param $depth
 *   The depth of the given node in the hierarchy. This
 *   is used only for generating output.
 * @return
 *   The HTML appended after the given node.
959
 */
960
function book_node_visitor_html_post($node, $depth) {
961 962 963
  return "</div>\n";
}

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

Dries's avatar
Dries committed
971 972 973 974 975 976 977 978
/**
 * 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) {

979
  switch ($op) {
Dries's avatar
Dries committed
980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
    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
997 998
}

999 1000 1001
/**
 * Implementation of hook_help().
 */
1002 1003
function book_help($path, $arg) {
  switch ($path) {
Dries's avatar
 
Dries committed
1004
    case 'admin/help#book':
1005
      $output = '<p>'. t('The <em>book</em> 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>';
Dries's avatar
Dries committed
1006
      $output .= '<p>'. t('Pages in the book hierarchy have navigation elements at the bottom of the page for moving through the text.  These link to the previous and next pages in the book, as well as a link labeled <em>up</em>, leading to the level above in the structure.  More comprehensive navigation may be provided by enabling the <em>book navigation block</em> on the <a href="@admin-block">block administration page</a>.', array('@admin-block' => url('admin/build/block'))) .'</p>';
1007
      $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>';
Dries's avatar
Dries committed
1008 1009
      $output .= '<p>'. t("Users with the <em>administer book outlines</em> permission can add content of any type to a book, placing it into the existing book structure through the edit form or through the interface that's available by clicking on the <em>outline</em> tab while viewing that post.", array('%book' => node_get_types('name', 'book'))) .'</p>';
      $output .= '<p>'. t('Administrators can view a list of all books on the <a href="@admin-node-book">book administration page</a>.  In this list there is a link to an outline page for each book, from which is it possible to change the titles of sections, or to change their weight, thus reordering sections.', array('@admin-node-book' => url('admin/content/book'))) .'</p>';
1010
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="@book">Book page</a>.', array('@book' => 'http://drupal.org/handbook/modules/book/')) .'</p>';
1011
      return $output;
1012
    case 'admin/content/book':
1013
      return '<p>'. t('The book module offers a means to organize a collection of related posts, collectively known as a book. When viewed, these posts automatically display links to adjacent book pages, providing a simple navigation system for creating and reviewing structured content.') .'</p>';
1014
    case 'node/%/outline':
Dries's avatar
Dries committed
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
      return '<p>'. t('The outline feature allows you to include posts 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>';
  }
}

/**
 * Like menu_link_load(), but adds additional data from the {book} table.
 *
 * Do not call when loading a node, since this function may call node_load().
 */
function book_link_load($mlid) {
  if ($item = db_fetch_array(db_query("SELECT * FROM {menu_links} ml INNER JOIN {book} b ON b.mlid = ml.mlid LEFT JOIN {menu_router} m ON m.path = ml.router_path WHERE ml.mlid = %d", $mlid))) {
    _menu_link_translate($item);
    return $item;
  }
  return FALSE;
}

/**
 * Get the data representing a subtree of the book hierarchy.
 *
 * The root of the subtree will be the link passed as a parameter, so the
 * returned tree will contain this item and all its descendents in the menu tree.
 *
 * @param $item
 *   A fully loaded menu link.
 * @return
 *   An subtree of menu links in an array, in the order they should be rendered.
 */
function book_menu_subtree_data($item) {
  static $tree = array();

  $cid = 'links:'. $item['menu_name'] .':subtree:'. $item['mlid'];

  if (!isset($tree[$cid])) {
    $cache = cache_get($cid, 'cache_menu');
    if ($cache && isset($cache->data)) {
      $data = $cache->data;
    }
    else {
1054 1055
      $match = array("menu_name  = '%s'");
      $args = array($item['menu_name']);
Dries's avatar
Dries committed
1056 1057 1058 1059 1060 1061 1062 1063
      $i = 1;
      while ($i <= MENU_MAX_DEPTH && $item["p$i"]) {
        $match[] = "p$i = %d";
        $args[] = $item["p$i"];
        $i++;
      }
      $sql = "
        SELECT b.*, m.load_functions, m.to_arg_functions, m.access_callback, m.access_arguments, m.page_callback, m.page_arguments, m.title, m.title_callback, m.title_arguments, m.type, ml.*
Dries's avatar