book.module 44 KB
Newer Older
Dries's avatar
 
Dries committed
1
2
<?php

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

8
/**
9
 * Implements hook_help().
10
11
12
13
14
 */
function book_help($path, $arg) {
  switch ($path) {
    case 'admin/help#book':
      $output = '<h3>' . t('About') . '</h3>';
15
      $output .= '<p>' . t('The Book module is used for creating structured, multi-page content, such as site resource guides, manuals, and wikis. It allows you to create content that has chapters, sections, subsections, or any similarly-tiered structure. For more information, see the online handbook entry for <a href="@book">Book module</a>.', array('@book' => 'http://drupal.org/handbook/modules/book/')) . '</p>';
16
17
18
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Adding and managing book content') . '</dt>';
19
      $output .= '<dd>' . t('You can assign separate permissions for <em>creating</em>, <em>editing</em>, and <em>deleting</em> book content, as well as <em>adding content to books</em>, and <em>creating new books</em>. Users with the <em>Administer book outlines</em> permission can add <em>any</em> type of content to a book by selecting the appropriate book outline while editing the content. They can also view a list of all books, and edit and rearrange section titles on the <a href="@admin-book">Book administration page</a>.', array('@admin-book' => url('admin/content/book'))) . '</dd>';
20
21
22
23
24
      $output .= '<dt>' . t('Book navigation') . '</dt>';
      $output .= '<dd>' . t("Book pages have a default book-specific navigation block. This navigation block contains links that lead to the previous and next pages in the book, and to the level above the current page in the book's structure. This block can be enabled on the <a href='@admin-block'>Blocks administration page</a>. For book pages to show up in the book navigation, they must be added to a book outline.", array('@admin-block' => url('admin/structure/block'))) . '</dd>';
      $output .= '<dt>' . t('Collaboration') . '</dt>';
      $output .= '<dd>' . t('Books can be created collaboratively, as they allow users with appropriate permissions to add pages into existing books, and add those pages to a custom table of contents menu.') . '</dd>';
      $output .= '<dt>' . t('Printing books') . '</dt>';
25
      $output .= '<dd>' . t("Users with the <em>View printer-friendly books</em> permission can select the <em>printer-friendly version</em> link visible at the bottom of a book page's content to generate a printer-friendly display of the page and all of its subsections.") . '</dd>';
26
27
28
29
30
31
32
33
34
      $output .= '</dl>';
      return $output;
    case 'admin/content/book':
      return '<p>' . t('The book module offers a means to organize a collection of related content pages, collectively known as a book. When viewed, this content automatically displays links to adjacent book pages, providing a simple navigation system for creating and reviewing structured content.') . '</p>';
    case 'node/%/outline':
      return '<p>' . t('The outline feature allows you to include pages in the <a href="@book">Book hierarchy</a>, as well as move them within the hierarchy or to <a href="@book-admin">reorder an entire book</a>.', array('@book' => url('book'), '@book-admin' => url('admin/content/book'))) . '</p>';
  }
}

35
/**
36
 * Implements hook_theme().
37
38
39
40
 */
function book_theme() {
  return array(
    'book_navigation' => array(
41
      'variables' => array('book_link' => NULL),
42
      'template' => 'book-navigation',
43
44
    ),
    'book_export_html' => array(
45
      'variables' => array('title' => NULL, 'contents' => NULL, 'depth' => NULL),
46
      'template' => 'book-export-html',
47
48
    ),
    'book_admin_table' => array(
49
      'render element' => 'form',
50
    ),
Dries's avatar
Dries committed
51
    'book_title_link' => array(
52
      'variables' => array('link' => NULL),
Dries's avatar
Dries committed
53
54
    ),
    'book_all_books_block' => array(
55
      'render element' => 'book_menus',
56
57
58
      'template' => 'book-all-books-block',
    ),
    'book_node_export_html' => array(
59
      'variables' => array('node' => NULL, 'children' => NULL),
60
      'template' => 'book-node-export-html',
Dries's avatar
Dries committed
61
    ),
62
63
64
  );
}

65
/**
66
 * Implements hook_permission().
67
 */
68
function book_permission() {
69
  return array(
70
71
72
73
74
75
76
    'administer book outlines' => array(
      'title' => t('Administer book outlines'),
    ),
    'create new books' => array(
      'title' => t('Create new books'),
    ),
    'add content to books' => array(
77
      'title' => t('Add content and child pages to books'),
78
79
    ),
    'access printer-friendly version' => array(
80
      'title' => t('View printer-friendly books'),
81
82
      'description' => t('View a book page and all of its sub-pages as a single document for ease of printing. Can be performance heavy.'),
    ),
83
  );
Dries's avatar
   
Dries committed
84
85
}

Dries's avatar
   
Dries committed
86
/**
Dries's avatar
Dries committed
87
 * Inject links into $node as needed.
Dries's avatar
   
Dries committed
88
 */
89
function book_node_view_link($node, $view_mode) {
Dries's avatar
   
Dries committed
90
  $links = array();
Dries's avatar
Dries committed
91

92
  if (isset($node->book['depth'])) {
93
    if ($view_mode == 'full' && node_is_page($node)) {
Dries's avatar
Dries committed
94
95
      $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) {
96
        $links['book_add_child'] = array(
97
          'title' => t('Add child page'),
98
          'href' => 'node/add/' . str_replace('_', '-', $child_type),
99
          'query' => array('parent' => $node->book['mlid']),
100
        );
Dries's avatar
   
Dries committed
101
      }
102

Dries's avatar
Dries committed
103
      if (user_access('access printer-friendly version')) {
104
        $links['book_printer'] = array(
105
          'title' => t('Printer-friendly version'),
106
          'href' => 'book/export/html/' . $node->nid,
107
          'attributes' => array('title' => t('Show a printer-friendly version of this book page and its sub-pages.'))
108
        );
109
      }
Dries's avatar
   
Dries committed
110
    }
Dries's avatar
   
Dries committed
111
  }
112

113
  if (!empty($links)) {
114
115
116
117
118
    $node->content['links']['book'] = array(
      '#theme' => 'links__node__book',
      '#links' => $links,
      '#attributes' => array('class' => array('links', 'inline')),
    );
119
  }
Dries's avatar
   
Dries committed
120
121
}

Dries's avatar
   
Dries committed
122
/**
123
 * Implements hook_menu().
Dries's avatar
   
Dries committed
124
 */
125
126
function book_menu() {
  $items['admin/content/book'] = array(
127
    'title' => 'Books',
128
    'description' => "Manage your site's book outlines.",
Dries's avatar
Dries committed
129
130
    'page callback' => 'book_admin_overview',
    'access arguments' => array('administer book outlines'),
131
    'type' => MENU_LOCAL_TASK,
132
    'file' => 'book.admin.inc',
133
134
  );
  $items['admin/content/book/list'] = array(
135
    'title' => 'List',
136
137
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
Dries's avatar
Dries committed
138
139
  $items['admin/content/book/settings'] = array(
    'title' => 'Settings',
140
    'page callback' => 'drupal_get_form',
Dries's avatar
Dries committed
141
142
    'page arguments' => array('book_admin_settings'),
    'access arguments' => array('administer site configuration'),
143
144
    'type' => MENU_LOCAL_TASK,
    'weight' => 8,
145
    'file' => 'book.admin.inc',
146
  );
Dries's avatar
Dries committed
147
148
149
150
151
152
153
  $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,
154
    'file' => 'book.admin.inc',
Dries's avatar
Dries committed
155
  );
156
  $items['book'] = array(
157
    'title' => 'Books',
158
159
160
    'page callback' => 'book_render',
    'access arguments' => array('access content'),
    'type' => MENU_SUGGESTED_ITEM,
161
    'file' => 'book.pages.inc',
162
163
164
165
  );
  $items['book/export/%/%'] = array(
    'page callback' => 'book_export',
    'page arguments' => array(2, 3),
Dries's avatar
Dries committed
166
    'access arguments' => array('access printer-friendly version'),
167
    'type' => MENU_CALLBACK,
168
    'file' => 'book.pages.inc',
169
  );
170
  $items['node/%node/outline'] = array(
171
    'title' => 'Outline',
Dries's avatar
Dries committed
172
173
    'page callback' => 'book_outline',
    'page arguments' => array(1),
174
175
176
177
    'access callback' => '_book_outline_access',
    'access arguments' => array(1),
    'type' => MENU_LOCAL_TASK,
    'weight' => 2,
178
    'file' => 'book.pages.inc',
179
  );
Dries's avatar
Dries committed
180
181
182
183
184
185
  $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),
186
    'file' => 'book.pages.inc',
Dries's avatar
Dries committed
187
  );
188

Dries's avatar
   
Dries committed
189
190
191
  return $items;
}

Dries's avatar
Dries committed
192
193
194
/**
 * Menu item access callback - determine if the outline tab is accessible.
 */
195
function _book_outline_access($node) {
Dries's avatar
Dries committed
196
197
198
199
200
201
  return user_access('administer book outlines') && node_access('view', $node);
}

/**
 * Menu item access callback - determine if the user can remove nodes from the outline.
 */
202
function _book_outline_remove_access($node) {
Dries's avatar
Dries committed
203
  return isset($node->book) && ($node->book['bid'] != $node->nid) && _book_outline_access($node);
204
205
}

206
207
208
209
/**
 * Implements hook_admin_paths().
 */
function book_admin_paths() {
210
211
212
213
214
215
216
  if (variable_get('node_admin_theme')) {
    $paths = array(
      'node/*/outline' => TRUE,
      'node/*/outline/remove' => TRUE,
    );
    return $paths;
  }
217
218
}

219
/**
220
 * Implements hook_entity_info_alter().
221
 */
222
223
224
225
226
function book_entity_info_alter(&$info) {
  // Add the 'Print' view mode for nodes.
  $info['node']['view modes'] += array(
    'print' => array(
      'label' => t('Print'),
227
      'custom settings' => FALSE,
228
229
    ),
  );
230
231
}

232
/**
233
 * Implements hook_block_info().
234
 */
235
function book_block_info() {
236
237
  $block = array();
  $block['navigation']['info'] = t('Book navigation');
238
  $block['navigation']['cache'] = DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE;
239
240
241
242
243

  return $block;
}

/**
244
 * Implements hook_block_view().
245
 *
Dries's avatar
   
Dries committed
246
247
 * Displays the book table of contents in a block when the current page is a
 * single-node view of a book node.
248
 */
249
function book_block_view($delta = '') {
Dries's avatar
   
Dries committed
250
  $block = array();
251
252
253
254
  $current_bid = 0;
  if ($node = menu_get_object()) {
    $current_bid = empty($node->book['bid']) ? 0 : $node->book['bid'];
  }
255

256
257
258
259
260
261
262
263
264
  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
265
      }
266
267
268
269
      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;
270
271
272
        // Check whether user can access the book link.
        $book_node = node_load($book['nid']);
        $book['access'] = node_access('view', $book_node);
273
274
        $pseudo_tree[0]['link'] = $book;
        $book_menus[$book_id] = menu_tree_output($pseudo_tree);
Dries's avatar
Dries committed
275
      }
276
    }
277
278
279
    if ($block['content'] = $book_menus) {
      $book_menus['#theme'] = 'book_all_books_block';
    }
280
281
282
  }
  elseif ($current_bid) {
    // Only display this block when the user is browsing a book.
283
284
  $select = db_select('node', 'n')
    ->fields('n', array('title'))
285
    ->condition('n.nid', $node->book['bid'])
286
    ->addTag('node_access');
287
288
289
290
291
292
    $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);
293
      $block['subject'] = theme('book_title_link', array('link' => $data['link']));
294
295
296
      $block['content'] = ($data['below']) ? menu_tree_output($data['below']) : '';
    }
  }
297

298
299
  return $block;
}
300

301
/**
302
 * Implements hook_block_configure().
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 */
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."),
    );
317

318
319
  return $form;
}
320

321
/**
322
 * Implements hook_block_save().
323
324
325
326
 */
function book_block_save($delta = '', $edit = array()) {
  $block = array();
  variable_set('book_block_mode', $edit['book_block_mode']);
Dries's avatar
Dries committed
327
}
Dries's avatar
   
Dries committed
328

329
/**
330
331
332
333
334
 * Returns HTML for a link to a book title when used as a block title.
 *
 * @param $variables
 *   An associative array containing:
 *   - link: An array containing title, href and options for the link.
Dries's avatar
Dries committed
335
336
 *
 * @ingroup themeable
337
 */
338
339
340
function theme_book_title_link($variables) {
  $link = $variables['link'];

341
  $link['options']['attributes']['class'] = array('book-title');
342

Dries's avatar
Dries committed
343
  return l($link['title'], $link['href'], $link['options']);
Dries's avatar
   
Dries committed
344
}
Dries's avatar
   
Dries committed
345

346
/**
Dries's avatar
Dries committed
347
348
349
350
 * 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.
351
 */
Dries's avatar
Dries committed
352
function book_get_books() {
353
  $all_books = &drupal_static(__FUNCTION__);
Dries's avatar
Dries committed
354
355
356

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

Dries's avatar
Dries committed
359
    if ($nids) {
360
      $query = db_select('book', 'b', array('fetch' => PDO::FETCH_ASSOC));
361
362
      $query->join('node', 'n', 'b.nid = n.nid');
      $query->join('menu_links', 'ml', 'b.mlid = ml.mlid');
363
364
365
      $query->addField('n', 'type', 'type');
      $query->addField('n', 'title', 'title');
      $query->fields('b');
366
      $query->fields('ml');
367
368
369
370
371
372
373
      $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
374
375
        $link['href'] = $link['link_path'];
        $link['options'] = unserialize($link['options']);
376
        $all_books[$link['bid']] = $link;
Dries's avatar
Dries committed
377
378
      }
    }
379
  }
380

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

Dries's avatar
Dries committed
384
/**
385
 * Implements hook_form_BASE_FORM_ID_alter().
386
387
 *
 * Adds the book fieldset to the node form.
388
389
 *
 * @see book_pick_book_nojs_submit()
Dries's avatar
Dries committed
390
 */
391
392
393
394
395
396
397
function book_form_node_form_alter(&$form, &$form_state, $form_id) {
  $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;
Dries's avatar
Dries committed
398
    }
399
  }
Dries's avatar
Dries committed
400

401
402
403
  if ($access) {
    _book_add_form_elements($form, $form_state, $node);
    // Since the "Book" dropdown can't trigger a form submission when
404
    // JavaScript is disabled, add a submit button to do that. book.admin.css hides
405
406
407
408
409
410
    // this button when JavaScript is enabled.
    $form['book']['pick-book'] = array(
      '#type' => 'submit',
      '#value' => t('Change book (update list of parents)'),
      '#submit' => array('book_pick_book_nojs_submit'),
      '#weight' => 20,
411
412
413
      '#attached' => array(
        'css' => array(drupal_get_path('module', 'book') . '/book.admin.css'),
      ),
414
    );
415
  }
Dries's avatar
Dries committed
416
}
417

418
419
420
421
422
423
424
/**
 * Submit handler to change a node's book.
 *
 * This handler is run when JavaScript is disabled. It triggers the form to
 * rebuild so that the "Parent item" options are changed to reflect the newly
 * selected book. When JavaScript is enabled, the submit button that triggers
 * this handler is hidden, and the "Book" dropdown directly triggers the
425
 * book_form_update() Ajax callback instead.
426
427
428
429
430
431
432
433
 *
 * @see book_form_update()
 */
function book_pick_book_nojs_submit($form, &$form_state) {
  $form_state['node']->book = $form_state['values']['book'];
  $form_state['rebuild'] = TRUE;
}

Dries's avatar
Dries committed
434
/**
435
 * Build the parent selection form element for the node form or outline tab.
Dries's avatar
Dries committed
436
437
 *
 * This function is also called when generating a new set of options during the
438
 * Ajax callback, so an array is returned that can be used to replace an existing
Dries's avatar
Dries committed
439
440
441
 * form element.
 */
function _book_parent_select($book_link) {
442
443
444
  if (variable_get('menu_override_parent_selector', FALSE)) {
    return array();
  }
Dries's avatar
Dries committed
445
446
447
448
449
450
451
  // 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>',
  );
452

Dries's avatar
Dries committed
453
454
455
  if ($book_link['nid'] === $book_link['bid']) {
    // This is a book - at the top level.
    if ($book_link['original_bid'] === $book_link['bid']) {
456
      $form['#prefix'] .= '<em>' . t('This is the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
457
458
    }
    else {
459
      $form['#prefix'] .= '<em>' . t('This will be the top-level page in this book.') . '</em>';
Dries's avatar
Dries committed
460
461
462
    }
  }
  elseif (!$book_link['bid']) {
463
    $form['#prefix'] .= '<em>' . t('No book selected.') . '</em>';
464
465
  }
  else {
Dries's avatar
Dries committed
466
467
468
469
    $form = array(
      '#type' => 'select',
      '#title' => t('Parent item'),
      '#default_value' => $book_link['plid'],
470
      '#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)),
471
      '#options' => book_toc($book_link['bid'], $book_link['parent_depth_limit'], array($book_link['mlid'])),
472
      '#attributes' => array('class' => array('book-title-select')),
473
474
      '#prefix' => '<div id="edit-book-plid-wrapper">',
      '#suffix' => '</div>',
475
    );
Dries's avatar
   
Dries committed
476
  }
477

478
  return $form;
Dries's avatar
   
Dries committed
479
480
}

481
/**
Dries's avatar
Dries committed
482
 * Build the common elements of the book form for the node and outline forms.
483
 */
484
function _book_add_form_elements(&$form, &$form_state, $node) {
485
  // If the form is being processed during the Ajax callback of our book bid
486
487
488
489
  // dropdown, then $form_state will hold the value that was selected.
  if (isset($form_state['values']['book'])) {
    $node->book = $form_state['values']['book'];
  }
Dries's avatar
Dries committed
490
491
492
493
494
495
496

  $form['book'] = array(
    '#type' => 'fieldset',
    '#title' => t('Book outline'),
    '#weight' => 10,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
497
    '#group' => 'additional_settings',
498
499
500
    '#attributes' => array(
      'class' => array('book-form'),
    ),
501
502
503
    '#attached' => array(
      'js' => array(drupal_get_path('module', 'book') . '/book.js'),
    ),
Dries's avatar
Dries committed
504
    '#tree' => TRUE,
505
    '#attributes' => array('class' => array('book-outline-form')),
506
  );
507
  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {
Dries's avatar
Dries committed
508
509
510
511
512
513
514
515
    $form['book'][$key] = array(
      '#type' => 'value',
      '#value' => $node->book[$key],
    );
  }

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

516
  // @see _book_admin_table_tree(). The weight may be larger than 15.
Dries's avatar
Dries committed
517
  $form['book']['weight'] = array(
518
    '#type' => 'weight',
519
    '#title' => t('Weight'),
Dries's avatar
Dries committed
520
    '#default_value' => $node->book['weight'],
521
    '#delta' => max(15, abs($node->book['weight'])),
Dries's avatar
Dries committed
522
    '#weight' => 5,
523
524
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
Dries's avatar
Dries committed
525
526
  $options = array();
  $nid = isset($node->nid) ? $node->nid : 'new';
527

528
  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {
529
    // This is the top level node in a maximum depth book and thus cannot be moved.
530
    $options[$node->nid] = $node->title;
531
532
533
534
535
536
537
  }
  else {
    foreach (book_get_books() as $book) {
      $options[$book['nid']] = $book['title'];
    }
  }

Dries's avatar
Dries committed
538
539
  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.
540
    $options = array($nid => '<' . t('create a new book') . '>') + $options;
Dries's avatar
Dries committed
541
542
  }
  if (!$node->book['mlid']) {
543
    // The node is not currently in the hierarchy.
544
    $options = array(0 => '<' . t('none') . '>') + $options;
Dries's avatar
Dries committed
545
546
547
548
549
550
551
552
  }

  // 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,
553
    '#access' => (bool) $options,
Dries's avatar
Dries committed
554
555
    '#description' => t('Your page will be a part of the selected book.'),
    '#weight' => -5,
556
    '#attributes' => array('class' => array('book-title-select')),
557
    '#ajax' => array(
558
      'callback' => 'book_form_update',
559
      'wrapper' => 'edit-book-plid-wrapper',
560
561
      'effect' => 'fade',
      'speed' => 'fast',
562
    ),
563
  );
Dries's avatar
Dries committed
564
}
Dries's avatar
   
Dries committed
565

566
567
568
/**
 * Renders a new parent page select element when the book selection changes.
 *
569
 * This function is called via Ajax when the selected book is changed on a node
570
571
572
573
574
575
576
577
578
 * or book outline form.
 *
 * @return
 *   The rendered parent page select element.
 */
function book_form_update($form, $form_state) {
  return $form['book']['plid'];
}

579
/**
Dries's avatar
Dries committed
580
 * Common helper function to handles additions and updates to the book outline.
Dries's avatar
Dries committed
581
 *
Dries's avatar
Dries committed
582
583
584
 * Performs all additions and updates to the book outline through node addition,
 * node editing, node deletion, or the outline tab.
 */
585
function _book_update_outline($node) {
Dries's avatar
Dries committed
586
587
588
589
590
  if (empty($node->book['bid'])) {
    return FALSE;
  }
  $new = empty($node->book['mlid']);

591
  $node->book['link_path'] = 'node/' . $node->nid;
592
  $node->book['link_title'] = $node->title;
Dries's avatar
Dries committed
593
594
595
596
597
598
599
600
601
  $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'])) {
602
603
604
      $parent = db_query("SELECT * FROM {book} WHERE mlid = :mlid", array(
        ':mlid' => $node->book['plid'],
      ))->fetchAssoc();
Dries's avatar
Dries committed
605
606
    }
    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {
607
608
609
      $node->book['plid'] = db_query("SELECT mlid FROM {book} WHERE nid = :nid", array(
        ':nid' => $node->book['bid'],
      ))->fetchField();
Dries's avatar
Dries committed
610
611
612
      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.
    }
  }
613

Dries's avatar
Dries committed
614
615
616
  if (menu_link_save($node->book)) {
    if ($new) {
      // Insert new.
617
618
619
620
621
622
623
      db_insert('book')
        ->fields(array(
          'nid' => $node->nid,
          'mlid' => $node->book['mlid'],
          'bid' => $node->book['bid'],
        ))
        ->execute();
624
625
      // Reset the cache of stored books.
      drupal_static_reset('book_get_books');
Dries's avatar
Dries committed
626
627
    }
    else {
628
629
630
      if ($node->book['bid'] != db_query("SELECT bid FROM {book} WHERE nid = :nid", array(
          ':nid' => $node->nid,
        ))->fetchField()) {
Dries's avatar
Dries committed
631
632
        // Update the bid for this page and all children.
        book_update_bid($node->book);
633
634
        // Reset the cache of stored books.
        drupal_static_reset('book_get_books');
Dries's avatar
Dries committed
635
636
      }
    }
637

Dries's avatar
Dries committed
638
639
    return TRUE;
  }
640
641

  // Failed to save the menu link.
Dries's avatar
Dries committed
642
643
644
  return FALSE;
}

645
/**
Dries's avatar
Dries committed
646
 * Update the bid for a page and its children when it is moved to a new book.
647
 *
Dries's avatar
Dries committed
648
649
650
651
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 */
function book_update_bid($book_link) {
652
653
  $query = db_select('menu_links');
  $query->addField('menu_links', 'mlid');
Dries's avatar
Dries committed
654
  for ($i = 1; $i <= MENU_MAX_DEPTH && $book_link["p$i"]; $i++) {
655
    $query->condition("p$i", $book_link["p$i"]);
Dries's avatar
Dries committed
656
  }
657
  $mlids = $query->execute()->fetchCol();
658

Dries's avatar
Dries committed
659
  if ($mlids) {
660
    db_update('book')
661
      ->fields(array('bid' => $book_link['bid']))
662
663
      ->condition('mlid', $mlids, 'IN')
      ->execute();
Dries's avatar
Dries committed
664
665
666
667
668
  }
}

/**
 * Get the book menu tree for a page, and return it as a linear array.
669
 *
Dries's avatar
Dries committed
670
671
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
672
 * @return
Dries's avatar
Dries committed
673
674
 *   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
675
 *   element corresponding to $node. The children of $node (if any) will come
676
677
 *   immediately after it in the array, and links will only be fetched as deep
 *   as one level deeper than $book_link.
678
 */
Dries's avatar
Dries committed
679
function book_get_flat_menu($book_link) {
680
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
681
682

  if (!isset($flat[$book_link['mlid']])) {
683
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
684
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
Dries's avatar
Dries committed
685
686
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
   
Dries committed
687
  }
688

Dries's avatar
Dries committed
689
  return $flat[$book_link['mlid']];
Dries's avatar
   
Dries committed
690
691
}

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

Dries's avatar
Dries committed
706
707
708
709
710
711
712
/**
 * 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
713
  }
Dries's avatar
Dries committed
714
715
716
717
718
719
720
721
722
723
724
725
  $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.
726
727
      $tree = book_menu_subtree_data($prev);
      $data = array_shift($tree);
Dries's avatar
Dries committed
728
729
730
731
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
732

Dries's avatar
Dries committed
733
734
735
736
737
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
   
Dries committed
738
739
740
  }
}

741
/**
Dries's avatar
Dries committed
742
 * Fetches the menu link for the next page of the book.
743
 */
Dries's avatar
Dries committed
744
745
746
747
748
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);
749
750
751
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
752
753
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
   
Dries committed
754
  }
Dries's avatar
Dries committed
755
}
Dries's avatar
   
Dries committed
756

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

Dries's avatar
Dries committed
763
764
765
766
767
768
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
769
770
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
771
772
773
774
775
    // 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
776
777
    }
  }
778

779
780
781
782
783
  if ($children) {
    $elements = menu_tree_output($children);
    return drupal_render($elements);
  }
  return '';
Dries's avatar
   
Dries committed
784
785
}

786
/**
Dries's avatar
Dries committed
787
 * Generate the corresponding menu name from a book ID.
788
 */
Dries's avatar
Dries committed
789
function book_menu_name($bid) {
790
  return 'book-toc-' . $bid;
Dries's avatar
Dries committed
791
792
}

793
/**
794
 * Implements hook_node_load().
795
 */
796
function book_node_load($nodes, $types) {
797
  $result = db_query("SELECT * FROM {book} b INNER JOIN {menu_links} ml ON b.mlid = ml.mlid WHERE b.nid IN (:nids)", array(':nids' =>  array_keys($nodes)), array('fetch' => PDO::FETCH_ASSOC));
798
799
800
801
802
  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']);
803
804
  }
}
805

806
/**
807
 * Implements hook_node_view().
808
 */
809
810
function book_node_view($node, $view_mode) {
  if ($view_mode == 'full') {
811
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
812
      $node->content['book_navigation'] = array(
813
        '#markup' => theme('book_navigation', array('book_link' => $node->book)),
814
815
816
817
        '#weight' => 100,
      );
    }
  }
Dries's avatar
Dries committed
818

819
820
  if ($view_mode != 'rss') {
    book_node_view_link($node, $view_mode);
821
  }
822
823
824
}

/**
825
 * Implements hook_page_alter().
826
827
828
829
830
831
832
833
834
835
 *
 * Add the book menu to the list of menus used to build the active trail when
 * viewing a book page.
 */
function book_page_alter(&$page) {
  if (($node = menu_get_object()) && !empty($node->book['bid'])) {
    $active_menus = menu_get_active_menu_names();
    $active_menus[] = $node->book['menu_name'];
    menu_set_active_menu_names($active_menus);
  }
836
}
837

838
/**
839
 * Implements hook_node_presave().
840
 */
841
function book_node_presave($node) {
842
843
844
  // Always save a revision for non-administrators.
  if (!empty($node->book['bid']) && !user_access('administer nodes')) {
    $node->revision = 1;
845
846
847
848
    // The database schema requires a log message for every revision.
    if (!isset($node->log)) {
      $node->log = '';
    }
849
850
851
852
853
854
  }
  // Make sure a new node gets a new menu link.
  if (empty($node->nid)) {
    $node->book['mlid'] = NULL;
  }
}
855

856
/**
857
 * Implements hook_node_insert().
858
 */
859
function book_node_insert($node) {
860
861
862
863
864
865
866
867
868
869
  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);
  }
}
870

871
/**
872
 * Implements hook_node_update().
873
 */
874
function book_node_update($node) {
875
876
877
878
879
880
881
882
883
884
  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);
  }
}
885

886
/**
887
 * Implements hook_node_delete().
888
 */
889
function book_node_delete($node) {
890
891
892
  if (!empty($node->book['bid'])) {
    if ($node->nid == $node->book['bid']) {
      // Handle deletion of a top-level post.
893
894
895
896
897
      $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);
898
899
        $child_node->book['bid'] = $child_node->nid;
        _book_update_outline($child_node);
Dries's avatar
Dries committed
900
      }
901