<?php

// $Id: book.module,v 1.454.2.6 2009/02/25 11:47:37 goba Exp $

/**

 * @file

 * Allows users to structure the pages of a site in a hierarchy or outline.

 */

/**

 * Implementation of hook_theme()

 */

function book_theme() {

  return array(

    'book_navigation' => array(

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

      'template' => 'book-navigation',

    ),

    'book_export_html' => array(

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

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

    ),

    'book_admin_table' => array(

      'arguments' => array('form' => NULL),

    ),

    'book_title_link' => array(

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

    ),

    'book_all_books_block' => array(

      'arguments' => array('book_menus' => array()),

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

    ),

    'book_node_export_html' => array(

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

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

    ),

  );

}

/**

 * Implementation of hook_perm().

 */

function book_perm() {

  return array('add content to books', 'administer book outlines', 'create new books', 'access printer-friendly version');

}

/**

 * Implementation of hook_link().

 */

function book_link($type, $node = NULL, $teaser = FALSE) {

  $links = array();

  if ($type == 'node' && isset($node->book)) {

    if (!$teaser) {

      $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' => "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.'))

        );

      }

    }

  }

  return $links;

}

/**

 * Implementation of 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'),

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

    'type' => MENU_CALLBACK,

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

  );

  $items['book/js/form'] = array(

    'page callback' => 'book_form_update',

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

    'type' => MENU_CALLBACK,

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

  );

  return $items;

}

/**

 * Menu item access callback - determine if the outline tab is accessible.

 */

function _book_outline_access($node) {

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

}

/**

 * Menu item access callback - determine if the user can remove nodes from the outline.

 */

function _book_outline_remove_access($node) {

  return isset($node->book) && ($node->book['bid'] != $node->nid) && _book_outline_access($node);

}

/**

 * Implementation of hook_init(). Add's the book module's CSS.

 */

function book_init() {

  drupal_add_css(drupal_get_path('module', 'book') .'/book.css');

}

/**

 * Implementation of hook_block().

 *

 * 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($op = 'list', $delta = 0, $edit = array()) {

  $block = array();

  switch ($op) {

    case 'list':

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

      $block[0]['cache'] = BLOCK_CACHE_PER_PAGE | BLOCK_CACHE_PER_ROLE;

      return $block;

    case 'view':

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

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

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

          }

        }

        $block['content'] = theme('book_all_books_block', $book_menus);

      }

      elseif ($current_bid) {

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

        $title = db_result(db_query(db_rewrite_sql('SELECT n.title FROM {node} n WHERE n.nid = %d'), $node->book['bid']));

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

        if ($title) {

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

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

          $data = array_shift($tree);

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

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

        }

      }

      return $block;

    case 'configure':

      $options = array(

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

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

      );

      $form['book_block_mode'] = array(

        '#type' => 'radios',

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

        '#options' => $options,

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

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

        );

      return $form;

    case 'save':

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

      break;

  }

}

/**

 * Generate the HTML output for a link to a book title when used as a block title.

 *

 * @ingroup themeable

 */

function theme_book_title_link($link) {

  $link['options']['attributes']['class'] =  '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.

 */

function book_get_books() {

  static $all_books;

  if (!isset($all_books)) {

    $all_books = array();

    $result = db_query("SELECT DISTINCT(bid) FROM {book}");

    $nids = array();

    while ($book = db_fetch_array($result)) {

      $nids[] = $book['bid'];

    }

    if ($nids) {

      $result2 = db_query(db_rewrite_sql("SELECT n.type, n.title, b.*, ml.* FROM {book} b INNER JOIN {node} n on b.nid = n.nid INNER JOIN {menu_links} ml ON b.mlid = ml.mlid WHERE n.nid IN (". implode(',', $nids) .") AND n.status = 1 ORDER BY ml.weight, ml.link_title"));

      while ($link = db_fetch_array($result2)) {

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

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

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

      }

    }

  }

  return $all_books;

}

/**

 * Implementation of hook_form_alter(). Adds the book fieldset to the node form.

 *

 * @see book_pick_book_submit()

 * @see book_submit()

 */

function book_form_alter(&$form, $form_state, $form_id) {

  if (isset($form['type']) && isset($form['#node']) && $form['type']['#value'] .'_node_form' == $form_id) {

    // Add elements to the node form

    $node = $form['#node'];

    $access = user_access('administer book outlines');

    if (!$access) {

      if (user_access('add content to books') && ((!empty($node->book['mlid']) && !empty($node->nid)) || book_type_is_allowed($node->type))) {

        // Already in the book hierarchy or this node type is allowed

        $access = TRUE;

      }

    }

    if ($access) {

      _book_add_form_elements($form, $node);

      $form['book']['pick-book'] = array(

        '#type' => 'submit',

        '#value' => t('Change book (update list of parents)'),

         // Submit the node form so the parent select options get updated.

         // This is typically only used when JS is disabled.  Since the parent options

         // won't be changed via AJAX, a button is provided in the node form to submit

         // the form and generate options in the parent select corresponding to the

         // selected book.  This is similar to what happens during a node preview.

        '#submit' => array('node_form_submit_build_node'),

        '#weight' => 20,

      );

    }

  }

}

/**

 * Build the parent selection form element for the node form or outline tab

 *

 * This function is also called when generating a new set of options during the

 * AJAX callback, so an array is returned that can be used to replace an existing

 * form element.

 */

function _book_parent_select($book_link) {

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

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

    );

  }

  return $form;

}

/**

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

 */

function _book_add_form_elements(&$form, $node) {

  // Need this for AJAX.

  $form['#cache'] = TRUE;

  drupal_add_js("if (Drupal.jsEnabled) { $(document).ready(function() { $('#edit-book-pick-book').css('display', 'none'); }); }", 'inline');

  $form['book'] = array(

    '#type' => 'fieldset',

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

    '#weight' => 10,

    '#collapsible' => TRUE,

    '#collapsed' => TRUE,

    '#tree' => TRUE,

    '#attributes' => array('class' => 'book-outline-form'),

  );

  foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) {

    $form['book'][$key] = array(

      '#type' => 'value',

      '#value' => $node->book[$key],

    );

  }

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

  $form['book']['weight'] = array(

    '#type' => 'weight',

    '#title' => t('Weight'),

    '#default_value' => $node->book['weight'],

    '#delta' => 15,

    '#weight' => 5,

    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),

  );

  $options = array();

  $nid = isset($node->nid) ? $node->nid : 'new';

  if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) {

    // This is the top level node in a maximum depth book and thus cannot be moved.

    $options[$node->nid] = $node->title;

  }

  else {

    foreach (book_get_books() as $book) {

      $options[$book['nid']] = $book['title'];

    }

  }

  if (user_access('create new books') && ($nid == 'new' || ($nid != $node->book['original_bid']))) {

    // The node can become a new book, if it is not one already.

    $options = array($nid => '<'. t('create a new book') .'>') + $options;

  }

  if (!$node->book['mlid']) {

    // The node is not currently in a the hierarchy.

    $options = array(0 => '<'. t('none') .'>') + $options;

  }

  // Add a drop-down to select the destination book.

  $form['book']['bid'] = array(

    '#type' => 'select',

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

    '#default_value' => $node->book['bid'],

    '#options' => $options,

    '#access' => (bool)$options,

    '#description' => t('Your page will be a part of the selected book.'),

    '#weight' => -5,

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

    '#ahah' => array(

      'path' => 'book/js/form',

      'wrapper' => 'edit-book-plid-wrapper',

      'effect' => 'slide',

    ),

  );

}

/**

 * Common helper function to handles additions and updates to the book outline.

 *

 * Performs all additions and updates to the book outline through node addition,

 * node editing, node deletion, or the outline tab.

 */

function _book_update_outline(&$node) {

  if (empty($node->book['bid'])) {

    return FALSE;

  }

  $new = empty($node->book['mlid']);

  $node->book['link_path'] = 'node/'. $node->nid;

  $node->book['link_title'] = $node->title;

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

  if ($node->book['bid'] == $node->nid) {

    $node->book['plid'] = 0;

    $node->book['menu_name'] = book_menu_name($node->nid);

  }

  else {

    // Check in case the parent is not is this book; the book takes precedence.

    if (!empty($node->book['plid'])) {

      $parent = db_fetch_array(db_query("SELECT * FROM {book} WHERE mlid = %d", $node->book['plid']));

    }

    if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) {

      $node->book['plid'] = db_result(db_query("SELECT mlid FROM {book} WHERE nid = %d", $node->book['bid']));

      $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled.

    }

  }

  if (menu_link_save($node->book)) {

    if ($new) {

      // Insert new.

      db_query("INSERT INTO {book} (nid, mlid, bid) VALUES (%d, %d, %d)", $node->nid, $node->book['mlid'], $node->book['bid']);

    }

    else {

      if ($node->book['bid'] != db_result(db_query("SELECT bid FROM {book} WHERE nid = %d", $node->nid))) {

        // Update the bid for this page and all children.

        book_update_bid($node->book);

      }

    }

    return TRUE;

  }

  // Failed to save the menu link

  return FALSE;

}

/**

 * Update the bid for a page and its children when it is moved to a new book.

 *

 * @param $book_link

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

 */

function book_update_bid($book_link) {

  for ($i = 1; $i <= MENU_MAX_DEPTH && $book_link["p$i"]; $i++) {

    $match[] = "p$i = %d";

    $args[] = $book_link["p$i"];

  }

  $result = db_query("SELECT mlid FROM {menu_links} WHERE ". implode(' AND ', $match), $args);

  $mlids = array();

  while ($a = db_fetch_array($result)) {

    $mlids[] = $a['mlid'];

  }

  if ($mlids) {

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

  }

}

/**

 * Get the book menu tree for a page, and return it as a linear array.

 *

 * @param $book_link

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

 * @return

 *   A linear array of menu links in the order that the links are shown in the

 *   menu, so the previous and next pages are the elements before and after the

 *   element corresponding to $node.  The children of $node (if any) will come

 *   immediately after it in the array.

 */

function book_get_flat_menu($book_link) {

  static $flat = array();

  if (!isset($flat[$book_link['mlid']])) {

    // Call menu_tree_all_data() to take advantage of the menu system's caching.

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

    $flat[$book_link['mlid']] = array();

    _book_flatten_menu($tree, $flat[$book_link['mlid']]);

  }

  return $flat[$book_link['mlid']];

}

/**

 * Recursive helper function for book_get_flat_menu().

 */

function _book_flatten_menu($tree, &$flat) {