book.module 27.3 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
use Drupal\Core\Entity\EntityInterface;
9
use Drupal\node\NodeInterface;
10
use Drupal\node\NodeTypeInterface;
11
use Drupal\Core\Language\Language;
12
use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
13
use Drupal\Core\Template\Attribute;
14

15
/**
16
 * Implements hook_help().
17
18
19
20
21
 */
function book_help($path, $arg) {
  switch ($path) {
    case 'admin/help#book':
      $output = '<h3>' . t('About') . '</h3>';
22
      $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 <a href="!book">online documentation for the Book module</a>.', array('!book' => 'https://drupal.org/documentation/modules/book')) . '</p>';
23
24
25
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Adding and managing book content') . '</dt>';
26
      $output .= '<dd>' . t('You can assign separate permissions for <em>creating new books</em> as well as <em>creating</em>, <em>editing</em> and <em>deleting</em> book content. 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' => \Drupal::url('book.admin'))) . '</dd>';
27
      $output .= '<dt>' . t('Book navigation') . '</dt>';
28
      $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' => \Drupal::url('block.admin_display'))) . '</dd>';
29
30
31
      $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>';
32
      $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>';
33
34
      $output .= '</dl>';
      return $output;
35
    case 'admin/structure/book':
36
37
      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':
38
      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' => \Drupal::url('book.render'), '!book-admin' => \Drupal::url('book.admin'))) . '</p>';
39
40
41
  }
}

42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/**
 * Implements hook_entity_bundle_info().
 */
function book_entity_bundle_info() {
  $bundles['menu_link']['book-toc'] = array(
    'label' => t('Book'),
    'translatable' => FALSE,
  );
  return $bundles;
}

/**
 * Implements hook_TYPE_load().
 */
function book_menu_link_load($entities) {
  foreach ($entities as $entity) {
    // Change the bundle of menu links related to a book.
    if (strpos($entity->menu_name, 'book-toc-') === 0) {
      $entity->bundle = 'book-toc';
    }
  }
}

65
/**
66
 * Implements hook_theme().
67
68
69
70
 */
function book_theme() {
  return array(
    'book_navigation' => array(
71
      'variables' => array('book_link' => NULL),
72
      'template' => 'book-navigation',
73
74
    ),
    'book_export_html' => array(
75
      'variables' => array('title' => NULL, 'contents' => NULL, 'depth' => NULL),
76
      'template' => 'book-export-html',
77
78
    ),
    'book_admin_table' => array(
79
      'render element' => 'form',
80
      'file' => 'book.admin.inc',
81
    ),
Dries's avatar
Dries committed
82
    'book_all_books_block' => array(
83
      'render element' => 'book_menus',
84
85
86
      'template' => 'book-all-books-block',
    ),
    'book_node_export_html' => array(
87
      'variables' => array('node' => NULL, 'children' => NULL),
88
      'template' => 'book-node-export-html',
Dries's avatar
Dries committed
89
    ),
90
91
92
  );
}

93
/**
94
 * Implements hook_permission().
95
 */
96
function book_permission() {
97
  return array(
98
99
100
101
102
103
104
    'administer book outlines' => array(
      'title' => t('Administer book outlines'),
    ),
    'create new books' => array(
      'title' => t('Create new books'),
    ),
    'add content to books' => array(
105
      'title' => t('Add content and child pages to books'),
106
107
    ),
    'access printer-friendly version' => array(
108
      'title' => t('View printer-friendly books'),
109
110
      'description' => t('View a book page and all of its sub-pages as a single document for ease of printing. Can be performance heavy.'),
    ),
111
  );
Dries's avatar
   
Dries committed
112
113
}

114
115
116
117
118
119
120
/**
 * Implements hook_entity_info().
 */
function book_entity_info(&$entity_info) {
  $entity_info['node']['controllers']['form']['book_outline'] = '\Drupal\book\Form\BookOutlineForm';
}

Dries's avatar
   
Dries committed
121
/**
122
 * Implements hook_node_links_alter().
Dries's avatar
   
Dries committed
123
 */
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
function book_node_links_alter(array &$node_links, NodeInterface $node, array &$context) {
  if ($context['view_mode'] != 'rss') {
    $account = \Drupal::currentUser();

    if (isset($node->book['depth'])) {
      if ($context['view_mode'] == 'full' && node_is_page($node)) {
        $child_type = \Drupal::config('book.settings')->get('child_type');
        $access_controller = \Drupal::entityManager()->getAccessController('node');
        if (($account->hasPermission('add content to books') || $account->hasPermission('administer book outlines')) && $access_controller->createAccess($child_type) && $node->isPublished() && $node->book['depth'] < MENU_MAX_DEPTH) {
          $links['book_add_child'] = array(
            'title' => t('Add child page'),
            'href' => 'node/add/' . $child_type,
            'query' => array('parent' => $node->book['mlid']),
          );
        }

        if ($account->hasPermission('access printer-friendly version')) {
          $links['book_printer'] = array(
            'title' => t('Printer-friendly version'),
            'href' => 'book/export/html/' . $node->id(),
            'attributes' => array('title' => t('Show a printer-friendly version of this book page and its sub-pages.'))
          );
        }
147
      }
Dries's avatar
   
Dries committed
148
    }
149

150
151
152
153
154
155
156
    if (!empty($links)) {
      $node_links['book'] = array(
        '#theme' => 'links__node__book',
        '#links' => $links,
        '#attributes' => array('class' => array('links', 'inline')),
      );
    }
157
  }
Dries's avatar
   
Dries committed
158
159
}

Dries's avatar
   
Dries committed
160
/**
161
 * Implements hook_menu().
Dries's avatar
   
Dries committed
162
 */
163
function book_menu() {
164
  $items['admin/structure/book'] = array(
165
    'title' => 'Books',
166
    'description' => "Manage your site's book outlines.",
167
    'route_name' => 'book.admin',
168
169
  );
  $items['book'] = array(
170
    'title' => 'Books',
171
    'route_name' => 'book.render',
172
173
    'type' => MENU_SUGGESTED_ITEM,
  );
Dries's avatar
Dries committed
174
175
  $items['node/%node/outline/remove'] = array(
    'title' => 'Remove from outline',
176
    'route_name' => 'book.remove',
Dries's avatar
Dries committed
177
  );
178

Dries's avatar
   
Dries committed
179
180
181
  return $items;
}

182
183
184
185
/**
 * Implements hook_admin_paths().
 */
function book_admin_paths() {
186
  if (\Drupal::config('node.settings')->get('use_admin_theme')) {
187
188
189
190
191
192
    $paths = array(
      'node/*/outline' => TRUE,
      'node/*/outline/remove' => TRUE,
    );
    return $paths;
  }
193
194
}

195
/**
Dries's avatar
Dries committed
196
197
 * Returns an array of all books.
 *
198
199
 * @todo Remove in favor of BookManager Service. http://drupal.org/node/1963894
 *
Dries's avatar
Dries committed
200
201
 * This list may be used for generating a list of all the books, or for building
 * the options for a form select.
202
203
204
 *
 * @return
 *   An array of all books.
205
 */
Dries's avatar
Dries committed
206
function book_get_books() {
207
  return \Drupal::service('book.manager')->getAllBooks();
208
}
209

Dries's avatar
Dries committed
210
/**
211
 * Implements hook_form_BASE_FORM_ID_alter() for node_form().
212
 *
213
 * Adds the book form element to the node form.
214
215
 *
 * @see book_pick_book_nojs_submit()
Dries's avatar
Dries committed
216
 */
217
function book_form_node_form_alter(&$form, &$form_state, $form_id) {
218
  $node = $form_state['controller']->getEntity();
219
  $account = \Drupal::currentUser();
220
  $access = $account->hasPermission('administer book outlines');
221
  if (!$access) {
222
    if ($account->hasPermission('add content to books') && ((!empty($node->book['mlid']) && !$node->isNew()) || book_type_is_allowed($node->getType()))) {
223
224
      // Already in the book hierarchy, or this node type is allowed.
      $access = TRUE;
Dries's avatar
Dries committed
225
    }
226
  }
Dries's avatar
Dries committed
227

228
  if ($access) {
229
    $form = \Drupal::service('book.manager')->addFormElements($form, $form_state, $node, $account);
230
    // Since the "Book" dropdown can't trigger a form submission when
231
    // JavaScript is disabled, add a submit button to do that. book.admin.css hides
232
233
234
235
236
237
    // 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,
238
      '#attached' => array(
239
        'css' => array(drupal_get_path('module', 'book') . '/css/book.admin.css'),
240
      ),
241
    );
242
    $form['#entity_builders'][] = 'book_node_builder';
243
  }
Dries's avatar
Dries committed
244
}
245

246
247
248
249
250
251
252
253
254
/**
 * Entity form builder to add the book information to the node.
 *
 * @todo: Remove this in favor of an entity field.
 */
function book_node_builder($entity_type, $entity, &$form, &$form_state) {
  $entity->book = $form_state['values']['book'];
}

255
/**
256
 * Form submission handler for node_form().
257
258
259
260
261
 *
 * 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
262
 * book_form_update() Ajax callback instead.
263
264
 *
 * @see book_form_update()
265
 * @see book_form_node_form_alter()
266
267
 */
function book_pick_book_nojs_submit($form, &$form_state) {
268
  $node = $form_state['controller']->getEntity();
269
  $node->book = $form_state['values']['book'];
270
271
272
  $form_state['rebuild'] = TRUE;
}

273
274
275
/**
 * Renders a new parent page select element when the book selection changes.
 *
276
 * This function is called via Ajax when the selected book is changed on a node
277
278
279
280
281
282
283
284
285
 * or book outline form.
 *
 * @return
 *   The rendered parent page select element.
 */
function book_form_update($form, $form_state) {
  return $form['book']['plid'];
}

Dries's avatar
Dries committed
286
/**
287
 * Gets the book menu tree for a page and returns it as a linear array.
288
 *
Dries's avatar
Dries committed
289
290
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
291
 *
292
 * @return
Dries's avatar
Dries committed
293
294
 *   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
295
296
297
 *   element corresponding to the current node. The children of the current node
 *   (if any) will come immediately after it in the array, and links will only
 *   be fetched as deep as one level deeper than $book_link.
298
 */
Dries's avatar
Dries committed
299
function book_get_flat_menu($book_link) {
300
  $flat = &drupal_static(__FUNCTION__, array());
Dries's avatar
Dries committed
301
302

  if (!isset($flat[$book_link['mlid']])) {
303
304
    // Call bookTreeAllData() to take advantage of the menu system's caching.
    $tree = \Drupal::service('book.manager')->bookTreeAllData($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
Dries's avatar
Dries committed
305
306
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
Dries's avatar
   
Dries committed
307
  }
308

Dries's avatar
Dries committed
309
  return $flat[$book_link['mlid']];
Dries's avatar
   
Dries committed
310
311
}

312
/**
313
314
315
316
317
 * Recursively converts a tree of menu links to a flat array.
 *
 * @param $tree
 *   A tree of menu links in an array.
 * @param $flat
318
 *   A flat array of the menu links from $tree, passed by reference.
319
320
 *
 * @see book_get_flat_menu().
321
 */
Dries's avatar
Dries committed
322
323
324
325
326
327
328
329
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
330
  }
Dries's avatar
Dries committed
331
}
Dries's avatar
   
Dries committed
332

Dries's avatar
Dries committed
333
334
/**
 * Fetches the menu link for the previous page of the book.
335
336
337
338
339
340
341
 *
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 *
 * @return
 *   A fully loaded menu link for the page before the one represented in
 *   $book_link.
Dries's avatar
Dries committed
342
343
344
345
346
 */
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
347
  }
Dries's avatar
Dries committed
348
349
350
351
352
353
354
355
356
357
358
359
  $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.
360
      $tree = \Drupal::service('book.manager')->bookMenuSubtreeData($prev);
361
      $data = array_shift($tree);
Dries's avatar
Dries committed
362
363
364
365
      // The link of interest is the last child - iterate to find the deepest one.
      while ($data['below']) {
        $data = end($data['below']);
      }
366

Dries's avatar
Dries committed
367
368
369
370
371
      return $data['link'];
    }
    else {
      return $prev;
    }
Dries's avatar
   
Dries committed
372
373
374
  }
}

375
/**
Dries's avatar
Dries committed
376
 * Fetches the menu link for the next page of the book.
377
378
379
380
381
382
383
 *
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 *
 * @return
 *   A fully loaded menu link for the page after the one represented in
 *   $book_link.
384
 */
Dries's avatar
Dries committed
385
386
387
388
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 {
389
    list($key, ) = each($flat);
390
391
392
  }
  while ($key && $key != $book_link['mlid']);

Dries's avatar
Dries committed
393
394
  if ($key == $book_link['mlid']) {
    return current($flat);
Dries's avatar
   
Dries committed
395
  }
Dries's avatar
Dries committed
396
}
Dries's avatar
   
Dries committed
397

Dries's avatar
Dries committed
398
/**
399
400
401
402
403
404
405
 * Formats the menu links for the child pages of the current page.
 *
 * @param $book_link
 *   A fully loaded menu link that is part of the book hierarchy.
 *
 * @return
 *   HTML for the links to the child pages of the current page.
Dries's avatar
Dries committed
406
407
408
 */
function book_children($book_link) {
  $flat = book_get_flat_menu($book_link);
409

Dries's avatar
Dries committed
410
411
412
413
414
415
  $children = array();

  if ($book_link['has_children']) {
    // Walk through the array until we find the current page.
    do {
      $link = array_shift($flat);
416
417
    }
    while ($link && ($link['mlid'] != $book_link['mlid']));
Dries's avatar
Dries committed
418
419
420
421
422
    // 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
423
424
    }
  }
425

426
  if ($children) {
427
    $elements = \Drupal::service('book.manager')->bookTreeOutput($children);
428
429
430
    return drupal_render($elements);
  }
  return '';
Dries's avatar
   
Dries committed
431
432
}

433
/**
434
 * Implements hook_node_load().
435
 */
436
function book_node_load($nodes) {
437
  $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));
438
439
440
441
442
  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']);
443
444
  }
}
445

446
/**
447
 * Implements hook_node_view().
448
 */
449
function book_node_view(EntityInterface $node, EntityViewDisplayInterface $display, $view_mode) {
450
  if ($view_mode == 'full') {
451
    if (!empty($node->book['bid']) && empty($node->in_preview)) {
452
      $book_navigation = array( '#theme' => 'book_navigation', '#book_link' => $node->book);
453
      $node->content['book_navigation'] = array(
454
        '#markup' => drupal_render($book_navigation),
455
        '#weight' => 100,
456
457
458
459
460
        '#attached' => array(
          'css' => array(
            drupal_get_path('module', 'book') . '/css/book.theme.css',
          ),
        ),
461
462
463
      );
    }
  }
464
465
}

466
/**
467
 * Implements hook_node_presave().
468
 */
469
function book_node_presave(EntityInterface $node) {
470
  // Always save a revision for non-administrators.
471
  if (!empty($node->book['bid']) && !\Drupal::currentUser()->hasPermission('administer nodes')) {
472
    $node->setNewRevision();
473
474
  }
  // Make sure a new node gets a new menu link.
475
  if ($node->isNew()) {
476
477
478
    $node->book['mlid'] = NULL;
  }
}
479

480
/**
481
 * Implements hook_node_insert().
482
 */
483
function book_node_insert(EntityInterface $node) {
484
  $book_manager = \Drupal::service('book.manager');
485
486
487
  if (!empty($node->book['bid'])) {
    if ($node->book['bid'] == 'new') {
      // New nodes that are their own book.
488
      $node->book['bid'] = $node->id();
489
    }
490
    $node->book['nid'] = $node->id();
491
492
    $node->book['menu_name'] = $book_manager->createMenuName($node->book['bid']);
    $book_manager->updateOutline($node);
493
494
  }
}
495

496
/**
497
 * Implements hook_node_update().
498
 */
499
function book_node_update(EntityInterface $node) {
500
  $book_manager = \Drupal::service('book.manager');
501
502
503
  if (!empty($node->book['bid'])) {
    if ($node->book['bid'] == 'new') {
      // New nodes that are their own book.
504
      $node->book['bid'] = $node->id();
505
    }
506
    $node->book['nid'] = $node->id();
507
508
    $node->book['menu_name'] = $book_manager->createMenuName($node->book['bid']);
    $book_manager->updateOutline($node);
509
510
  }
}
511

512
/**
513
 * Implements hook_node_predelete().
514
 */
515
function book_node_predelete(EntityInterface $node) {
516
  if (!empty($node->book['bid'])) {
517
    if ($node->id() == $node->book['bid']) {
518
      // Handle deletion of a top-level post.
519
520
521
522
      $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) {
523
524
        $child_node = node_load($child->id());
        $child_node->book['bid'] = $child_node->id();
525
        \Drupal::service('book.manager')->updateOutline($child_node);
Dries's avatar
Dries committed
526
      }
527
    }
528
    // @todo - remove this call when we change the schema.
529
    menu_link_delete($node->book['mlid']);
530
531
532
    db_delete('book')
      ->condition('mlid', $node->book['mlid'])
      ->execute();
533
    drupal_static_reset('book_get_books');
534
535
536
537
  }
}

/**
538
 * Implements hook_node_prepare_form().
539
 */
540
function book_node_prepare_form(NodeInterface $node, $form_display, $operation, array &$form_state) {
541
  // Get BookManager service
542
  $book_manager = \Drupal::service('book.manager');
543

544
  // Prepare defaults for the add/edit form.
545
  $account = \Drupal::currentUser();
546
  if (empty($node->book) && ($account->hasPermission('add content to books') || $account->hasPermission('administer book outlines'))) {
547
548
    $node->book = array();

549
    $query = \Drupal::request()->query;
550
    if ($node->isNew() && !is_null($query->get('parent')) && is_numeric($query->get('parent'))) {
551
      // Handle "Add child page" links:
552
      $parent = book_link_load($query->get('parent'));
553
554
555
556
557

      if ($parent && $parent['access']) {
        $node->book['bid'] = $parent['bid'];
        $node->book['plid'] = $parent['mlid'];
        $node->book['menu_name'] = $parent['menu_name'];
558
      }
559
560
    }
    // Set defaults.
561
562
    $node_ref = !$node->isNew() ? $node->id() : 'new';
    $node->book += $book_manager->getLinkDefaults($node_ref);
563
564
565
566
567
568
569
570
  }
  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'])) {
571
    $node->book['parent_depth_limit'] = $book_manager->getParentDepthLimit($node->book);
Dries's avatar
Dries committed
572
573
574
575
  }
}

/**
576
 * Implements hook_form_FORM_ID_alter() for node_delete_confirm().
577
578
579
580
 *
 * Alters the confirm form for a single node deletion.
 *
 * @see node_delete_confirm()
Dries's avatar
Dries committed
581
582
583
584
585
586
 */
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(
587
      '#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->label())) . '</p>',
Dries's avatar
Dries committed
588
589
      '#weight' => -10,
    );
Dries's avatar
   
Dries committed
590
  }
Dries's avatar
   
Dries committed
591
}
Dries's avatar
   
Dries committed
592

593
/**
594
 * Implements hook_preprocess_HOOK() for block templates.
595
596
 */
function book_preprocess_block(&$variables) {
597
  if ($variables['configuration']['module'] == 'book') {
598
    $variables['attributes']['role'] = 'navigation';
599
600
601
  }
}

602
/**
603
604
605
 * Prepares variables for book listing block templates.
 *
 * Default template: book-all-books-block.html.twig.
606
 *
607
608
609
 * All non-renderable elements are removed so that the template has full access
 * to the structured data but can also simply iterate over all elements and
 * render them (as in the default template).
610
 *
611
612
 * @param array $variables
 *   An associative array containing the following key:
613
614
 *   - book_menus: An associative array containing renderable menu links for all
 *     book menus.
615
616
617
618
619
620
621
622
623
624
 */
function template_preprocess_book_all_books_block(&$variables) {
  // Remove all non-renderable elements.
  $elements = $variables['book_menus'];
  $variables['book_menus'] = array();
  foreach (element_children($elements) as $index) {
    $variables['book_menus'][$index] = $elements[$index];
  }
}

Dries's avatar
Dries committed
625
/**
626
627
628
 * Prepares variables for book navigation templates.
 *
 * Default template: book-navigation.html.twig.
Dries's avatar
Dries committed
629
 *
630
631
 * @param array $variables
 *   An associative array containing the following key:
632
633
 *   - book_link: An associative array of book link properties.
 *     Properties used: bid, link_title, depth, plid, mlid.
634
 */
635
636
637
638
639
640
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']);
641
  $variables['book_url'] = 'node/' . $book_link['bid'];
642
643
  $variables['current_depth'] = $book_link['depth'];
  $variables['tree'] = '';
644

Dries's avatar
Dries committed
645
  if ($book_link['mlid']) {
646
    $variables['tree'] = book_children($book_link);
Dries's avatar
   
Dries committed
647

648
649
    $build = array();

Dries's avatar
Dries committed
650
    if ($prev = book_prev($book_link)) {
651
      $prev_href = url($prev['href']);
652
653
654
655
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'prev',
        'href' => $prev_href,
      );
656
657
      $variables['prev_url'] = $prev_href;
      $variables['prev_title'] = check_plain($prev['title']);
Dries's avatar
   
Dries committed
658
    }
659

Dries's avatar
Dries committed
660
    if ($book_link['plid'] && $parent = book_link_load($book_link['plid'])) {
661
      $parent_href = url($parent['link_path']);
662
663
664
665
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'up',
        'href' => $parent_href,
      );
666
667
      $variables['parent_url'] = $parent_href;
      $variables['parent_title'] = check_plain($parent['title']);
Dries's avatar
   
Dries committed
668
    }
669

Dries's avatar
Dries committed
670
    if ($next = book_next($book_link)) {
671
      $next_href = url($next['href']);
672
673
674
675
      $build['#attached']['drupal_add_html_head_link'][][] = array(
        'rel' => 'next',
        'href' => $next_href,
      );
676
677
      $variables['next_url'] = $next_href;
      $variables['next_title'] = check_plain($next['title']);
Dries's avatar
   
Dries committed
678
    }
679
  }
Dries's avatar
   
Dries committed
680

681
682
683
684
  if (!empty($build)) {
    drupal_render($build);
  }

685
686
687
688
689
690
691
692
693
694
695
  $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] = '';
696
    }
Dries's avatar
   
Dries committed
697
  }
Dries's avatar
   
Dries committed
698
}
Dries's avatar
 
Dries committed
699

700
/**
701
 * Prepares variables for book export templates.
702
 *
703
 * Default template: book-export-html.html.twig.
704
 *
705
706
707
708
709
 * @param array $variables
 *   An associative array containing:
 *   - title: The title of the book.
 *   - contents: Output of each book page.
 *   - depth: The max depth of the book.
710
711
 */
function template_preprocess_book_export_html(&$variables) {
712
  global $base_url;
713
  $language_interface = language(Language::TYPE_INTERFACE);
714
715
716

  $variables['title'] = check_plain($variables['title']);
  $variables['base_url'] = $base_url;
717
  $variables['language'] = $language_interface;
718
  $variables['language_rtl'] = ($language_interface->direction == Language::DIRECTION_RTL);
719
  $variables['head'] = drupal_get_html_head();
720
721

  // HTML element attributes.
722
  $attributes = array();
723
  $attributes['lang'] = $language_interface->id;
724
725
  $attributes['dir'] = $language_interface->direction ? 'rtl' : 'ltr';
  $variables['html_attributes'] = new Attribute($attributes);
726
727
}

728
/**
729
730
731
 * Prepares variables for single node export templates.
 *
 * Default template: book-node-export-html.html.twig.
Dries's avatar
Dries committed
732
 *
733
734
 * @param array $variables
 *   An associative array containing the following keys:
735
736
737
 *   - node: The node that will be output.
 *   - children: All the rendered child nodes within the current node. Defaults
 *     to an empty string.
738
 */
739
740
function template_preprocess_book_node_export_html(&$variables) {
  $variables['depth'] = $variables['node']->book['depth'];
741
  $variables['title'] = check_plain($variables['node']->label());
742
  $variables['content'] = $variables['node']->rendered;
743
744
}

745
/**
746
 * Determines if a given node type is in the list of types allowed for books.
747
748
749
750
751
752
 *
 * @param string $type
 *   A node type.
 *
 * @return bool
 *   A Boolean TRUE if the node type can be included in books; otherwise, FALSE.
753
 */
Dries's avatar
Dries committed
754
function book_type_is_allowed($type) {
755
  return in_array($type, \Drupal::config('book.settings')->get('allowed_types'));
756
757
}

Dries's avatar
Dries committed
758
/**
759
 * Implements hook_node_type_update().
Dries's avatar
Dries committed
760
 *
761
762
 * Updates book.settings configuration object if the machine-readable name of a
 * node type is changed.
Dries's avatar
Dries committed
763
 */
764
function book_node_type_update(NodeTypeInterface $type) {
765
  if ($type->getOriginalId() != $type->id()) {
766
    $config = \Drupal::config('book.settings');
767
    // Update the list of node types that are allowed to be added to books.
768
    $allowed_types = $config->get('allowed_types');
769
    $old_key = array_search($type->getOriginalId(), $allowed_types);
770

771
    if ($old_key !== FALSE) {
772
      $allowed_types[$old_key] = $type->id();
773
      // Ensure that the allowed_types array is sorted consistently.
774
      // @see BookSettingsForm::submitForm()
775
      sort($allowed_types);
776
      $config->set('allowed_types', $allowed_types);
777
778
779
    }

    // Update the setting for the "Add child page" link.
780
    if ($config->get('child_type') == $type->getOriginalId()) {
781
      $config->set('child_type', $type->id());
782
    }
783
    $config->save();
Dries's avatar
Dries committed
784
  }
Dries's avatar
   
Dries committed
785
786
}

Dries's avatar
Dries committed
787
/**
788
789
 * Gets a book menu link by its menu link ID.
 *
Dries's avatar
Dries committed
790
791
792
 * Like menu_link_load(), but adds additional data from the {book} table.
 *
 * Do not call when loading a node, since this function may call node_load().
793
794
795
796
797
798
 *
 * @param $mlid
 *   The menu link ID of the menu item.
 *
 * @return
 *   A menu link, with the link translated for rendering and data added from the
799
 *   {book} table. FALSE if there is an error.
Dries's avatar
Dries committed
800
801
 */
function book_link_load($mlid) {
802
  return entity_load('menu_link', $mlid);
Dries's avatar
Dries committed
803
804
}

805
806
807
808
809
810
/**
 * Implements hook_library_info().
 */
function book_library_info() {
  $libraries['drupal.book'] = array(
    'title' => 'Book',
811
    'version' => \Drupal::VERSION,
812
813
814
815
816
817
818
819
820
821
822
823
    'js' => array(
      drupal_get_path('module', 'book') . '/book.js' => array(),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'drupal.form'),
    ),
  );

  return $libraries;
}