array(
'name' => t('book page'),
'module' => 'book',
'description' => t("A book is a collaborative writing effort: users can collaborate writing the pages of the book, positioning the pages in the right order, and reviewing or modifying pages previously written. So when you have some information to share or when you read a page of the book and you didn't like it, or if you think a certain page could have been written better, you can do something about it.
Use this link to $link, otherwise your book page will be created independently of any existing book."),
),
'book_cover' => array(
'name' => t('book cover'),
'module' => 'book',
'description' => t("Add a new book."),
),
);
}
/**
* Implementation of hook_perm().
*/
function book_perm() {
return array('outline posts in books', 'create book pages', 'create new books', 'edit book pages', 'edit own book pages', 'see printer-friendly version');
}
/**
* Implementation of hook_access() for a book cover.
*/
function book_cover_access($op, $node) {
global $user;
if ($op == 'create') {
// Only registered users can create books. Given the nature
// of the book module this is considered to be a good/safe idea.
return user_access('create new books');
}
if ($op == 'update') {
// Only registered users can update book pages. Given the nature
// of the book module this is considered to be a good/safe idea.
// One can only update a book page if there are no suggested updates
// of that page waiting for approval. That is, only updates that
// don't overwrite the current or pending information are allowed.
if ($node->uid == $user->uid && user_access('edit own book pages')) {
return TRUE;
}
else {
// do nothing. node-access() will determine further access
}
}
}
/**
* Implementation of hook_access() for a book page.
*/
function book_access($op, $node) {
global $user;
if ($op == 'create') {
// Only registered users can create book pages. Given the nature
// of the book module this is considered to be a good/safe idea.
return user_access('create book pages');
}
if ($op == 'update') {
// Only registered users can update book pages. Given the nature
// of the book module this is considered to be a good/safe idea.
// One can only update a book page if there are no suggested updates
// of that page waiting for approval. That is, only updates that
// don't overwrite the current or pending information are allowed.
if (user_access('edit book pages') || ($node->uid == $user->uid && user_access('edit own book pages'))) {
return TRUE;
}
else {
// do nothing. node-access() will determine further access
}
}
}
/**
* Implementation of hook_link().
*/
function book_link($type, $node = NULL, $teaser = FALSE) {
$links = array();
if ($type == 'node' && $node->type == 'book_cover') {
if (user_access('create new books', $node)) {
$links['book_add_child'] = array(
'title' => t('add child page'),
'href' => "node/add/book/bid/$node->bid"
);
}
return $links;
}
if ($type == 'node' && isset($node->parent)) {
if (!$teaser) {
if (book_access('create', $node)) {
$links['book_add_child'] = array(
'title' => t('add child page'),
'href' => "node/add/book/parent/$node->nid"
);
}
if (user_access('see 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($may_cache) {
$items = array();
if ($may_cache) {
$items[] = array(
'path' => 'admin/content/book',
'title' => t('books'),
'description' => t('Manage site\'s books and orphaned book pages.'),
'callback' => 'book_admin',
'access' => user_access('administer nodes'));
$items[] = array(
'path' => 'admin/content/book/list',
'title' => t('list'),
'type' => MENU_DEFAULT_LOCAL_TASK);
$items[] = array(
'path' => 'admin/content/book/orphan',
'title' => t('orphan pages'),
'callback' => 'book_admin_orphan',
'type' => MENU_LOCAL_TASK,
'weight' => 8);
$items[] = array(
'path' => 'book',
'title' => t('book shelf'),
'callback' => 'book_shelf',
'type' => MENU_NORMAL_ITEM,
'access' => user_access('access content'));
$items[] = array(
'path' => 'book/export',
'callback' => 'book_export',
'access' => user_access('access content'),
'type' => MENU_CALLBACK);
}
else {
$items[] = array(
'path' => 'node/add/book/selectbook',
'title' => t('New page'),
'callback' => '_add_page_select_book',
'access' => user_access('create book pages'),
'type' => MENU_LOCAL_TASK,
'weight' => 2);
// To avoid SQL overhead, check whether we are on a node page and whether the
// user is allowed to outline posts in books.
if (arg(0) == 'node' && is_numeric(arg(1)) && user_access('outline posts in books')) {
// Only add the outline-tab for non-book pages:
$result = db_fetch_object(db_query(db_rewrite_sql('SELECT n.nid, n.type FROM {node} n WHERE n.nid = %d'), arg(1)));
if ($result->type == 'book') {
// If it's a book page, add the 'book' tab.
$items[] = array(
'path' => 'node/'.arg(1).'/movetobook',
'title' => t('book'),
'callback' => 'move_page_to_book',
'access' => user_access('outline posts in books'),
'type' => MENU_LOCAL_TASK,
'weight' => 8);
}
elseif ($result->type != 'book_cover') {
// add outline tab
$items[] = array(
'path' => 'node/'. arg(1) .'/outline',
'title' => t('outline'),
'callback' => 'book_outline',
'callback arguments' => array(arg(1)),
'access' => user_access('outline posts in books'),
'type' => MENU_LOCAL_TASK,
'weight' => 2);
}
}
}
return $items;
}
/**
* Menu call back: Select a book to move a page to.
* @param:
* outline: TRUE if it is a non-book page.
*/
function move_page_to_book($outline = FALSE) {
$result = db_query('SELECT b.bid, n.title FROM {book} b JOIN {node} n ON n.nid = b.nid ORDER BY b.weight, n.title');
$books = array();
$books[0] = t('Independant, top-level book page');
while ($book = db_fetch_object($result)) {
$books[$book->bid] = $book->title;
}
$nid = arg(1);
$bid = db_result(db_query('SELECT bid FROM {book_pages} WHERE nid = %d', $nid));
$form = array();
$form['bid'] = array(
'#type' => 'select',
'#title' => t('Select a book'),
'#default_value' => $bid,
'#options' => $books,
'#description' => t('Select the book you wish to move your page to.'),
);
/*
// It is better and simpler if we do not include this function.
$form['children'] = array(
'#type' => 'checkbox',
'#title' => t('Move all the page\'s children to the other book, too'),
'#default_value' => 1,
);
$form[] = array(
'#value' => t('Note: if you don\'t want to move the page\'s children, those will be attached to the current page\'s own parent.
'),
);
*/
$form['outline'] = array(
'#type' => 'value',
'#value' => FALSE,
);
$form['nid'] = array(
'#type' => 'value',
'#value' => $nid,
);
$form['children_note'] = array(
'#value' => t('Note: All of this pages\'s children will be moved together to the new book. If you do not wish that, please update the outline of the children pages first.
'),
);
$form['submit'] = array(
'#type' => 'submit',
'#value' => t('Submit'),
);
//override some of the above defaults if it is not a book_page node
if ($outline) {
$form['outline']['#value'] = TRUE;
$form['children_note'] = NULL;
}
$output = drupal_get_form('move_page_to_book', $form);
return $output;
}
/**
* Menu call back: Select a book to move a page to.
*/
function move_page_to_book_submit($form_id, $form) {
if($form['outline']) {
$node = node_load($form['nid']);
db_query('INSERT INTO {book_pages} (nid, vid, bid, parent, weight) VALUES (%d, %d, %d, %d, %d)', $node->nid, $node->vid, $form['bid'], $form['parent'], $form['weight']);
db_query("UPDATE {node_revisions} SET log = '%s' WHERE vid = %d", $form['log'], $node->vid);
drupal_set_message(t('The post has been added to the book. Now update where in the book you want to add the post.'));
drupal_goto('node/'. $form['nid'].'/outline');
}
$result = db_query('UPDATE {book_pages} SET bid = %d, parent = 0 WHERE nid = %d', $form['bid'], $form['nid']);
//if ($form['children']) {
book_update_children_bid($form['nid'], $form['bid']);
/*
}
else {
$parent = db_result(db_query('SELECT parent FROM {book_pages} WHERE nid / %d', $form['nid']));
$result = db_query('UPDATE {book_pages} SET parent = %d WHERE parent = %d', $parent, $form['nid']);
}
*/
drupal_set_message(t('The page and its children have been relocated.
You can now edit the page\'s location within the new book.'));
drupal_goto('node/'. $form['nid'].'/edit');
}
/**
* Helper function to recursively update $bid for each children
* when moving the parent to a new book.
*/
function book_update_children_bid($parent, $bid, $i=1) {
$sql = "SELECT DISTINCT(nid) FROM {book_pages} WHERE parent = %d";
$result[$i] = db_query($sql,$parent);
if (db_num_rows($result[$i]) > 0) {
while ($page = db_fetch_object($result[$i])) {
$sql = "UPDATE {book_pages} SET bid = %d WHERE nid = %d";
$result[$i+1] = db_query($sql, $bid, $page->nid);
book_update_children_bid($page->nid, $bid, $i+2);
}
}
}
/**
* 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) {
$block = array();
if ($op == 'list') {
$block['navigation']['info'] = t('Book navigation');
$block['license']['info'] = t('Book license');
return $block;
}
else if ($op == 'view') {
// Book license block
// Only display this block when the user is browsing a book page:
// (the block will not appear on the book cover. Maybe it should but it's not implemented yet.
// being able to call global $node and check on $node->bid would be much more convenient.)
if ($delta == 'license') {
if (arg(0) == 'node' && is_numeric(arg(1))) {
$result = db_query(db_rewrite_sql('SELECT b.book_license, n.title, nr.format FROM {book} b JOIN {book_pages} bp ON bp.bid = b.bid JOIN {node} n ON n.nid = b.nid JOIN {node_revisions} nr ON nr.vid = n.vid WHERE bp.nid = %d'), arg(1));
if (db_num_rows($result) > 0) {
$book = db_fetch_object($result);
$block['subject'] = check_plain($book->title). ' ' . t('license');
$block['content'] = check_markup($book->book_license, $book->format, FALSE);
}
}
return $block;
}
// Book navigation block
// Only display this block when the user is browsing a book:
if (arg(0) == 'node' && is_numeric(arg(1))) {
$result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book_pages} b ON n.vid = b.vid WHERE n.nid = %d'), arg(1));
if (db_num_rows($result) > 0) {
$node = db_fetch_object($result);
$path = book_location($node);
$path[] = $node;
$expand = array();
foreach ($path as $key => $node) {
$expand[] = $node->nid;
}
$block['subject'] = check_plain($path[0]->title);
$block['content'] = book_tree($expand[0], 5, $expand);
}
}
return $block;
}
}
/**
* Implementation of hook_load() for a book cover.
*/
function book_cover_load($node) {
return db_fetch_object(db_query('SELECT * FROM {book} WHERE nid = %d', $node->nid));
}
/**
* Implementation of hook_load().
*/
function book_load($node) {
return db_fetch_object(db_query('SELECT * FROM {book_pages} WHERE vid = %d', $node->vid));
}
/**
* Implementation of hook_insert() for book pages.
*/
function book_cover_insert($node) {
$bid = db_next_id('book_bid');
db_query('INSERT INTO {book} (bid, nid, book_author, book_license, weight) VALUES (%d, %d, "%s", "%s", %d)', $bid, $node->nid, $node->book_author, $node->book_license, $node->weight);
}
/**
* Implementation of hook_insert() for book pages.
*/
function book_insert($node) {
db_query("INSERT INTO {book_pages} (nid, bid, vid, parent, weight) VALUES (%d, %d, %d, %d, %d)", $node->nid, $node->bid, $node->vid, $node->parent, $node->weight);
}
/**
* Implementation of hook_update() for book covers.
*/
function book_cover_update($node) {
db_query('UPDATE {book} SET book_author = "%s", weight = %d, book_license = "%s" WHERE bid = %d', $node->book_author, $node->weight, $node->book_license, $node->bid);
}
/**
* Implementation of hook_update().
*/
function book_update($node) {
if ($node->revision) {
db_query("INSERT INTO {book_pages} (nid, vid, parent, weight) VALUES (%d, %d, %d, %d)", $node->nid, $node->vid, $node->parent, $node->weight);
}
else {
db_query("UPDATE {book_pages} SET parent = %d, weight = %d WHERE vid = %d", $node->parent, $node->weight, $node->vid);
}
}
/**
* Implementation of hook_delete() for book covers.
*/
function book_cover_delete(&$node) {
db_query('UPDATE {book_pages} SET bid = 0 WHERE bid = %d', $node->bid);
db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
}
/**
* Implementation of hook_delete().
*/
function book_delete(&$node) {
db_query('DELETE FROM {book_pages} WHERE nid = %d', $node->nid);
}
/**
* Implementation of hook_submit() for book covers.
*/
function book_cover_submit(&$node) {
global $form;
}
/**
* Implementation of hook_submit() for book pages.
*/
function book_submit(&$node) {
global $user;
// Set default values for non-administrators.
if (!user_access('administer nodes')) {
$node->weight = 0;
$node->revision = 1;
$book->uid = $user->uid;
$book->name = $user->uid ? $user->name : '';
}
}
/**
* Implementation of hook_form() for a book.
*/
function book_cover_form(&$node) {
$form['title'] = array('#type' => 'textfield',
'#title' => t('Title'),
'#required' => TRUE,
'#default_value' => $node->title,
'#weight' => -5,
'#description' => t('Title of the whole book.'),
);
$form['body_filter']['body'] = array('#type' => 'textarea',
'#title' => t('Body'),
'#default_value' => $node->body,
'#rows' => 20,
'#required' => TRUE,
'#description' => t('The content of book cover.'),
);
$form['body_filter']['format'] = filter_form($node->format);
$form['book_author'] = array('#type' => 'textfield',
'#title' => t('Author'),
'#required' => FALSE,
'#default_value' => $node->book_author,
'#description' => t('The author of all the book pages that will be added to this book. The author can be a single person, or a collective. Leave blank if you do not wish to display the authoring information on the book cover.'),
);
$form['book_license'] = array('#type' => 'textarea',
'#title' => t('License'),
'#default_value' => $node->book_license,
'#rows' => 8,
'#required' => FALSE,
'#description' => t('The license of all the book pages within this book. This information can be displayed within a block on each relevant book page. Leave blank if you do not wish to display any license information. The input format is the same as the one selected for the body.'),
);
return $form;
}
/**
* Implementation of hook_form() for a book page.
*/
function book_form(&$node) {
// looking for url like node/add/book/bid/$bid
if (arg(3) == 'bid') {
if (is_numeric(arg(4))) {
$node->bid = arg(4);
$node->parent = 0;
}
}
// url like node/add/book/parent/$nid
elseif (arg(3) == 'parent') {
$node->parent = arg(4);
$sql = "SELECT bid FROM {book_pages} where nid = %d";
$result = db_query($sql, $node->parent);
$node->bid = db_result($result);
}
elseif (arg(2) == 'book') {
drupal_goto('node/add/book/selectbook');
}
// check that the book exists.
if (!$result = db_result(db_query('SELECT n.title, n.nid FROM {book} AS b JOIN {node} AS n ON n.nid = b.nid WHERE b.bid = %d', $node->bid))) {
$node->bid = 0;
$form_parent_title = t('Parent');
}
else {
$form_parent_title = t('Position in the book ') .''. $result . '';
}
$form['bid'] = array ('#type' => 'hidden',
'#value' => $node->bid,
);
$type = node_get_types('type', $node);
if ($node->nid && !$node->parent && !user_access('create new books')) {
$form['parent'] = array('#type' => 'value', '#value' => $node->parent);
}
else {
$form['parent'] = array('#type' => 'select',
'#title' => $form_parent_title,
'#default_value' => ($node->parent ? $node->parent : arg(4)),
'#options' => book_toc($node->nid, $node->bid),
'#weight' => -4,
'#description' => t('The parent that this page belongs in. "Top level" means the highest level within this book.'),
);
}
if (!isset($node->parent)) {
$node->parent = 0;
}
$form['title'] = array('#type' => 'textfield',
'#title' => check_plain($type->title_label),
'#required' => TRUE,
'#default_value' => $node->title,
'#weight' => -5,
);
$form['body_filter']['body'] = array('#type' => 'textarea',
'#title' => check_plain($type->body_label),
'#default_value' => $node->body,
'#rows' => 20,
'#required' => TRUE,
);
$form['body_filter']['format'] = filter_form($node->format);
$form['log'] = array(
'#type' => 'textarea',
'#title' => t('Log message'),
'#default_value' => $node->log,
'#weight' => 5,
'#description' => t('An explanation of the additions or updates being made to help other authors understand your motivations.'),
);
if (user_access('administer nodes')) {
$form['weight'] = array('#type' => 'weight',
'#title' => t('Weight'),
'#default_value' => $node->weight,
'#delta' => 15,
'#weight' => 5,
'#description' => t('Pages at a given level are ordered first by weight and then by title.'),
);
}
else {
// If a regular user updates a book page, we create a new revision
// authored by that user:
$form['revision'] = array('#type' => 'hidden', '#value' => 1);
}
return $form;
}
/**
* Implementation of function book_outline()
* Handles all book outline operations.
*/
function book_outline($nid) {
$node = node_load($nid);
$page = book_load($node);
if (!$page) {
return move_page_to_book(TRUE);
}
$form['parent'] = array('#type' => 'select',
'#title' => t('Parent'),
'#default_value' => $page->parent,
'#options' => book_toc($node->nid, $page->bid),
'#description' => t('The parent page in the book.'),
);
$form['weight'] = array('#type' => 'weight',
'#title' => t('Weight'),
'#default_value' => $page->weight,
'#delta' => 15,
'#description' => t('Pages at a given level are ordered first by weight and then by title.'),
);
$form['log'] = array('#type' => 'textarea',
'#title' => t('Log message'),
'#default_value' => $node->log,
'#description' => t('An explanation to help other authors understand your motivations to put this post into the book.'),
);
$form['nid'] = array('#type' => 'value', '#value' => $nid);
if ($page->nid) {
$form['change-book'] = array('#value' => t('If you wish to move this node to another book, you must first remove the node from the book outline, then add it back to the book you wish.
'));
$form['update'] = array('#type' => 'submit',
'#value' => t('Update book outline'),
);
$form['remove'] = array('#type' => 'submit',
'#value' => t('Remove from book outline'),
);
}
else {
$form['add'] = array('#type' => 'submit', '#value' => t('Add to book outline'));
}
drupal_set_title(check_plain($node->title));
return drupal_get_form('book_outline', $form);
}
/**
* Handles book outline form submissions.
*/
function book_outline_submit($form_id, $form_values) {
$op = $_POST['op'];
$node = node_load($form_values['nid']);
switch ($op) {
case t('Add to book outline'):
db_query('INSERT INTO {book_pages} (nid, vid, parent, weight) VALUES (%d, %d, %d, %d)', $node->nid, $node->vid, $form_values['parent'], $form_values['weight']);
db_query("UPDATE {node_revisions} SET log = '%s' WHERE vid = %d", $form_values['log'], $node->vid);
drupal_set_message(t('The post has been added to the book.'));
break;
case t('Update book outline'):
db_query('UPDATE {book_pages} SET parent = %d, weight = %d WHERE vid = %d', $form_values['parent'], $form_values['weight'], $node->vid);
db_query("UPDATE {node_revisions} SET log = '%s' WHERE vid = %d", $form_values['log'], $node->vid);
drupal_set_message(t('The book outline has been updated.'));
break;
case t('Remove from book outline'):
db_query('DELETE FROM {book_pages} WHERE nid = %d', $node->nid);
drupal_set_message(t('The post has been removed from the book.'));
break;
}
return "node/$node->nid";
}
/**
* Given a node, this function returns an array of 'book node' objects
* representing the path in the book tree from the root to the
* parent of the given node.
*
* @param node - a book node object for which to compute the path
*
* @return - an array of book node objects representing the path of
* nodes root to parent of the given node. Returns an empty array if
* the node does not exist or is not part of a book hierarchy.
*
*/
function book_location($node, $nodes = array()) {
$parent = db_fetch_object(db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent, b.weight FROM {node} n INNER JOIN {book_pages} b ON n.vid = b.vid WHERE n.nid = %d'), $node->parent));
if (isset($parent->title)) {
$nodes = book_location($parent, $nodes);
$nodes[] = $parent;
}
return $nodes;
}
/**
* Accumulates the nodes up to the root of the book from the given node in the $nodes array.
*/
function book_location_down($node, $nodes = array()) {
$last_direct_child = db_fetch_object(db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent, b.weight FROM {node} n INNER JOIN {book_pages} b ON n.vid = b.vid WHERE n.status = 1 AND b.parent = %d ORDER BY b.weight DESC, n.title DESC'), $node->nid));
if ($last_direct_child) {
$nodes[] = $last_direct_child;
$nodes = book_location_down($last_direct_child, $nodes);
}
return $nodes;
}
/**
* Fetches the node object of the previous page of the book.
*/
function book_prev($node) {
// If the parent is zero, we are at the start of a book so there is no previous.
if ($node->parent == 0) {
return NULL;
}
// Previous on the same level:
$direct_above = db_fetch_object(db_query(db_rewrite_sql("SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book_pages} b ON n.vid = b.vid WHERE b.parent = %d AND n.status = 1 AND n.moderate = 0 AND (b.weight < %d OR (b.weight = %d AND n.title < '%s')) ORDER BY b.weight DESC, n.title DESC"), $node->parent, $node->weight, $node->weight, $node->title));
if ($direct_above) {
// Get last leaf of $above.
$path = book_location_down($direct_above);
return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
}
else {
// Direct parent:
$prev = db_fetch_object(db_query(db_rewrite_sql('SELECT n.nid, n.title FROM {node} n INNER JOIN {book_pages} b ON n.vid = b.vid WHERE n.nid = %d AND n.status = 1 AND n.moderate = 0'), $node->parent));
return $prev;
}
}
/**
* Fetches the node object of the next page of the book.
*/
function book_next($node) {
// get first direct child
$child = db_fetch_object(db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book_pages} b ON n.vid = b.vid WHERE b.parent = %d AND n.status = 1 AND n.moderate = 0 ORDER BY b.weight ASC, n.title ASC'), $node->nid));
if ($child) {
return $child;
}
// No direct child: get next for this level or any parent in this book.
$path = book_location($node); // Path to top-level node including this one.
$path[] = $node;
while (($leaf = array_pop($path)) && count($path)) {
$next = db_fetch_object(db_query(db_rewrite_sql("SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book_pages} b ON n.vid = b.vid WHERE b.parent = %d AND n.status = 1 AND n.moderate = 0 AND (b.weight > %d OR (b.weight = %d AND n.title > '%s')) ORDER BY b.weight ASC, n.title ASC"), $leaf->parent, $leaf->weight, $leaf->weight, $leaf->title));
if ($next) {
return $next;
}
}
}
/**
* Returns the content of a given node. If $teaser if TRUE, returns
* the teaser rather than full content. Displays the most recently
* approved revision of a node (if any) unless we have to display this
* page in the context of the moderation queue.
*/
function book_content($node, $teaser = FALSE) {
// Return the page body.
return node_prepare($node, $teaser);
}
/**
* Implementation of hook_view().
*
*/
function book_cover_view(&$node, $teaser = FALSE, $page = FALSE) {
$node = node_prepare($node, $teaser);
if (!empty($node->book_author)) {
$node->content['book_author'] = array(
'#value' => ''. t('A book by ') . $node->book_author .'
',
'#weight' => -1,
);
$node->teaser = ''. $node->book_author .'
'. $node->teaser;
}
//$book_author = theme('book_cover_book_author', $node);
//$book_license = theme('book_cover_book_license', $node);
if (!empty($node->book_license)) {
$node->book_license = check_markup($node->book_license, $node->format, FALSE);
$node->content['book_license'] = array(
'#value' => ''. t('License') .'
'. $node->book_license .'
',
'#weight' => 100,
);
}
$node->content['book_toc'] = array(
'#value' => _book_cover_toc($node->bid),
'#weight' => 200,
);
return $node;
}
/**
* Implementation of hook_view().
*/
function ibook_view(&$node, $teaser = FALSE, $page = FALSE) {
$node->content['body'] = array(
'#value' => 'test'. $node->body,
'#weight' => 1,
);
// code below needs to be updated.
if ($node->type == 'book_cover') {
if (!empty($node->book_author)) {
$node->body = ''.t('A book by ') . $node->book_author.'
' . $node->body;
$node->teaser = ''.$node->book_author.'
' . $node->teaser;
}
//$book_author = theme('book_cover_book_author', $node);
//$book_license = theme('book_cover_book_license', $node);
if (!empty($node->book_license)) {
$node->body .= '' . t('License') . '
';
$node->book_license = check_markup($node->book_license, $node->format, FALSE);
$node->body .= ''.$node->book_license.'
';
}
$node->body .= _book_cover_toc($node->bid);
$node->content = array();
}
return $node;
}
/**
* Creates the Table of contents printed on book cover $bid.
* Returns formatted html.
*/
function _book_cover_toc($bid) {
$toc = '
' . t('Table of contents') . '
';
$result = db_query('SELECT n.nid, n.title, bp.parent, bp.weight FROM {node} n INNER JOIN {book_pages} bp ON n.vid = bp.vid WHERE n.status = 1 AND bp.bid = %d ORDER BY bp.weight, n.title', $bid);
while ($node = db_fetch_object($result)) {
if (!$children[$node->parent]) {
$children[$node->parent] = array();
}
$children[$node->parent][] = $node;
}
$toc .= _book_cover_toc_recurse(0, $children);
$toc .= '
';
return $toc;
}
/**
* This is a helper function for _book_cover_toc().
*/
function _book_cover_toc_recurse($nid, $children) {
if ($children[$nid]) {
$toc = '';
foreach ($children[$nid] as $foo => $node) {
$toc .= '- '. l($node->title , 'node/'.$node->nid). '
';
$toc .= _book_cover_toc_recurse($node->nid, $children);
}
$toc .= '
';
}
return $toc;
}
/**
* Implementation of hook_nodeapi().
*
* Appends book navigation to all nodes in the book.
*/
function book_nodeapi(&$node, $op, $teaser, $page) {
switch ($op) {
case 'view':
if (!$teaser) {
if ($node->type == 'book_cover') {
$node->breadcrumb = array(); // Overwrite the trail with a book trail.
$node->breadcrumb[] = array ('path' => 'book', 'title' => t('books'));
$node->breadcrumb[] = array ('path' => 'node/'. $node->nid, 'title' => $node->title);
menu_set_location($node->breadcrumb);
}
else {
// check if it is a node added in the outline:
$book = db_fetch_array(db_query('SELECT * FROM {book_pages} WHERE vid = %d', $node->vid));
if ($book) {
foreach ($book as $key => $value) {
$node->$key = $value;
}
$path = book_location($node);
// Construct the breadcrumb:
$node->breadcrumb = array(); // Overwrite the trail with a book trail.
$node->breadcrumb[] = array ('path' => 'book', 'title' => t('books'));
if (!empty($node->bid)) {
$cover = db_fetch_object(db_query('SELECT n.title, n.nid FROM {book} AS b JOIN {node} AS n ON n.nid = b.nid WHERE b.bid = %d', $node->bid));
$node->breadcrumb[] = array ('path' => 'node/'. $cover->nid, 'title' => $cover->title);
}
foreach ($path as $level) {
$node->breadcrumb[] = array('path' => 'node/'. $level->nid, 'title' => $level->title);
}
$node->breadcrumb[] = array('path' => 'node/'. $node->nid);
$node->content['book_navigation'] = array(
'#value' => theme('book_navigation', $node),
'#weight' => 100,
);
if ($page) {
menu_set_location($node->breadcrumb);
}
}
}
}
break;
case 'delete revision':
db_query('DELETE FROM {book_pages} WHERE vid = %d', $node->vid);
break;
case 'delete':
db_query('DELETE FROM {book_pages} WHERE nid = %d', $node->nid);
break;
}
}
/**
* Prepares the links to children (TOC) and forward/backward
* navigation for a node presented as a book page.
*
* @ingroup themeable
*/
function theme_book_navigation($node) {
$output = '';
$links = '';
if ($node->nid) {
$tree = book_tree($node->nid);
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')));
}
else {
$cover_nid = db_result(db_query('SELECT nid FROM {book} WHERE bid = %d', $node->bid));
$links .= l(t('up'), 'node/'. $cover_nid, array('class' => 'page-up', 'title' => t('Go to book cover')));
}
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 (isset($tree) || isset($links)) {
$output = '';
if (isset($tree)) {
$output .= $tree;
}
if (isset($links)) {
$output .= '
'. $links .'
';
}
$output .= '
' . t('books') . '
';
$books = array();
while ($node = db_fetch_object($result)) {
$books[] = l($node->title, 'node/'. $node->nid);
}
$output .= theme('item_list', $books);
// Add to those the top-level book pages without a book_cover.
// Do we need to make two lists separated with a heading
?
$result = db_query('SELECT b.nid , n.title FROM {book_pages} b JOIN {node} n ON n.nid = b.nid WHERE parent = 0 AND bid = 0 ORDER BY weight, title');
$books = array();
while ($node = db_fetch_object($result)) {
$books[] = l($node->title, 'node/'. $node->nid);
}
if (count($books)) {
$output .= '' . t('Independent top level book pages') . '
';
$output .= theme('item_list', $books);
}
return $output;
}
/**
* Menu callback; Generates various representation of a book page with
* all descendants and prints the requested representation to output.
*
* 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
*
*/
function book_export($type = 'html', $nid = 0) {
$type = drupal_strtolower($type);
$node_result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book_pages} 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);
}
else {
drupal_set_message(t('Unknown export format.'));
drupal_not_found();
}
}
/**
* This function is called by book_export() to generate HTML for export.
*
* The given node is /embedded to its absolute depth in a top level
* section/. For example, a child node with depth 2 in the hierarchy
* is contained in (otherwise empty) <div> elements
* corresponding to depth 0 and depth 1. This is intended to support
* WYSIWYG output - e.g., level 3 sections always look like level 3
* 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
*
* @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')) {
$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";
}
return theme('book_export_html', check_plain($node->title), $content);
}
else {
drupal_access_denied();
}
}
/**
* How the book's HTML export should be themed
*
* @ingroup themeable
*/
function theme_book_export_html($title, $content) {
global $base_url;
$html = "\n";
$html .= '';
$html .= "\n". $title ."\n";
$html .= '';
$html .= '' . "\n";
$html .= "\n";
$html .= "\n\n". $content . "\n\n\n";
return $html;
}
/**
* 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.
*
* @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.
* @return
* - the output generated in visiting each node
*/
function book_recurse($nid = 0, $depth = 1, $visit_pre, $visit_post) {
$result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book_pages} b ON n.vid = b.vid WHERE n.status = 1 AND n.nid = %d AND n.moderate = 0 ORDER BY b.weight, n.title'), $nid);
while ($page = db_fetch_object($result)) {
// Load the node:
$node = node_load($page->nid);
if ($node) {
if (function_exists($visit_pre)) {
$output .= call_user_func($visit_pre, $node, $depth, $nid);
}
else {
$output .= book_node_visitor_html_pre($node, $depth, $nid);
}
$children = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book_pages} b ON n.vid = b.vid WHERE n.status = 1 AND b.parent = %d AND n.moderate = 0 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 (function_exists($visit_post)) {
$output .= call_user_func($visit_post, $node, $depth);
}
else {
# default
$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().
*
* @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.
* @param $nid
* - the node id (nid) of the given node. This
* is used only for generating output.
* @return
* - the HTML generated for the given node.
*/
function book_node_visitor_html_pre($node, $depth, $nid) {
// Output the content:
if (node_hook($node, 'content')) {
$node = node_invoke($node, 'content');
}
// Allow modules to change $node->body before viewing.
node_invoke_nodeapi($node, 'print', $node->body, FALSE);
$output .= "nid ."\" class=\"section-$depth\">\n";
$output .= "
". check_plain($node->title) ."
\n";
if ($node->body) {
$output .= drupal_render($node->content);
}
return $output;
}
/**
* Finishes up generation of printer-friendly HTML after visiting a
* node. This function is a 'post-node' visitor function for
* book_recurse().
*/
function book_node_visitor_html_post($node, $depth) {
return "\n";
}
function _book_admin_table($nodes = array()) {
$form = array(
'#theme' => 'book_admin_table',
'#tree' => TRUE,
);
foreach ($nodes as $node) {
if ($node->type == 'book_cover') {
$result = db_query('SELECT nid FROM {book_pages} WHERE parent = 0 AND bid = %d', $node->bid);
while ($chapters = db_fetch_object($result)) {
$chapter = node_load($chapters->nid);
$form = array_merge($form, _book_admin_table_tree($chapter, 0));
}
}
else {
$form = array_merge($form, _book_admin_table_tree($node, 0));
}
}
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, b.weight FROM {node} n INNER JOIN {book_pages} 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));
}
return $form;
}
function theme_book_admin_table($form) {
$header = array(t('Title'), t('Weight'), array('data' => t('Operations'), 'colspan' => '3'));
$rows = array();
foreach (element_children($form) as $key) {
$nid = $form[$key]['nid']['#value'];
$pid = $form[0]['nid']['#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', NULL, 'destination=admin/content/book'. (arg(3) == 'orphan' ? '/orphan' : '') . ($pid != $nid ? '/'.$pid : ''))
);
}
return theme('table', $header, $rows);
}
/**
* Display an administrative view of the hierarchy of a book.
*/
function book_admin_edit($nid) {
$node = node_load($nid);
if ($node->nid) {
drupal_set_title(check_plain($node->title));
$form = array();
$form['table'] = _book_admin_table(array($node));
$form['save'] = array(
'#type' => 'submit',
'#value' => t('Save book pages'),
);
return drupal_get_form('book_admin_edit', $form);
}
else {
drupal_not_found();
}
}
/**
* Menu callback; displays a listing of all orphaned book pages.
*/
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_pages} 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 = array();
$form['table'] = _book_admin_table($orphans);
$form['save'] = array(
'#type' => 'submit',
'#value' => t('Save book pages'),
);
return drupal_get_form('book_admin_edit', $form);
}
else {
return ''. t('There are no orphan pages.') .'
';
}
}
function book_admin_edit_submit($form_id, $form_values) {
foreach ($form_values['table'] as $row) {
$node = node_load($row['nid']);
if ($row['title'] != $node->title || $row['weight'] != $node->weight) {
$node->title = $row['title'];
$node->weight = $row['weight'];
node_save($node);
watchdog('content', t('%type: updated %title.', array('%type' => theme('placeholder', t('book')), '%title' => theme('placeholder', $node->title))), WATCHDOG_NOTICE, l(t('view'), 'node/'. $node->nid));
}
}
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' => theme('placeholder', $book->title))));
}
else {
// Updating the orphan pages.
drupal_set_message(t('Updated orphan book pages.'));
}
}
/**
* Menu callback; displays the book administration page.
*/
function book_admin($nid = 0) {
if ($nid) {
return book_admin_edit($nid);
}
else {
return book_admin_overview();
}
}
/**
* Returns an administrative overview of all books.
*/
function book_admin_overview() {
$output = '';
// List all book covers
$rows = array();
$result = db_query(db_rewrite_sql('SELECT b.bid, b.nid , n.title FROM {book} b JOIN {node} n ON n.nid = b.nid ORDER BY weight, title'));
while ($book = db_fetch_object($result)) {
$rows[] = array(l($book->title, "node/$book->nid"), l(t('outline'), "admin/content/book/$book->nid"));
}
if (count($rows)) {
$headers = array(t('Book'), t('Operations'));
$output .= theme('table', $headers, $rows);
$output .= '
';
}
// List all independent top-level book pages.
$rows = array();
$result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book_pages} b ON n.vid = b.vid WHERE b.parent = 0 AND b.bid = 0 ORDER BY b.weight, n.title'));
while ($book = db_fetch_object($result)) {
$rows[] = array(l($book->title, "node/$book->nid"), l(t('outline'), "admin/content/book/$book->nid"));
}
if (count($rows)) {
$headers = array(t('Independent book pages'), t('Operations'));
$output .= theme('table', $headers, $rows);
}
return $output;
}
/**
* Implementation of hook_help().
*/
function book_help($section) {
switch ($section) {
case 'admin/help#book':
$output = ''. t('The book content type 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('Books have additional previous, up, and next navigation elements at the bottom of each page for moving through the text. Additional 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('Administrators can view a book outline, from which is it possible to change the titles of sections, and their weight (thus reordering sections). From this outline, it is also possible to edit and/or delete book pages. Many content types besides pages (for example, blog entries, stories, and polls) can be added to a collaborative book by choosing the outline tab when viewing the post.') .'
';
$output .= t('You can
', array('%node-add-book' => url('node/add/book'), '%admin-node-book' => url('admin/content/book'), '%admin-settings-content-types-book-page' => url('admin/content/types/book'), '%admin-block' => url('admin/build/block'), '%admin-access' => url('admin/user/access')));
$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/settings/modules#description':
return t('Allows users to collaboratively author a book.');
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.
');
}
if (arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == 'outline') {
return t('The outline feature allows you to include posts in the book hierarchy.', array('%book' => url('book')));
}
}
/**
* Prints a list of books in which the user can add pages.
*/
function _add_page_select_book() {
$books = array();
$result = db_query('SELECT b.bid, b.nid , n.title FROM {book} b JOIN {node} n ON n.nid = b.nid ORDER BY weight, title');
while($book = db_fetch_object($result)) {
$books[] = l($book->title, 'node/add/book/bid/'.$book->bid);
}
if (count($books)) {
$link = l(t('click here to create a book page that does not belong to any particular book'), 'node/add/book/bid/0');
$output = '' . t('Either '). $link . t(' or select below the book you wish to add the page to.
');
$output .= theme('item_list', $books);
}
else {
drupal_goto('node/add/book/bid/0');
}
return $output;
}
/**
* Implementation of hook_form_alter()
*/
function book_form_alter($form_id, &$form) {
switch($form_id) {
case 'node_delete_confirm':
$node_type = db_result(db_query('SELECT type FROM {node} WHERE nid = %d ', $form['nid']['#value']));
if ($node_type == 'book_cover') {
$form['book_cover'] = array(
'#value' => t('Note that all book pages belonging to this book (if any) will no longer be associated to any book. You may want to move remaining book pages within this book to another book, first. '),
);
}
}
}