', 'options' => array());
+
+ $tree = menu_tree_all_data($book_link['menu_name'], $book_link);
+ $curr = array_shift($tree);
+
+ while ($curr) {
+ if ($curr['link']['href'] == $book_link['href']) {
+ $trail[] = $curr['link'];
+ $curr = FALSE;
+ }
+ else {
+ if ($curr['below'] && $curr['link']['in_active_trail']) {
+ $trail[] = $curr['link'];
+ $tree = $curr['below'];
+ }
+ $curr = array_shift($tree);
+ }
+ }
+ }
+ return $trail;
}
/**
* Implementation of hook_nodeapi().
*
- * Appends book navigation to all nodes in the book.
+ * Appends book navigation to all nodes in the book, and handles book outline
+ * insertions and updates via the node form.
*/
function book_nodeapi(&$node, $op, $teaser, $page) {
switch ($op) {
case 'load':
- return db_fetch_array(db_query('SELECT parent, weight FROM {book} WHERE vid = %d', $node->vid));
+ // Note - we cannot use book_link_load() because it will call node_load()
+ $info['book'] = db_fetch_array(db_query('SELECT * FROM {book} b INNER JOIN {menu_links} ml ON b.mlid = ml.mlid WHERE b.nid = %d', $node->nid));
+ if ($info['book']) {
+ $info['book']['href'] = $info['book']['link_path'];
+ $info['book']['title'] = $info['book']['link_title'];
+ $info['book']['options'] = unserialize($info['book']['options']);
+ return $info;
+ }
break;
case 'view':
- if (!$teaser) {
- if (isset($node->parent)) {
- $path = book_location($node);
- // Construct the breadcrumb:
- $node->breadcrumb = array(); // Overwrite the trail with a book trail.
- foreach ($path as $level) {
- $node->breadcrumb[] = array('path' => 'node/'. $level->nid, 'title' => $level->title);
- }
- $node->breadcrumb[] = array('path' => 'node/'. $node->nid);
+ if (!$teaser) {
+ if (!empty($node->book['book_id']) && $node->build_mode == NODE_BUILD_NORMAL) {
$node->content['book_navigation'] = array(
- '#value' => theme('book_navigation', $node),
+ '#value' => theme('book_navigation', $node->book),
'#weight' => 100,
);
if ($page) {
- menu_set_location($node->breadcrumb);
+ menu_set_active_trail(book_build_active_trail($node->book));
+ menu_set_active_menu_name($node->book['menu_name']);
}
}
}
break;
+ case 'presave':
+ // Always save a revision for non-administrators.
+ if (!empty($node->book['book_id']) && !user_access('administer nodes')) {
+ $node->revision = 1;
+ }
+ break;
+ case 'insert':
case 'update':
- if (isset($node->parent)) {
- if (!empty($node->revision)) {
- db_query("INSERT INTO {book} (nid, vid, parent, weight) VALUES (%d, %d, %d, %d)", $node->nid, $node->vid, $node->parent, $node->weight);
- }
- else {
- db_query("UPDATE {book} SET parent = %d, weight = %d WHERE vid = %d", $node->parent, $node->weight, $node->vid);
+ if (!empty($node->book['book_id'])) {
+ if ($node->book['book_id'] == 'new') {
+ // New nodes that are their own book.
+ $node->book['book_id'] = $node->nid;
}
+ $node->book['nid'] = $node->nid;
+ $node->book['menu_name'] = book_menu_name($node->book['book_id']);
+ _book_update_outline($node);
}
break;
- case 'delete revision':
- db_query('DELETE FROM {book} WHERE vid = %d', $node->vid);
- break;
case 'delete':
- db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
+ if (!empty($node->book['book_id'])) {
+ if ($node->nid == $node->book['book_id']) {
+ // Handle deletion of a top-level post.
+ $result = db_query("SELECT b.nid FROM {menu_links} ml INNER JOIN {book} b on b.mlid = ml.mlid WHERE ml.plid = %d", $node->book['mlid']);
+ while ($child = db_fetch_array($result)) {
+ $child_node = node_load($child['nid']);
+ $child_node->book['book_id'] = $child_node->nid;
+ _book_update_outline($child_node);
+ }
+ }
+ menu_link_delete($node->book['mlid']);
+ db_query('DELETE FROM {book} WHERE mlid = %d', $node->book['mlid']);
+ }
+ break;
+ case 'prepare':
+ // Prepare defaults for the add/edit form.
+ if (empty($node->book) && (user_access('add content to books') || user_access('administer book outlines'))) {
+ $node->book = array();
+ if (empty($node->nid) && isset($_GET['parent']) && is_numeric($_GET['parent'])) {
+ // Handle "Add child page" links:
+ $parent = book_link_load($_GET['parent']);
+ if ($parent && $parent['access']) {
+ $node->book['book_id'] = $parent['book_id'];
+ $node->book['plid'] = $parent['mlid'];
+ $node->book['menu_name'] = $parent['menu_name'];
+ }
+ }
+ // Set defaults.
+ $node->book += _book_link_defaults(!empty($node->nid) ? $node->nid : 'new');
+ }
+ else {
+ if (isset($node->book['book_id']) && !isset($node->book['orig_book_id'])) {
+ $node->book['orig_book_id'] = $node->book['book_id'];
+ }
+ }
break;
}
}
/**
- * Prepares the links to children (TOC) and forward/backward
- * navigation for a node presented as a book page.
+ * Form altering function for the confirm form for a single node deletion.
+ */
+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(
+ '#value' => ''. 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->title)) .'
',
+ '#weight' => -10,
+ );
+ }
+}
+
+/**
+ * Return an array with default values for a book link.
+ */
+function _book_link_defaults($nid) {
+ return array('orig_book_id' => 0, 'menu_name' => '', 'nid' => $nid, 'book_id' => 0, 'router_path' => 'node/%', 'plid' => 0, 'mlid' => 0, 'has_children' => 0, 'weight' => 0, 'module' => 'book', 'options' => array());
+}
+
+/**
+ * Prepares the links to the children of the page and the previous/up/next navigation.
+ *
+ * These navigation elements are added to the content of a node in the book
+ * outline when it is viewed as a page and in similar contexts.
*
* @ingroup themeable
*/
-function theme_book_navigation($node) {
+function theme_book_navigation($book_link) {
$output = '';
$links = '';
- if ($node->nid) {
- $tree = book_tree($node->nid);
+ if ($book_link['mlid']) {
+ $tree = book_children($book_link);
- if ($prev = book_prev($node)) {
- drupal_add_link(array('rel' => 'prev', 'href' => url('node/'. $prev->nid)));
- $links .= l(t('‹ ') . $prev->title, 'node/'. $prev->nid, array('class' => 'page-previous', 'title' => t('Go to previous page')));
- }
- if ($node->parent) {
- drupal_add_link(array('rel' => 'up', 'href' => url('node/'. $node->parent)));
- $links .= l(t('up'), 'node/'. $node->parent, array('class' => 'page-up', 'title' => t('Go to parent page')));
- }
- if ($next = book_next($node)) {
- drupal_add_link(array('rel' => 'next', 'href' => url('node/'. $next->nid)));
- $links .= l($next->title . t(' ›'), 'node/'. $next->nid, array('class' => 'page-next', 'title' => t('Go to next page')));
+ if ($prev = book_prev($book_link)) {
+ drupal_add_link(array('rel' => 'prev', 'href' => url($prev['href'])));
+ $links .= l(t('‹ ') . $prev['title'], $prev['href'], array('attributes' => array('class' => 'page-previous', 'title' => t('Go to previous page'))));
+ }
+ if ($book_link['plid'] && $parent = book_link_load($book_link['plid'])) {
+ drupal_add_link(array('rel' => 'up', 'href' => url($parent['href'])));
+ $links .= l(t('up'), $parent['href'], array('attributes' => array('class' => 'page-up', 'title' => t('Go to parent page'))));
+ }
+ if ($next = book_next($book_link)) {
+ drupal_add_link(array('rel' => 'next', 'href' => url($next['href'])));
+ $links .= l($next['title'] . t(' ›'), $next['href'], array('attributes' => array('class' => 'page-next', 'title' => t('Go to next page'))));
}
if (isset($tree) || isset($links)) {
@@ -516,141 +885,80 @@ function theme_book_navigation($node) {
}
/**
- * This is a helper function for book_toc().
+ * A recursive helper function for book_toc().
*/
-function book_toc_recurse($nid, $indent, $toc, $children, $exclude) {
- if (!empty($children[$nid])) {
- foreach ($children[$nid] as $foo => $node) {
- if (!$exclude || $exclude != $node->nid) {
- $toc[$node->nid] = $indent .' '. $node->title;
- $toc = book_toc_recurse($node->nid, $indent .'--', $toc, $children, $exclude);
+function _book_toc_recurse($tree, $indent, &$toc, $exclude) {
+ foreach ($tree as $data) {
+ if (!in_array($data['link']['mlid'], $exclude)) {
+ $toc[$data['link']['mlid']] = $indent .' '. truncate_utf8($data['link']['title'], 30, TRUE, TRUE);
+ if ($data['below'] && $data['link']['depth'] < MENU_MAX_DEPTH - 1) {
+ _book_toc_recurse($data['below'], $indent .'--', $toc, $exclude);
}
}
}
-
- return $toc;
}
/**
- * Returns an array of titles and nid entries of book pages in table of contents order.
+ * Returns an array of book pages in table of contents order.
+ *
+ * @param $book_id
+ * The ID of the book whose pages are to be listed.
+ * @param $exclude
+ * Optional array of mlid values. Any link whose mlid is in this array
+ * will be excluded (along with its children).
+ * @return
+ * An array of mlid, title pairs for use as options for selecting a book page.
*/
-function book_toc($exclude = 0) {
- $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE n.status = 1 ORDER BY b.weight, n.title'));
-
- $children = array();
- while ($node = db_fetch_object($result)) {
- if (empty($children[$node->parent])) {
- $children[$node->parent] = array();
- }
- $children[$node->parent][] = $node;
- }
+function book_toc($book_id, $exclude = array()) {
+ $tree = menu_tree_all_data(book_menu_name($book_id));
$toc = array();
- // If the user has permission to create new books, add the top-level book page to the menu;
- if (user_access('create new books')) {
- $toc[0] = '<'. t('top-level') .'>';
- }
-
- $toc = book_toc_recurse(0, '', $toc, $children, $exclude);
+ _book_toc_recurse($tree, '', $toc, $exclude);
return $toc;
}
/**
- * This is a helper function for book_tree()
- */
-function book_tree_recurse($nid, $depth, $children, $unfold = array()) {
- $output = '';
- if ($depth > 0) {
- if (isset($children[$nid])) {
- foreach ($children[$nid] as $foo => $node) {
- if (in_array($node->nid, $unfold)) {
- if ($tree = book_tree_recurse($node->nid, $depth - 1, $children, $unfold)) {
- $output .= '';
- $output .= l($node->title, 'node/'. $node->nid);
- $output .= '';
- $output .= '';
- }
- else {
- $output .= ''. l($node->title, 'node/'. $node->nid) .'';
- }
- }
- else {
- if ($tree = book_tree_recurse($node->nid, 1, $children)) {
- $output .= ''. l($node->title, 'node/'. $node->nid) .'';
- }
- else {
- $output .= ''. l($node->title, 'node/'. $node->nid) .'';
- }
- }
- }
- }
- }
-
- return $output;
-}
-
-/**
- * Returns an HTML nested list (wrapped in a menu-class div) representing the book nodes
- * as a tree.
- */
-function book_tree($parent = 0, $depth = 3, $unfold = array()) {
- $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE n.status = 1 ORDER BY b.weight, n.title'));
-
- while ($node = db_fetch_object($result)) {
- $list = isset($children[$node->parent]) ? $children[$node->parent] : array();
- $list[] = $node;
- $children[$node->parent] = $list;
- }
-
- if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
- return '';
- }
-}
-
-/**
* Menu callback; prints a listing of all books.
*/
function book_render() {
- $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE b.parent = 0 AND n.status = 1 ORDER BY b.weight, n.title'));
-
- $books = array();
- while ($node = db_fetch_object($result)) {
- $books[] = l($node->title, 'node/'. $node->nid);
+ $book_list = array();
+ foreach (book_get_books() as $book) {
+ $book_list[] = l($book['title'], $book['href'], $book['options']);
}
- return theme('item_list', $books);
+ return theme('item_list', $book_list);
}
/**
- * Menu callback; Generates various representation of a book page with
- * all descendants and prints the requested representation to output.
+ * Menu callback; Generates various representation of a book page and its children.
*
* The function delegates the generation of output to helper functions.
* The function name is derived by prepending 'book_export_' to the
* given output type. So, e.g., a type of 'html' results in a call to
* the function book_export_html().
*
- * @param type
- * - a string encoding the type of output requested.
- * The following types are currently supported in book module
- * html: HTML (printer friendly output)
- * Other types are supported in contributed modules.
- * @param nid
- * - an integer representing the node id (nid) of the node to export
+ * @param $type
+ * A string encoding the type of output requested. The following
+ * types are currently supported in book module:
+ *
+ * - html: HTML (printer friendly output)
*
+ * Other types may be supported in contributed modules.
+ * @param $nid
+ * An integer representing the node id (nid) of the node to export
+ * @return
+ * A string representing the node and its children in the book hierarchy
+ * in a format determined by the $type parameter.
*/
function book_export($type, $nid) {
+
$type = drupal_strtolower($type);
- $node_result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE n.nid = %d'), $nid);
- if (db_num_rows($node_result) > 0) {
- $node = db_fetch_object($node_result);
- }
- $depth = count(book_location($node)) + 1;
+
$export_function = 'book_export_'. $type;
if (function_exists($export_function)) {
- print call_user_func($export_function, $nid, $depth);
+ print call_user_func($export_function, $nid);
}
else {
drupal_set_message(t('Unknown export format.'));
@@ -669,26 +977,27 @@ function book_export($type, $nid) {
* sections, no matter their depth relative to the node selected to be
* exported as printer-friendly HTML.
*
- * @param nid
- * - an integer representing the node id (nid) of the node to export
- * @param depth
- * - an integer giving the depth in the book hierarchy of the node
- * which is to be exported
- *
+ * @param $nid
+ * An integer representing the node id (nid) of the node to export.
* @return
- * - string containing HTML representing the node and its children in
- * the book hierarchy
-*/
-function book_export_html($nid, $depth) {
- if (user_access('see printer-friendly version')) {
+ * A string containing HTML representing the node and its children in
+ * the book hierarchy.
+ */
+function book_export_html($nid) {
+ if (user_access('access printer-friendly version')) {
$content = '';
$node = node_load($nid);
- for ($i = 1; $i < $depth; $i++) {
- $content .= "\n";
- }
- $content .= book_recurse($nid, $depth, 'book_node_visitor_html_pre', 'book_node_visitor_html_post');
- for ($i = 1; $i < $depth; $i++) {
- $content .= "
\n";
+ if (isset($node->book)) {
+ $depth = $node->book['depth'];
+ for ($i = 1; $i < $depth; $i++) {
+ $content .= "\n";
+ }
+ $tree = book_menu_subtree_data($node->book);
+ $content .= book_export_traverse($tree, 'book_node_visitor_html_pre', 'book_node_visitor_html_post');
+
+ for ($i = 1; $i < $depth; $i++) {
+ $content .= "
\n";
+ }
}
return theme('book_export_html', check_plain($node->title), $content);
}
@@ -719,90 +1028,75 @@ function theme_book_export_html($title,
}
/**
- * Traverses the book tree. Applies the $visit_pre() callback to each
- * node, is called recursively for each child of the node (in weight,
- * title order). Finally appends the output of the $visit_post()
- * callback to the output before returning the generated output.
- *
- * @todo This is duplicitous with node_build_content().
- *
- * @param nid
- * - the node id (nid) of the root node of the book hierarchy.
- * @param depth
- * - the depth of the given node in the book hierarchy.
- * @param visit_pre
- * - a function callback to be called upon visiting a node in the tree
- * @param visit_post
- * - a function callback to be called after visiting a node in the tree,
- * but before recursively visiting children.
+ * Traverse the book tree to build printable or exportable output.
+ *
+ * During the traversal, the $visit_pre() callback is applied to each
+ * node, and is called recursively for each child of the node (in weight,
+ * title order). Finally, the output of the $visit_post() callback is
+ * appended before returning the generated output.
+ *
+ * @param $tree
+ * A subtree of the book menu hierarchy, rooted at the current page.
+ * @param $visit_pre
+ * A function callback to be called upon visiting a node in the tree.
+ * @param $visit_post
+ * A function callback to be called after visiting a node in the tree,
+ * but before recursively visiting children.
* @return
- * - the output generated in visiting each node
+ * The output generated in visiting each node.
*/
-function book_recurse($nid = 0, $depth = 1, $visit_pre, $visit_post) {
+function book_export_traverse($tree, $visit_pre, $visit_post) {
$output = '';
- $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE n.status = 1 AND n.nid = %d ORDER BY b.weight, n.title'), $nid);
- while ($page = db_fetch_object($result)) {
- // Load the node:
- $node = node_load($page->nid);
+
+ foreach ($tree as $data) {
+ // Note- access checking is already performed when building the tree.
+ $node = node_load($data['link']['nid'], FALSE);
if ($node) {
+ $depth = $node->book['depth'];
if (function_exists($visit_pre)) {
- $output .= call_user_func($visit_pre, $node, $depth, $nid);
+ $output .= call_user_func($visit_pre, $node, $depth);
}
else {
- $output .= book_node_visitor_html_pre($node, $depth, $nid);
+ // Use the default function.
+ $output .= book_node_visitor_html_pre($node, $depth);
}
- $children = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE n.status = 1 AND b.parent = %d ORDER BY b.weight, n.title'), $node->nid);
- while ($childpage = db_fetch_object($children)) {
- $childnode = node_load($childpage->nid);
- if ($childnode->nid != $node->nid) {
- $output .= book_recurse($childnode->nid, $depth + 1, $visit_pre, $visit_post);
- }
+ if ($data['below']) {
+ $output .= book_export_traverse($data['below'], $visit_pre, $visit_post);
}
+
if (function_exists($visit_post)) {
$output .= call_user_func($visit_post, $node, $depth);
}
else {
- # default
+ // Use the default function.
$output .= book_node_visitor_html_post($node, $depth);
}
}
}
-
return $output;
}
/**
- * Generates printer-friendly HTML for a node. This function
- * is a 'pre-node' visitor function for book_recurse().
+ * Generates printer-friendly HTML for a node.
+ *
+ * This function is a 'pre-node' visitor function.
+ *
+ * @see book_export_traverse().
*
* @param $node
- * - the node to generate output for.
+ * The node to generate output for.
* @param $depth
- * - the depth of the given node in the hierarchy. This
- * is used only for generating output.
- * @param $nid
- * - the node id (nid) of the given node. This
+ * The depth of the given node in the hierarchy. This
* is used only for generating output.
* @return
- * - the HTML generated for the given node.
+ * The HTML generated for the given node.
*/
-function book_node_visitor_html_pre($node, $depth, $nid) {
- // Remove the delimiter (if any) that separates the teaser from the body.
- $node->body = str_replace('', '', $node->body);
-
- // The 'view' hook can be implemented to overwrite the default function
- // to display nodes.
- if (node_hook($node, 'view')) {
- $node = node_invoke($node, 'view', FALSE, FALSE);
- }
- else {
- $node = node_prepare($node, FALSE);
- }
+function book_node_visitor_html_pre($node, $depth) {
- // Allow modules to make their own additions to the node.
- node_invoke_nodeapi($node, 'print');
+ $node->build_mode = NODE_BUILD_PRINT;
+ $node = node_build_content($node, FALSE, FALSE);
$output = "nid ."\" class=\"section-$depth\">\n";
$output .= "
". check_plain($node->title) ."
\n";
@@ -812,66 +1106,91 @@ function book_node_visitor_html_pre($nod
}
/**
- * Finishes up generation of printer-friendly HTML after visiting a
- * node. This function is a 'post-node' visitor function for
- * book_recurse().
+ * Finishes up generation of printer-friendly HTML after visiting a node.
+ *
+ * This function is a 'post-node' visitor function.
+ *
+ * @see book_export_traverse().
+ *
+ * @param $node
+ * The node to generate output for.
+ * @param $depth
+ * The depth of the given node in the hierarchy. This
+ * is used only for generating output.
+ * @return
+ * The HTML appended after the given node.
*/
function book_node_visitor_html_post($node, $depth) {
return "\n";
}
-function _book_admin_table($nodes = array()) {
+/**
+ * Build the table portion of the form for the book administration page.
+ *
+ * @see book_admin_edit()
+ */
+function _book_admin_table($node) {
$form = array(
'#theme' => 'book_admin_table',
'#tree' => TRUE,
);
- foreach ($nodes as $node) {
- $form = array_merge($form, _book_admin_table_tree($node, 0));
- }
-
+ $tree = book_menu_subtree_data($node->book);
+ _book_admin_table_tree($tree, $form);
return $form;
}
-function _book_admin_table_tree($node, $depth) {
- $form = array();
-
- $form[] = array(
- 'nid' => array('#type' => 'value', '#value' => $node->nid),
- 'depth' => array('#type' => 'value', '#value' => $depth),
- 'title' => array(
- '#type' => 'textfield',
- '#default_value' => $node->title,
- '#maxlength' => 255,
- ),
- 'weight' => array(
- '#type' => 'weight',
- '#default_value' => $node->weight,
- '#delta' => 15,
- ),
- );
-
- $children = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE b.parent = %d ORDER BY b.weight, n.title'), $node->nid);
- while ($child = db_fetch_object($children)) {
- $form = array_merge($form, _book_admin_table_tree(node_load($child->nid), $depth + 1));
+/**
+ * Recursive helper to build the main table in the book administration page form.
+ *
+ * @see book_admin_edit()
+ */
+function _book_admin_table_tree($tree, &$form) {
+ foreach ($tree as $data) {
+ $form[] = array(
+ 'nid' => array('#type' => 'value', '#value' => $data['link']['nid']),
+ 'depth' => array('#type' => 'value', '#value' => $data['link']['depth']),
+ 'href' => array('#type' => 'value', '#value' => $data['link']['href']),
+ 'title' => array(
+ '#type' => 'textfield',
+ '#default_value' => $data['link']['link_title'],
+ '#maxlength' => 255,
+ ),
+ 'weight' => array(
+ '#type' => 'weight',
+ '#default_value' => $data['link']['weight'],
+ '#delta' => 15,
+ ),
+ );
+ if ($data['below']) {
+ _book_admin_table_tree($data['below'], &$form);
+ }
}
return $form;
}
+/**
+ * Theme function for the book administration page form.
+ *
+ * @ingroup themeable
+ */
function theme_book_admin_table($form) {
+
$header = array(t('Title'), t('Weight'), array('data' => t('Operations'), 'colspan' => '3'));
$rows = array();
+ $destination = drupal_get_destination();
+ $access = user_access('administer nodes');
foreach (element_children($form) as $key) {
$nid = $form[$key]['nid']['#value'];
- $pid = $form[0]['nid']['#value'];
+ $href = $form[$key]['href']['#value'];
$rows[] = array(
''. drupal_render($form[$key]['title']) .'
',
drupal_render($form[$key]['weight']),
- l(t('view'), 'node/'. $nid),
- l(t('edit'), 'node/'. $nid .'/edit'),
- l(t('delete'), 'node/'. $nid .'/delete', array('query' => 'destination=admin/content/book'. (arg(3) == 'orphan' ? '/orphan' : '') . ($pid != $nid ? '/'. $pid : ''))),
+ l(t('view'), $href),
+ $access ? l(t('edit'), 'node/'. $nid .'/edit', array('query' => $destination)) : ' ',
+ $access ? l(t('delete'), 'node/'. $nid .'/delete', array('query' => $destination) ) : ' ',
);
}
@@ -879,112 +1198,138 @@ function theme_book_admin_table($form) {
}
/**
- * Display an administrative view of the hierarchy of a book.
+ * Build the form to administrate the hierarchy of a single book.
+ *
+ * @see book_admin_edit_submit()
+ *
+ * @ingroup forms.
*/
-function book_admin_edit($form_state, $nid) {
- $node = node_load($nid);
- if ($node->nid) {
+function book_admin_edit($form_state, $node) {
+
drupal_set_title(check_plain($node->title));
$form = array();
- $form['table'] = _book_admin_table(array($node));
+ $form['#node'] = $node;
+ $form['table'] = _book_admin_table($node);
$form['save'] = array(
'#type' => 'submit',
'#value' => t('Save book pages'),
);
-
- return $form;
- }
- else {
- drupal_not_found();
- }
+ return $form;
}
/**
- * Menu callback; displays a listing of all orphaned book pages.
+ * Handle submission of the book administrative page form.
+ *
+ * @see book_admin_edit()
*/
-function book_admin_orphan() {
- $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, n.status, b.parent FROM {node} n INNER JOIN {book} b ON n.vid = b.vid'));
-
- $pages = array();
- while ($page = db_fetch_object($result)) {
- $pages[$page->nid] = $page;
- }
-
- $orphans = array();
- if (count($pages)) {
- foreach ($pages as $page) {
- if ($page->parent && empty($pages[$page->parent])) {
- $orphans[] = node_load($page->nid);
- }
- }
- }
-
- if (count($orphans)) {
- $form['table'] = _book_admin_table($orphans);
- $form['save'] = array(
- '#type' => 'submit',
- '#value' => t('Save book pages'),
- );
-
- }
- else {
- $form['error'] = array('#value' => ''. t('There are no orphan pages.') .'
');
- }
- $form['#submit'][] = 'book_admin_edit_submit';
- $form['#validate'][] = 'book_admin_edit_validate';
- $form['#theme'] = 'book_admin_edit';
- return $form;
-}
-
function book_admin_edit_submit($form, &$form_state) {
foreach ($form_state['values']['table'] as $row) {
- $node = node_load($row['nid']);
+ $node = node_load($row['nid'], FALSE);
- if ($row['title'] != $node->title || $row['weight'] != $node->weight) {
+ if ($row['title'] != $node->title || $row['weight'] != $node->book['weight']) {
$node->title = $row['title'];
- $node->weight = $row['weight'];
+ $node->book['link_title'] = $row['title'];
+ $node->book['weight'] = $row['weight'];
+ $node->revision = 1;
node_save($node);
watchdog('content', 'book: updated %title.', array('%title' => $node->title), WATCHDOG_NOTICE, l(t('view'), 'node/'. $node->nid));
}
}
+ // Insure we have the current title - it may have been changed in the form.
+ $title = db_result(db_query("SELECT title FROM {node} WHERE nid = %d", $form['#node']->nid));
+ drupal_set_message(t('Updated book %title.', array('%title' => $title)));
+}
- if (is_numeric(arg(3))) {
- // Updating pages in a single book.
- $book = node_load(arg(3));
- drupal_set_message(t('Updated book %title.', array('%title' => $book->title)));
- }
- else {
- // Updating the orphan pages.
- drupal_set_message(t('Updated orphan book pages.'));
+/**
+ * Returns an administrative overview of all books.
+ */
+function book_admin_overview() {
+ $rows = array();
+ foreach (book_get_books() as $book) {
+ $rows[] = array(l($book['title'], $book['href'], $book['options']), l(t('edit order and titles'), "admin/content/book/". $book['nid']));
}
+ $headers = array(t('Book'), t('Operations'));
+
+ return theme('table', $headers, $rows);
}
/**
- * Menu callback; displays the book administration page.
+ * Determine if a given node type is in the list of types allowed for books.
*/
-function book_admin($nid = 0) {
- if ($nid) {
- return drupal_get_form('book_admin_edit', $nid);
- }
- else {
- return book_admin_overview();
- }
+function book_type_is_allowed($type) {
+ return in_array($type, variable_get('book_allowed_types', array('book')));
}
/**
- * Returns an administrative overview of all books.
+ * Builds and returns the book settings form.
+ *
+ * @see book_admin_settings_validate()
+ *
+ * @ingroup forms
*/
-function book_admin_overview() {
- $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE b.parent = 0 ORDER BY b.weight, n.title'));
- $rows = array();
- while ($book = db_fetch_object($result)) {
- $rows[] = array(l($book->title, "node/$book->nid"), l(t('outline'), "admin/content/book/$book->nid"));
+function book_admin_settings() {
+
+ $types = node_get_types('names');
+ $form['book_allowed_types'] = array(
+ '#type' => 'checkboxes',
+ '#title' => t('Allowed book outline types'),
+ '#default_value' => variable_get('book_allowed_types', array('book')),
+ '#options' => $types,
+ '#description' => t('Select content types which users with the %add-perm permission will be allowed to add to the book hierarchy. Users with the %outline-perm permission can add all content types.', array('%add-perm' => t('add content to books'), '%outline-perm' => t('administer book outlines'))),
+ '#required' => TRUE,
+ );
+ $form['book_child_type'] = array(
+ '#type' => 'radios',
+ '#title' => t('Default child page type'),
+ '#default_value' => variable_get('book_child_type', 'book'),
+ '#options' => $types,
+ '#description' => t('The content type for the %add-child link must be one of those selected as an allowed book outline type.', array('%add-child' => t('Add child page'))),
+ '#required' => TRUE,
+ );
+ $form['#validate'][] = 'book_admin_settings_validate';
+ return system_settings_form($form);
+}
+
+/**
+ * Validate the book settings form.
+ *
+ * @see book_admin_settings()
+ */
+function book_admin_settings_validate($form, &$form_state) {
+ $child_type = $form_state['values']['book_child_type'];
+ if (empty($form_state['values']['book_allowed_types'][$child_type])) {
+ form_set_error('book_child_type', t('The content type for the %add-child link must be one of those selected as an allowed book outline type.', array('%add-child' => t('Add child page'))));
}
- $headers = array(t('Book'), t('Operations'));
+}
- return theme('table', $headers, $rows);
+/**
+ * Implementation of hook_node_type().
+ *
+ * Update book module's persistent variables if the machine-readable name of a
+ * node type is changed.
+ */
+function book_node_type($op, $type) {
+
+ switch ($op){
+ case 'update':
+ if (!empty($type->old_type) && $type->old_type != $type->type) {
+ // Update the list of node types that are allowed to be added to books.
+ $allowed_types = variable_get('book_allowed_types', array('book'));
+ $key = array_search($type->old_type, $allowed_types);
+ if ($key !== FALSE) {
+ $allowed_types[$type->type] = $allowed_types[$key] ? $type->type : 0;
+ unset($allowed_types[$key]);
+ variable_set('book_allowed_types', $allowed_types);
+ }
+ // Update the setting for the "Add child page" link.
+ if (variable_get('book_child_type', 'book') == $type->old_type) {
+ variable_set('book_child_type', $type->type);
+ }
+ }
+ break;
+ }
}
/**
@@ -994,17 +1339,79 @@ function book_help($path, $arg) {
switch ($path) {
case 'admin/help#book':
$output = ''. t('The book module is suited for creating structured, multi-page hypertexts such as site resource guides, manuals, and Frequently Asked Questions (FAQs). It permits a document to have chapters, sections, subsections, etc. Authors with suitable permissions can add pages to a collaborative book, placing them into the existing document by adding them to a table of contents menu.') .'
';
- $output .= ''. t('Book pages have navigation elements at the bottom of the page for moving through the text. These link to the previous and next pages in the book, as well as a link labeled up, leading to the level above in the structure. More comprehensive navigation may be provided by enabling the book navigation block on the block administration page.', array('@admin-block' => url('admin/build/block'))) .'
';
+ $output .= ''. t('Pages in the book hierarchy have navigation elements at the bottom of the page for moving through the text. These link to the previous and next pages in the book, as well as a link labeled up, leading to the level above in the structure. More comprehensive navigation may be provided by enabling the book navigation block on the block administration page.', array('@admin-block' => url('admin/build/block'))) .'
';
$output .= ''. t('Users can select the printer-friendly version link visible at the bottom of a book page to generate a printer-friendly display of the page and all of its subsections. ') .'
';
- $output .= ''. t("Posts of type %book are automatically added to the book hierarchy. Users with the outline posts in books permission can also add content of any other type to a book, placing it into the existing book structure through the interface that's available by clicking on the outline tab while viewing that post.", array('%book' => node_get_types('name', 'book'))) .'
';
- $output .= ''. t('Administrators can view a list of all books on the book administration page. In this list there is a link to an outline page for each book, from which is it possible to change the titles of sections, or to change their weight, thus reordering sections. From this administrative interface, it is also possible to determine whether there are any orphan pages - pages that have become disconnected from the rest of the book structure.', array('@admin-node-book' => url('admin/content/book'))) .'
';
+ $output .= ''. t("Users with the administer book outlines permission can add content of any type to a book, placing it into the existing book structure through the edit form or through the interface that's available by clicking on the outline tab while viewing that post.", array('%book' => node_get_types('name', 'book'))) .'
';
+ $output .= ''. t('Administrators can view a list of all books on the book administration page. In this list there is a link to an outline page for each book, from which is it possible to change the titles of sections, or to change their weight, thus reordering sections.', array('@admin-node-book' => url('admin/content/book'))) .'
';
$output .= ''. t('For more information please read the configuration and customization handbook Book page.', array('@book' => 'http://drupal.org/handbook/modules/book/')) .'
';
return $output;
case 'admin/content/book':
return ''. t('The book module offers a means to organize content, authored by many users, in an online manual, outline or FAQ.') .'
';
- case 'admin/content/book/orphan':
- return ''. t('Pages in a book are like a tree. As pages are edited, reorganized and removed, child pages might be left with no link to the rest of the book. Such pages are referred to as "orphan pages". On this page, administrators can review their books for orphans and reattach those pages as desired.') .'
';
case 'node/%/outline':
- return ''. t('The outline feature allows you to include posts in the book hierarchy.', array('@book' => url('book'))) .'
';
+ return ''. t('The outline feature allows you to include posts in the book hierarchy, as well as move them within the hierarchy or to reorder an entire book.', array('@book' => url('book'), '@book-admin' => url('admin/content/book'))) .'
';
}
}
+
+/**
+ * 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().
+ */
+function book_link_load($mlid) {
+ if ($item = db_fetch_array(db_query("SELECT * FROM {menu_links} ml INNER JOIN {book} b ON b.mlid = ml.mlid LEFT JOIN {menu_router} m ON m.path = ml.router_path WHERE ml.mlid = %d", $mlid))) {
+ _menu_link_translate($item);
+ return $item;
+ }
+ return FALSE;
+}
+
+/**
+ * Get the data representing a subtree of the book hierarchy.
+ *
+ * The root of the subtree will be the link passed as a parameter, so the
+ * returned tree will contain this item and all its descendents in the menu tree.
+ *
+ * @param $item
+ * A fully loaded menu link.
+ * @return
+ * An subtree of menu links in an array, in the order they should be rendered.
+ */
+function book_menu_subtree_data($item) {
+ static $tree = array();
+
+ $cid = 'links:'. $item['menu_name'] .':subtree:'. $item['mlid'];
+
+ if (!isset($tree[$cid])) {
+ $cache = cache_get($cid, 'cache_menu');
+ if ($cache && isset($cache->data)) {
+ $data = $cache->data;
+ }
+ else {
+ $i = 1;
+ $match = array();
+ while ($i <= MENU_MAX_DEPTH && $item["p$i"]) {
+ $match[] = "p$i = %d";
+ $args[] = $item["p$i"];
+ $i++;
+ }
+ $sql = "
+ SELECT b.*, m.load_functions, m.to_arg_functions, m.access_callback, m.access_arguments, m.page_callback, m.page_arguments, m.title, m.title_callback, m.title_arguments, m.type, ml.*
+ FROM {menu_links} ml LEFT JOIN {menu_router} m ON m.path = ml.router_path
+ INNER JOIN {book} b ON ml.mlid = b.mlid
+ WHERE ml.hidden >= 0 AND ". implode(' AND ', $match) ."
+ ORDER BY p1 ASC, p2 ASC, p3 ASC, p4 ASC, p5 ASC";
+
+ $data['tree'] = menu_tree_data(db_query($sql, $args), array(), $item['depth']);
+ $data['node_links'] = array();
+ menu_tree_collect_node_links($data['tree'], $data['node_links']);
+ // Cache the data.
+ cache_set($cid, $data, 'cache_menu');
+ }
+ // Check access for the current user to each item in the tree.
+ menu_tree_check_access($data['tree'], $data['node_links']);
+ $tree[$cid] = $data['tree'];
+ }
+
+ return $tree[$cid];
+}
+
Index: modules/book/book.schema
===================================================================
RCS file: /cvs/drupal/drupal/modules/book/book.schema,v
retrieving revision 1.1
diff -u -p -r1.1 book.schema
--- modules/book/book.schema 25 May 2007 12:46:43 -0000 1.1
+++ modules/book/book.schema 28 Jul 2007 15:30:02 -0000
@@ -4,16 +4,15 @@
function book_schema() {
$schema['book'] = array(
'fields' => array(
- 'vid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
- 'nid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
- 'parent' => array('type' => 'int', 'not null' => TRUE, 'default' => 0),
- 'weight' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny')
+ 'mlid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
+ 'nid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
+ 'book_id' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
),
'indexes' => array(
- 'nid' => array('nid'),
- 'parent' => array('parent')
+ 'nid' => array('nid'),
+ 'book_id' => array('book_id')
),
- 'primary key' => array('vid'),
+ 'primary key' => array('mlid'),
);
return $schema;