Newer
Older
// $Id$
$info["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.");
/*
** Everyone can access all published book pages whether these pages
** are still waiting for approval or not. We might not always want
** to display pages that are waiting for approval, but we take care
** of that problem in the book_view() function.
*/
return $node->status;
/*
** Only registered users can create book pages. Given the nature
** of the book module this is considered to be a good/safe idea.
*/
** Only registered users can update book pages. Given the nature
** of the book module this is considered to be a good/safe idea.
** of that page waiting for approval, when it is not a PHP-page and
** as long as the "create new revision"-bit is set. That is, only
** updates that don't overwrite the current or pending information
** are allowed.
return user_access("maintain books") && !$node->moderate && !$node->format && $node->revision;
$links[] = l(t("books"), "book", array("title" => t("Read and contribute to the collaborative books.")));
if ($type == "node" && $node->type == "book") {
if (book_access("update", $node)) {
$links[] = l(t("edit this page"), "node/edit/$node->nid", array("title" => t("Suggest an update for this book page.")));
}
if (!$main) {
$links[] = l(t("printer-friendly version"), "book/print/$node->nid", array("title" => t("Show a printer-friendly version of this book page and its sub-pages.")));
}
Dries Buytaert
committed
menu("admin/node/book/orphan", t("orphan pages"), "book_admin_orphan", 8);
menu("admin/node/book/help", t("help"), "book_help", 9);
$result = db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = 0 ORDER BY b.weight, n.title");
while ($book = db_fetch_object($result)) {
menu("admin/node/book/$book->nid", t("'%title' book", array("%title" => $book->title)), "book_admin");
$book = db_fetch_object(db_query("SELECT format, parent, weight, log FROM {book} WHERE nid = %d", $node->nid));
** fields to reflect the changes. We use the request URI to
if ($user->uid) {
$book->uid = $user->uid;
$book->name = $user->name;
}
else {
$book->uid = 0;
$book->name = "";
}
/*
** We set the revision field to indicate that we have to create
** a new revision when updating this book page. We enable this
db_query("INSERT INTO {book} (nid, format, parent, weight, log) VALUES (%d, %d, %d, %d, '%s')", $node->nid, $node->format, $node->parent, $node->weight, $node->log);
db_query("UPDATE {book} SET format = %d, parent = %d, weight = %d, log = '%s' WHERE nid = %d", $node->format, $node->parent, $node->weight, $node->log, $node->nid);
Kjartan Mannes
committed
function book_delete(&$node) {
function book_validate(&$node) {
if ($node->format && user_access("create php content")) {
// Do not filter PHP code, do not auto-extract a teaser
$node->teaser = $node->body;
}
else {
$node->format = 0;
}
// Set default values for non administrators:
if (!user_access("administer nodes")) {
$node->format = 0;
$node->weight = 0;
$node->revision = 1;
}
Kjartan Mannes
committed
function book_form(&$node, &$help, &$error) {
$output = form_select(t("Parent"), "parent", $node->parent, book_toc(), t("The parent subject or category the page belongs in."));
if (function_exists("taxonomy_node_form")) {
$output .= implode("", taxonomy_node_form("book", $node));
}
$output .= form_textarea(t("Body"), "body", $node->body, 60, 20, form_allowed_tags_text());
$output .= form_textarea(t("Log message"), "log", $node->log, 60, 5, t("An explanation of the additions or updates being made to help the group understand your motivations."));
$output .= form_weight(t("Weight"), "weight", $node->weight, 15, t("The heavier pages will sink and the lighter pages will be positioned nearer the top."));
if (user_access("create php content")) {
$output .= form_select("Type", "format", $node->format, array(0 => "HTML / text", 1 => "PHP"));
}
}
else {
/*
** Carry out some explanation or submission guidelines:
*/
/*
** If a regular user updates a book page, we create a new revision
** authored by that user:
*/
$output .= form_hidden("revision", 1);
}
return $output;
}
if ($node->type != "book") {
if ($edit["nid"]) {
$node = node_load(array("nid" => $edit["nid"]));
}
if ($op == t("Add to book outline")) {
db_query("INSERT INTO {book} (nid, parent, weight) VALUES (%d, %d, %d)", $node->nid, $edit["parent"], $edit["weight"]);
$output .= status(t("added the node to the book."));
}
if ($op == t("Update book outline")) {
db_query("UPDATE {book} SET parent = %d, weight = %d WHERE nid = %d", $edit["parent"], $edit["weight"], $node->nid);
$output .= status(t("updated the book outline."));
}
if ($op == t("Remove from book outline")) {
$output .= "<h3>". t("Edit book outline for node <i>%booktitle</i>", array("%booktitle" => $node->title)) ."</h3>";
$page = db_fetch_object(db_query("SELECT * FROM {book} WHERE nid = %d", $node->nid));
$output .= form_select(t("Parent"), "parent", $page->parent, book_toc(), t("The parent subject or category the page belongs in."));
$output .= form_weight(t("Weight"), "weight", $node->weight, 15, t("The heavier pages will sink and the lighter pages will be positioned nearer the top."));
if ($page->nid) {
$output .= form_submit(t("Update book outline"));
$output .= form_submit(t("Remove from book outline"));
}
else {
$output .= form_submit(t("Add to book outline"));
}
}
else {
$output .= form_submit(t("Edit book outline"));
}
$output .= form_hidden("nid", $node->nid);
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
/*
** Return the the most recent revision that matches the specified
** conditions.
*/
function book_revision_load($page, $conditions = array()) {
$revisions = array_reverse(node_revision_list($page));
foreach ($revisions as $revision) {
/*
** Extract the specified revision:
*/
$node = node_revision_load($page, $revision);
/*
** Check to see if the conditions are met:
*/
$status = 1;
foreach ($conditions as $key => $value) {
if ($node->$key != $value) {
$status = 0;
}
}
if ($status) {
return $node;
}
}
}
/*
** Return the path (call stack) to a certain book page.
*/
$parent = db_fetch_object(db_query("SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.nid = %d", $node->parent));
if ($parent->title) {
$nodes = book_location($parent, $nodes);
array_push($nodes, $parent);
}
return $nodes;
}
$last_direct_child = db_fetch_object(db_query("SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d ORDER BY b.weight DESC, n.title DESC", $node->nid));
if ($last_direct_child) {
array_push($nodes, $last_direct_child);
$nodes = book_location_down($last_direct_child, $nodes);
}
return $nodes;
}
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;
}
$direct_above = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '') 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;
$prev = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.nid = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '')", $node->parent));
return $prev;
}
}
function book_next($node) {
// get first direct child
$child = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '') ORDER BY b.weight ASC, n.title ASC", $node->nid));
array_push($path = book_location($node), $node); // path to root node including this one
// loop through nodes to book root, starting with this node
while (($leaf = array_pop($path)) && count($path)) {
$next = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '') 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 any) unless we have to display this page in the context of
** the moderation queue.
$revision = book_revision_load($node, array("moderate" => 0, "status" => 1));
if ($revision) {
$node = $revision;
}
/*
** Extract the page body. If body is dynamic (using PHP code), the body
** will be generated.
*/
if ($node->format == 1) {
// Make sure only authorized users can preview PHP pages.
if ($op == t("Preview") && !user_access("create php content")) {
return;
}
ob_start();
eval($node->body);
$node->teaser = $node->body = ob_get_contents();
ob_end_clean();
}
else {
$node->teaser = check_output($node->teaser);
$node->body = check_output($node->body);
}
return $node;
}
function book_view($node, $main = 0) {
$node = book_content($node);
/*
** Display the node. If not displayed on the main page, we render
** the node as a page in the book with extra links to the previous
** and the next page.
*/
if ($node->moderate) {
$node->body = $node->body . "<div class=\"log\"><div class=\"title\">". t("Log") .":</div>$node->log</div>";
}
// Add the navigation and the breadcrumb if we view a page
if (arg(1) == "view") {
if (module_hook($node->type, "content")) {
$node = node_invoke($node, "content");
$book = db_fetch_object(db_query("SELECT * FROM {book} WHERE nid = %d", $node->nid));
if ($book) {
foreach ($book as $key => $value) {
$node->$key = $value;
}
$node = book_navigation($node);
}
/*
** View the node
*/
theme("breadcrumb", $node->breadcrumb);
}
else {
/*
** We can't get the content of the node and just view the node.
** We don't add breadcrums or links.
*/
node_view($node, 0);
}
}
if (function_exists("comment_render") && $node->comment) {
comment_render($node, $cid);
}
/*
** Construct the breadcrumb:
*/
$node->breadcrumb = ""; // Overwrite the trail with a book trail.
$node->breadcrumb[] = l(t("Home"), "");
$node->breadcrumb[] = l(t("Books"), "book");
foreach ($path as $level) {
$node->breadcrumb[] = l($level->title, "book/view/$level->nid");
if ($node->nid) {
$prev = book_prev($node);
$next = book_next($node);
$output .= "<div class=\"tree\">". book_tree($node->nid) ."</div>";
if ($prev) {
$links .= "<div class=\"prev\">";
$links .= l(t("previous"), "book/view/$prev->nid", array("title" => t("View the previous page in this book.")));
$links .= "</div>";
$titles .= "<div class=\"prev\">$prev->title</div>";
}
if ($next) {
$links .= "<div class=\"next\">";
$links .= l(t("next"), "book/view/$next->nid", array("title" => t("View the next page in this book.")));
$links .= "</div>";
$titles .= "<div class=\"next\">$next->title</div>";
}
else {
$links .= "<div class=\"next\"> </div>"; // make an empty div to fill the space
}
$links .= l(t("up"), "book/view/$node->parent", array("title" => t("View this page's parent section.")));
//if ($node->parent != $path[0]->nid) {
// $links .= " | ";
// $links .= l(t("index"), "node/view/".$path[0]->nid."", array("title" => t("View this book's table of contents.")));
//}
$links .= "</div>";
}
$output .= "<div class=\"nav\">";
$output .= "<div class=\"links\">$links</div>";
$output .= "<div class=\"titles\">$titles</div>";
$output .= "</div>";
function book_toc_recurse($nid, $indent, $toc, $children) {
if ($children[$nid]) {
foreach ($children[$nid] as $foo => $node) {
$toc[$node->nid] = "$indent $node->title";
$toc = book_toc_recurse($node->nid, "$indent--", $toc, $children);
}
}
return $toc;
}
$result = db_query("SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = '1' ORDER BY b.weight, n.title");
while ($node = db_fetch_object($result)) {
$list = $children[$node->parent] ? $children[$node->parent] : array();
array_push($list, $node);
$children[$node->parent] = $list;
}
** If the user is an administrator, add the root node; only
** administrators can start new books.
if ($children[$nid]) {
foreach ($children[$nid] as $foo => $node) {
if ($tree = book_tree_recurse($node->nid, $depth - 1, $children)) {
$output .= "<ul>$tree</ul>";
}
$result = db_query("SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = '1' AND n.moderate = '0' ORDER BY b.weight, n.title");
while ($node = db_fetch_object($result)) {
$list = $children[$node->parent] ? $children[$node->parent] : array();
array_push($list, $node);
$children[$node->parent] = $list;
$output = book_tree_recurse($parent, $depth, $children);
$output = "<ul>$output</ul>";
$result = db_query("SELECT n.nid FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = 0 AND n.status = 1 AND (n.moderate = 0 OR n.revisions IS NOT NULL) ORDER BY b.weight, n.title");
while ($page = db_fetch_object($result)) {
// load the node:
$node = node_load(array("nid" => $page->nid));
// take the most recent approved revision, extract the page and check output:
$node = book_content($node);
$output .= "<div class=\"title\">". l($node->title, "book/view/$node->nid") ."</div>";
theme("box", t("Books"), "$output");
theme("header");
book_show($node, arg(3));
theme("footer");
break;
theme("header");
theme("box", t("Access denied"), message_access());
theme("footer");
Dries Buytaert
committed
function book_print($id = "", $depth = 1) {
$result = db_query("SELECT n.nid FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND n.nid = %d AND (n.moderate = 0 OR n.revisions IS NOT NULL) ORDER BY b.weight, n.title", $id);
while ($page = db_fetch_object($result)) {
// load the node:
$node = node_load(array("nid" => $page->nid));
if (module_hook($node->type, "content")) {
$node = node_invoke($node, "content");
}
$output .= "<h1 id=\"$node->nid\" name=\"$node->nid\" class=\"book-h$depth\">$node->title</h1>";
Dries Buytaert
committed
$output .= book_print_recurse($id, $depth);
$html = "<html><head><title>$node->title</title>";
$html .= "<base href=\"$base_url/\" />";
$html .= "<style type=\"text/css\">\n@import url(misc/print.css);\n</style>";
$html .= "</head><body>". $output ."</body></html>";
return $html;
Dries Buytaert
committed
function book_print_recurse($parent = "", $depth = 1) {
$result = db_query("SELECT n.nid FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND b.parent = '$parent' AND (n.moderate = 0 OR n.revisions IS NOT NULL) ORDER BY b.weight, n.title");
while ($page = db_fetch_object($result)) {
// load the node:
$node = node_load(array("nid" => $page->nid));
// take the most recent approved revision:
if ($node->moderate) {
$node = book_revision_load($node, array("moderate" => 0, "status" => 1));
if (module_hook($node->type, "content")) {
$node = node_invoke($node, "content");
}
$output .= "<h1 id=\"$node->nid\" name=\"$node->nid\" class=\"book-h$depth\">$node->title</h1>";
Dries Buytaert
committed
$output .= book_print_recurse($node->nid, $depth + 1);
$row = array("<div style=\"padding-left: ". (25 * $depth) ."px;\">". form_textfield(NULL, "$node->nid][title", $node->title, 64, 255) ."</div>", form_weight(NULL, "$node->nid][weight", $node->weight), l(t("view node"), "node/view/$node->nid"), l(t("edit node"), "admin/node/edit/$node->nid"), l(t("delete node"), "admin/node/delete/$node->nid"));
$result = db_query("SELECT n.nid FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d ORDER BY b.weight, n.title", $nid);
while ($node = db_fetch_object($result)) {
$node = node_load(array("nid" => $node->nid));
$rows[] = book_admin_view_line($node, $depth);
$rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
$header = array(t("title"), t("weight"), array("data" => t("operations"), "colspan" => 3));
$rows[] = book_admin_view_line($node);
$rows = array_merge($rows, book_admin_view_book($nid));
$output .= table($header, $rows);
$output .= form_submit(t("Save book pages"));
foreach ($edit as $nid => $value) {
/*
** Check to see whether the title needs updating:
*/
$title = db_result(db_query("SELECT title FROM {node} WHERE nid = %d", $nid));
db_query("UPDATE {node} SET title = '%s' WHERE nid = %d", $value["title"], $nid);
$weight = db_result(db_query("SELECT weight FROM {book} WHERE nid = %d", $nid));
db_query("UPDATE {book} SET weight = %d WHERE nid = %d", $value["weight"], $nid);
$message = t("updated book '%title'", array("%title" => $book->title));
watchdog("special", $message);
$result = db_query("SELECT n.nid, n.title, n.status, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.type = 'book'");
while ($page = db_fetch_object($result)) {
$pages[$page->nid] = $page;
}
$output .= "<h3>Orphan pages</h3>";
$header = array(t("title"), t("weight"), array("data" => t("operations"), "colspan" => 3));
foreach ($pages as $nid => $node) {
if ($node->parent && empty($pages[$node->parent])) {
$rows[] = book_admin_view_line($node, $depth);
$rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
}
return $output;
}
function book_admin_links() {
}
function book_admin() {
case t("Edit book outline"):
case t("Add to book outline"):
case t("Remove from book outline"):
case t("Update book outline"):
$output .= "<p>The book organises content into a nested hierarchical structure. It is particularly good for manuals, Frequently Asked Questions (FAQs) and the like, allowing you to have chapters, sections, etc.</p>";
$output .= "<p>A book is simply a collection of nodes that have been linked together. These nodes are usually of type <i>book page</i>, but you can insert nodes of any type into a book outline. Every node in the book has a <i>parent</i> node which \"contains\" it. This is how book.module establishes its hierarchy. At any given level in the hierarchy, a book can contain many nodes. All these sibling nodes are sorted according to the <i>weight</i> that you give them.</p>";
$output .= "<p>A book page is a special node type that allows you to embed PHP within the body of the page. This capability is only offerred to administrators, since malicious users could abuse this power. In addiiton, book pages contain a <i>log message</i> field which helps your users understand the motivation behind an edit of a book page. Each edited version of a book page is stored as a new revision of a node. This capability makes it easy to revert to an old version of a page, should that be desirable.</p>";
$output .= "<p>Like other node types, book submissions and edits may be subject to moderation, depending on your configuration. Similarly, books use %permissions to determine who may read and write to them. Only administrators are allowed to create new books, which are really just nodes whose parent is <i><root></i>. To include an existing node in your book, click on the \"administer\"-link in that node. At the bottom of this administration page, click on the <i>edit book outline</i> button. This enables you to place the node wherever you'd like within the book hierarchy. To add a new node into your book, use the %create link.</p>";
$output .= "<p>Administrators may review the hierarchy of their books by clicking on the %collaborative-book link in the adminstration pages. There, nodes may be edited, reorganized, removed from book, and deleted. This behavior may change in the future. When a parent node is deleted, it may leave behind child nodes. These nodes are now <i>orphans</i>. Administrators should periodically %orphans-book and reaffiliate those pages as desired. Finally, administrators may also %export-book to a single, flat HTML page which is suitable for printing.</p>";
$output .= "<h3>Maintaining a FAQ using a collaborative book</h3>";
$output .= "<p>Collaborative books let you easily set up a Frequently Asked Questions (FAQ) section on your web site. The main benefit is that you don't have to write all the questions/answers by yourself - let the community do it for you!</p>";
$output .= "<p>In order to set up the FAQ, you have to create a new book which will hold all your content. To do so, click on the %create link. Give it a thoughtful title, and body. A title like \"Estonia Travel - FAQ\" is nice. You may always edit these fields later. You will probably want to designate <i><root></i> as the parent of this page. Leave the <i>log message</i> and <i>type</i> fields blank for now. After you have submitted this book page, you are ready to begin filling up your book with questions that are frequently asked.</p>";
$output .= "<p>Whenever you come across a post which you want to include in your FAQ, click on the <i>administer</i> link. Then click on the <i>edit book outline</i> button at the bottom of the page. Then place the relevant post wherever is most appropriate in your book by selecting a <i>parent</i>. Books are quite flexible. They can have sections like <i>Flying to Estonia</i>, <i>Eating in Estonia</i> and so on. As you get more experienced with the book module, you can reorganize posts in your book so that it stays organized.</p>";
$output .= "<p>Notes:</p><ul><li>Any comments attached to those relevant posts which you designate as book pages will also be transported into your book. This is a great feature, since much wisdom is shared via comments. Remember that all future comments and edits will automatically be reflected in your book.</li><li>You may wish to edit the title of posts when adding them to your FAQ. This is done on the same page as the <i>Edit book outline</i> button. Clear titles improve navigability enormously.</li><li>Book pages may come from any content type (blog, story, page, etc.). If you are creating a post solely for inclusion in your book, then use the %create link.</li><li>If you don't see the <i>administer</i> link, then you probably have insufficient %permissions.</li><li>If you want to get really fancy, note that books are one of the few content types which allow raw PHP in their <i>body</i>. So you've got lots of geeky possibilities there.</li></ul>";
$output = t($output, array("%permissions" => l(t("permissions"), "admin/user/permission"), "%create" => l(t("submit content") ." » ". t("book page"), "node/add/book"), "%collaborative-book" => l(t("collaborative book"), "admin/node/book"), "%orphans-book" => l(t("review their books for orphans"), "admin/node/book/orphan"), "%export-book" => l(t("export their books"), "book/print")));
$output = t("The book module offers a mean to organize content, authored by many users, in an online manual, outline or FAQ.");
$output = 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 refered to as 'orphan pages'. On this page, administrators can review their books for orphans and reattach those pages as desired.");