webmaster@1: <?php
webmaster@1: // $Id: book.pages.inc,v 1.5 2007/12/22 23:24:24 goba Exp $
webmaster@1: 
webmaster@1: /**
webmaster@1:  * @file
webmaster@1:  * User page callbacks for the book module.
webmaster@1:  */
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Menu callback; prints a listing of all books.
webmaster@1:  */
webmaster@1: function book_render() {
webmaster@1:   $book_list = array();
webmaster@1:   foreach (book_get_books() as $book) {
webmaster@1:     $book_list[] = l($book['title'], $book['href'], $book['options']);
webmaster@1:   }
webmaster@1: 
webmaster@1:   return theme('item_list', $book_list);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Menu callback; Generates various representation of a book page and its children.
webmaster@1:  *
webmaster@1:  * The function delegates the generation of output to helper functions.
webmaster@1:  * The function name is derived by prepending 'book_export_' to the
webmaster@1:  * given output type. So, e.g., a type of 'html' results in a call to
webmaster@1:  * the function book_export_html().
webmaster@1:  *
webmaster@1:  * @param $type
webmaster@1:  *   A string encoding the type of output requested. The following
webmaster@1:  *   types are currently supported in book module:
webmaster@1:  *
webmaster@1:  *   - html: HTML (printer friendly output)
webmaster@1:  *
webmaster@1:  *   Other types may be supported in contributed modules.
webmaster@1:  * @param $nid
webmaster@1:  *   An integer representing the node id (nid) of the node to export
webmaster@1:  * @return
webmaster@1:  *   A string representing the node and its children in the book hierarchy
webmaster@1:  *   in a format determined by the $type parameter.
webmaster@1:  */
webmaster@1: function book_export($type, $nid) {
webmaster@1: 
webmaster@1:   $type = drupal_strtolower($type);
webmaster@1: 
webmaster@1:   $export_function = 'book_export_'. $type;
webmaster@1: 
webmaster@1:   if (function_exists($export_function)) {
webmaster@1:     print call_user_func($export_function, $nid);
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     drupal_set_message(t('Unknown export format.'));
webmaster@1:     drupal_not_found();
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * This function is called by book_export() to generate HTML for export.
webmaster@1:  *
webmaster@1:  * The given node is /embedded to its absolute depth in a top level
webmaster@1:  * section/. For example, a child node with depth 2 in the hierarchy
webmaster@1:  * is contained in (otherwise empty) &lt;div&gt; elements
webmaster@1:  * corresponding to depth 0 and depth 1. This is intended to support
webmaster@1:  * WYSIWYG output - e.g., level 3 sections always look like level 3
webmaster@1:  * sections, no matter their depth relative to the node selected to be
webmaster@1:  * exported as printer-friendly HTML.
webmaster@1:  *
webmaster@1:  * @param $nid
webmaster@1:  *   An integer representing the node id (nid) of the node to export.
webmaster@1:  * @return
webmaster@1:  *   A string containing HTML representing the node and its children in
webmaster@1:  *   the book hierarchy.
webmaster@1:  */
webmaster@1: function book_export_html($nid) {
webmaster@1:   if (user_access('access printer-friendly version')) {
webmaster@1:     $export_data = array();
webmaster@1:     $node = node_load($nid);
webmaster@1:     if (isset($node->book)) {
webmaster@1:       $tree = book_menu_subtree_data($node->book);
webmaster@1:       $contents = book_export_traverse($tree, 'book_node_export');
webmaster@1:     }
webmaster@1:     return theme('book_export_html', $node->title, $contents, $node->book['depth']);
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     drupal_access_denied();
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Menu callback; show the outline form for a single node.
webmaster@1:  */
webmaster@1: function book_outline($node) {
webmaster@1:   drupal_set_title(check_plain($node->title));
webmaster@1:   return drupal_get_form('book_outline_form', $node);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Build the form to handle all book outline operations via the outline tab.
webmaster@1:  *
webmaster@1:  * @see book_outline_form_submit()
webmaster@1:  * @see book_remove_button_submit()
webmaster@1:  *
webmaster@1:  * @ingroup forms
webmaster@1:  */
webmaster@1: function book_outline_form(&$form_state, $node) {
webmaster@1: 
webmaster@1:   if (!isset($node->book)) {
webmaster@1:     // The node is not part of any book yet - set default options.
webmaster@1:     $node->book = _book_link_defaults($node->nid);
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     $node->book['original_bid'] = $node->book['bid'];
webmaster@1:   }
webmaster@1:   // Find the depth limit for the parent select.
webmaster@1:   if (!isset($node->book['parent_depth_limit'])) {
webmaster@1:     $node->book['parent_depth_limit'] = _book_parent_depth_limit($node->book);
webmaster@1:   }
webmaster@1:   $form['#node'] = $node;
webmaster@1:   $form['#id'] = 'book-outline';
webmaster@1:   _book_add_form_elements($form, $node);
webmaster@1: 
webmaster@1:   $form['book']['#collapsible'] = FALSE;
webmaster@1: 
webmaster@1:   $form['update'] = array(
webmaster@1:     '#type' => 'submit',
webmaster@1:     '#value' => $node->book['original_bid'] ? t('Update book outline') : t('Add to book outline'),
webmaster@1:     '#weight' => 15,
webmaster@1:   );
webmaster@1: 
webmaster@1:   $form['remove'] = array(
webmaster@1:     '#type' => 'submit',
webmaster@1:     '#value' => t('Remove from book outline'),
webmaster@1:     '#access' => $node->nid != $node->book['bid'] && $node->book['bid'],
webmaster@1:     '#weight' => 20,
webmaster@1:     '#submit' => array('book_remove_button_submit'),
webmaster@1:   );
webmaster@1: 
webmaster@1:   return $form;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Button submit function to redirect to removal confirm form.
webmaster@1:  *
webmaster@1:  * @see book_outline_form()
webmaster@1:  */
webmaster@1: function book_remove_button_submit($form, &$form_state) {
webmaster@1:   $form_state['redirect'] = 'node/'. $form['#node']->nid .'/outline/remove';
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Handles book outline form submissions from the outline tab.
webmaster@1:  *
webmaster@1:  * @see book_outline_form()
webmaster@1:  */
webmaster@1: function book_outline_form_submit($form, &$form_state) {
webmaster@1:   $node = $form['#node'];
webmaster@1:   $form_state['redirect'] = "node/". $node->nid;
webmaster@1:   $book_link = $form_state['values']['book'];
webmaster@1:   if (!$book_link['bid']) {
webmaster@1:     drupal_set_message(t('No changes were made'));
webmaster@1:     return;
webmaster@1:   }
webmaster@1: 
webmaster@1:   $book_link['menu_name'] = book_menu_name($book_link['bid']);
webmaster@1:   $node->book = $book_link;
webmaster@1:   if (_book_update_outline($node)) {
webmaster@1:     if ($node->book['parent_mismatch']) {
webmaster@1:       // This will usually only happen when JS is disabled.
webmaster@1:       drupal_set_message(t('The post has been added to the selected book. You may now position it relative to other pages.'));
webmaster@1:       $form_state['redirect'] = "node/". $node->nid ."/outline";
webmaster@1:     }
webmaster@1:     else {
webmaster@1:       drupal_set_message(t('The book outline has been updated.'));
webmaster@1:     }
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     drupal_set_message(t('There was an error adding the post to the book.'), 'error');
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Menu callback; builds a form to confirm removal of a node from the book.
webmaster@1:  *
webmaster@1:  * @see book_remove_form_submit()
webmaster@1:  *
webmaster@1:  * @ingroup forms
webmaster@1:  */
webmaster@1: function book_remove_form(&$form_state, $node) {
webmaster@1:   $form['#node'] = $node;
webmaster@1:   $title = array('%title' => $node->title);
webmaster@1: 
webmaster@1:   if ($node->book['has_children']) {
webmaster@1:     $description = t('%title has associated child pages, which will be relocated automatically to maintain their connection to the book. To recreate the hierarchy (as it was before removing this page), %title may be added again using the Outline tab, and each of its former child pages will need to be relocated manually.', $title);
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     $description = t('%title may be added to hierarchy again using the Outline tab.', $title);
webmaster@1:   }
webmaster@1: 
webmaster@1:   return confirm_form($form, t('Are you sure you want to remove %title from the book hierarchy?', $title), 'node/'. $node->nid, $description, t('Remove'));
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Confirm form submit function to remove a node from the book.
webmaster@1:  *
webmaster@1:  * @see book_remove_form()
webmaster@1:  */
webmaster@1: function book_remove_form_submit($form, &$form_state) {
webmaster@1:   $node = $form['#node'];
webmaster@1:   if ($node->nid != $node->book['bid']) {
webmaster@1:     // Only allowed when this is not a book (top-level page).
webmaster@1:     menu_link_delete($node->book['mlid']);
webmaster@1:     db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
webmaster@1:     drupal_set_message(t('The post has been removed from the book.'));
webmaster@1:   }
webmaster@1:   $form_state['redirect'] = 'node/'. $node->nid;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * AJAX callback to replace the book parent select options.
webmaster@1:  *
webmaster@1:  * This function is called when the selected book is changed.  It updates the
webmaster@1:  * cached form (either the node form or the book outline form) and returns
webmaster@1:  * rendered output to be used to replace the select containing the possible
webmaster@1:  * parent pages in the newly selected book.
webmaster@1:  *
webmaster@1:  * @param $build_id
webmaster@1:  *   The form's build_id.
webmaster@1:  * @param $bid
webmaster@1:  *   A bid from from among those in the form's book select.
webmaster@1:  * @return
webmaster@1:  *   Prints the replacement HTML in JSON format.
webmaster@1:  */
webmaster@1: function book_form_update() {
webmaster@1:   $cid = 'form_'. $_POST['form_build_id'];
webmaster@1:   $bid = $_POST['book']['bid'];
webmaster@1:   $cache = cache_get($cid, 'cache_form');
webmaster@1:   if ($cache) {
webmaster@1:     $form = $cache->data;
webmaster@1: 
webmaster@1:     // Validate the bid.
webmaster@1:     if (isset($form['book']['bid']['#options'][$bid])) {
webmaster@1:       $book_link = $form['#node']->book;
webmaster@1:       $book_link['bid'] = $bid;
webmaster@1:       // Get the new options and update the cache.
webmaster@1:       $form['book']['plid'] = _book_parent_select($book_link);
webmaster@1:       cache_set($cid, $form, 'cache_form', $cache->expire);
webmaster@1: 
webmaster@1:       // Build and render the new select element, then return it in JSON format.
webmaster@1:       $form_state = array();
webmaster@1:       $form['#post'] = array();
webmaster@1:       $form = form_builder($form['form_id']['#value'] , $form, $form_state);
webmaster@1:       $output = drupal_render($form['book']['plid']);
webmaster@1:       drupal_json(array('status' => TRUE, 'data' => $output));
webmaster@1:     }
webmaster@1:     else {
webmaster@1:       drupal_json(array('status' => FALSE, 'data' => ''));
webmaster@1:     }
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     drupal_json(array('status' => FALSE, 'data' => ''));
webmaster@1:   }
webmaster@1:   exit();
webmaster@1: }