book.module 40.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
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
 * Inject links into $node as needed. 
Dries's avatar
 
Dries committed
65
 */
66
function book_nodeapi_view_link($node, $teaser, $page) {
Dries's avatar
 
Dries committed
67
  $links = array();
68 69
  
  if (isset($node->book['depth'])) {
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

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

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

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

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

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

187
/**
188 189 190 191 192 193 194 195 196 197 198 199
 * Implementation of hook_block_list().
 */
function book_block_list() {
  $block = array();
  $block['navigation']['info'] = t('Book navigation');
  $block['navigation']['cache'] = BLOCK_CACHE_PER_PAGE | BLOCK_CACHE_PER_ROLE;

  return $block;
}

/**
 * Implementation of hook_block_view().
200
 *
Dries's avatar
 
Dries committed
201 202
 * Displays the book table of contents in a block when the current page is a
 * single-node view of a book node.
203
 */
204
function book_block_view($delta = '') {
Dries's avatar
 
Dries committed
205
  $block = array();
206 207 208 209
  $current_bid = 0;
  if ($node = menu_get_object()) {
    $current_bid = empty($node->book['bid']) ? 0 : $node->book['bid'];
  }
210

211 212 213 214 215 216 217 218 219
  if (variable_get('book_block_mode', 'all pages') == 'all pages') {
    $block['subject'] = t('Book navigation');
    $book_menus = array();
    $pseudo_tree = array(0 => array('below' => FALSE));
    foreach (book_get_books() as $book_id => $book) {
      if ($book['bid'] == $current_bid) {
        // If the current page is a node associated with a book, the menu
        // needs to be retrieved.
        $book_menus[$book_id] = menu_tree_output(menu_tree_all_data($node->book['menu_name'], $node->book));
Dries's avatar
 
Dries committed
220
      }
221 222 223 224 225 226
      else {
        // Since we know we will only display a link to the top node, there
        // is no reason to run an additional menu tree query for each book.
        $book['in_active_trail'] = FALSE;
        $pseudo_tree[0]['link'] = $book;
        $book_menus[$book_id] = menu_tree_output($pseudo_tree);
Dries's avatar
Dries committed
227
      }
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
    }
    $block['content'] = theme('book_all_books_block', $book_menus);
  }
  elseif ($current_bid) {
    // Only display this block when the user is browsing a book.
    $select = db_select('node');
    $select->addField('node', 'title');
    $select->condition('nid', $node->book['bid']);
    $select->addTag('node_access');
    $title = $select->execute()->fetchField();
    // Only show the block if the user has view access for the top-level node.
    if ($title) {
      $tree = menu_tree_all_data($node->book['menu_name'], $node->book);
      // There should only be one element at the top level.
      $data = array_shift($tree);
      $block['subject'] = theme('book_title_link', $data['link']);
      $block['content'] = ($data['below']) ? menu_tree_output($data['below']) : '';
    }
  }
247

248 249
  return $block;
}
250

251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
/**
 * Implementation of hook_block_configure().
 */
function book_block_configure($delta = '') {
  $block = array();
  $options = array(
    'all pages' => t('Show block on all pages'),
    'book pages' => t('Show block only on book pages'),
  );
  $form['book_block_mode'] = array(
    '#type' => 'radios',
    '#title' => t('Book navigation block display'),
    '#options' => $options,
    '#default_value' => variable_get('book_block_mode', 'all pages'),
    '#description' => t("If <em>Show block on all pages</em> is selected, the block will contain the automatically generated menus for all of the site's books. If <em>Show block only on book pages</em> is selected, the block will contain only the one menu corresponding to the current page's book. In this case, if the current page is not in a book, no block will be displayed. The <em>Page specific visibility settings</em> or other visibility settings can be used in addition to selectively display this block."),
    );
267

268 269
  return $form;
}
270

271 272 273 274 275 276
/**
 * Implementation of hook_block_save().
 */
function book_block_save($delta = '', $edit = array()) {
  $block = array();
  variable_set('book_block_mode', $edit['book_block_mode']);
Dries's avatar
Dries committed
277
}
Dries's avatar
 
Dries committed
278

279
/**
Dries's avatar
Dries committed
280 281 282
 * Generate the HTML output for a link to a book title when used as a block title.
 *
 * @ingroup themeable
283
 */
Dries's avatar
Dries committed
284 285
function theme_book_title_link($link) {
  $link['options']['attributes']['class'] =  'book-title';
286

Dries's avatar
Dries committed
287
  return l($link['title'], $link['href'], $link['options']);
Dries's avatar
 
Dries committed
288
}
Dries's avatar
 
Dries committed
289

290
/**
Dries's avatar
Dries committed
291 292 293 294
 * 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.
295
 */
Dries's avatar
Dries committed
296 297 298 299 300
function book_get_books() {
  static $all_books;

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

Dries's avatar
Dries committed
303
    if ($nids) {
304 305 306 307 308 309 310 311 312 313 314 315 316 317
      $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
318 319
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
320
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
321 322
      }
    }
323
  }
324

Dries's avatar
Dries committed
325
  return $all_books;
326
}
327

Dries's avatar
Dries committed
328
/**
329 330 331
 * Implementation of hook_form_alter().
 *
 * Adds the book fieldset to the node form.
Dries's avatar
Dries committed
332 333 334 335 336 337
 *
 * @see book_pick_book_submit()
 * @see book_submit()
 */
function book_form_alter(&$form, $form_state, $form_id) {

338
  if (!empty($form['#node_edit_form'])) {
339
    // Add elements to the node form.
Dries's avatar
Dries committed
340 341 342 343 344
    $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))) {
345
        // Already in the book hierarchy, or this node type is allowed.
Dries's avatar
Dries committed
346 347 348 349 350 351 352 353 354
        $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)'),
355
         // Submit the node form so the parent select options get updated.
356
         // This is typically only used when JS is disabled. Since the parent options
357 358
         // 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
359
         // selected book. This is similar to what happens during a node preview.
360
        '#submit' => array('node_form_submit_build_node'),
Dries's avatar
Dries committed
361 362 363
        '#weight' => 20,
      );
    }
364
  }
Dries's avatar
Dries committed
365
}
366

Dries's avatar
Dries committed
367
/**
368
 * Build the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
369 370 371 372 373 374
 *
 * 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) {
375 376 377
  if (variable_get('menu_override_parent_selector', FALSE)) {
    return array();
  }
Dries's avatar
Dries committed
378 379 380 381 382 383 384
  // 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>',
  );
385

Dries's avatar
Dries committed
386 387 388
  if ($book_link['nid'] === $book_link['bid']) {
    // This is a book - at the top level.
    if ($book_link['original_bid'] === $book_link['bid']) {
389
      $form['#prefix'] .= '<em>' . t('This is the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
390 391
    }
    else {
392
      $form['#prefix'] .= '<em>' . t('This will be the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
393 394 395
    }
  }
  elseif (!$book_link['bid']) {
396
    $form['#prefix'] .= '<em>' . t('No book selected.') . '</em>';
397 398
  }
  else {
Dries's avatar
Dries committed
399 400 401 402
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
403
      '#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)),
404
      '#options' => book_toc($book_link['bid'], array($book_link['mlid']), $book_link['parent_depth_limit']),
405
      '#attributes' => array('class' => 'book-title-select'),
406
    );
Dries's avatar
 
Dries committed
407
  }
408

409
  return $form;
Dries's avatar
 
Dries committed
410 411
}

412
/**
Dries's avatar
Dries committed
413
 * Build the common elements of the book form for the node and outline forms.
414
 */
Dries's avatar
Dries committed
415 416 417
function _book_add_form_elements(&$form, $node) {
  // Need this for AJAX.
  $form['#cache'] = TRUE;
418
  drupal_add_js("if (Drupal.jsEnabled) { $(document).ready(function() { $('#edit-book-pick-book').css('display', 'none'); }); }", 'inline');
Dries's avatar
Dries committed
419 420 421 422 423 424 425 426

  $form['book'] = array(
    '#type' => 'fieldset',
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#tree' => TRUE,
427
    '#attributes' => array('class' => 'book-outline-form'),
428
  );
429
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
430 431 432 433 434 435 436 437 438 439
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

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

  $form['book']['weight'] = array(
    '#type' => 'weight',
440
    '#title' => t('Weight'),
Dries's avatar
Dries committed
441
    '#default_value' => $node->book['weight'],
442
    '#delta' => 15,
Dries's avatar
Dries committed
443
    '#weight' => 5,
444 445
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
446 447
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
448

449
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
450 451 452 453 454 455 456 457 458
    // 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
459 460
  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.
461
    $options = array($nid => '<' . t('create a new book') . '>') + $options;
Dries's avatar
Dries committed
462 463
  }
  if (!$node->book['mlid']) {
464
    // The node is not currently in the hierarchy.
465
    $options = array(0 => '<' . t('none') . '>') + $options;
Dries's avatar
Dries committed
466 467 468 469 470 471 472 473 474 475 476
  }

  // 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,
477
    '#attributes' => array('class' => 'book-title-select'),
478 479 480 481 482
    '#ahah' => array(
      'path' => 'book/js/form',
      'wrapper' => 'edit-book-plid-wrapper',
      'effect' => 'slide',
    ),
483
  );
Dries's avatar
Dries committed
484
}
Dries's avatar
 
Dries committed
485

486
/**
Dries's avatar
Dries committed
487
 * Common helper function to handles additions and updates to the book outline.
Dries's avatar
Dries committed
488
 *
Dries's avatar
Dries committed
489 490 491 492 493 494 495 496 497
 * 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']);

498
  $node->book['link_path'] = 'node/' . $node->nid;
Dries's avatar
Dries committed
499 500 501 502 503 504 505 506 507 508
  $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'])) {
509 510 511
      $parent = db_query("SELECT * FROM {book} WHERE mlid = :mlid", array(
        ':mlid' => $node->book['plid'],
      ))->fetchAssoc();
Dries's avatar
Dries committed
512 513
    }
    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {
514 515 516
      $node->book['plid'] = db_query("SELECT mlid FROM {book} WHERE nid = :nid", array(
        ':nid' => $node->book['bid'],
      ))->fetchField();
Dries's avatar
Dries committed
517 518 519
      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.
    }
  }
520

Dries's avatar
Dries committed
521 522 523
  if (menu_link_save($node->book)) {
    if ($new) {
      // Insert new.
524 525 526 527 528 529 530
      db_insert('book')
        ->fields(array(
          'nid' => $node->nid,
          'mlid' => $node->book['mlid'],
          'bid' => $node->book['bid'],
        ))
        ->execute();
Dries's avatar
Dries committed
531 532
    }
    else {
533 534 535
      if ($node->book['bid'] != db_query("SELECT bid FROM {book} WHERE nid = :nid", array(
          ':nid' => $node->nid,
        ))->fetchField()) {
Dries's avatar
Dries committed
536 537 538 539
        // Update the bid for this page and all children.
        book_update_bid($node->book);
      }
    }
540

Dries's avatar
Dries committed
541 542
    return TRUE;
  }
543 544

  // Failed to save the menu link.
Dries's avatar
Dries committed
545 546 547
  return FALSE;
}

548
/**
Dries's avatar
Dries committed
549
 * Update the bid for a page and its children when it is moved to a new book.
550
 *
Dries's avatar
Dries committed
551 552 553 554
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 */
function book_update_bid($book_link) {
555 556
  $query = db_select('menu_links');
  $query->addField('menu_links', 'mlid');
Dries's avatar
Dries committed
557
  for ($i = 1; $i <= MENU_MAX_DEPTH && $book_link["p$i"]; $i++) {
558
    $query->condition("p$i", $book_link["p$i"]);
Dries's avatar
Dries committed
559
  }
560
  $mlids = $query->execute()->fetchCol();
561

Dries's avatar
Dries committed
562
  if ($mlids) {
563 564 565 566
    db_update('book')
      ->fields(array('bid', $book_link['bid']))
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
567 568 569 570 571
  }
}

/**
 * Get the book menu tree for a page, and return it as a linear array.
572
 *
Dries's avatar
Dries committed
573 574
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
575
 * @return
Dries's avatar
Dries committed
576 577
 *   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
578
 *   element corresponding to $node. The children of $node (if any) will come
Dries's avatar
Dries committed
579
 *   immediately after it in the array.
580
 */
Dries's avatar
Dries committed
581 582 583 584
function book_get_flat_menu($book_link) {
  static $flat = array();

  if (!isset($flat[$book_link['mlid']])) {
585
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
Dries's avatar
Dries committed
586 587 588
    $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
589
  }
590

Dries's avatar
Dries committed
591
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
592 593
}

594
/**
Dries's avatar
Dries committed
595
 * Recursive helper function for book_get_flat_menu().
596
 */
Dries's avatar
Dries committed
597 598 599 600 601 602 603 604
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
605
  }
Dries's avatar
Dries committed
606
}
Dries's avatar
 
Dries committed
607

Dries's avatar
Dries committed
608 609 610 611 612 613 614
/**
 * 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
615
  }
Dries's avatar
Dries committed
616 617 618 619 620 621 622 623 624 625 626 627
  $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.
628 629
      $tree = book_menu_subtree_data($prev);
      $data = array_shift($tree);
Dries's avatar
Dries committed
630 631 632 633
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
634

Dries's avatar
Dries committed
635 636 637 638 639
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
640 641 642
  }
}

643
/**
Dries's avatar
Dries committed
644
 * Fetches the menu link for the next page of the book.
645
 */
Dries's avatar
Dries committed
646 647 648 649 650
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);
651 652 653
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
654 655
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
656
  }
Dries's avatar
Dries committed
657
}
Dries's avatar
 
Dries committed
658

Dries's avatar
Dries committed
659 660 661 662 663
/**
 * Format the menu links for the child pages of the current page.
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
664

Dries's avatar
Dries committed
665 666 667 668 669 670
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
671 672
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
673 674 675 676 677
    // 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
678 679
    }
  }
680

Dries's avatar
Dries committed
681
  return $children ? menu_tree_output($children) : '';
Dries's avatar
 
Dries committed
682 683
}

684
/**
Dries's avatar
Dries committed
685
 * Generate the corresponding menu name from a book ID.
686
 */
Dries's avatar
Dries committed
687
function book_menu_name($bid) {
688
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
689 690 691 692 693 694 695 696 697 698
}

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

  if (!isset($trail)) {
    $trail = array();
699
    $trail[] = array('title' => t('Home'), 'href' => '<front>', 'localized_options' => array());
Dries's avatar
Dries committed
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717

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

Dries's avatar
Dries committed
719
  return $trail;
Dries's avatar
 
Dries committed
720 721
}

722
/**
723
 * Implementation of hook_nodeapi_load().
724
 */
725 726 727 728 729 730 731
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']);
732 733
  }
}
734

735 736 737
/**
 * Implementation of hook_nodeapi_view().
 */
738
function book_nodeapi_view($node, $teaser, $page) {
739 740 741 742 743 744
  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,
      );
745

746 747 748
      if ($page) {
        menu_set_active_trail(book_build_active_trail($node->book));
        menu_set_active_menu_name($node->book['menu_name']);
749
      }
750 751
    }
  }
752 753
  
  book_nodeapi_view_link($node, $teaser, $page);
754
}
755

756 757 758
/**
 * Implementation of hook_nodeapi_presave().
 */
759
function book_nodeapi_presave($node) {
760 761 762 763 764 765 766 767 768
  // 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;
  }
}
769

770 771 772
/**
 * Implementation of hook_nodeapi_insert().
 */
773
function book_nodeapi_insert($node) {
774 775 776 777 778 779 780 781 782 783
  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);
  }
}
784

785 786 787
/**
 * Implementation of hook_nodeapi_update().
 */
788
function book_nodeapi_update($node) {
789 790 791 792 793 794 795 796 797 798
  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);
  }
}
799

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

/**
 * Implementation of hook_nodeapi_prepare().
 */
826
function book_nodeapi_prepare($node) {
827 828 829 830 831 832 833 834 835 836 837 838
  // 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'];
839
      }
840 841 842 843 844 845 846 847 848 849 850 851
    }
    // 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
852 853 854
  }
}

855 856 857 858 859 860 861
/**
 * 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
862 863 864 865 866 867 868 869
/**
 * 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(
870
      '#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
871 872
      '#weight' => -10,
    );
Dries's avatar
 
Dries committed
873
  }
Dries's avatar
 
Dries committed
874
}
Dries's avatar
 
Dries committed
875

876
/**
Dries's avatar
Dries committed
877 878 879 880 881 882 883
 * 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());
}

/**
884
 * Process variables for book-navigation.tpl.php.
Dries's avatar
Dries committed
885
 *
886 887
 * The $variables array contains the following arguments:
 * - $book_link
888
 *
889
 * @see book-navigation.tpl.php
890
 */
891 892 893 894 895 896
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']);
897
  $variables['book_url'] = 'node/' . $book_link['bid'];
898 899
  $variables['current_depth'] = $book_link['depth'];
  $variables['tree'] = '';
900

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

Dries's avatar
Dries committed
904
    if ($prev = book_prev($book_link)) {
905 906 907 908
      $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
909
    }
910

Dries's avatar
Dries committed
911
    if ($book_link['plid'] && $parent = book_link_load($book_link['plid'])) {
912 913 914 915
      $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
916
    }
917

Dries's avatar
Dries committed
918
    if ($next = book_next($book_link)) {
919 920 921 922
      $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
923
    }
924
  }
Dries's avatar
 
Dries committed
925

926 927 928 929 930 931 932 933 934 935 936
  $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] = '';
937
    }
Dries's avatar
 
Dries committed
938
  }
Dries's avatar
 
Dries committed
939
}
Dries's avatar
 
Dries committed
940

941
/**
Dries's avatar
Dries committed
942
 * A recursive helper function for book_toc().
943
 */
944
function _book_toc_recurse($tree, $indent, &$toc, $exclude, $depth_limit) {
Dries's avatar
Dries committed
945
  foreach ($tree as $data) {
946 947 948 949
    if ($data['link']['depth'] > $depth_limit) {
      // Don't iterate through any links on this level.
      break;
    }
950

Dries's avatar
Dries committed
951
    if (!in_array($data['link']['mlid'], $exclude)) {
952
      $toc[$data['link']['mlid']] = $indent . ' ' . truncate_utf8($data['link']['title'], 30, TRUE, TRUE);
953
      if ($data['below']) {
954
        _book_toc_recurse($data['below'], $indent . '--', $toc, $exclude, $depth_limit);
955
      }
Dries's avatar
 
Dries committed
956 957 958 959
    }
  }
}

960
/**
Dries's avatar
Dries committed
961 962 963 964 965
 * 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
966
 *   Optional array of mlid values. Any link whose mlid is in this array
Dries's avatar
Dries committed
967
 *   will be excluded (along with its children).
968 969
 * @param $depth_limit
 *   Any link deeper than this value will be excluded (along with its children).
Dries's avatar
Dries committed
970 971
 * @return
 *   An array of mlid, title pairs for use as options for selecting a book page.
972
 */
973
function book_toc($bid, $exclude = array(), $depth_limit) {
Dries's avatar
Dries committed
974
  $tree = menu_tree_all_data(book_menu_name($bid));
975
  $toc = array();
976
  _book_toc_recurse($tree, '', $toc, $exclude, $depth_limit);
Dries's avatar
 
Dries committed
977

Dries's avatar
 
Dries committed
978 979 980
  return $toc;
}

981 982 983 984 985 986 987 988 989 990