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

Dries's avatar
 
Dries committed
4 5
/**
 * @file
Dries's avatar
Dries committed
6
 * Allows users to structure the pages of a site in a hierarchy or outline.
Dries's avatar
 
Dries committed
7 8
 */

9 10 11 12 13 14
/**
 * Implementation of hook_theme()
 */
function book_theme() {
  return array(
    'book_navigation' => array(
Dries's avatar
Dries committed
15
      'arguments' => array('book_link' => NULL),
16 17 18 19 20 21 22
    ),
    'book_export_html' => array(
      'arguments' => array('title' => NULL, 'content' => NULL),
    ),
    'book_admin_table' => array(
      'arguments' => array('form' => NULL),
    ),
Dries's avatar
Dries committed
23 24 25 26 27 28
    'book_title_link' => array(
      'arguments' => array('link' => NULL),
    ),
    'book_all_books_block' => array(
      'arguments' => array('book_menus' => array()),
    ),
29 30 31
  );
}

32 33 34
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
35
function book_perm() {
Dries's avatar
Dries committed
36
  return array('add content to books', 'administer book outlines', 'create new books', 'access printer-friendly version');
Dries's avatar
 
Dries committed
37 38
}

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

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

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

Dries's avatar
Dries committed
135 136 137
/**
 * Menu item access callback - determine if the outline tab is accessible.
 */
138
function _book_outline_access($node) {
Dries's avatar
Dries committed
139 140 141 142 143 144 145 146
  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);
147 148
}

Dries's avatar
Dries committed
149 150 151
/**
 * Implementation of hook_init(). Add's the book module's CSS.
 */
152 153 154 155
function book_init() {
  drupal_add_css(drupal_get_path('module', 'book') .'/book.css');
}

156 157 158
/**
 * Implementation of hook_block().
 *
Dries's avatar
 
Dries committed
159 160
 * Displays the book table of contents in a block when the current page is a
 * single-node view of a book node.
161
 */
Dries's avatar
Dries committed
162
function book_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
 
Dries committed
163
  $block = array();
Dries's avatar
Dries committed
164 165 166
  switch ($op) {
    case 'list':
      $block[0]['info'] = t('Book navigation');
167
      $block[0]['cache'] = BLOCK_CACHE_PER_PAGE | BLOCK_CACHE_PER_ROLE;
Dries's avatar
Dries committed
168 169
      return $block;
    case 'view':
170 171 172 173
      if (arg(0) == 'node' && is_numeric(arg(1))) {
        $node = node_load(arg(1));
      }
      $current_bid = empty($node->book['bid']) ? 0 : $node->book['bid'];
Dries's avatar
Dries committed
174 175 176 177
      $mode = variable_get('book_block_mode', 'all pages');
      if ($mode == 'all pages') {
        $block['subject'] = t('Book navigation');
        $book_menus = array();
178
        $pseudo_tree = array(0 => array('below' => FALSE));
Dries's avatar
Dries committed
179
        foreach (book_get_books() as $book) {
180 181 182 183 184 185 186 187 188 189 190 191
          if ($book['bid'] == $current_bid) {
            // If the current page is a node associated with a book, the menu
            // needs to be retrieved.
            $book_menus[] = menu_tree_output(menu_tree_all_data($node->book['menu_name'], $node->book));
          }
          else {
            // Since we know we will only display a link to the top node, there
            // is no reason to run an additional menu tree query for each book.
            $book['in_active_trail'] = FALSE;
            $pseudo_tree[0]['link'] = $book;
            $book_menus[] = menu_tree_output($pseudo_tree);
          }
Dries's avatar
 
Dries committed
192
        }
Dries's avatar
Dries committed
193
        $block['content'] = theme('book_all_books_block', $book_menus);
Dries's avatar
 
Dries committed
194
      }
195
      elseif ($current_bid) {
Dries's avatar
Dries committed
196
        // Only display this block when the user is browsing a book.
197 198 199 200 201 202 203 204
        $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
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
        }
      }
      return $block;
    case 'configure':
      $options = array(
        'all pages' => t('Show block on all pages'),
        'book pages' => t('Show block only on book pages'),
      );
      $form['book_block_mode'] = array(
        '#type' => 'radios',
        '#title' => t('Book navigation block display'),
        '#options' => $options,
        '#default_value' => variable_get('book_block_mode', 'all pages'),
        '#description' => t("If <em>Show block on all pages</em> is selected, the block will contain the automatically generated menus for all of the site's books. If <em>Show block only on book pages</em> is selected, the block will contain only the one menu corresponding to the current page's book. In this case, if the current page is not in a book, no block will be displayed.  The <em>Page specific visibility settings</em> or other visibility settings can be used in addition to selectively display this block."),
        );
      return $form;
    case 'save':
      variable_set('book_block_mode', $edit['book_block_mode']);
      break;
  }
}
Dries's avatar
 
Dries committed
226

Dries's avatar
Dries committed
227 228 229 230 231 232 233 234 235
/**
 * Generate the HTML output for the block showing all book menus.
 *
 * @ingroup themeable
 */
function theme_book_all_books_block($book_menus) {
  $output = '';
  foreach ($book_menus as $menu) {
    $output .= '<div class="book-block-menu">'. $menu ."</div>\n";
236
  }
Dries's avatar
Dries committed
237
  return $output;
Dries's avatar
 
Dries committed
238 239
}

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

250
/**
Dries's avatar
Dries committed
251 252 253 254
 * Returns an array of all books.
 *
 * This list may be used for generating a list of all the books, or for building
 * the options for a form select.
255
 */
Dries's avatar
Dries committed
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
function book_get_books() {
  static $all_books;

  if (!isset($all_books)) {
    $all_books = array();
    $result = db_query("SELECT DISTINCT(bid) FROM {book}");
    $nids = array();
    while ($book = db_fetch_array($result)) {
      $nids[] = $book['bid'];
    }
    if ($nids) {
      $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"));
      while ($link = db_fetch_array($result2)) {
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
        $all_books[] = $link;
      }
    }
274
  }
Dries's avatar
Dries committed
275
  return $all_books;
276
}
277

278
/**
Dries's avatar
Dries committed
279 280 281 282 283 284 285 286 287 288 289 290 291
 * AJAX callback to replace the book parent select options.
 *
 * This function is called when the selected book is changed.  It updates the
 * cached form (either the node form or the book outline form) and returns
 * rendered output to be used to replace the select containing the possible
 * parent pages in the newly selected book.
 *
 * @param $build_id
 *   The form's build_id.
 * @param $bid
 *   A bid from from among those in the form's book select.
 * @return
 *   Prints the replacement HTML in JSON format.
292
 */
Dries's avatar
Dries committed
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
function book_form_update($build_id, $bid) {

  $cid = 'form_'. $build_id;
  $cache = cache_get($cid, 'cache_form');
  if ($cache) {
    $form = $cache->data;

    // Validate the bid.
    if (isset($form['book']['bid']['#options'][$bid])) {
      $book_link = $form['#node']->book;
      $book_link['bid'] = $bid;
      // Get the new options and update the cache.
      $form['book']['plid'] = _book_parent_select($book_link);
      // We set an updated expiration time for the cached form using the same
      // formula as used originally in function drupal_get_form()
      $expire = max(ini_get('session.cookie_lifetime'), 86400);
      cache_set($cid, $form, 'cache_form', $expire);

      // Build and render the new select element, then return it in JSON format.
      $form_state = array();
      $form['#post'] = array();
      $form = form_builder($form['form_id']['#value'] , $form, $form_state);
      $output = drupal_render($form['book']['plid']);
      drupal_json(array('book' => $output));
    }
318
  }
Dries's avatar
Dries committed
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
  exit();
}

/**
 * Implementation of hook_form_alter(). Adds the book fieldset to the node form.
 *
 * @see book_pick_book_submit()
 * @see book_submit()
 */
function book_form_alter(&$form, $form_state, $form_id) {

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

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

    if ($access) {
      _book_add_form_elements($form, $node);
      $form['book']['pick-book'] = array(
        '#type' => 'submit',
        '#value' => t('Change book (update list of parents)'),
347 348 349 350 351 352
         // Submit the node form so the parent select options get updated.
         // This is typically only used when JS is disabled.  Since the parent options
         // won't be changed via AJAX, a button is provided in the node form to submit
         // the form and generate options in the parent select corresponding to the
         // selected book.  This is similar to what happens during a node preview.
        '#submit' => array('node_form_submit_build_node'),
Dries's avatar
Dries committed
353 354 355
        '#weight' => 20,
      );
    }
356
  }
Dries's avatar
Dries committed
357
}
358

Dries's avatar
Dries committed
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
/**
 * Build the parent selection form element for the node form or outline tab
 *
 * This function is also called when generating a new set of options during the
 * AJAX callback, so an array is returned that can be used to replace an existing
 * form element.
 */
function _book_parent_select($book_link) {
  // Offer a message or a drop-down to choose a different parent page.
  $form = array(
    '#type' => 'hidden',
    '#value' => -1,
    '#prefix' => '<div id="edit-book-plid-wrapper">',
    '#suffix' => '</div>',
  );
374

Dries's avatar
Dries committed
375 376 377 378 379 380 381 382 383 384 385
  if ($book_link['nid'] === $book_link['bid']) {
    // This is a book - at the top level.
    if ($book_link['original_bid'] === $book_link['bid']) {
      $form['#prefix'] .= '<em>'. t('This is the top-level page in this book.') .'</em>';
    }
    else {
      $form['#prefix'] .= '<em>'. t('This will be the top-level page in this book.') .'</em>';
    }
  }
  elseif (!$book_link['bid']) {
    $form['#prefix'] .= '<em>'. t('No book selected.') .'</em>';
386 387
  }
  else {
388 389 390
    // If the item has children, there is an added limit to the depth of valid parents.
    $limit = MENU_MAX_DEPTH - 1 - ($book_link['has_children'] ? menu_link_children_relative_depth($book_link) : 0);

Dries's avatar
Dries committed
391 392 393 394
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
395 396 397
      '#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)),
      '#options' => book_toc($book_link['bid'], array($book_link['mlid']), $limit),
      '#attributes' => array('class' => 'book-title-select'),
398
    );
Dries's avatar
 
Dries committed
399
  }
400
  return $form;
Dries's avatar
 
Dries committed
401 402
}

403
/**
Dries's avatar
Dries committed
404
 * Build the common elements of the book form for the node and outline forms.
405
 */
Dries's avatar
Dries committed
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
function _book_add_form_elements(&$form, $node) {
  $settings['book']['formCallback'] = url('book-form-update' , array());
  $settings['book']['formId'] = $form['#id'];
  drupal_add_js($settings, 'setting');
  drupal_add_js(drupal_get_path('module', 'book'). '/book.js');
  drupal_add_js('misc/progress.js');

  // Need this for AJAX.
  $form['#cache'] = TRUE;

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

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

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

445 446 447 448 449 450 451 452 453 454
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && $node->book['has_children'] && (MENU_MAX_DEPTH - 1 - menu_link_children_relative_depth($node->book) == 0)) {
    // 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
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
  if (user_access('create new books') && ($nid == 'new' || ($nid != $node->book['original_bid']))) {
    // The node can become a new book, if it is not one already.
    $options = array($nid => '<'. t('create a new book') .'>') + $options;
  }
  if (!$node->book['mlid']) {
    // The node is not currently in a the hierarchy.
    $options = array(0 => '<'. t('none') .'>') + $options;
  }

  // Add a drop-down to select the destination book.
  $form['book']['bid'] = array(
    '#type' => 'select',
    '#title' => t('Book'),
    '#default_value' => $node->book['bid'],
    '#options' => $options,
    '#access' => (bool)$options,
    '#description' => t('Your page will be a part of the selected book.'),
    '#weight' => -5,
473
    '#attributes' => array('class' => 'book-title-select'),
474
  );
Dries's avatar
Dries committed
475
}
Dries's avatar
 
Dries committed
476

Dries's avatar
Dries committed
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
/**
 * Menu callback; show the outline form for a single node.
 */
function book_outline($node) {
  drupal_set_title(check_plain($node->title));
  return drupal_get_form('book_outline_form', $node);
}

/**
 * Build the form to handle all book outline operations via the outline tab.
 *
 * @see book_outline_form_submit()
 * @see book_remove_button_submit()
 *
 * @ingroup forms
 */
function book_outline_form(&$form_state, $node) {

  if (!isset($node->book)) {
    // The node is not part of any book yet - set default options.
    $node->book = _book_link_defaults($node->nid);
498 499
  }
  else {
Dries's avatar
Dries committed
500
    $node->book['original_bid'] = $node->book['bid'];
501
  }
Dries's avatar
Dries committed
502 503 504 505 506 507
  $form['#node'] = $node;
  $form['#id'] = 'book-outline';
  _book_add_form_elements($form, $node);

  $form['book']['#collapsible'] = FALSE;

508
  $form['update'] = array(
Dries's avatar
Dries committed
509 510 511 512 513
    '#type' => 'submit',
    '#value' => $node->book['original_bid'] ? t('Update book outline') : t('Add to book outline'),
    '#weight' => 15,
  );

514
  $form['remove'] = array(
Dries's avatar
Dries committed
515 516 517 518 519 520
    '#type' => 'submit',
    '#value' => t('Remove from book outline'),
    '#access' => $node->nid != $node->book['bid'] && $node->book['bid'],
    '#weight' => 20,
    '#submit' => array('book_remove_button_submit'),
  );
Dries's avatar
 
Dries committed
521

522
  return $form;
523 524 525
}

/**
Dries's avatar
Dries committed
526 527 528
 * Button submit function to redirect to removal confirm form.
 *
 * @see book_outline_form()
529
 */
Dries's avatar
Dries committed
530 531 532
function book_remove_button_submit($form,  &$form_state) {
  $form_state['redirect'] = 'node/'. $form['#node']->nid .'/outline/remove';
}
533

Dries's avatar
Dries committed
534 535 536 537 538 539 540 541 542
/**
 * Menu callback; builds a form to confirm removal of a node from the book.
 *
 * @see book_remove_form_submit()
 *
 * @ingroup forms
 */
function book_remove_form(&$form_state, $node) {
  $form['#node'] = $node;
543
  $title = array('%title' => $node->title);
Dries's avatar
Dries committed
544

545 546 547 548 549 550 551 552
  if ($node->book['has_children']) {
    $description = t('%title has associated child pages, which will be relocated automatically to maintain their connection to the book. To recreate the hierarchy (as it was before removing this page), %title may be added again using the Outline tab, and each of its former child pages will need to be relocated manually.', $title);
  }
  else {
    $description = t('%title may be added to hierarchy again using the Outline tab.', $title);
  }

  return confirm_form($form, t('Are you sure you want to remove %title from the book hierarchy?', $title), 'node/'. $node->nid,  $description, t('Remove'));
Dries's avatar
Dries committed
553 554 555 556 557 558 559 560 561 562 563 564 565 566
}

/**
 * Confirm form submit function to remove a node from the book.
 *
 * @see book_remove_form()
 */
function book_remove_form_submit($form, &$form_state) {
  $node = $form['#node'];
  if ($node->nid != $node->book['bid']) {
    // Only allowed when this is not a book (top-level page).
    menu_link_delete($node->book['mlid']);
    db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
    drupal_set_message(t('The post has been removed from the book.'));
Dries's avatar
 
Dries committed
567
  }
Dries's avatar
Dries committed
568
  $form_state['redirect'] = 'node/'. $node->nid;
Dries's avatar
 
Dries committed
569 570
}

571
/**
Dries's avatar
Dries committed
572
 * Common helper function to handles additions and updates to the book outline.
Dries's avatar
Dries committed
573
 *
Dries's avatar
Dries committed
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
 * Performs all additions and updates to the book outline through node addition,
 * node editing, node deletion, or the outline tab.
 */
function _book_update_outline(&$node) {
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

  $node->book['link_path'] = 'node/'. $node->nid;
  $node->book['link_title'] = $node->title;
  $node->book['parent_mismatch'] = FALSE; // The normal case.

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

/**
 * Handles book outline form submissions from the outline tab.
620
 *
Dries's avatar
Dries committed
621
 * @see book_outline_form()
622
 */
Dries's avatar
Dries committed
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
function book_outline_form_submit($form, &$form_state) {
  $node = $form['#node'];
  $form_state['redirect'] = "node/". $node->nid;
  $book_link = $form_state['values']['book'];
  if (!$book_link['bid']) {
    drupal_set_message(t('No changes were made'));
    return;
  }

  $book_link['menu_name'] = book_menu_name($book_link['bid']);
  $node->book = $book_link;
  if (_book_update_outline($node)) {
    if ($node->book['parent_mismatch']) {
      // This will usually only happen when JS is disabled.
      drupal_set_message(t('The post has been added to the selected book. You may now position it relative to other pages.'));
      $form_state['redirect'] = "node/". $node->nid ."/outline";
    }
    else {
      drupal_set_message(t('The book outline has been updated.'));
    }
  }
  else {
645
    drupal_set_message(t('There was an error adding the post to the book.'), 'error');
Dries's avatar
 
Dries committed
646 647 648
  }
}

649
/**
Dries's avatar
Dries committed
650
 * Update the bid for a page and its children when it is moved to a new book.
651
 *
Dries's avatar
Dries committed
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 */
function book_update_bid($book_link) {

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

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

/**
 * Get the book menu tree for a page, and return it as a linear array.
674
 *
Dries's avatar
Dries committed
675 676
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
677
 * @return
Dries's avatar
Dries committed
678 679 680 681
 *   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.
682
 */
Dries's avatar
Dries committed
683 684 685 686 687 688 689 690
function book_get_flat_menu($book_link) {
  static $flat = array();

  if (!isset($flat[$book_link['mlid']])) {
    // Call menu_tree_full_data() to take advantage of the menu system's caching.
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link);
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
 
Dries committed
691
  }
Dries's avatar
Dries committed
692
  return $flat[$book_link['mlid']];
Dries's avatar
 
Dries committed
693 694
}

695
/**
Dries's avatar
Dries committed
696
 * Recursive helper function for book_get_flat_menu().
697
 */
Dries's avatar
Dries committed
698 699 700 701 702 703 704 705
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
706
  }
Dries's avatar
Dries committed
707
}
Dries's avatar
 
Dries committed
708

Dries's avatar
Dries committed
709 710 711 712 713 714 715
/**
 * 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
716
  }
Dries's avatar
Dries committed
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
  $flat = book_get_flat_menu($book_link);
  // Assigning the array to $flat resets the array pointer for use with each().
  $curr = NULL;
  do {
    $prev = $curr;
    list($key, $curr) = each($flat);
  } while ($key && $key != $book_link['mlid']);

  if ($key == $book_link['mlid']) {
    // The previous page in the book may be a child of the previous visible link.
    if ($prev['depth'] == $book_link['depth'] && $prev['has_children']) {
      // The subtree will have only one link at the top level - get its data.
      $data = array_shift(book_menu_subtree_data($prev));
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
 
Dries committed
739 740 741
  }
}

742
/**
Dries's avatar
Dries committed
743
 * Fetches the menu link for the next page of the book.
744
 */
Dries's avatar
Dries committed
745 746 747 748 749 750 751 752
function book_next($book_link) {
  $flat = book_get_flat_menu($book_link);
  // Assigning the array to $flat resets the array pointer for use with each().
  do {
    list($key, $curr) = each($flat);
  } while ($key && $key != $book_link['mlid']);
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
 
Dries committed
753
  }
Dries's avatar
Dries committed
754
}
Dries's avatar
 
Dries committed
755

Dries's avatar
Dries committed
756 757 758 759 760
/**
 * Format the menu links for the child pages of the current page.
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
761

Dries's avatar
Dries committed
762 763 764 765 766 767 768 769 770 771 772 773
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
    } while ($link && ($link['mlid'] != $book_link['mlid']));
    // Continue though the array and collect the links whose parent is this page.
    while (($link = array_shift($flat)) && $link['plid'] == $book_link['mlid']) {
      $data['link'] = $link;
      $data['below'] = '';
      $children[] = $data;
Dries's avatar
 
Dries committed
774 775
    }
  }
Dries's avatar
Dries committed
776
  return $children ? menu_tree_output($children) : '';
Dries's avatar
 
Dries committed
777 778
}

779
/**
Dries's avatar
Dries committed
780
 * Generate the corresponding menu name from a book ID.
781
 */
Dries's avatar
Dries committed
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
function book_menu_name($bid) {
  return 'book-toc-'. $bid;
}

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

  if (!isset($trail)) {
    $trail = array();
    $trail[] = array('title' => t('Home'), 'href' => '<front>', 'options' => array());

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

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

816
/**
Dries's avatar
 
Dries committed
817 818
 * Implementation of hook_nodeapi().
 *
Dries's avatar
Dries committed
819 820
 * Appends book navigation to all nodes in the book, and handles book outline
 * insertions and updates via the node form.
821
 */
Dries's avatar
 
Dries committed
822 823
function book_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
824
    case 'load':
Dries's avatar
Dries committed
825 826 827 828 829 830 831 832
      // Note - we cannot use book_link_load() because it will call node_load()
      $info['book'] = db_fetch_array(db_query('SELECT * FROM {book} b INNER JOIN {menu_links} ml ON b.mlid = ml.mlid WHERE b.nid = %d', $node->nid));
      if ($info['book']) {
        $info['book']['href'] = $info['book']['link_path'];
        $info['book']['title'] = $info['book']['link_title'];
        $info['book']['options'] = unserialize($info['book']['options']);
        return $info;
      }
833
      break;
Dries's avatar
 
Dries committed
834
    case 'view':
Dries's avatar
Dries committed
835 836
    if (!$teaser) {
        if (!empty($node->book['bid']) && $node->build_mode == NODE_BUILD_NORMAL) {
837

838
          $node->content['book_navigation'] = array(
Dries's avatar
Dries committed
839
            '#value' => theme('book_navigation', $node->book),
840 841
            '#weight' => 100,
          );
842

843
          if ($page) {
Dries's avatar
Dries committed
844 845
            menu_set_active_trail(book_build_active_trail($node->book));
            menu_set_active_menu_name($node->book['menu_name']);
846
          }
Dries's avatar
 
Dries committed
847
        }
Dries's avatar
 
Dries committed
848
      }
Dries's avatar
 
Dries committed
849
      break;
Dries's avatar
Dries committed
850 851 852 853 854 855 856
    case 'presave':
      // Always save a revision for non-administrators.
      if (!empty($node->book['bid']) && !user_access('administer nodes')) {
        $node->revision = 1;
      }
      break;
    case 'insert':
857
    case 'update':
Dries's avatar
Dries committed
858 859 860 861
      if (!empty($node->book['bid'])) {
        if ($node->book['bid'] == 'new') {
          // New nodes that are their own book.
          $node->book['bid'] = $node->nid;
862
        }
Dries's avatar
Dries committed
863 864 865
        $node->book['nid'] = $node->nid;
        $node->book['menu_name'] = book_menu_name($node->book['bid']);
        _book_update_outline($node);
866 867
      }
      break;
868
    case 'delete':
Dries's avatar
Dries committed
869 870 871 872 873 874 875 876 877 878 879 880 881
      if (!empty($node->book['bid'])) {
        if ($node->nid == $node->book['bid']) {
          // Handle deletion of a top-level post.
          $result = db_query("SELECT b.nid FROM {menu_links} ml INNER JOIN {book} b on b.mlid = ml.mlid WHERE ml.plid = %d", $node->book['mlid']);
          while ($child = db_fetch_array($result)) {
            $child_node = node_load($child['nid']);
            $child_node->book['bid'] = $child_node->nid;
            _book_update_outline($child_node);
          }
        }
        menu_link_delete($node->book['mlid']);
        db_query('DELETE FROM {book} WHERE mlid = %d', $node->book['mlid']);
      }
882
      break;
Dries's avatar
Dries committed
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
    case 'prepare':
      // Prepare defaults for the add/edit form.
      if (empty($node->book) && (user_access('add content to books') || user_access('administer book outlines'))) {
        $node->book = array();
        if (empty($node->nid) && isset($_GET['parent']) && is_numeric($_GET['parent'])) {
          // Handle "Add child page" links:
          $parent = book_link_load($_GET['parent']);
          if ($parent && $parent['access']) {
            $node->book['bid'] = $parent['bid'];
            $node->book['plid'] = $parent['mlid'];
            $node->book['menu_name'] = $parent['menu_name'];
          }
        }
        // Set defaults.
        $node->book += _book_link_defaults(!empty($node->nid) ? $node->nid : 'new');
      }
      else {
        if (isset($node->book['bid']) && !isset($node->book['original_bid'])) {
          $node->book['original_bid'] = $node->book['bid'];
        }
      }
      break;
  }
}

/**
 * Form altering function for the confirm form for a single node deletion.
 */
function book_form_node_delete_confirm_alter(&$form, $form_state) {

  $node = node_load($form['nid']['#value']);

  if (isset($node->book) && $node->book['has_children']) {
    $form['book_warning'] = array(
      '#value' => '<p>'. t('%title is part of a book outline, and has associated child pages. If you proceed with deletion, the child pages will be relocated automatically.', array('%title' => $node->title)) .'</p>',
      '#weight' => -10,
    );
Dries's avatar
 
Dries committed
920
  }
Dries's avatar
 
Dries committed
921
}
Dries's avatar
 
Dries committed
922

923
/**
Dries's avatar
Dries committed
924 925 926 927 928 929 930 931 932 933 934
 * Return an array with default values for a book link.
 */
function _book_link_defaults($nid) {
  return array('original_bid' => 0, 'menu_name' => '', 'nid' => $nid, 'bid' => 0, 'router_path' => 'node/%', 'plid' => 0, 'mlid' => 0, 'has_children' => 0, 'weight' => 0, 'module' => 'book', 'options' => array());
}

/**
 * Prepares the links to the children of the page and the previous/up/next navigation.
 *
 * These navigation elements are added to the content of a node in the book
 * outline when it is viewed as a page and in similar contexts.
935 936
 *
 * @ingroup themeable
937
 */
Dries's avatar
Dries committed
938
function theme_book_navigation($book_link) {
939
  $output = '';
940
  $links = '';
941

Dries's avatar
Dries committed
942 943
  if ($book_link['mlid']) {
    $tree = book_children($book_link);
Dries's avatar
 
Dries committed
944

Dries's avatar
Dries committed
945 946 947
    if ($prev = book_prev($book_link)) {
      drupal_add_link(array('rel' => 'prev', 'href' => url($prev['href'])));
      $links .= l(t('‹ ') . $prev['title'], $prev['href'], array('attributes' => array('class' => 'page-previous', 'title' => t('Go to previous page'))));
Dries's avatar
 
Dries committed
948
    }
Dries's avatar
Dries committed
949 950 951
    if ($book_link['plid'] && $parent = book_link_load($book_link['plid'])) {
      drupal_add_link(array('rel' => 'up', 'href' => url($parent['href'])));
      $links .= l(t('up'), $parent['href'], array('attributes' => array('class' => 'page-up', 'title' => t('Go to parent page'))));
Dries's avatar
 
Dries committed
952
    }
Dries's avatar
Dries committed
953 954 955
    if ($next = book_next($book_link)) {
      drupal_add_link(array('rel' => 'next', 'href' => url($next['href'])));
      $links .= l($next['title'] . t(' ›'), $next['href'], array('attributes' => array('class' => 'page-next', 'title' => t('Go to next page'))));
Dries's avatar
 
Dries committed
956
    }
Dries's avatar
 
Dries committed
957

958 959 960 961 962 963
    if (isset($tree) || isset($links)) {
      $output = '<div class="book-navigation">';
      if (isset($tree)) {
        $output .= $tree;
      }
      if (isset($links)) {
964
        $output .= '<div class="page-links clear-block">'. $links .'</div>';
965 966 967
      }
      $output .= '</div>';
    }
Dries's avatar
 
Dries committed
968
  }
Dries's avatar
 
Dries committed
969

970
  return $output;
Dries's avatar
 
Dries committed
971
}
Dries's avatar
 
Dries committed
972

973
/**
Dries's avatar
Dries committed
974
 * A recursive helper function for book_toc().
975
 */
976
function _book_toc_recurse($tree, $indent, &$toc, $exclude, $depth_limit) {
Dries's avatar
Dries committed
977
  foreach ($tree as $data) {
978 979 980 981
    if ($data['link']['depth'] > $depth_limit) {
      // Don't iterate through any links on this level.
      break;
    }
Dries's avatar
Dries committed
982 983
    if (!in_array($data['link']['mlid'], $exclude)) {
      $toc[$data['link']['mlid']] = $indent .' '. truncate_utf8($data['link']['title'], 30, TRUE, TRUE);
984 985
      if ($data['below']) {
        _book_toc_recurse($data['below'], $indent .'--', $toc, $exclude, $depth_limit);
986
      }
Dries's avatar
 
Dries committed
987 988 989 990
    }
  }
}

991
/**
Dries's avatar
Dries committed
992 993 994 995 996 997 998
 * 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).
999 1000
 * @param $depth_limit
 *   Any link deeper than this value will be excluded (along with its children).
Dries's avatar
Dries committed
1001 1002
 * @return
 *   An array of mlid, title pairs for use as options for selecting a book page.
1003
 */
1004
function book_toc($bid, $exclude = array(), $depth_limit) {
Dries's avatar
 
Dries committed
1005

Dries's avatar
Dries committed
1006
  $tree = menu_tree_all_data(book_menu_name($bid));
1007
  $toc = array();
1008
  _book_toc_recurse($tree, '', $toc, $exclude, $depth_limit);
Dries's avatar
 
Dries committed
1009

Dries's avatar
 
Dries committed
1010 1011 1012
  return $toc;
}

1013
/**
Dries's avatar
Dries committed
1014
 * Menu callback; prints a listing of all books.
1015
 */
Dries's avatar
 
Dries committed
1016
function book_render() {
Dries's avatar
Dries committed
1017 1018 1019
  $book_list = array();
  foreach (book_get_books() as $book) {
    $book_list[] = l($book['title'], $book['href'], $book['options']);
1020 1021
  }

Dries's avatar
Dries committed
1022
  return theme('item_list', $book_list);
Dries's avatar
 
Dries committed
1023 1024
}

1025
/**
Dries's avatar
Dries committed
1026
 * Menu callback; Generates various representation of a book page and its children.
1027
 *
1028 1029
 * The function delegates the generation of output to helper functions.
 * The function name is derived by prepending 'book_export_' to the
1030
 * given output type. So, e.g., a type of 'html' results in a call to
1031
 * the function book_export_html().
1032
 *
Dries's avatar
Dries committed
1033 1034 1035
 * @param $type
 *   A string encoding the type of output requested. The following
 *   types are currently supported in book module:
1036
 *
Dries's avatar
Dries committed
1037 1038 1039 1040 1041 1042 1043 1044
 *   - html: HTML (printer friendly output)
 *
 *   Other types may be supported in contributed modules.
 * @param $nid
 *   An integer representing the node id (nid) of the node to export
 * @return
 *   A string representing the node and its children in the book hierarchy
 *   in a format determined by the $type parameter.
1045
 */
1046
function book_export($type, $nid) {
Dries's avatar
Dries committed
1047

1048
  $type = drupal_strtolower($type);
Dries's avatar
Dries committed
1049

1050
  $export_function = 'book_export_'. $type;
1051 1052

  if (function_exists($export_function)) {
Dries's avatar
Dries committed
1053
    print call_user_func($export_function, $nid);
1054 1055
  }
  else {
1056
    drupal_set_message(t('Unknown export format.'));
1057
    drupal_not_found();
1058
  }
1059
}
Dries's avatar
 
Dries committed
1060

1061 1062 1063 1064
/**
 * This function is called by book_export() to generate HTML for export.
 *
 * The given node is /embedded to its absolute depth in a top level
1065
 * section/. For example, a child node with depth 2 in the hierarchy
1066
 * is contained in (otherwise empty) &lt;div&gt; elements
1067
 * corresponding to depth 0 and depth 1. This is intended to support
1068 1069 1070 1071
 * WYSIWYG output - e.g., level 3 sections always look like level 3
 * sections, no matter their depth relative to the node selected to be
 * exported as printer-friendly HTML.
 *
Dries's avatar
Dries committed
1072 1073
 * @param $nid
 *   An integer representing the node id (nid) of the node to export.
1074
 * @return
Dries's avatar
Dries committed
1075 1076 1077 1078 1079
 *   A string containing HTML representing the node and its children in
 *   the book hierarchy.
 */
function book_export_html($nid) {
  if (user_access('access printer-friendly version')) {
1080
    $content = '';
1081
    $node = node_load($nid);
Dries's avatar
Dries committed
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
    if (isset($node->book)) {
      $depth = $node->book['depth'];
      for ($i = 1; $i < $depth; $i++) {
        $content .= "<div class=\"section-$i\">\n";
      }
      $tree = book_menu_subtree_data($node->book);
      $content .= book_export_traverse($tree, 'book_node_visitor_html_pre', 'book_node_visitor_html_post');

      for ($i = 1; $i < $depth; $i++) {
        $content .= "</div>\n";
      }
1093
    }
1094
    return theme('book_export_html', check_plain($node->title), $content);
1095 1096 1097 1098 1099 1100
  }
  else {
    drupal_access_denied();
  }
}

1101 1102 1103 1104 1105 1106
/**
 * How the book's HTML export should be themed
 *
 * @ingroup themeable
 */
function theme_book_export_html($title, $content) {
1107
  global $base_url, $language;
1108 1109 1110 1111
  $html = "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
  $html .= '<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">';
  $html .= "<head>\n<title>". $title ."</title>\n";
  $html .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
1112
  $html .= '<base href="'. $base_url .'/" />'."\n";
1113
  $html .= "<style type=\"text/css\">\n@import url(misc/print.css);\n";
1114
  if (defined('LANGUAGE_RTL') && $language->direction == LANGUAGE_RTL) {
1115 1116 1117
    $html .= "@import url(misc/print-rtl.css);\n";
  }
  $html .= "</style>\n";
1118
  $html .= "</head>\n<body>\n". $content ."\n</body>\n</html>\n";
1119 1120 1121
  return $html;
}

1122
/**
Dries's avatar
Dries committed
1123
 * Traverse the book tree to build printable or exportable output.
1124
 *
Dries's avatar
Dries committed
1125 1126 1127 1128
 * During the traversal, the $visit_pre() callback is applied to each
 * node, and is called recursively for each child of the node (in weight,
 * title order). Finally, the output of the $visit_post() callback is
 * appended before returning the generated output.