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

39 40 41
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
42
function book_perm() {
43
  return array(
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
    'administer book outlines' => array(
      'title' => t('Administer book outlines'),
      'description' => t('Manage books through the administration panel.'),
    ),
    'create new books' => array(
      'title' => t('Create new books'),
      'description' => t('Add new top-level books.'),
    ),
    'add content to books' => array(
      'title' => t('Add content to books'),
      'description' => t('Add new content and child pages to books.'),
    ),
    'access printer-friendly version' => array(
      'title' => t('Access printer-friendly version'),
      'description' => t('View a book page and all of its sub-pages as a single document for ease of printing. Can be performance heavy.'),
    ),
60
  );
Dries's avatar
 
Dries committed
61 62
}

Dries's avatar
 
Dries committed
63 64 65
/**
 * Implementation of hook_link().
 */
66
function book_link($type, $node = NULL, $teaser = FALSE) {
Dries's avatar
 
Dries committed
67 68
  $links = array();

Dries's avatar
Dries committed
69
  if ($type == 'node' && isset($node->book)) {
70
    if (!$teaser) {
Dries's avatar
Dries committed
71 72
      $child_type = variable_get('book_child_type', 'book');
      if ((user_access('add content to books') || user_access('administer book outlines')) && node_access('create', $child_type) && $node->status == 1 && $node->book['depth'] < MENU_MAX_DEPTH) {
73
        $links['book_add_child'] = array(
74
          'title' => t('Add child page'),
75 76
          'href' => "node/add/" . str_replace('_', '-', $child_type),
          'query' => "parent=" . $node->book['mlid'],
77
        );
Dries's avatar
 
Dries committed
78
      }
79

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

Dries's avatar
 
Dries committed
90
  return $links;
Dries's avatar
 
Dries committed
91 92
}

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

Dries's avatar
 
Dries committed
158 159 160
  return $items;
}

Dries's avatar
Dries committed
161 162 163
/**
 * Menu item access callback - determine if the outline tab is accessible.
 */
164
function _book_outline_access($node) {
Dries's avatar
Dries committed
165 166 167 168 169 170 171 172
  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);
173 174
}

Dries's avatar
Dries committed
175
/**
176
 * Implementation of hook_init().
Dries's avatar
Dries committed
177
 */
178
function book_init() {
179
  drupal_add_css(drupal_get_path('module', 'book') . '/book.css');
180 181
}

182 183 184
/**
 * Implementation of hook_block().
 *
Dries's avatar
 
Dries committed
185 186
 * Displays the book table of contents in a block when the current page is a
 * single-node view of a book node.
187
 */
188
function book_block($op = 'list', $delta = '', $edit = array()) {
Dries's avatar
 
Dries committed
189
  $block = array();
Dries's avatar
Dries committed
190 191
  switch ($op) {
    case 'list':
192 193
      $block['navigation']['info'] = t('Book navigation');
      $block['navigation']['cache'] = BLOCK_CACHE_PER_PAGE | BLOCK_CACHE_PER_ROLE;
194

Dries's avatar
Dries committed
195
      return $block;
196

Dries's avatar
Dries committed
197
    case 'view':
198 199 200
      $current_bid = 0;
      if ($node = menu_get_object()) {
        $current_bid = empty($node->book['bid']) ? 0 : $node->book['bid'];
201
      }
202

203
      if (variable_get('book_block_mode', 'all pages') == 'all pages') {
Dries's avatar
Dries committed
204 205
        $block['subject'] = t('Book navigation');
        $book_menus = array();
206
        $pseudo_tree = array(0 => array('below' => FALSE));
207
        foreach (book_get_books() as $book_id => $book) {
208 209 210
          if ($book['bid'] == $current_bid) {
            // If the current page is a node associated with a book, the menu
            // needs to be retrieved.
211
            $book_menus[$book_id] = menu_tree_output(menu_tree_all_data($node->book['menu_name'], $node->book));
212 213 214 215 216 217
          }
          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;
218
            $book_menus[$book_id] = menu_tree_output($pseudo_tree);
219
          }
Dries's avatar
 
Dries committed
220
        }
Dries's avatar
Dries committed
221
        $block['content'] = theme('book_all_books_block', $book_menus);
Dries's avatar
 
Dries committed
222
      }
223
      elseif ($current_bid) {
Dries's avatar
Dries committed
224
        // Only display this block when the user is browsing a book.
225 226 227 228 229 230 231 232
        $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
233 234
        }
      }
235

Dries's avatar
Dries committed
236
      return $block;
237

Dries's avatar
Dries committed
238 239 240 241 242 243 244 245 246 247
    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'),
248
        '#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
249
        );
250

Dries's avatar
Dries committed
251
      return $form;
252

Dries's avatar
Dries committed
253 254 255 256 257
    case 'save':
      variable_set('book_block_mode', $edit['book_block_mode']);
      break;
  }
}
Dries's avatar
 
Dries committed
258

259
/**
Dries's avatar
Dries committed
260 261 262
 * Generate the HTML output for a link to a book title when used as a block title.
 *
 * @ingroup themeable
263
 */
Dries's avatar
Dries committed
264 265
function theme_book_title_link($link) {
  $link['options']['attributes']['class'] =  'book-title';
266

Dries's avatar
Dries committed
267
  return l($link['title'], $link['href'], $link['options']);
Dries's avatar
 
Dries committed
268
}
Dries's avatar
 
Dries committed
269

270
/**
Dries's avatar
Dries committed
271 272 273 274
 * 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.
275
 */
Dries's avatar
Dries committed
276 277 278 279 280 281 282 283 284 285
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'];
    }
286

Dries's avatar
Dries committed
287
    if ($nids) {
288
      $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
289 290 291
      while ($link = db_fetch_array($result2)) {
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
292
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
293 294
      }
    }
295
  }
296

Dries's avatar
Dries committed
297
  return $all_books;
298
}
299

Dries's avatar
Dries committed
300
/**
301 302 303
 * Implementation of hook_form_alter().
 *
 * Adds the book fieldset to the node form.
Dries's avatar
Dries committed
304 305 306 307 308 309
 *
 * @see book_pick_book_submit()
 * @see book_submit()
 */
function book_form_alter(&$form, $form_state, $form_id) {

310
  if (!empty($form['#node_edit_form'])) {
311
    // Add elements to the node form.
Dries's avatar
Dries committed
312 313 314 315 316
    $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))) {
317
        // Already in the book hierarchy, or this node type is allowed.
Dries's avatar
Dries committed
318 319 320 321 322 323 324 325 326
        $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)'),
327
         // Submit the node form so the parent select options get updated.
328
         // This is typically only used when JS is disabled. Since the parent options
329 330
         // 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
331
         // selected book. This is similar to what happens during a node preview.
332
        '#submit' => array('node_form_submit_build_node'),
Dries's avatar
Dries committed
333 334 335
        '#weight' => 20,
      );
    }
336
  }
Dries's avatar
Dries committed
337
}
338

Dries's avatar
Dries committed
339
/**
340
 * Build the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
341 342 343 344 345 346
 *
 * 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) {
347 348 349
  if (variable_get('menu_override_parent_selector', FALSE)) {
    return array();
  }
Dries's avatar
Dries committed
350 351 352 353 354 355 356
  // 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>',
  );
357

Dries's avatar
Dries committed
358 359 360
  if ($book_link['nid'] === $book_link['bid']) {
    // This is a book - at the top level.
    if ($book_link['original_bid'] === $book_link['bid']) {
361
      $form['#prefix'] .= '<em>' . t('This is the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
362 363
    }
    else {
364
      $form['#prefix'] .= '<em>' . t('This will be the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
365 366 367
    }
  }
  elseif (!$book_link['bid']) {
368
    $form['#prefix'] .= '<em>' . t('No book selected.') . '</em>';
369 370
  }
  else {
Dries's avatar
Dries committed
371 372 373 374
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
375
      '#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)),
376
      '#options' => book_toc($book_link['bid'], array($book_link['mlid']), $book_link['parent_depth_limit']),
377
      '#attributes' => array('class' => 'book-title-select'),
378
    );
Dries's avatar
 
Dries committed
379
  }
380

381
  return $form;
Dries's avatar
 
Dries committed
382 383
}

384
/**
Dries's avatar
Dries committed
385
 * Build the common elements of the book form for the node and outline forms.
386
 */
Dries's avatar
Dries committed
387 388 389
function _book_add_form_elements(&$form, $node) {
  // Need this for AJAX.
  $form['#cache'] = TRUE;
390
  drupal_add_js("if (Drupal.jsEnabled) { $(document).ready(function() { $('#edit-book-pick-book').css('display', 'none'); }); }", 'inline');
Dries's avatar
Dries committed
391 392 393 394 395 396 397 398

  $form['book'] = array(
    '#type' => 'fieldset',
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#tree' => TRUE,
399
    '#attributes' => array('class' => 'book-outline-form'),
400
  );
401
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
402 403 404 405 406 407 408 409 410 411
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

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

  $form['book']['weight'] = array(
    '#type' => 'weight',
412
    '#title' => t('Weight'),
Dries's avatar
Dries committed
413
    '#default_value' => $node->book['weight'],
414
    '#delta' => 15,
Dries's avatar
Dries committed
415
    '#weight' => 5,
416 417
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
418 419
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
420

421
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
422 423 424 425 426 427 428 429 430
    // 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
431 432
  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.
433
    $options = array($nid => '<' . t('create a new book') . '>') + $options;
Dries's avatar
Dries committed
434 435
  }
  if (!$node->book['mlid']) {
436
    // The node is not currently in the hierarchy.
437
    $options = array(0 => '<' . t('none') . '>') + $options;
Dries's avatar
Dries committed
438 439 440 441 442 443 444 445 446 447 448
  }

  // 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,
449
    '#attributes' => array('class' => 'book-title-select'),
450 451 452 453 454
    '#ahah' => array(
      'path' => 'book/js/form',
      'wrapper' => 'edit-book-plid-wrapper',
      'effect' => 'slide',
    ),
455
  );
Dries's avatar
Dries committed
456
}
Dries's avatar
 
Dries committed
457

458
/**
Dries's avatar
Dries committed
459
 * Common helper function to handles additions and updates to the book outline.
Dries's avatar
Dries committed
460
 *
Dries's avatar
Dries committed
461 462 463 464 465 466 467 468 469
 * 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']);

470
  $node->book['link_path'] = 'node/' . $node->nid;
Dries's avatar
Dries committed
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
  $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.
    }
  }
488

Dries's avatar
Dries committed
489 490 491 492 493 494 495 496 497 498 499
  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);
      }
    }
500

Dries's avatar
Dries committed
501 502
    return TRUE;
  }
503 504

  // Failed to save the menu link.
Dries's avatar
Dries committed
505 506 507
  return FALSE;
}

508
/**
Dries's avatar
Dries committed
509
 * Update the bid for a page and its children when it is moved to a new book.
510
 *
Dries's avatar
Dries committed
511 512 513 514 515 516 517 518
 * @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"];
  }
519
  $result = db_query("SELECT mlid FROM {menu_links} WHERE " . implode(' AND ', $match), $args);
Dries's avatar
Dries committed
520 521 522 523 524

  $mlids = array();
  while ($a = db_fetch_array($result)) {
    $mlids[] = $a['mlid'];
  }
525

Dries's avatar
Dries committed
526
  if ($mlids) {
527
    db_query("UPDATE {book} SET bid = %d WHERE mlid IN (" . implode(',', $mlids) . ")", $book_link['bid']);
Dries's avatar
Dries committed
528 529 530 531 532
  }
}

/**
 * Get the book menu tree for a page, and return it as a linear array.
533
 *
Dries's avatar
Dries committed
534 535
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
536
 * @return
Dries's avatar
Dries committed
537 538 539 540
 *   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.
541
 */
Dries's avatar
Dries committed
542 543 544 545
function book_get_flat_menu($book_link) {
  static $flat = array();

  if (!isset($flat[$book_link['mlid']])) {
546
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
Dries's avatar
Dries committed
547 548 549
    $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
550
  }
551

Dries's avatar
Dries committed
552
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
553 554
}

555
/**
Dries's avatar
Dries committed
556
 * Recursive helper function for book_get_flat_menu().
557
 */
Dries's avatar
Dries committed
558 559 560 561 562 563 564 565
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
566
  }
Dries's avatar
Dries committed
567
}
Dries's avatar
 
Dries committed
568

Dries's avatar
Dries committed
569 570 571 572 573 574 575
/**
 * 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
576
  }
Dries's avatar
Dries committed
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
  $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']);
      }
594

Dries's avatar
Dries committed
595 596 597 598 599
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
600 601 602
  }
}

603
/**
Dries's avatar
Dries committed
604
 * Fetches the menu link for the next page of the book.
605
 */
Dries's avatar
Dries committed
606 607 608 609 610
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);
611 612 613
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
614 615
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
616
  }
Dries's avatar
Dries committed
617
}
Dries's avatar
 
Dries committed
618

Dries's avatar
Dries committed
619 620 621 622 623
/**
 * Format the menu links for the child pages of the current page.
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
624

Dries's avatar
Dries committed
625 626 627 628 629 630
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
631 632
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
633 634 635 636 637
    // 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
638 639
    }
  }
640

Dries's avatar
Dries committed
641
  return $children ? menu_tree_output($children) : '';
Dries's avatar
 
Dries committed
642 643
}

644
/**
Dries's avatar
Dries committed
645
 * Generate the corresponding menu name from a book ID.
646
 */
Dries's avatar
Dries committed
647
function book_menu_name($bid) {
648
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
649 650 651 652 653 654 655 656 657 658
}

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

  if (!isset($trail)) {
    $trail = array();
659
    $trail[] = array('title' => t('Home'), 'href' => '<front>', 'localized_options' => array());
Dries's avatar
Dries committed
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677

    $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);
      }
    }
  }
678

Dries's avatar
Dries committed
679
  return $trail;
Dries's avatar
 
Dries committed
680 681
}

682
/**
683
 * Implementation of hook_nodeapi_load().
684
 */
685 686 687
function book_nodeapi_load(&$node, $teaser, $page) {
  // 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));
688

689 690 691 692
  if ($info['book']) {
    $info['book']['href'] = $info['book']['link_path'];
    $info['book']['title'] = $info['book']['link_title'];
    $info['book']['options'] = unserialize($info['book']['options']);
693

694 695 696
    return $info;
  }
}
697

698 699 700 701 702 703 704 705 706 707
/**
 * Implementation of hook_nodeapi_view().
 */
function book_nodeapi_view(&$node, $teaser, $page) {
  if (!$teaser) {
    if (!empty($node->book['bid']) && $node->build_mode == NODE_BUILD_NORMAL) {
      $node->content['book_navigation'] = array(
        '#markup' => theme('book_navigation', $node->book),
        '#weight' => 100,
      );
708

709 710 711
      if ($page) {
        menu_set_active_trail(book_build_active_trail($node->book));
        menu_set_active_menu_name($node->book['menu_name']);
712
      }
713 714 715
    }
  }
}
716

717 718 719 720 721 722 723 724 725 726 727 728 729
/**
 * Implementation of hook_nodeapi_presave().
 */
function book_nodeapi_presave(&$node, $teaser, $page) {
  // Always save a revision for non-administrators.
  if (!empty($node->book['bid']) && !user_access('administer nodes')) {
    $node->revision = 1;
  }
  // Make sure a new node gets a new menu link.
  if (empty($node->nid)) {
    $node->book['mlid'] = NULL;
  }
}
730

731 732 733 734 735 736 737 738 739 740 741 742 743 744
/**
 * Implementation of hook_nodeapi_insert().
 */
function book_nodeapi_insert(&$node, $teaser, $page) {
  if (!empty($node->book['bid'])) {
    if ($node->book['bid'] == 'new') {
      // New nodes that are their own book.
      $node->book['bid'] = $node->nid;
    }
    $node->book['nid'] = $node->nid;
    $node->book['menu_name'] = book_menu_name($node->book['bid']);
    _book_update_outline($node);
  }
}
745

746 747 748 749 750 751 752 753 754 755 756 757 758 759
/**
 * Implementation of hook_nodeapi_update().
 */
function book_nodeapi_update(&$node, $teaser, $page) {
  if (!empty($node->book['bid'])) {
    if ($node->book['bid'] == 'new') {
      // New nodes that are their own book.
      $node->book['bid'] = $node->nid;
    }
    $node->book['nid'] = $node->nid;
    $node->book['menu_name'] = book_menu_name($node->book['bid']);
    _book_update_outline($node);
  }
}
760

761 762 763 764 765 766 767 768 769 770 771 772
/**
 * Implementation of hook_nodeapi_delete().
 */
function book_nodeapi_delete(&$node, $teaser, $page) {
  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);
Dries's avatar
Dries committed
773
      }
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
    }
    menu_link_delete($node->book['mlid']);
    db_query('DELETE FROM {book} WHERE mlid = %d', $node->book['mlid']);
  }
}

/**
 * Implementation of hook_nodeapi_prepare().
 */
function book_nodeapi_prepare(&$node, $teaser, $page) {
  // 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'];
796
      }
797 798 799 800 801 802 803 804 805 806 807 808
    }
    // Set defaults.
    $node->book += _book_link_defaults(!empty($node->nid) ? $node->nid : 'new');
  }
  else {
    if (isset($node->book['bid']) && !isset($node->book['original_bid'])) {
      $node->book['original_bid'] = $node->book['bid'];
    }
  }
  // Find the depth limit for the parent select.
  if (isset($node->book['bid']) && !isset($node->book['parent_depth_limit'])) {
    $node->book['parent_depth_limit'] = _book_parent_depth_limit($node->book);
Dries's avatar
Dries committed
809 810 811
  }
}

812 813 814 815 816 817 818
/**
 * 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
819 820 821 822 823 824 825 826
/**
 * 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(
827
      '#markup' => '<p>' . t('%title is part of a book outline, and has associated child pages. If you proceed with deletion, the child pages will be relocated automatically.', array('%title' => $node->title)) . '</p>',
Dries's avatar
Dries committed
828 829
      '#weight' => -10,
    );
Dries's avatar
 
Dries committed
830
  }
Dries's avatar
 
Dries committed
831
}
Dries's avatar
 
Dries committed
832

833
/**
Dries's avatar
Dries committed
834 835 836 837 838 839 840
 * 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());
}

/**
841
 * Process variables for book-navigation.tpl.php.
Dries's avatar
Dries committed
842
 *
843 844
 * The $variables array contains the following arguments:
 * - $book_link
845
 *
846
 * @see book-navigation.tpl.php
847
 */
848 849 850 851 852 853
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']);
854
  $variables['book_url'] = 'node/' . $book_link['bid'];
855 856
  $variables['current_depth'] = $book_link['depth'];
  $variables['tree'] = '';
857

Dries's avatar
Dries committed
858
  if ($book_link['mlid']) {
859
    $variables['tree'] = book_children($book_link);
Dries's avatar
 
Dries committed
860

Dries's avatar
Dries committed
861
    if ($prev = book_prev($book_link)) {
862 863 864 865
      $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
866
    }
867

Dries's avatar
Dries committed
868
    if ($book_link['plid'] && $parent = book_link_load($book_link['plid'])) {
869 870 871 872
      $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
873
    }
874

Dries's avatar
Dries committed
875
    if ($next = book_next($book_link)) {
876 877 878 879
      $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
880
    }
881
  }
Dries's avatar
 
Dries committed
882

883 884 885 886 887 888 889 890 891 892 893
  $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] = '';
894
    }
Dries's avatar
 
Dries committed
895
  }
Dries's avatar
 
Dries committed
896
}
Dries's avatar
 
Dries committed
897

898
/**
Dries's avatar
Dries committed
899
 * A recursive helper function for book_toc().
900
 */
901
function _book_toc_recurse($tree, $indent, &$toc, $exclude, $depth_limit) {
Dries's avatar
Dries committed
902
  foreach ($tree as $data) {
903 904 905 906
    if ($data['link']['depth'] > $depth_limit) {
      // Don't iterate through any links on this level.
      break;
    }
907

Dries's avatar
Dries committed
908
    if (!in_array($data['link']['mlid'], $exclude)) {
909
      $toc[$data['link']['mlid']] = $indent . ' ' . truncate_utf8($data['link']['title'], 30, TRUE, TRUE);
910
      if ($data['below']) {
911
        _book_toc_recurse($data['below'], $indent . '--', $toc, $exclude, $depth_limit);
912
      }
Dries's avatar
 
Dries committed
913 914 915 916
    }
  }
}

917
/**
Dries's avatar
Dries committed
918 919 920 921 922 923 924
 * 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).
925 926
 * @param $depth_limit
 *   Any link deeper than this value will be excluded (along with its children).
Dries's avatar
Dries committed
927 928
 * @return
 *   An array of mlid, title pairs for use as options for selecting a book page.
929
 */
930
function book_toc($bid, $exclude = array(), $depth_limit) {
Dries's avatar
Dries committed
931
  $tree = menu_tree_all_data(book_menu_name($bid));
932
  $toc = array();
933
  _book_toc_recurse($tree, '', $toc, $exclude, $depth_limit);
Dries's avatar
 
Dries committed
934

Dries's avatar
 
Dries committed
935 936 937
  return $toc;
}

938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
/**
 * 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();
}

958
/**
Dries's avatar
Dries committed
959
 * Traverse the book tree to build printable or exportable output.
960
 *
961
 * During the traversal, the $visit_func() callback is applied to each
Dries's avatar
Dries committed
962
 * node, and is called recursively for each child of the node (in weight,
963
 * title order).
964
 *
Dries's avatar
Dries committed
965 966
 * @param $tree
 *   A subtree of the book menu hierarchy, rooted at the current page.
967
 * @param $visit_func
Dries's avatar
Dries committed
968
 *   A function callback to be called upon visiting a node in the tree.
969
 * @return
Dries's avatar
Dries committed
970
 *   The output generated in visiting each node.
971
 */
972
function book_export_traverse($tree, $visit_func) {
973
  $output = '';
Dries's avatar
Dries committed
974 975 976

  foreach ($tree as $data) {
    // Note- access checking is already performed when building the tree.
977 978
    if ($node = node_load($data['link']['nid'], FALSE)) {
      $children = '';
979

Dries's avatar
Dries committed
980
      if ($data['below']) {
981
        $children = book_export_traverse($data['below'], $visit_func);