<?php

/**

 * @file

 * Allows users to create and organize related content in an outline.

 */

/**

 * Implements hook_help().

 */

function book_help($path, $arg) {

  switch ($path) {

    case 'admin/help#book':

      $output = '<h3>' . t('About') . '</h3>';

      $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/documentation/modules/book/')) . '</p>';

      $output .= '<h3>' . t('Uses') . '</h3>';

      $output .= '<dl>';

      $output .= '<dt>' . t('Adding and managing book content') . '</dt>';

      $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>';

      $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>';

      $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>';

      $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>';

  }

}

/**

 * Implements hook_theme().

 */

function book_theme() {

  return array(

    'book_navigation' => array(

      'variables' => array('book_link' => NULL),

      'template' => 'book-navigation',

    ),

    'book_export_html' => array(

      'variables' => array('title' => NULL, 'contents' => NULL, 'depth' => NULL),

      'template' => 'book-export-html',

    ),

    'book_admin_table' => array(

      'render element' => 'form',

    ),

    'book_title_link' => array(

      'variables' => array('link' => NULL),

    ),

    'book_all_books_block' => array(

      'render element' => 'book_menus',

      'template' => 'book-all-books-block',

    ),

    'book_node_export_html' => array(

      'variables' => array('node' => NULL, 'children' => NULL),

      'template' => 'book-node-export-html',

    ),

  );

}

/**

 * Implements hook_permission().

 */

function book_permission() {

  return array(

    'administer book outlines' => array(

      'title' => t('Administer book outlines'),

    ),

    'create new books' => array(

      'title' => t('Create new books'),

    ),

    'add content to books' => array(

      'title' => t('Add content and child pages to books'),

    ),

    'access printer-friendly version' => array(

      'title' => t('View printer-friendly books'),

      'description' => t('View a book page and all of its sub-pages as a single document for ease of printing. Can be performance heavy.'),

    ),

  );

}

/**

 * Adds relevant book links to the node's links.

 *

 * @param $node

 *   The book page node to add links to.

 * @param $view_mode

 *   The view mode of the node.

 */

function book_node_view_link($node, $view_mode) {

  $links = array();

  if (isset($node->book['depth'])) {

    if ($view_mode == 'full' && node_is_page($node)) {

      $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) {

        $links['book_add_child'] = array(

          'title' => t('Add child page'),

          'href' => 'node/add/' . str_replace('_', '-', $child_type),

          'query' => array('parent' => $node->book['mlid']),

        );

      }

      if (user_access('access printer-friendly version')) {

        $links['book_printer'] = array(

          'title' => t('Printer-friendly version'),

          'href' => 'book/export/html/' . $node->nid,

          'attributes' => array('title' => t('Show a printer-friendly version of this book page and its sub-pages.'))

        );

      }

    }

  }

  if (!empty($links)) {

    $node->content['links']['book'] = array(

      '#theme' => 'links__node__book',

      '#links' => $links,

      '#attributes' => array('class' => array('links', 'inline')),

    );

  }

}

/**

 * Implements hook_menu().

 */

function book_menu() {

  $items['admin/content/book'] = array(

    'title' => 'Books',

    'description' => "Manage your site's book outlines.",

    'page callback' => 'book_admin_overview',

    'access arguments' => array('administer book outlines'),

    'type' => MENU_LOCAL_TASK,

    'file' => 'book.admin.inc',

  );

  $items['admin/content/book/list'] = array(

    'title' => 'List',

    'type' => MENU_DEFAULT_LOCAL_TASK,

  );

  $items['admin/content/book/settings'] = array(

    'title' => 'Settings',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('book_admin_settings'),

    'access arguments' => array('administer site configuration'),

    'type' => MENU_LOCAL_TASK,

    'weight' => 8,

    'file' => 'book.admin.inc',

  );

  $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,

    'file' => 'book.admin.inc',

  );

  $items['book'] = array(

    'title' => 'Books',

    'page callback' => 'book_render',

    'access arguments' => array('access content'),

    'type' => MENU_SUGGESTED_ITEM,

    'file' => 'book.pages.inc',

  );

  $items['book/export/%/%'] = array(

    'page callback' => 'book_export',

    'page arguments' => array(2, 3),

    'access arguments' => array('access printer-friendly version'),

    'type' => MENU_CALLBACK,

    'file' => 'book.pages.inc',

  );

  $items['node/%node/outline'] = array(

    'title' => 'Outline',

    'page callback' => 'book_outline',

    'page arguments' => array(1),

    'access callback' => '_book_outline_access',

    'access arguments' => array(1),

    'type' => MENU_LOCAL_TASK,

    'weight' => 2,

    'file' => 'book.pages.inc',

  );

  $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),

    'file' => 'book.pages.inc',

  );

  return $items;

}

/**

 * Access callback: Determines if the outline tab is accessible.

 *

 * @param $node

 *   The node whose outline tab is to be viewed.

 */

function _book_outline_access($node) {

  return user_access('administer book outlines') && node_access('view', $node);

}

/**

 * Access callback: Determines if the user can remove nodes from the outline.

 *

 * @param $node

 *   The node to remove from the outline.

 *

 * @see book_menu()

 */

function _book_outline_remove_access($node) {

  return _book_node_is_removable($node) && _book_outline_access($node);

}

/**

 * Determines if a node can be removed from the book.

 *

 * A node can be removed from a book if it is actually in a book and it either

 * is not a top-level page or is a top-level page with no children.

 *

 * @param $node

 *   The node to remove from the outline.

 */

function _book_node_is_removable($node) {

  return (!empty($node->book['bid']) && (($node->book['bid'] != $node->nid) || !$node->book['has_children']));

}

/**

 * Implements hook_admin_paths().

 */

function book_admin_paths() {

  if (variable_get('node_admin_theme')) {

    $paths = array(

      'node/*/outline' => TRUE,

      'node/*/outline/remove' => TRUE,

    );

    return $paths;

  }

}

/**

 * Implements hook_entity_info_alter().

 */

function book_entity_info_alter(&$info) {

  // Add the 'Print' view mode for nodes.

  $info['node']['view modes'] += array(

    'print' => array(

      'label' => t('Print'),

      'custom settings' => FALSE,

    ),

  );

}

/**

 * Implements hook_block_info().

 */

function book_block_info() {

  $block = array();

  $block['navigation']['info'] = t('Book navigation');

  $block['navigation']['cache'] = DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE;

  return $block;

}

/**

 * Implements hook_block_view().

 *

 * Displays the book table of contents in a block when the current page is a

 * single-node view of a book node.

 */

function book_block_view($delta = '') {

  $block = array();

  $current_bid = 0;

  if ($node = menu_get_object()) {

    $current_bid = empty($node->book['bid']) ? 0 : $node->book['bid'];

  }

  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));

      }

      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;

        // Check whether user can access the book link.

        $book_node = node_load($book['nid']);

        $book['access'] = node_access('view', $book_node);

        $pseudo_tree[0]['link'] = $book;

        $book_menus[$book_id] = menu_tree_output($pseudo_tree);

      }

    }

    $book_menus['#theme'] = 'book_all_books_block';

    $block['content'] = $book_menus;

  }

  elseif ($current_bid) {

    // Only display this block when the user is browsing a book.

  $select = db_select('node', 'n')

    ->fields('n', array('title'))

    ->condition('n.nid', $node->book['bid'])

    ->addTag('node_access');

    $title = $select->execute()->fetchField();

    // Only show the block if the user has view access for the top-level node.

    if ($title) {

      $tree = menu_tree_all_data($node->book['menu_name'], $node->book);

      // There should only be one element at the top level.

      $data = array_shift($tree);

      $block['subject'] = theme('book_title_link', array('link' => $data['link']));

      $block['content'] = ($data['below']) ? menu_tree_output($data['below']) : '';

    }

  }

  return $block;

}

/**

 * Implements hook_block_configure().

 */

function book_block_configure($delta = '') {

  $block = array();

  $options = array(

    'all pages' => t('Show block on all pages'),

    'book pages' => t('Show block only on book pages'),

  );

  $form['book_block_mode'] = array(

    '#type' => 'radios',

    '#title' => t('Book navigation block display'),

    '#options' => $options,

    '#default_value' => variable_get('book_block_mode', 'all pages'),

    '#description' => t("If <em>Show block on all pages</em> is selected, the block will contain the automatically generated menus for all of the site's books. If <em>Show block only on book pages</em> is selected, the block will contain only the one menu corresponding to the current page's book. In this case, if the current page is not in a book, no block will be displayed. The <em>Page specific visibility settings</em> or other visibility settings can be used in addition to selectively display this block."),

    );

  return $form;

}

/**

 * Implements hook_block_save().

 */

function book_block_save($delta = '', $edit = array()) {

  $block = array();

  variable_set('book_block_mode', $edit['book_block_mode']);

}

/**

 * 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.

 *

 * @ingroup themeable

 */

function theme_book_title_link($variables) {

  $link = $variables['link'];

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

  return l($link['title'], $link['href'], $link['options']);

}

/**

 * 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.

 *

 * @return

 *   An array of all books.

 */

function book_get_books() {

  $all_books = &drupal_static(__FUNCTION__);

  if (!isset($all_books)) {

    $all_books = array();

    $nids = db_query("SELECT DISTINCT(bid) FROM {book}")->fetchCol();

    if ($nids) {

      $query = db_select('book', 'b', array('fetch' => PDO::FETCH_ASSOC));

      $query->join('node', 'n', 'b.nid = n.nid');

      $query->join('menu_links', 'ml', 'b.mlid = ml.mlid');

      $query->addField('n', 'type', 'type');

      $query->addField('n', 'title', 'title');

      $query->fields('b');

      $query->fields('ml');

      $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) {

        $link['href'] = $link['link_path'];

        $link['options'] = unserialize($link['options']);

        $all_books[$link['bid']] = $link;

      }

    }

  }

  return $all_books;

}

/**

 * Implements hook_form_BASE_FORM_ID_alter() for node_form().

 *

 * Adds the book fieldset to the node form.

 *

 * @see book_pick_book_nojs_submit()

 */

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;

    }

  }

  if ($access) {

    _book_add_form_elements($form, $form_state, $node);

    // Since the "Book" dropdown can't trigger a form submission when

    // JavaScript is disabled, add a submit button to do that. book.css hides

    // 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,

    );

  }

}

/**

 * Form submission handler for node_form().

 *

 * 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

 * book_form_update() Ajax callback instead.

 *

 * @see book_form_update()

 * @see book_form_node_form_alter()

 */

function book_pick_book_nojs_submit($form, &$form_state) {

  $form_state['node']->book = $form_state['values']['book'];

  $form_state['rebuild'] = TRUE;

}

/**

 * Builds 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.

 *

 * @param $book_link

 *   A fully loaded menu link that is part of the book hierarchy.

 *

 * @return

 *   A parent selection form element.

 */

function _book_parent_select($book_link) {

  if (variable_get('menu_override_parent_selector', FALSE)) {

    return array();

  }

  // 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>',

  );

  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>';

  }

  else {

    $form = array(

      '#type' => 'select',

      '#title' => t('Parent item'),

      '#default_value' => $book_link['plid'],

      '#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'], $book_link['parent_depth_limit'], array($book_link['mlid'])),

      '#attributes' => array('class' => array('book-title-select')),

      '#prefix' => '<div id="edit-book-plid-wrapper">',

      '#suffix' => '</div>',

    );

  }

  return $form;

}

/**

 * Builds the common elements of the book form for the node and outline forms.

 *

 * @param $node

 *   The node whose form is being viewed.

 */

function _book_add_form_elements(&$form, &$form_state, $node) {

  // If the form is being processed during the Ajax callback of our book bid

  // dropdown, then $form_state will hold the value that was selected.

  if (isset($form_state['values']['book'])) {

    $node->book = $form_state['values']['book'];

  }

  $form['book'] = array(

    '#type' => 'fieldset',

    '#title' => t('Book outline'),

    '#weight' => 10,