book.module 28.8 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 62 63

  $links = array();

Dries's avatar
 
Dries committed
64
  if ($type == "page" && user_access("access content")) {
Dries's avatar
 
Dries committed
65
    $links[] = l(t("collaborative book"), "book", array("title" => t("Read and contribute to the collaborative books.")));
Dries's avatar
 
Dries committed
66 67
  }

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

Dries's avatar
 
Dries committed
72 73 74 75
  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.")));
    }
Dries's avatar
 
Dries committed
76
    $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
77 78
  }

Dries's avatar
 
Dries committed
79 80 81 82
  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
83 84 85
    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
86 87 88

    $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
89
      menu("admin/node/book/$book->nid", "'$book->title' book", "book_admin");
Dries's avatar
 
Dries committed
90 91 92
    }
  }

Dries's avatar
 
Dries committed
93
  return $links;
Dries's avatar
 
Dries committed
94 95
}

Dries's avatar
 
Dries committed
96
function book_load($node) {
Dries's avatar
 
Dries committed
97
  global $user;
Dries's avatar
 
Dries committed
98

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

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

Dries's avatar
 
Dries committed
103 104 105 106 107 108 109
    /*
    ** 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
110 111 112 113 114 115 116 117
    if ($user->uid) {
      $book->uid = $user->uid;
      $book->name = $user->name;
    }
    else {
      $book->uid = 0;
      $book->name = "";
    }
Dries's avatar
 
Dries committed
118
  }
Dries's avatar
 
Dries committed
119

Dries's avatar
 
Dries committed
120 121 122
  /*
  ** 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
123
  ** always such that the "edit this page"-links appear.
Dries's avatar
 
Dries committed
124
  */
Dries's avatar
 
Dries committed
125

Dries's avatar
 
Dries committed
126
  $book->revision = 1;
Dries's avatar
 
Dries committed
127

Dries's avatar
 
Dries committed
128
  return $book;
Dries's avatar
 
Dries committed
129 130
}

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

Dries's avatar
 
Dries committed
135
function book_update($node) {
Dries's avatar
 
Dries committed
136
  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
137
}
Dries's avatar
 
Dries committed
138

139
function book_delete(&$node) {
Dries's avatar
 
Dries committed
140
  db_query("DELETE FROM book WHERE nid = %d", $node->nid);
Dries's avatar
 
Dries committed
141 142
}

143
function book_validate(&$node) {
144
  if ($node->format && user_access("create php content")) {
145 146 147 148 149 150 151 152
    // 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
153

154 155 156 157 158 159
  // 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
160 161
}

162
function book_form(&$node, &$help, &$error) {
Dries's avatar
 
Dries committed
163
  global $user;
Dries's avatar
 
Dries committed
164

Dries's avatar
 
Dries committed
165
  $op = $_POST["op"];
166
  $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
167

168 169 170 171
  if (function_exists("taxonomy_node_form")) {
    $output .= implode("", taxonomy_node_form("book", $node));
  }

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

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

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

Dries's avatar
 
Dries committed
187 188
    $help = book_node("description");

Dries's avatar
 
Dries committed
189 190 191 192 193 194 195 196 197 198 199
    /*
    ** 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
200
function book_node_link($node = 0) {
Dries's avatar
 
Dries committed
201 202 203 204
  global $user;

  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
 
Dries committed
205 206 207 208 209 210 211 212

  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
213
      db_query("INSERT INTO book (nid, parent, weight) VALUES (%d, %d, %d)", $node->nid, $edit["parent"], $edit["weight"]);
Dries's avatar
 
Dries committed
214 215 216 217
      $output .= status(t("added the node to the book."));
    }

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

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

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

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

      $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
233
      $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
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249

      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
250
    return form($output, "post", url("admin/node/book"));
Dries's avatar
 
Dries committed
251 252 253
  }
}

Dries's avatar
 
Dries committed
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 284 285 286 287 288 289 290 291
/*
** 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
292
function book_location($node, $nodes = array()) {
Dries's avatar
 
Dries committed
293
  $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
294 295 296 297 298 299 300
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

Dries's avatar
 
Dries committed
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
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
316
    return $path ? (count($path) > 1 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
  }
  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
332
  // no direct child: get next for this level or any parent in this book
Dries's avatar
 
Dries committed
333
  array_push($path = book_location($node), $node); // path to root node including this one
Dries's avatar
 
Dries committed
334 335
  // loop through nodes to book root, starting with this node
  while (($leaf = array_pop($path)) && count($path)) {
Dries's avatar
 
Dries committed
336 337 338 339 340 341 342
    $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
343
function book_body($node) {
Dries's avatar
 
Dries committed
344
  $op = $_POST["op"];
Dries's avatar
 
Dries committed
345 346

  if ($node->format == 1) {
Dries's avatar
 
Dries committed
347 348 349
    // Make sure only authorized users can preview PHP pages.
    if ($op == t("Preview") && !user_access("create php content")) {
      return;
Dries's avatar
 
Dries committed
350 351 352 353 354 355 356 357
    }

    ob_start();
    eval($node->body);
    $output = ob_get_contents();
    ob_end_clean();
  }
  else {
Dries's avatar
 
Dries committed
358
    $output = check_output(filter($node->body));
Dries's avatar
 
Dries committed
359 360 361 362 363
  }

  return $output;
}

Dries's avatar
 
Dries committed
364
function book_view($node, $main = 0) {
Dries's avatar
 
Dries committed
365
  global $mod;
Dries's avatar
 
Dries committed
366 367 368

  /*
  ** Always display the most recently approved revision of a node
Dries's avatar
 
Dries committed
369 370
  ** (if any) unless we have to display this page in the context of
  ** the moderation queue.
Dries's avatar
 
Dries committed
371 372 373
  */

  if ($node->moderate && $mod != "queue") {
Dries's avatar
 
Dries committed
374 375 376 377 378
    $revision = book_revision_load($node, array("moderate" => 0, "status" => 1));

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
 
Dries committed
379 380
  }

Dries's avatar
 
Dries committed
381 382 383 384 385 386 387
  /*
  ** 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
388 389 390 391 392
  /*
  ** 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
393

Dries's avatar
 
Dries committed
394
  if ($main) {
Dries's avatar
 
Dries committed
395
    theme("node", $node, $main);
Dries's avatar
 
Dries committed
396
  }
Dries's avatar
 
Dries committed
397
  else {
Dries's avatar
 
Dries committed
398 399 400 401
    /*
    ** Construct the "next" and "previous" links:
    */

Dries's avatar
 
Dries committed
402 403 404
    if ($node->nid) {
      $prev = book_prev($node);
      $next = book_next($node);
Dries's avatar
 
Dries committed
405
    }
Dries's avatar
 
Dries committed
406

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

Dries's avatar
 
Dries committed
409
    if ($node->title) {
Dries's avatar
 
Dries committed
410 411 412 413 414 415
      // 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
416
      }
Dries's avatar
 
Dries committed
417

Dries's avatar
 
Dries committed
418
      $output .= " <tr><td colspan=\"3\">$location</td></tr>";
Dries's avatar
 
Dries committed
419
      $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
Dries's avatar
 
Dries committed
420
      $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
421
    }
Dries's avatar
 
Dries committed
422

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

427 428 429 430
    if ($node->moderate) {
      $output .= " <tr><td colspan=\"3\"><hr /><b>". t("Log") .":</b><br />$node->log</td></tr>";
    }

Dries's avatar
 
Dries committed
431
    if ($node->nid) {
Dries's avatar
 
Dries committed
432
      $output .= " <tr><td colspan=\"3\"><br />". book_tree($node->nid) ."</td></tr>";
Dries's avatar
 
Dries committed
433
    }
Dries's avatar
 
Dries committed
434

Dries's avatar
 
Dries committed
435
    $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
Dries's avatar
 
Dries committed
436 437
    $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
438
    $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
Dries's avatar
 
Dries committed
439
    $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
440
    $output .= "</table>";
Dries's avatar
 
Dries committed
441

Dries's avatar
 
Dries committed
442
    theme("box", t("Handbook"), $output);
Dries's avatar
 
Dries committed
443
  }
Dries's avatar
 
Dries committed
444 445
}

Dries's avatar
 
Dries committed
446 447 448 449 450 451 452 453 454 455 456 457
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
458
function book_toc($parent = 0, $indent = "", $toc = array()) {
Dries's avatar
 
Dries committed
459

460
  $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
461

Dries's avatar
 
Dries committed
462 463 464 465 466
  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
467 468

  /*
Dries's avatar
 
Dries committed
469 470
  ** If the user is an administrator, add the root node; only
  ** administrators can start new books.
Dries's avatar
 
Dries committed
471
  */
Dries's avatar
 
Dries committed
472

Dries's avatar
 
Dries committed
473
  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
474
    $toc[0] = "<". t("root") .">";
Dries's avatar
 
Dries committed
475 476
  }

Dries's avatar
 
Dries committed
477
  /*
Dries's avatar
 
Dries committed
478
  ** Iterate root book nodes:
Dries's avatar
 
Dries committed
479 480
  */

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

Dries's avatar
 
Dries committed
483 484 485
  return $toc;
}

Dries's avatar
 
Dries committed
486

Dries's avatar
 
Dries committed
487
function book_tree_recurse($nid, $depth, $children) {
Dries's avatar
 
Dries committed
488

Dries's avatar
 
Dries committed
489
  if ($depth > 0) {
Dries's avatar
 
Dries committed
490 491
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
Dries's avatar
 
Dries committed
492 493
        $output .= "<li>";
        $output .= l($node->title, "node/view/$node->nid");
Dries's avatar
 
Dries committed
494 495 496
        if ($tree = book_tree_recurse($node->nid, $depth - 1, $children)) {
          $output .= "<ul>$tree</ul>";
        }
Dries's avatar
 
Dries committed
497
        $output .= "</li>";
Dries's avatar
 
Dries committed
498 499
      }
    }
Dries's avatar
 
Dries committed
500 501 502 503 504
  }

  return $output;
}

Dries's avatar
 
Dries committed
505

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

Dries's avatar
 
Dries committed
508
  $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
509

Dries's avatar
 
Dries committed
510 511 512 513
  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
514
  }
Dries's avatar
 
Dries committed
515

Dries's avatar
 
Dries committed
516 517
  $output = book_tree_recurse($parent, $depth, $children);
  $output = "<ul>$output</ul>";
Dries's avatar
 
Dries committed
518

Dries's avatar
 
Dries committed
519 520 521
  return $output;
}

Dries's avatar
 
Dries committed
522

Dries's avatar
 
Dries committed
523
function book_render() {
Dries's avatar
 
Dries committed
524

Dries's avatar
Dries committed
525

Dries's avatar
 
Dries committed
526
  $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
527

Dries's avatar
 
Dries committed
528 529 530 531 532 533
  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
534
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
535 536
    }

Dries's avatar
 
Dries committed
537 538
    if ($node) {
      // output the content:
Dries's avatar
 
Dries committed
539
      $output .= "<dt>". l($node->title, "node/view/$node->nid") ."</dt><dd>". book_body($node) ."<br /><br /></dd>";
Dries's avatar
 
Dries committed
540
    }
Dries's avatar
 
Dries committed
541 542
  }

Dries's avatar
 
Dries committed
543 544 545
  theme("header");
  theme("box", t("Handbook"), "<dl>$output</dl>");
  theme("footer");
Dries's avatar
 
Dries committed
546 547 548
}

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

Dries's avatar
 
Dries committed
550

Dries's avatar
 
Dries committed
551
  if (user_access("access content")) {
Dries's avatar
 
Dries committed
552
    switch (arg(1)) {
Dries's avatar
 
Dries committed
553
      case "print":
Dries's avatar
 
Dries committed
554
        print book_print(arg(2), $depth = 1);
Dries's avatar
 
Dries committed
555 556 557
        break;
      default:
        book_render();
Dries's avatar
 
Dries committed
558 559 560
    }
  }
  else {
Dries's avatar
 
Dries committed
561 562 563
    theme("header");
    theme("box", t("Access denied"), message_access());
    theme("footer");
Dries's avatar
 
Dries committed
564
  }
Dries's avatar
 
Dries committed
565 566
}

567
function book_print($id = "", $depth = 1) {
Dries's avatar
 
Dries committed
568
  $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
569

Dries's avatar
 
Dries committed
570 571 572
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));
Dries's avatar
 
Dries committed
573

Dries's avatar
 
Dries committed
574 575
    // take the most recent approved revision:
    if ($node->moderate) {
Dries's avatar
 
Dries committed
576
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
577 578
    }

Dries's avatar
 
Dries committed
579 580
    if ($node) {
      // output the content:
Dries's avatar
 
Dries committed
581
      $output .= "<h$depth>$node->title</h$depth>";
Dries's avatar
 
Dries committed
582

Dries's avatar
 
Dries committed
583
      if ($node->body) {
Dries's avatar
 
Dries committed
584
        $output .= "<ul>". book_body($node) ."</ul>";
Dries's avatar
 
Dries committed
585
      }
Dries's avatar
 
Dries committed
586
    }
Dries's avatar
 
Dries committed
587
  }
Dries's avatar
 
Dries committed
588

589
  $output .= book_print_recurse($id, $depth);
Dries's avatar
 
Dries committed
590 591 592 593

  return $output;
}

594
function book_print_recurse($parent = "", $depth = 1) {
Dries's avatar
 
Dries committed
595
  $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
596

Dries's avatar
 
Dries committed
597 598 599 600 601 602
  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
603
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
604 605
    }

Dries's avatar
 
Dries committed
606 607
    if ($node) {
      // output the content:
Dries's avatar
 
Dries committed
608
      $output .= "<h$depth>$node->title</h$depth>";
Dries's avatar
 
Dries committed
609

Dries's avatar
 
Dries committed
610
      if ($node->body) {
Dries's avatar
 
Dries committed
611
        $output .= "<ul>". book_body($node) ."</ul>";
Dries's avatar
 
Dries committed
612
      }
Dries's avatar
 
Dries committed
613

614
      $output .= book_print_recurse($node->nid, $depth + 1);
Dries's avatar
 
Dries committed
615
    }
Dries's avatar
 
Dries committed
616
  }
Dries's avatar
 
Dries committed
617

Dries's avatar
 
Dries committed
618 619
  return $output;
}
Dries's avatar
 
Dries committed
620

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

Dries's avatar
 
Dries committed
623
  $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
624 625

  return $row;
Dries's avatar
 
Dries committed
626 627 628
}

function book_admin_view_book($nid, $depth = 1) {
Dries's avatar
 
Dries committed
629
  $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
630 631 632

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

Dries's avatar
 
Dries committed
637
  return $rows;
Dries's avatar
 
Dries committed
638 639 640 641 642 643
}

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

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

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

Dries's avatar
 
Dries committed
646 647 648 649 650
  $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
651 652 653 654 655 656 657 658 659 660 661 662 663 664
  $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:
    */

Dries's avatar
 
Dries committed
665
    $title = db_result(db_query("SELECT title FROM node WHERE nid = %d", $nid));
Dries's avatar
 
Dries committed
666
    if ($title != $value["title"]) {
Dries's avatar
 
Dries committed
667
      db_query("UPDATE node SET title = '%s' WHERE nid = %d", $value["title"], $nid);
Dries's avatar
 
Dries committed
668 669 670 671 672 673
    }

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

Dries's avatar
 
Dries committed
674
    $weight = db_result(db_query("SELECT weight FROM book WHERE nid = %d", $nid));
Dries's avatar
 
Dries committed
675
    if ($weight != $value["weight"]) {
Dries's avatar
 
Dries committed
676
      db_query("UPDATE book SET weight = %d WHERE nid = %d", $value["weight"], $nid);
Dries's avatar
 
Dries committed
677 678 679 680 681 682 683
    }
  }

  $message = t("updated book '%title'", array("%title" => $book->title));
  watchdog("special", $message);

  return $message;
Dries's avatar
 
Dries committed
684 685 686 687 688 689 690 691 692 693
}

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
694 695 696 697 698
  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
699
        $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
700
      }
Dries's avatar
 
Dries committed
701
    }
Dries's avatar
 
Dries committed
702
    $output .= "</table>";
Dries's avatar
 
Dries committed
703 704 705 706 707 708 709 710 711
  }

  return $output;
}

function book_admin_links() {
}

function book_admin() {
Dries's avatar
 
Dries committed
712 713
  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
 
Dries committed
714 715

  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
716
    if (empty($op)) {
Dries's avatar
 
Dries committed
717
      $op = arg(3);
Dries's avatar
 
Dries committed
718 719
    }

Dries's avatar
 
Dries committed
720
    switch ($op) {
Dries's avatar
 
Dries committed
721 722 723 724 725 726
      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
727 728 729
      case "orphan":
        print book_admin_orphan();
        break;
730
      case t("Save book pages"):
Dries's avatar
 
Dries committed
731
        print status(book_admin_save(arg(3), $edit));
Dries's avatar
 
Dries committed
732
        // fall through:
Dries's avatar
 
Dries committed
733
      default:
Dries's avatar
 
Dries committed
734
        print book_admin_view(arg(3));
Dries's avatar
 
Dries committed
735 736 737 738 739
        break;
    }
  }
}

740 741
function book_help() {
  ?>
Dries's avatar
 
Dries committed
742
<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>
743

Dries's avatar
 
Dries committed
744 745 746 747
<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
748
<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
749

Dries's avatar
 
Dries committed
750
<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>
751

Dries's avatar
Dries committed
752
<a name="faq"></a><h3>Maintain a FAQ using a collaborative book</h3>
Dries's avatar
 
Dries committed
753 754 755

<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
756
<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
757 758

<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>
759 760 761

<p>Notes:</p>
<ul>
Dries's avatar
 
Dries committed
762 763 764
 <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
765
 <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
766
 <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>
767 768
</ul>
  <?php
769
}
Dries's avatar
 
Dries committed
770
?>