book.module 28.7 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

4 5 6 7 8
function book_system($field){
  $system["description"] = t("Allows users to collaboratively author a book.");
  return $system[$field];
}

Dries's avatar
 
Dries committed
9 10 11
function book_node($field) {
  global $user;

Dries's avatar
 
Dries committed
12
  $info["name"] = t("book page");
Dries's avatar
 
Dries committed
13
  $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.");
Dries's avatar
 
Dries committed
14 15 16 17

  return $info[$field];
}

Dries's avatar
 
Dries committed
18 19 20 21
function book_perm() {
  return array("maintain books");
}

Dries's avatar
 
Dries committed
22
function book_access($op, $node) {
Dries's avatar
 
Dries committed
23
  global $user;
Dries's avatar
 
Dries committed
24 25

  if ($op == "view") {
Dries's avatar
 
Dries committed
26 27 28 29 30 31 32 33
    /*
    ** 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;
Dries's avatar
 
Dries committed
34 35
  }

Dries's avatar
 
Dries committed
36
  if ($op == "create") {
Dries's avatar
 
Dries committed
37 38 39 40 41
    /*
    ** Only registered users can create book pages.  Given the nature
    ** of the book module this is considered to be a good/safe idea.
    */

Dries's avatar
 
Dries committed
42
    return user_access("maintain books");
Dries's avatar
 
Dries committed
43 44 45
  }

  if ($op == "update") {
Dries's avatar
 
Dries committed
46
    /*
Dries's avatar
 
Dries committed
47 48 49 50 51 52 53
    ** 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 upate a book page if there are no suggested updates
    ** 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.
Dries's avatar
 
Dries committed
54
    */
Dries's avatar
 
Dries committed
55

Dries's avatar
 
Dries committed
56
    return user_access("maintain books") && !$node->moderate && !$node->format && $node->revision;
Dries's avatar
 
Dries committed
57
  }
Dries's avatar
 
Dries committed
58 59
}

Dries's avatar
 
Dries committed
60
function book_link($type, $node = 0, $main = 0) {
Dries's avatar
 
Dries committed
61
  if ($type == "page" && user_access("access content")) {
Dries's avatar
 
Dries committed
62
    $links[] = l(t("collaborative book"), "book", array("title" => t("Read and contribute to the collaborative books.")));
Dries's avatar
 
Dries committed
63 64
  }

Dries's avatar
 
Dries committed
65
  if ($type == "menu.create" && user_access("maintain books")) {
Dries's avatar
 
Dries committed
66
    $links[] = l(t("create book page"), "node/add/book", array("title" => t("Add a new book page.")));
Dries's avatar
 
Dries committed
67
  }
Dries's avatar
 
Dries committed
68

Dries's avatar
 
Dries committed
69
  if ($type == "node" && $node->type == "book" && book_access("update", $node)) {
Dries's avatar
 
Dries committed
70 71
    $links[] = l(t("edit this page"), "node/edit/$node->nid", array("title" => t("Suggest an update for this book page.")));
    $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's avatar
 
Dries committed
72 73
  }

Dries's avatar
 
Dries committed
74 75 76 77
  if ($type == "admin" && user_access("maintain books")) {
    $help["book"] = "The collaborative book offers a mean to organize content, authored by many users, in an online manual, outline or FAQ.";
    $help["orphan"] = "As pages in a book are edited, reorganized and removed, child pages might be left behind.  We refer to such pages as 'orphan pages'.  On this page, administrators can review their books for orphans and reaffiliate those pages as desired.";

Dries's avatar
 
Dries committed
78 79 80
    menu("admin/node/book", "collaborative books", "book_admin", $help["book"], 4);
    menu("admin/node/book/orphan", "orphan pages", "book_admin", $help["orphan"], 8);
    menu("admin/node/book/help", "help", "book_help", NULL, 9);
Dries's avatar
 
Dries committed
81 82 83

    $result = db_query("SELECT n.nid, n.title FROM node n LEFT JOIN book b ON n.nid = b.nid WHERE b.parent = 0 ORDER BY b.weight, n.title");
    while ($book = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
84
      menu("admin/node/book/$book->nid", "'$book->title' book", "book_admin");
Dries's avatar
 
Dries committed
85 86 87
    }
  }

Dries's avatar
 
Dries committed
88
  return $links ? $links : array();
Dries's avatar
 
Dries committed
89 90
}

Dries's avatar
 
Dries committed
91
function book_load($node) {
Dries's avatar
 
Dries committed
92
  global $user;
Dries's avatar
 
Dries committed
93

Dries's avatar
 
Dries committed
94
  $book = db_fetch_object(db_query("SELECT format, parent, weight, log FROM book WHERE nid = '%d'", $node->nid));
Dries's avatar
 
Dries committed
95

Dries's avatar
 
Dries committed
96
  if (strstr(request_uri(), "node/edit")) {
Dries's avatar
 
Dries committed
97

Dries's avatar
 
Dries committed
98 99 100 101 102 103 104
    /*
    ** If a user is about to update a book page, we overload some
    ** fields to reflect the changes.  We use the $REQUEST_URI to
    ** dectect this as we don't want to interfer with updating a
    ** book page through the admin pages.  See also: book_save().
    */

Dries's avatar
 
Dries committed
105 106 107 108 109 110 111 112
    if ($user->uid) {
      $book->uid = $user->uid;
      $book->name = $user->name;
    }
    else {
      $book->uid = 0;
      $book->name = "";
    }
Dries's avatar
 
Dries committed
113
  }
Dries's avatar
 
Dries committed
114

Dries's avatar
 
Dries committed
115 116 117
  /*
  ** We set the revision field to indicate that we have to create
  ** a new revision when updating this book page.  We enable this
Dries's avatar
 
Dries committed
118
  ** always such that the "edit this page"-links appear.
Dries's avatar
 
Dries committed
119
  */
Dries's avatar
 
Dries committed
120

Dries's avatar
 
Dries committed
121
  $book->revision = 1;
Dries's avatar
 
Dries committed
122

Dries's avatar
 
Dries committed
123
  return $book;
Dries's avatar
 
Dries committed
124 125
}

Dries's avatar
 
Dries committed
126
function book_insert($node) {
Dries's avatar
 
Dries committed
127
  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);
Dries's avatar
 
Dries committed
128
}
Dries's avatar
 
Dries committed
129

Dries's avatar
 
Dries committed
130
function book_update($node) {
Dries's avatar
 
Dries committed
131
  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);
Dries's avatar
 
Dries committed
132
}
Dries's avatar
 
Dries committed
133

134
function book_delete(&$node) {
Dries's avatar
 
Dries committed
135
  db_query("DELETE FROM book WHERE nid = '%d'", $node->nid);
Dries's avatar
 
Dries committed
136 137
}

138
function book_validate(&$node) {
139
  if ($node->format && user_access("create php content")) {
140 141 142 143 144 145 146 147
    // Do not filter PHP code, do not auto-extract a teaser
    $node->teaser = $node->body;
  }
  else {
    $node->format = 0;
    $node->body = filter($node->body);
    $node->teaser = filter($node->body);
  }
Dries's avatar
 
Dries committed
148

149 150 151 152 153 154
  // Set default values for non administrators:
  if (!user_access("administer nodes")) {
    $node->format = 0;
    $node->weight = 0;
    $node->revision = 1;
  }
Dries's avatar
 
Dries committed
155 156
}

157
function book_form(&$node, &$help, &$error) {
Dries's avatar
 
Dries committed
158
  global $user, $op;
Dries's avatar
 
Dries committed
159

160
  $output = form_select(t("Parent"), "parent", $node->parent, book_toc(), t("The parent subject or category the page belongs in."));
Dries's avatar
 
Dries committed
161

162 163 164 165
  if (function_exists("taxonomy_node_form")) {
    $output .= implode("", taxonomy_node_form("book", $node));
  }

Dries's avatar
 
Dries committed
166
  $output .= form_textarea(t("Body"), "body", $node->body, 60, 20, t("Allowed HTML tags") .": ". htmlspecialchars(variable_get("allowed_html", "")));
167
  $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."));
Dries's avatar
 
Dries committed
168 169

  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
170
    $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."));
Dries's avatar
 
Dries committed
171 172 173
    if (user_access("create php content")) {
      $output .= form_select("Type", "format", $node->format, array(0 => "HTML / text", 1 => "PHP"));
    }
Dries's avatar
 
Dries committed
174 175 176 177 178 179 180
  }
  else {

    /*
    ** Carry out some explanation or submission guidelines:
    */

Dries's avatar
 
Dries committed
181 182
    $help = book_node("description");

Dries's avatar
 
Dries committed
183 184 185 186 187 188 189 190 191 192 193
    /*
    ** If a regular user updates a book page, we create a new revision
    ** authored by that user:
    */

    $output .= form_hidden("revision", 1);
  }

  return $output;
}

Dries's avatar
 
Dries committed
194 195 196 197 198 199 200 201 202 203
function book_node_link($node = 0) {
  global $user, $op, $edit;

  if ($node->type != "book") {

    if ($edit["nid"]) {
      $node = node_load(array("nid" => $edit["nid"]));
    }

    if ($op == t("Add to book outline")) {
Dries's avatar
 
Dries committed
204
      db_query("INSERT INTO book (nid, parent, weight) VALUES ('%d', '%s', '%s')", $node->nid, $edit["parent"], $edit["weight"]);
Dries's avatar
 
Dries committed
205 206 207 208
      $output .= status(t("added the node to the book."));
    }

    if ($op == t("Update book outline")) {
Dries's avatar
 
Dries committed
209
      db_query("UPDATE book SET parent = '%s', weight = '%s' WHERE nid = '%d'", $edit["parent"], $edit["weight"], $node->nid);
Dries's avatar
 
Dries committed
210 211 212 213
      $output .= status(t("updated the book outline."));
    }

    if ($op == t("Remove from book outline")) {
Dries's avatar
 
Dries committed
214
      db_query("DELETE FROM book WHERE nid = '%d'", $node->nid);
Dries's avatar
 
Dries committed
215 216 217
      $output .= status(t("removed the node form the book."));
    }

Dries's avatar
 
Dries committed
218
    $output .= "<h3>". t("Edit book outline for node <i>") . "$node->title</i></h3>";
Dries's avatar
 
Dries committed
219 220

    if ($edit["nid"]) {
Dries's avatar
 
Dries committed
221
      $page = db_fetch_object(db_query("SELECT * FROM book WHERE nid = '%d'", $node->nid));
Dries's avatar
 
Dries committed
222 223

      $output .= form_select(t("Parent"), "parent", $page->parent, book_toc(), t("The parent subject or category the page belongs in."));
Dries's avatar
 
Dries committed
224
      $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."));
Dries's avatar
 
Dries committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240

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

Dries's avatar
 
Dries committed
241
    return form($output, "post", url("admin/node/book"));
Dries's avatar
 
Dries committed
242 243 244
  }
}

Dries's avatar
 
Dries committed
245 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
/*
** 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.
*/
Dries's avatar
 
Dries committed
283
function book_location($node, $nodes = array()) {
Dries's avatar
 
Dries committed
284
  $parent = db_fetch_object(db_query("SELECT n.nid, n.title, b.parent FROM node n LEFT JOIN book b ON n.nid = b.nid WHERE n.nid = '%d'", $node->parent));
Dries's avatar
 
Dries committed
285 286 287 288 289 290 291
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

Dries's avatar
 
Dries committed
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
function book_location_down($node, $nodes = array()) {
  $last_direct_child = db_fetch_object(db_query("SELECT n.nid, n.title, b.parent FROM node n LEFT 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) {
  // previous on the same level
  $direct_above = db_fetch_object(db_query("SELECT n.nid, n.title FROM node n LEFT 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);
Dries's avatar
 
Dries committed
307
    return $path ? (count($path) > 1 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
  }
  else {
    // direct parent
    $prev = db_fetch_object(db_query("SELECT n.nid, n.title FROM node n LEFT 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 LEFT 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));
  if ($child) {
    return $child;
  }

Dries's avatar
 
Dries committed
323
  // no direct child: get next for this level or any parent in this book
Dries's avatar
 
Dries committed
324
  array_push($path = book_location($node), $node); // path to root node including this one
Dries's avatar
 
Dries committed
325 326
  // loop through nodes to book root, starting with this node
  while (($leaf = array_pop($path)) && count($path)) {
Dries's avatar
 
Dries committed
327 328 329 330 331 332 333
    $next = db_fetch_object(db_query("SELECT n.nid, n.title FROM node n LEFT 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 ($next) {
      return $next;
    }
  }
}

Dries's avatar
 
Dries committed
334
function book_body($node) {
Dries's avatar
 
Dries committed
335
  global $op;
Dries's avatar
 
Dries committed
336 337

  if ($node->format == 1) {
Dries's avatar
 
Dries committed
338 339 340
    // Make sure only authorized users can preview PHP pages.
    if ($op == t("Preview") && !user_access("create php content")) {
      return;
Dries's avatar
 
Dries committed
341 342 343 344 345 346 347 348
    }

    ob_start();
    eval($node->body);
    $output = ob_get_contents();
    ob_end_clean();
  }
  else {
Dries's avatar
 
Dries committed
349
    $output = check_output(filter($node->body));
Dries's avatar
 
Dries committed
350 351 352 353 354
  }

  return $output;
}

Dries's avatar
 
Dries committed
355
function book_view($node, $main = 0) {
Dries's avatar
 
Dries committed
356
  global $mod;
Dries's avatar
 
Dries committed
357 358 359

  /*
  ** Always display the most recently approved revision of a node
Dries's avatar
 
Dries committed
360 361
  ** (if any) unless we have to display this page in the context of
  ** the moderation queue.
Dries's avatar
 
Dries committed
362 363 364
  */

  if ($node->moderate && $mod != "queue") {
Dries's avatar
 
Dries committed
365 366 367 368 369
    $revision = book_revision_load($node, array("moderate" => 0, "status" => 1));

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
 
Dries committed
370 371
  }

Dries's avatar
 
Dries committed
372 373 374 375 376 377 378
  /*
  ** Extract the page body.  If body is dynamic (using PHP code), the body
  ** will be generated.
  */

  $node->body = book_body($node);

Dries's avatar
 
Dries committed
379 380 381 382 383
  /*
  ** 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.
  */
Dries's avatar
 
Dries committed
384

Dries's avatar
 
Dries committed
385
  if ($main) {
Dries's avatar
 
Dries committed
386
    theme("node", $node, $main);
Dries's avatar
 
Dries committed
387
  }
Dries's avatar
 
Dries committed
388
  else {
Dries's avatar
 
Dries committed
389 390 391 392
    /*
    ** Construct the "next" and "previous" links:
    */

Dries's avatar
 
Dries committed
393 394 395
    if ($node->nid) {
      $prev = book_prev($node);
      $next = book_next($node);
Dries's avatar
 
Dries committed
396
    }
Dries's avatar
 
Dries committed
397

Dries's avatar
 
Dries committed
398
    $output .= "<table border=\"0\" cellpadding=\"1\" cellspacing=\"1\" width=\"100%\">";
Dries's avatar
 
Dries committed
399

Dries's avatar
 
Dries committed
400
    if ($node->title) {
Dries's avatar
 
Dries committed
401 402 403 404 405 406
      // build the tree from bottom to top to have the book index in $level for navigation later
      $path = array_reverse(book_location($node));
      $i = count($path);
      foreach ($path as $level) {
        $indent = str_repeat("-", --$i);
        $location = "$indent ". l($level->title, "node/view/$level->nid") ."<br />". $location;
Dries's avatar
 
Dries committed
407
      }
Dries's avatar
 
Dries committed
408

Dries's avatar
 
Dries committed
409
      $output .= " <tr><td colspan=\"3\">$location</td></tr>";
Dries's avatar
 
Dries committed
410
      $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
Dries's avatar
 
Dries committed
411
      $output .= " <tr><td colspan=\"3\"><b><big>$node->title</big></b>". ($node->body ? "<br /><small><i>". t("Last updated by %u on %d", array("%u" => format_name($node), "%d" => format_date($node->created))) ."</i></small> " : "") ."</td></tr>";
Dries's avatar
 
Dries committed
412
    }
Dries's avatar
 
Dries committed
413

Dries's avatar
 
Dries committed
414
    if ($node->body) {
Dries's avatar
 
Dries committed
415
      $output .= " <tr><td colspan=\"3\"><br />$node->body</td></tr>";
Dries's avatar
 
Dries committed
416
    }
Dries's avatar
 
Dries committed
417

418 419 420 421
    if ($node->moderate) {
      $output .= " <tr><td colspan=\"3\"><hr /><b>". t("Log") .":</b><br />$node->log</td></tr>";
    }

Dries's avatar
 
Dries committed
422
    if ($node->nid) {
Dries's avatar
 
Dries committed
423
      $output .= " <tr><td colspan=\"3\"><br />". book_tree($node->nid) ."</td></tr>";
Dries's avatar
 
Dries committed
424
    }
Dries's avatar
 
Dries committed
425

Dries's avatar
 
Dries committed
426
    $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
Dries's avatar
 
Dries committed
427 428
    $output .= " <tr><td align=\"left\" width=\"33%\">". ($prev ? l(t("previous"), "node/view/$prev->nid", array("title" => t("View the previous page in this book."))) : "&nbsp;") ."</td><td align=\"center\" width=\"34%\">". ($node->parent ? l(t("up"), "node/view/$node->parent", array("title" => t("View this page's parent section."))) : "&nbsp;") ."</td><td align=\"right\" width=\"33%\">". ($next ? l(t("next"), "node/view/$next->nid", array("title" => t("View the next page in this book."))) : "&nbsp;") ."</td></tr>";
    $output .= " <tr><td align=\"left\" width=\"33%\">". ($prev ? "<small>$prev->title</small>" : "&nbsp;") ."</td><td align=\"center\" width=\"34%\">". ($node->parent && $node->parent != $level->nid ? l(t("index"), "node/view/$level->nid", array("title" => t("View this book's table of contents."))) : "&nbsp;") ."</td><td align=\"right\" width=\"33%\">". ($next ? "<small>$next->title</small>" : "&nbsp;") ."</td></tr>";
Dries's avatar
 
Dries committed
429
    $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
Dries's avatar
 
Dries committed
430
    $output .= " <tr><td colspan=\"3\" align=\"right\"><div style=\"margin: 10 10 10 10;\">". theme("links", link_node($node, $main)) ."</div></td></tr>";
Dries's avatar
 
Dries committed
431
    $output .= "</table>";
Dries's avatar
 
Dries committed
432

Dries's avatar
 
Dries committed
433
    theme("box", t("Handbook"), $output);
Dries's avatar
 
Dries committed
434
  }
Dries's avatar
 
Dries committed
435 436
}

Dries's avatar
 
Dries committed
437 438 439 440 441 442 443 444 445 446 447 448
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;
}

Dries's avatar
 
Dries committed
449
function book_toc($parent = 0, $indent = "", $toc = array()) {
Dries's avatar
 
Dries committed
450

451
  $result = db_query("SELECT n.nid, n.title, b.parent FROM node n LEFT JOIN book b ON n.nid = b.nid WHERE n.status = '1' ORDER BY b.weight, n.title");
Dries's avatar
 
Dries committed
452

Dries's avatar
 
Dries committed
453 454 455 456 457
  while ($node = db_fetch_object($result)) {
    $list = $children[$node->parent] ? $children[$node->parent] : array();
    array_push($list, $node);
    $children[$node->parent] = $list;
  }
Dries's avatar
 
Dries committed
458 459

  /*
Dries's avatar
 
Dries committed
460 461
  ** If the user is an administrator, add the root node; only
  ** administrators can start new books.
Dries's avatar
 
Dries committed
462
  */
Dries's avatar
 
Dries committed
463

Dries's avatar
 
Dries committed
464
  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
465
    $toc[0] = "<". t("root") .">";
Dries's avatar
 
Dries committed
466 467
  }

Dries's avatar
 
Dries committed
468
  /*
Dries's avatar
 
Dries committed
469
  ** Iterate root book nodes:
Dries's avatar
 
Dries committed
470 471
  */

Dries's avatar
 
Dries committed
472
  $toc = book_toc_recurse($parent, $indent, $toc, $children);
Dries's avatar
 
Dries committed
473

Dries's avatar
 
Dries committed
474 475 476
  return $toc;
}

Dries's avatar
 
Dries committed
477

Dries's avatar
 
Dries committed
478
function book_tree_recurse($nid, $depth, $children) {
Dries's avatar
 
Dries committed
479

Dries's avatar
 
Dries committed
480
  if ($depth > 0) {
Dries's avatar
 
Dries committed
481 482
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
Dries's avatar
 
Dries committed
483
        $output .= "<li>". l($node->title, "node/view/$node->nid") ."</li>";
Dries's avatar
 
Dries committed
484 485 486 487

        if ($tree = book_tree_recurse($node->nid, $depth - 1, $children)) {
          $output .= "<ul>$tree</ul>";
        }
Dries's avatar
 
Dries committed
488 489
      }
    }
Dries's avatar
 
Dries committed
490 491 492 493 494
  }

  return $output;
}

Dries's avatar
 
Dries committed
495

Dries's avatar
 
Dries committed
496 497
function book_tree($parent = 0, $depth = 3) {

Dries's avatar
 
Dries committed
498
  $result = db_query("SELECT n.nid, n.title, b.parent FROM node n LEFT JOIN book b ON n.nid = b.nid WHERE n.status = '1' AND n.moderate = '0' ORDER BY b.weight, n.title");
Dries's avatar
 
Dries committed
499

Dries's avatar
 
Dries committed
500 501 502 503
  while ($node = db_fetch_object($result)) {
    $list = $children[$node->parent] ? $children[$node->parent] : array();
    array_push($list, $node);
    $children[$node->parent] = $list;
Dries's avatar
 
Dries committed
504
  }
Dries's avatar
 
Dries committed
505

Dries's avatar
 
Dries committed
506 507
  $output = book_tree_recurse($parent, $depth, $children);
  $output = "<ul>$output</ul>";
Dries's avatar
 
Dries committed
508

Dries's avatar
 
Dries committed
509 510 511
  return $output;
}

Dries's avatar
 
Dries committed
512

Dries's avatar
 
Dries committed
513
function book_render() {
Dries's avatar
 
Dries committed
514

Dries's avatar
Dries committed
515

Dries's avatar
 
Dries committed
516
  $result = db_query("SELECT n.nid FROM node n LEFT 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");
Dries's avatar
 
Dries committed
517

Dries's avatar
 
Dries committed
518 519 520 521 522 523
  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) {
Dries's avatar
 
Dries committed
524
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
525 526
    }

Dries's avatar
 
Dries committed
527 528
    if ($node) {
      // output the content:
Dries's avatar
 
Dries committed
529
      $output .= "<dt>". l($node->title, "node/view/$node->nid") ."</dt><dd>". book_body($node) ."<br /><br /></dd>";
Dries's avatar
 
Dries committed
530
    }
Dries's avatar
 
Dries committed
531 532
  }

Dries's avatar
 
Dries committed
533 534 535
  theme("header");
  theme("box", t("Handbook"), "<dl>$output</dl>");
  theme("footer");
Dries's avatar
 
Dries committed
536 537 538
}

function book_page() {
Dries's avatar
 
Dries committed
539

Dries's avatar
 
Dries committed
540

Dries's avatar
 
Dries committed
541
  if (user_access("access content")) {
Dries's avatar
 
Dries committed
542
    switch (arg(1)) {
Dries's avatar
 
Dries committed
543
      case "print":
Dries's avatar
 
Dries committed
544
        print book_print(arg(2), $depth = 1);
Dries's avatar
 
Dries committed
545 546 547
        break;
      default:
        book_render();
Dries's avatar
 
Dries committed
548 549 550
    }
  }
  else {
Dries's avatar
 
Dries committed
551 552 553
    theme("header");
    theme("box", t("Access denied"), message_access());
    theme("footer");
Dries's avatar
 
Dries committed
554
  }
Dries's avatar
 
Dries committed
555 556
}

557
function book_print($id = "", $depth = 1) {
Dries's avatar
 
Dries committed
558
  $result = db_query("SELECT n.nid FROM node n LEFT 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);
Dries's avatar
 
Dries committed
559

Dries's avatar
 
Dries committed
560 561 562
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));
Dries's avatar
 
Dries committed
563

Dries's avatar
 
Dries committed
564 565
    // take the most recent approved revision:
    if ($node->moderate) {
Dries's avatar
 
Dries committed
566
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
567 568
    }

Dries's avatar
 
Dries committed
569 570
    if ($node) {
      // output the content:
Dries's avatar
 
Dries committed
571
      $output .= "<h$depth>$node->title</h$depth>";
Dries's avatar
 
Dries committed
572

Dries's avatar
 
Dries committed
573
      if ($node->body) {
Dries's avatar
 
Dries committed
574
        $output .= "<ul>". book_body($node) ."</ul>";
Dries's avatar
 
Dries committed
575
      }
Dries's avatar
 
Dries committed
576
    }
Dries's avatar
 
Dries committed
577
  }
Dries's avatar
 
Dries committed
578

579
  $output .= book_print_recurse($id, $depth);
Dries's avatar
 
Dries committed
580 581 582 583

  return $output;
}

584
function book_print_recurse($parent = "", $depth = 1) {
Dries's avatar
 
Dries committed
585
  $result = db_query("SELECT n.nid FROM node n LEFT 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");
Dries's avatar
 
Dries committed
586

Dries's avatar
 
Dries committed
587 588 589 590 591 592
  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) {
Dries's avatar
 
Dries committed
593
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
594 595
    }

Dries's avatar
 
Dries committed
596 597
    if ($node) {
      // output the content:
Dries's avatar
 
Dries committed
598
      $output .= "<h$depth>$node->title</h$depth>";
Dries's avatar
 
Dries committed
599

Dries's avatar
 
Dries committed
600
      if ($node->body) {
Dries's avatar
 
Dries committed
601
        $output .= "<ul>". book_body($node) ."</ul>";
Dries's avatar
 
Dries committed
602
      }
Dries's avatar
 
Dries committed
603

604
      $output .= book_print_recurse($node->nid, $depth + 1);
Dries's avatar
 
Dries committed
605
    }
Dries's avatar
 
Dries committed
606
  }
Dries's avatar
 
Dries committed
607

Dries's avatar
 
Dries committed
608 609
  return $output;
}
Dries's avatar
 
Dries committed
610

Dries's avatar
 
Dries committed
611 612
function book_admin_view_line($node, $depth = 0) {

Dries's avatar
 
Dries committed
613
  $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"));
Dries's avatar
 
Dries committed
614 615

  return $row;
Dries's avatar
 
Dries committed
616 617 618
}

function book_admin_view_book($nid, $depth = 1) {
Dries's avatar
 
Dries committed
619
  $result = db_query("SELECT n.nid FROM node n LEFT JOIN book b ON n.nid = b.nid WHERE b.parent = '%d' ORDER BY b.weight, n.title", $nid);
Dries's avatar
 
Dries committed
620 621 622

  while ($node = db_fetch_object($result)) {
    $node = node_load(array("nid" => $node->nid));
Dries's avatar
 
Dries committed
623 624
    $rows[] = book_admin_view_line($node, $depth);
    $rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
Dries's avatar
 
Dries committed
625 626
  }

Dries's avatar
 
Dries committed
627
  return $rows;
Dries's avatar
 
Dries committed
628 629 630 631 632 633
}

function book_admin_view($nid, $depth = 0) {

  $node = node_load(array("nid" => $nid));

Dries's avatar
 
Dries committed
634
  $output .= "<h3>$node->title</h3>";
Dries's avatar
 
Dries committed
635

Dries's avatar
 
Dries committed
636 637 638 639 640
  $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);
Dries's avatar
 
Dries committed
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
  $output .= form_submit(t("Save book pages"));

  return form($output);
}

function book_admin_save($nid, $edit = array()) {

  $book = node_load(array("nid" => $nid));

  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));
    if ($title != $value["title"]) {
      db_query("UPDATE node SET title = '%s' WHERE nid = '%d'", $value["title"], $nid);
    }

    /*
    ** Check to see whether the weight needs updating:
    */

    $weight = db_result(db_query("SELECT weight FROM book WHERE nid = '%d'", $nid));
    if ($weight != $value["weight"]) {
      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);

  return $message;
Dries's avatar
 
Dries committed
674 675 676 677 678 679 680 681 682 683
}

function book_admin_orphan() {

  $result = db_query("SELECT n.nid, n.title, b.parent FROM node n LEFT JOIN book b ON n.nid = b.nid WHERE n.type = 'book'");

  while ($page = db_fetch_object($result)) {
    $pages[$page->nid] = $page;
  }

Dries's avatar
 
Dries committed
684 685 686 687 688
  if ($pages) {
    $output .= "<table border=\"1\" cellpadding=\"2\" cellspacing=\"2\">";
    $output .= " <tr><th>title</th><th colspan=\"2\">operations</th></tr>";
    foreach ($pages as $nid => $node) {
      if ($node->parent && empty($pages[$node->parent])) {
Dries's avatar
 
Dries committed
689
        $output .= "<tr><td>". l($node->title, "node/view/$node->nid") ."</td><td>". l(t("edit page"), "admin/node/edit/$node->nid") ."</td><td>". l(t("delete page"), "admin/node/delete/$node->nid") ."</td>";
Dries's avatar
 
Dries committed
690
      }
Dries's avatar
 
Dries committed
691
    }
Dries's avatar
 
Dries committed
692
    $output .= "</table>";
Dries's avatar
 
Dries committed
693 694 695 696 697 698 699 700 701
  }

  return $output;
}

function book_admin_links() {
}

function book_admin() {
Dries's avatar
 
Dries committed
702
  global $op, $edit;
Dries's avatar
 
Dries committed
703 704

  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
705
    if (empty($op)) {
Dries's avatar
 
Dries committed
706
      $op = arg(3);
Dries's avatar
 
Dries committed
707 708
    }

Dries's avatar
 
Dries committed
709
    switch ($op) {
Dries's avatar
 
Dries committed
710 711 712 713 714 715
      case t("Edit book outline"):
      case t("Add to book outline"):
      case t("Remove from book outline"):
      case t("Update book outline"):
        print book_node_link();
        break;
Dries's avatar
 
Dries committed
716 717 718
      case "orphan":
        print book_admin_orphan();
        break;
719
      case t("Save book pages"):
Dries's avatar
 
Dries committed
720
        print status(book_admin_save(arg(3), $edit));
Dries's avatar
 
Dries committed
721
        // fall through:
Dries's avatar
 
Dries committed
722
      default:
Dries's avatar
 
Dries committed
723
        print book_admin_view(arg(3));
Dries's avatar
 
Dries committed
724 725 726 727 728
        break;
    }
  }
}

729 730
function book_help() {
  ?>
Dries's avatar
 
Dries committed
731
<p>The <i>collaborative book</i> is a magnificient mechanism for organizing content authored by many users.  You may use it to organize a manual, to <a href="#faq">maintain a FAQ</a>, or to manage any outline-like content. Books can have chapters, sections, etc.  In fact, books can have an arbitrarily deep nesting strucuture.</p>
732

Dries's avatar
 
Dries committed
733 734 735 736
<p>Under the covers, a book is only an organization of nodes. These nodes are often of type <i>book page</i>, but can be of any content type. Every node in the book has a <i>Parent</i>. The parent is the node which "contains" the child node. This is how book.module establishes its hierarchy. On any given level in the hierarchy, a book can contain many nodes. Book uses the Weight field to order these sibling nodes.</p>

<p>Book pages are a special, powerful node type. These nodes are specifically designed to be included in a book.  Their special power comes from the bilility 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 usually stored as a new revision of a node. This capability makes it easy to revert to an old version of a page, should that become desirable.</p>

Dries's avatar
 
Dries committed
737
<p>Like other node types, book submissions and edits may be subject to moderation, depending on your configuration.  Similarly, books use <?php echo l("permissions", "admin/user/permission") ?> 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>&lt;root&gt;</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 <i>create book page</i> link.</p>
Dries's avatar
 
Dries committed
738

Dries's avatar
 
Dries committed
739
<p>Administrators may review the hierarchy of their books by clicking on the <?php echo l("collaborative book link", "admin/book") ?> 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, he may leave behind child nodes.  These nodes are now <i>orphans</i>. Administrators should periodically <?php echo l("review their books for orphans", "admin/book/orphan") ?> and reaffiliate those pages as desired. Finally, administrators may also <?php echo l("export their books", "book/print") ?> to a single, flat HTML page which is suitable for printing.</p>
740

Dries's avatar
Dries committed
741
<a name="faq"></a><h3>Maintain a FAQ using a collaborative book</h3>
Dries's avatar
 
Dries committed
742 743 744

<p>The collaborative book (i.e. <code>book.module</code>) in Drupal is a terrific way to easily manage an FAQ (Frequently Asked Questions) section of your web site. The main benefit for an administrator is that you don't have to write all the questions/answers by yourself. Let the community do it for you!</p>

Dries's avatar
Dries committed
745
<p>In order to setup the FAQ, you have to create a new <i>Book</i> which will hold all your content. To do so, click on <i>Create Book Page</i> in your user box. 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>&lt;root&gt;</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>
Dries's avatar
 
Dries committed
746 747

<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 <i>collaborative book</i>, you can reorganize posts in your book so that it stays organized.</p>
748 749 750

<p>Notes:</p>
<ul>
Dries's avatar
 
Dries committed
751 752 753
 <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. And remember that all future comments and edits will automatically be reflected in your book.</li>
 <li>You may wish to edit the title and teaser 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 help users navigate quickly to the information that they seek.</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 <i>Create book page</i> link.</li>
Dries's avatar
 
Dries committed
754
 <li>If you don't see the <i>administer</i> link, then you probably have insufficient <?php echo l("permissions", "admin/user/permission") ?>.</li>
Dries's avatar
 
Dries committed
755
 <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>
756 757
</ul>
  <?php
758
}
Dries's avatar
 
Dries committed
759
?>