book.module 39.9 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

Dries's avatar
 
Dries committed
4 5
/**
 * @file
6
 * Allows users to create and organize related content in an outline.
Dries's avatar
 
Dries committed
7 8
 */

9
/**
10
 * 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
        $select = db_select('node');
        $select->addField('node', 'title');
        $select->condition('nid', $node->book['bid']);
        $select->addTag('node_access');
        $title = $select->execute()->fetchField();
230 231 232 233 234 235 236
        // 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
237 238
        }
      }
239

Dries's avatar
Dries committed
240
      return $block;
241

Dries's avatar
Dries committed
242 243 244 245 246 247 248 249 250 251
    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'),
252
        '#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
253
        );
254

Dries's avatar
Dries committed
255
      return $form;
256

Dries's avatar
Dries committed
257 258 259 260 261
    case 'save':
      variable_set('book_block_mode', $edit['book_block_mode']);
      break;
  }
}
Dries's avatar
 
Dries committed
262

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

Dries's avatar
Dries committed
271
  return l($link['title'], $link['href'], $link['options']);
Dries's avatar
 
Dries committed
272
}
Dries's avatar
 
Dries committed
273

274
/**
Dries's avatar
Dries committed
275 276 277 278
 * 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.
279
 */
Dries's avatar
Dries committed
280 281 282 283 284
function book_get_books() {
  static $all_books;

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

Dries's avatar
Dries committed
287
    if ($nids) {
288 289 290 291 292 293 294 295 296 297 298 299 300 301
      $query = db_select('book', 'b', array('fetch' => PDO::FETCH_ASSOC));
      $node_alias = $query->join('node', 'n', 'b.nid = n.nid');
      $menu_links_alias = $query->join('menu_links', 'ml', 'b.mlid = ml.mlid');
      $query->addField('n', 'type', 'type');
      $query->addField('n', 'title', 'title');
      $query->fields('b');
      $query->fields($menu_links_alias);
      $query->condition('n.nid', $nids, 'IN');
      $query->condition('n.status', 1);
      $query->orderBy('ml.weight');
      $query->orderBy('ml.link_title');
      $query->addTag('node_access');
      $result2 = $query->execute();
      foreach ($result2 as $link) {
Dries's avatar
Dries committed
302 303
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
304
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
305 306
      }
    }
307
  }
308

Dries's avatar
Dries committed
309
  return $all_books;
310
}
311

Dries's avatar
Dries committed
312
/**
313 314 315
 * Implementation of hook_form_alter().
 *
 * Adds the book fieldset to the node form.
Dries's avatar
Dries committed
316 317 318 319 320 321
 *
 * @see book_pick_book_submit()
 * @see book_submit()
 */
function book_form_alter(&$form, $form_state, $form_id) {

322
  if (!empty($form['#node_edit_form'])) {
323
    // Add elements to the node form.
Dries's avatar
Dries committed
324 325 326 327 328
    $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))) {
329
        // Already in the book hierarchy, or this node type is allowed.
Dries's avatar
Dries committed
330 331 332 333 334 335 336 337 338
        $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)'),
339
         // Submit the node form so the parent select options get updated.
340
         // This is typically only used when JS is disabled. Since the parent options
341 342
         // 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
343
         // selected book. This is similar to what happens during a node preview.
344
        '#submit' => array('node_form_submit_build_node'),
Dries's avatar
Dries committed
345 346 347
        '#weight' => 20,
      );
    }
348
  }
Dries's avatar
Dries committed
349
}
350

Dries's avatar
Dries committed
351
/**
352
 * Build the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
353 354 355 356 357 358
 *
 * 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) {
359 360 361
  if (variable_get('menu_override_parent_selector', FALSE)) {
    return array();
  }
Dries's avatar
Dries committed
362 363 364 365 366 367 368
  // 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>',
  );
369

Dries's avatar
Dries committed
370 371 372
  if ($book_link['nid'] === $book_link['bid']) {
    // This is a book - at the top level.
    if ($book_link['original_bid'] === $book_link['bid']) {
373
      $form['#prefix'] .= '<em>' . t('This is the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
374 375
    }
    else {
376
      $form['#prefix'] .= '<em>' . t('This will be the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
377 378 379
    }
  }
  elseif (!$book_link['bid']) {
380
    $form['#prefix'] .= '<em>' . t('No book selected.') . '</em>';
381 382
  }
  else {
Dries's avatar
Dries committed
383 384 385 386
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
387
      '#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)),
388
      '#options' => book_toc($book_link['bid'], array($book_link['mlid']), $book_link['parent_depth_limit']),
389
      '#attributes' => array('class' => 'book-title-select'),
390
    );
Dries's avatar
 
Dries committed
391
  }
392

393
  return $form;
Dries's avatar
 
Dries committed
394 395
}

396
/**
Dries's avatar
Dries committed
397
 * Build the common elements of the book form for the node and outline forms.
398
 */
Dries's avatar
Dries committed
399 400 401
function _book_add_form_elements(&$form, $node) {
  // Need this for AJAX.
  $form['#cache'] = TRUE;
402
  drupal_add_js("if (Drupal.jsEnabled) { $(document).ready(function() { $('#edit-book-pick-book').css('display', 'none'); }); }", 'inline');
Dries's avatar
Dries committed
403 404 405 406 407 408 409 410

  $form['book'] = array(
    '#type' => 'fieldset',
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#tree' => TRUE,
411
    '#attributes' => array('class' => 'book-outline-form'),
412
  );
413
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
414 415 416 417 418 419 420 421 422 423
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

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

  $form['book']['weight'] = array(
    '#type' => 'weight',
424
    '#title' => t('Weight'),
Dries's avatar
Dries committed
425
    '#default_value' => $node->book['weight'],
426
    '#delta' => 15,
Dries's avatar
Dries committed
427
    '#weight' => 5,
428 429
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
430 431
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
432

433
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
434 435 436 437 438 439 440 441 442
    // 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
443 444
  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.
445
    $options = array($nid => '<' . t('create a new book') . '>') + $options;
Dries's avatar
Dries committed
446 447
  }
  if (!$node->book['mlid']) {
448
    // The node is not currently in the hierarchy.
449
    $options = array(0 => '<' . t('none') . '>') + $options;
Dries's avatar
Dries committed
450 451 452 453 454 455 456 457 458 459 460
  }

  // 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,
461
    '#attributes' => array('class' => 'book-title-select'),
462 463 464 465 466
    '#ahah' => array(
      'path' => 'book/js/form',
      'wrapper' => 'edit-book-plid-wrapper',
      'effect' => 'slide',
    ),
467
  );
Dries's avatar
Dries committed
468
}
Dries's avatar
 
Dries committed
469

470
/**
Dries's avatar
Dries committed
471
 * Common helper function to handles additions and updates to the book outline.
Dries's avatar
Dries committed
472
 *
Dries's avatar
Dries committed
473 474 475 476 477 478 479 480 481
 * 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']);

482
  $node->book['link_path'] = 'node/' . $node->nid;
Dries's avatar
Dries committed
483 484 485 486 487 488 489 490 491 492
  $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'])) {
493 494 495
      $parent = db_query("SELECT * FROM {book} WHERE mlid = :mlid", array(
        ':mlid' => $node->book['plid'],
      ))->fetchAssoc();
Dries's avatar
Dries committed
496 497
    }
    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {
498 499 500
      $node->book['plid'] = db_query("SELECT mlid FROM {book} WHERE nid = :nid", array(
        ':nid' => $node->book['bid'],
      ))->fetchField();
Dries's avatar
Dries committed
501 502 503
      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.
    }
  }
504

Dries's avatar
Dries committed
505 506 507
  if (menu_link_save($node->book)) {
    if ($new) {
      // Insert new.
508 509 510 511 512 513 514
      db_insert('book')
        ->fields(array(
          'nid' => $node->nid,
          'mlid' => $node->book['mlid'],
          'bid' => $node->book['bid'],
        ))
        ->execute();
Dries's avatar
Dries committed
515 516
    }
    else {
517 518 519
      if ($node->book['bid'] != db_query("SELECT bid FROM {book} WHERE nid = :nid", array(
          ':nid' => $node->nid,
        ))->fetchField()) {
Dries's avatar
Dries committed
520 521 522 523
        // Update the bid for this page and all children.
        book_update_bid($node->book);
      }
    }
524

Dries's avatar
Dries committed
525 526
    return TRUE;
  }
527 528

  // Failed to save the menu link.
Dries's avatar
Dries committed
529 530 531
  return FALSE;
}

532
/**
Dries's avatar
Dries committed
533
 * Update the bid for a page and its children when it is moved to a new book.
534
 *
Dries's avatar
Dries committed
535 536 537 538
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 */
function book_update_bid($book_link) {
539 540
  $query = db_select('menu_links');
  $query->addField('menu_links', 'mlid');
Dries's avatar
Dries committed
541
  for ($i = 1; $i <= MENU_MAX_DEPTH && $book_link["p$i"]; $i++) {
542
    $query->condition("p$i", $book_link["p$i"]);
Dries's avatar
Dries committed
543
  }
544
  $mlids = $query->execute()->fetchCol();
545

Dries's avatar
Dries committed
546
  if ($mlids) {
547 548 549 550
    db_update('book')
      ->fields(array('bid', $book_link['bid']))
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
551 552 553 554 555
  }
}

/**
 * Get the book menu tree for a page, and return it as a linear array.
556
 *
Dries's avatar
Dries committed
557 558
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
559
 * @return
Dries's avatar
Dries committed
560 561 562 563
 *   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.
564
 */
Dries's avatar
Dries committed
565 566 567 568
function book_get_flat_menu($book_link) {
  static $flat = array();

  if (!isset($flat[$book_link['mlid']])) {
569
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
Dries's avatar
Dries committed
570 571 572
    $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
573
  }
574

Dries's avatar
Dries committed
575
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
576 577
}

578
/**
Dries's avatar
Dries committed
579
 * Recursive helper function for book_get_flat_menu().
580
 */
Dries's avatar
Dries committed
581 582 583 584 585 586 587 588
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
589
  }
Dries's avatar
Dries committed
590
}
Dries's avatar
 
Dries committed
591

Dries's avatar
Dries committed
592 593 594 595 596 597 598
/**
 * 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
599
  }
Dries's avatar
Dries committed
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
  $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']);
      }
617

Dries's avatar
Dries committed
618 619 620 621 622
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
623 624 625
  }
}

626
/**
Dries's avatar
Dries committed
627
 * Fetches the menu link for the next page of the book.
628
 */
Dries's avatar
Dries committed
629 630 631 632 633
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);
634 635 636
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
637 638
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
639
  }
Dries's avatar
Dries committed
640
}
Dries's avatar
 
Dries committed
641

Dries's avatar
Dries committed
642 643 644 645 646
/**
 * Format the menu links for the child pages of the current page.
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
647

Dries's avatar
Dries committed
648 649 650 651 652 653
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
654 655
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
656 657 658 659 660
    // 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
661 662
    }
  }
663

Dries's avatar
Dries committed
664
  return $children ? menu_tree_output($children) : '';
Dries's avatar
 
Dries committed
665 666
}

667
/**
Dries's avatar
Dries committed
668
 * Generate the corresponding menu name from a book ID.
669
 */
Dries's avatar
Dries committed
670
function book_menu_name($bid) {
671
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
672 673 674 675 676 677 678 679 680 681
}

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

  if (!isset($trail)) {
    $trail = array();
682
    $trail[] = array('title' => t('Home'), 'href' => '<front>', 'localized_options' => array());
Dries's avatar
Dries committed
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700

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

Dries's avatar
Dries committed
702
  return $trail;
Dries's avatar
 
Dries committed
703 704
}

705
/**
706
 * Implementation of hook_nodeapi_load().
707
 */
708 709 710 711 712 713 714
function book_nodeapi_load($nodes, $types) {
  $result = db_query("SELECT * FROM {book} b INNER JOIN {menu_links} ml ON b.mlid = ml.mlid WHERE b.nid IN (" . db_placeholders(array_keys($nodes)) . ")",  array_keys($nodes), array('fetch' => PDO::FETCH_ASSOC));
  foreach ($result as $record) {
    $nodes[$record['nid']]->book = $record;
    $nodes[$record['nid']]->book['href'] = $record['link_path'];
    $nodes[$record['nid']]->book['title'] = $record['link_title'];
    $nodes[$record['nid']]->book['options'] = unserialize($record['options']);
715 716
  }
}
717

718 719 720
/**
 * Implementation of hook_nodeapi_view().
 */
721
function book_nodeapi_view($node, $teaser, $page) {
722 723 724 725 726 727
  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,
      );
728

729 730 731
      if ($page) {
        menu_set_active_trail(book_build_active_trail($node->book));
        menu_set_active_menu_name($node->book['menu_name']);
732
      }
733 734 735
    }
  }
}
736

737 738 739
/**
 * Implementation of hook_nodeapi_presave().
 */
740
function book_nodeapi_presave($node) {
741 742 743 744 745 746 747 748 749
  // 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;
  }
}
750

751 752 753
/**
 * Implementation of hook_nodeapi_insert().
 */
754
function book_nodeapi_insert($node) {
755 756 757 758 759 760 761 762 763 764
  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);
  }
}
765

766 767 768
/**
 * Implementation of hook_nodeapi_update().
 */
769
function book_nodeapi_update($node) {
770 771 772 773 774 775 776 777 778 779
  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);
  }
}
780

781 782 783
/**
 * Implementation of hook_nodeapi_delete().
 */
784
function book_nodeapi_delete($node) {
785 786 787
  if (!empty($node->book['bid'])) {
    if ($node->nid == $node->book['bid']) {
      // Handle deletion of a top-level post.
788 789 790 791 792
      $result = db_query("SELECT b.nid FROM {menu_links} ml INNER JOIN {book} b on b.mlid = ml.mlid WHERE ml.plid = :plid", array(
        ':plid' => $node->book['mlid']
      ));
      foreach ($result as $child) {
        $child_node = node_load($child->nid);
793 794
        $child_node->book['bid'] = $child_node->nid;
        _book_update_outline($child_node);
Dries's avatar
Dries committed
795
      }
796 797
    }
    menu_link_delete($node->book['mlid']);
798 799 800
    db_delete('book')
      ->condition('mlid', $node->book['mlid'])
      ->execute();
801 802 803 804 805 806
  }
}

/**
 * Implementation of hook_nodeapi_prepare().
 */
807
function book_nodeapi_prepare($node) {
808 809 810 811 812 813 814 815 816 817 818 819
  // 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'];
820
      }
821 822 823 824 825 826 827 828 829 830 831 832
    }
    // 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
833 834 835
  }
}

836 837 838 839 840 841 842
/**
 * 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
843 844 845 846 847 848 849 850
/**
 * 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(
851
      '#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
852 853
      '#weight' => -10,
    );
Dries's avatar
 
Dries committed
854
  }
Dries's avatar
 
Dries committed
855
}
Dries's avatar
 
Dries committed
856

857
/**
Dries's avatar
Dries committed
858 859 860 861 862 863 864
 * 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());
}

/**
865
 * Process variables for book-navigation.tpl.php.
Dries's avatar
Dries committed
866
 *
867 868
 * The $variables array contains the following arguments:
 * - $book_link
869
 *
870
 * @see book-navigation.tpl.php
871
 */
872 873 874 875 876 877
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']);
878
  $variables['book_url'] = 'node/' . $book_link['bid'];
879 880
  $variables['current_depth'] = $book_link['depth'];
  $variables['tree'] = '';
881

Dries's avatar
Dries committed
882
  if ($book_link['mlid']) {
883
    $variables['tree'] = book_children($book_link);
Dries's avatar
 
Dries committed
884

Dries's avatar
Dries committed
885
    if ($prev = book_prev($book_link)) {
886 887 888 889
      $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
890
    }
891

Dries's avatar
Dries committed
892
    if ($book_link['plid'] && $parent = book_link_load($book_link['plid'])) {
893 894 895 896
      $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
897
    }
898

Dries's avatar
Dries committed
899
    if ($next = book_next($book_link)) {
900 901 902 903
      $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
904
    }
905
  }
Dries's avatar
 
Dries committed
906

907 908 909 910 911 912 913 914 915 916 917
  $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] = '';
918
    }
Dries's avatar
 
Dries committed
919
  }
Dries's avatar
 
Dries committed
920
}
Dries's avatar
 
Dries committed
921

922
/**
Dries's avatar
Dries committed
923
 * A recursive helper function for book_toc().
924
 */
925
function _book_toc_recurse($tree, $indent, &$toc, $exclude, $depth_limit) {
Dries's avatar
Dries committed
926
  foreach ($tree as $data) {
927 928 929 930
    if ($data['link']['depth'] > $depth_limit) {
      // Don't iterate through any links on this level.
      break;
    }
931

Dries's avatar
Dries committed
932
    if (!in_array($data['link']['mlid'], $exclude)) {
933
      $toc[$data['link']['mlid']] = $indent . ' ' . truncate_utf8($data['link']['title'], 30, TRUE, TRUE);
934
      if ($data['below']) {
935
        _book_toc_recurse($data['below'], $indent . '--', $toc, $exclude, $depth_limit);
936
      }
Dries's avatar
 
Dries committed
937 938 939 940
    }
  }
}

941
/**
Dries's avatar
Dries committed
942 943 944 945 946 947 948
 * 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).
949 950
 * @param $depth_limit
 *   Any link deeper than this value will be excluded (along with its children).
Dries's avatar
Dries committed
951 952
 * @return
 *   An array of mlid, title pairs for use as options for selecting a book page.
953
 */
954
function book_toc($bid, $exclude = array(), $depth_limit) {
Dries's avatar
Dries committed
955
  $tree = menu_tree_all_data(book_menu_name($bid));
956
  $toc = array();
957
  _book_toc_recurse($tree, '', $toc, $exclude, $depth_limit);
Dries's avatar
 
Dries committed
958

Dries's avatar
 
Dries committed
959 960 961
  return $toc;