book.module 28.9 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_save($op, $node) {
Dries's avatar
 
Dries committed
61
  global $user;
Dries's avatar
 
Dries committed
62 63 64 65 66 67

  if ($op == "approve") {
    return array("status" => 1);
  }

  if ($op == "create") {
Dries's avatar
 
Dries committed
68
    if (user_access("administer nodes")) {
69
      return array("body" => filter($node->body), "teaser" => filter($node->body), "format", "parent", "weight", "log");
Dries's avatar
 
Dries committed
70 71
    }
    else {
72
      return array("body" => filter($node->body), "teaser" => filter($node->body), "format", "moderate" => 1, "parent", "promote" => 0, "status" => 1, "weight", "log");
Dries's avatar
 
Dries committed
73
    }
Dries's avatar
 
Dries committed
74 75 76 77 78 79 80
  }

  if ($op == "decline") {
    return array("status" => 0);
  }

  if ($op == "update") {
Dries's avatar
 
Dries committed
81
    if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
82
      /*
Dries's avatar
 
Dries committed
83 84
      ** If a node administrator updates a book page, we don't create a
      ** new revision unless we are explicitly instructed to.
Dries's avatar
 
Dries committed
85 86
      */

87
      return array("body" => filter($node->body), "teaser" => filter($node->body), "format", "parent", "weight", "log");
Dries's avatar
 
Dries committed
88
    }
Dries's avatar
 
Dries committed
89
    else {
Dries's avatar
 
Dries committed
90
      /*
Dries's avatar
 
Dries committed
91 92 93
      ** If a regular user updates a book page, we always create a new
      ** revision.  All new revisions have to be approved (moderation)
      ** and are not promoted by default.  See also: book_load().
Dries's avatar
 
Dries committed
94 95
      */

96
      return array("body" => filter($node->body), "teaser" => filter($node->body), "created" => time(), "format", "moderate" => 1, "parent", "promote" => 0, "score" => 0, "status" => 1, "users" => "", "revisions", "votes" => 0, "weight", "log");
Dries's avatar
 
Dries committed
97 98 99 100 101
    }
  }

}

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

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

Dries's avatar
 
Dries committed
111
  if ($type == "node" && $node->type == "book" && book_access("update", $node)) {
Dries's avatar
 
Dries committed
112 113
    $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
114 115
  }

Dries's avatar
 
Dries committed
116 117 118 119
  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
120 121 122
    menu_add("collaborative books", url("admin/book"), "Maintain collaborative books.", $help["book"], "content management");
    menu_add("orphan pages", url("admin/book/orphan"), "Display all orphan pages.", $orphan, "collaborative books", 8);
    menu_add("help", url("admin/book/help"), "More information about the collaborative book.", NULL, "collaborative books", 9);
Dries's avatar
 
Dries committed
123 124 125

    $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
126
      menu_add("administer book '$book->title'", url("admin/book/view/$book->nid"), "Display a book outline.", NULL, "collaborative books");
Dries's avatar
 
Dries committed
127 128 129
    }
  }

Dries's avatar
 
Dries committed
130
  return $links ? $links : array();
Dries's avatar
 
Dries committed
131 132
}

Dries's avatar
 
Dries committed
133
function book_load($node) {
Dries's avatar
 
Dries committed
134
  global $user;
Dries's avatar
 
Dries committed
135

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

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

Dries's avatar
 
Dries committed
140 141 142 143 144 145 146
    /*
    ** 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
147 148 149 150 151 152 153 154
    if ($user->uid) {
      $book->uid = $user->uid;
      $book->name = $user->name;
    }
    else {
      $book->uid = 0;
      $book->name = "";
    }
Dries's avatar
 
Dries committed
155
  }
Dries's avatar
 
Dries committed
156

Dries's avatar
 
Dries committed
157 158 159
  /*
  ** 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
160
  ** always such that the "edit this page"-links appear.
Dries's avatar
 
Dries committed
161
  */
Dries's avatar
 
Dries committed
162

Dries's avatar
 
Dries committed
163
  $book->revision = 1;
Dries's avatar
 
Dries committed
164

Dries's avatar
 
Dries committed
165
  return $book;
Dries's avatar
 
Dries committed
166 167
}

Dries's avatar
 
Dries committed
168
function book_insert($node) {
Dries's avatar
 
Dries committed
169 170 171 172 173
  if (!user_access("administer nodes")) {
    $node->format = 0;
    $node->weight = 0;
  }

Dries's avatar
 
Dries committed
174
  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
175
}
Dries's avatar
 
Dries committed
176

Dries's avatar
 
Dries committed
177
function book_update($node) {
Dries's avatar
 
Dries committed
178 179 180 181 182
  if (!user_access("administer nodes")) {
    $node->format = 0;
    $node->weight = 0;
  }

Dries's avatar
 
Dries committed
183
  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
184
}
Dries's avatar
 
Dries committed
185

186
function book_delete(&$node) {
Dries's avatar
 
Dries committed
187
  db_query("DELETE FROM book WHERE nid = '%d'", $node->nid);
Dries's avatar
 
Dries committed
188 189
}

Dries's avatar
 
Dries committed
190 191 192 193 194 195 196 197
function book_validate($node, &$error) {

  // Make sure user has permissions to create php content:
  $node->format = $node->format && user_access("create php content");

  return $node;
}

198
function book_form(&$node, &$help, &$error) {
Dries's avatar
 
Dries committed
199
  global $user, $op;
Dries's avatar
 
Dries committed
200

201
  $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
202

Dries's avatar
 
Dries committed
203 204 205 206 207
  if ($node->format) {
    if ($op != t("Preview")) {
      $node->body = addslashes($node->body);
    }
  }
Dries's avatar
 
Dries committed
208

209 210 211 212
  if (function_exists("taxonomy_node_form")) {
    $output .= implode("", taxonomy_node_form("book", $node));
  }

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

  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
217
    $output .= form_select(t("Weight"), "weight", $node->weight, array(0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30), t("The heavier pages will sink and the lighter pages will be positioned nearer the top."));
Dries's avatar
 
Dries committed
218 219 220
    if (user_access("create php content")) {
      $output .= form_select("Type", "format", $node->format, array(0 => "HTML / text", 1 => "PHP"));
    }
Dries's avatar
 
Dries committed
221 222 223 224 225 226 227
  }
  else {

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

Dries's avatar
 
Dries committed
228 229
    $help = book_node("description");

Dries's avatar
 
Dries committed
230 231 232 233 234 235 236 237 238 239 240
    /*
    ** 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
241 242 243 244 245 246 247 248 249 250
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
251
      db_query("INSERT INTO book (nid, parent, weight) VALUES ('%d', '%s', '%s')", $node->nid, $edit["parent"], $edit["weight"]);
Dries's avatar
 
Dries committed
252 253 254 255
      $output .= status(t("added the node to the book."));
    }

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

    if ($op == t("Remove from book outline")) {
Dries's avatar
 
Dries committed
261
      db_query("DELETE FROM book WHERE nid = '%d'", $node->nid);
Dries's avatar
 
Dries committed
262 263 264 265 266 267
      $output .= status(t("removed the node form the book."));
    }

    $output .= "<h3>". t("Edit book outline") ."</h3>";

    if ($edit["nid"]) {
Dries's avatar
 
Dries committed
268
      $page = db_fetch_object(db_query("SELECT * FROM book WHERE nid = '%d'", $node->nid));
Dries's avatar
 
Dries committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287

      $output .= form_select(t("Parent"), "parent", $page->parent, book_toc(), t("The parent subject or category the page belongs in."));
      $output .= form_select(t("Weight"), "weight", $page->weight, array(0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30), 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);

Dries's avatar
 
Dries committed
288
    return form($output, "post", url("admin/book/outline"));
Dries's avatar
 
Dries committed
289 290 291
  }
}

Dries's avatar
 
Dries committed
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
/*
** 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
331
function book_location($node, $nodes = array()) {
Dries's avatar
 
Dries committed
332
  $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
333 334 335 336 337 338 339
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

Dries's avatar
 
Dries committed
340
function book_body($node) {
Dries's avatar
 
Dries committed
341
  global $op;
Dries's avatar
 
Dries committed
342 343 344 345 346 347

  if ($node->format == 1) {
    /*
    ** Make sure only authorized users can preview PHP pages.
    */

Dries's avatar
 
Dries committed
348
    if ($op == t("Preview")) {
Dries's avatar
 
Dries committed
349
      if (user_access("create php content")) {
Dries's avatar
 
Dries committed
350 351 352 353 354
        $node->body = stripslashes($node->body);  // see also book_form()
      }
      else {
        return;
      }
Dries's avatar
 
Dries committed
355 356 357 358 359 360 361 362
    }

    ob_start();
    eval($node->body);
    $output = ob_get_contents();
    ob_end_clean();
  }
  else {
Dries's avatar
 
Dries committed
363
    $output = check_output(filter($node->body));
Dries's avatar
 
Dries committed
364 365 366 367 368
  }

  return $output;
}

Dries's avatar
 
Dries committed
369
function book_view($node, $main = 0) {
Dries's avatar
 
Dries committed
370
  global $mod;
Dries's avatar
 
Dries committed
371 372 373

  /*
  ** Always display the most recently approved revision of a node
Dries's avatar
 
Dries committed
374 375
  ** (if any) unless we have to display this page in the context of
  ** the moderation queue.
Dries's avatar
 
Dries committed
376 377 378
  */

  if ($node->moderate && $mod != "queue") {
Dries's avatar
 
Dries committed
379 380 381 382 383
    $revision = book_revision_load($node, array("moderate" => 0, "status" => 1));

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
 
Dries committed
384 385
  }

Dries's avatar
 
Dries committed
386 387 388 389 390 391 392
  /*
  ** 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
393 394 395 396 397
  /*
  ** 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
398

Dries's avatar
 
Dries committed
399
  if ($main) {
Dries's avatar
 
Dries committed
400
    theme("node", $node, $main);
Dries's avatar
 
Dries committed
401
  }
Dries's avatar
 
Dries committed
402
  else {
Dries's avatar
 
Dries committed
403 404 405 406
    /*
    ** Construct the "next" and "previous" links:
    */

Dries's avatar
 
Dries committed
407
    if ($node->nid && $node->parent) {
Dries's avatar
 
Dries committed
408 409
      $next = db_fetch_object(db_query("SELECT n.nid, n.title FROM node n LEFT JOIN book b ON n.nid = b.nid WHERE n.status = 1 AND b.parent = '%d' AND (b.weight > '%d' OR (b.weight = '%d' AND n.title > '%s')) AND (n.moderate = 0 OR n.revisions != '') ORDER BY b.weight ASC, n.title ASC", $node->parent, $node->weight, $node->weight, $node->title));
      $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.status = 1 AND b.parent = '%d' AND (b.weight < '%d' OR (b.weight = '%d' AND n.title < '%s')) AND (n.moderate = 0 OR n.revisions != '') ORDER BY b.weight DESC, n.title DESC", $node->parent, $node->weight, $node->weight, $node->title));
Dries's avatar
 
Dries committed
410
    }
Dries's avatar
 
Dries committed
411

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

Dries's avatar
 
Dries committed
414 415
    if ($node->title) {
      foreach (book_location($node) as $level) {
Dries's avatar
 
Dries committed
416
        $location .= "$indent ". l($level->title, "node/view/$level->nid") ."<br />";
Dries's avatar
 
Dries committed
417 418
        $indent .= "-";
      }
Dries's avatar
 
Dries committed
419

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

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

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

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

Dries's avatar
 
Dries committed
437
    $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
Dries's avatar
 
Dries committed
438 439
    $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."))) : t("previous")) ."</td><td align=\"center\" width=\"34%\">". l(t("index"), "book", array("title" => t("View this book's table of contents."))) ."</td><td align=\"right\" width=\"33%\">". ($next ? l(t("next"), "node/view/$next->nid", array("title" => t("View the next page in this book."))) : t("next")) ."</td></tr>";
    $output .= " <tr><td align=\"left\" width=\"33%\">". ($prev ? "<small>$prev->title</small>" : "&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."))) : t("up")) ."</td><td align=\"right\" width=\"33%\">". ($next ? "<small>$next->title</small>" : "&nbsp;") ."</td></tr>";
Dries's avatar
 
Dries committed
440
    $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
Dries's avatar
 
Dries committed
441
    $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
442
    $output .= "</table>";
Dries's avatar
 
Dries committed
443

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

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

462
  $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
463

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

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

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

Dries's avatar
 
Dries committed
479
  /*
Dries's avatar
 
Dries committed
480
  ** Iterate root book nodes:
Dries's avatar
 
Dries committed
481 482
  */

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

Dries's avatar
 
Dries committed
485 486 487
  return $toc;
}

Dries's avatar
 
Dries committed
488

Dries's avatar
 
Dries committed
489
function book_tree_recurse($nid, $depth, $children) {
Dries's avatar
 
Dries committed
490

Dries's avatar
 
Dries committed
491
  if ($depth > 0) {
Dries's avatar
 
Dries committed
492 493
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
Dries's avatar
 
Dries committed
494
        $output .= "<li>". l($node->title, "node/view/$node->nid") ."</li>";
Dries's avatar
 
Dries committed
495 496 497 498

        if ($tree = book_tree_recurse($node->nid, $depth - 1, $children)) {
          $output .= "<ul>$tree</ul>";
        }
Dries's avatar
 
Dries committed
499 500
      }
    }
Dries's avatar
 
Dries committed
501 502 503 504 505
  }

  return $output;
}

Dries's avatar
 
Dries committed
506

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

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

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

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

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

Dries's avatar
 
Dries committed
523

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

Dries's avatar
Dries committed
526

527
  $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 != '') ORDER BY b.weight, n.title");
Dries's avatar
 
Dries committed
528

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

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

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

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

Dries's avatar
 
Dries committed
551

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

568 569
function book_print($id = "", $depth = 1) {
  $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 != '') ORDER BY b.weight, n.title", $id);
Dries's avatar
 
Dries committed
570

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

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

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

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

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

  return $output;
}

595 596
function book_print_recurse($parent = "", $depth = 1) {
  $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 != '') ORDER BY b.weight, n.title");
Dries's avatar
 
Dries committed
597

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

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

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

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

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

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

Dries's avatar
 
Dries committed
624 625 626 627 628 629 630 631
  $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"));

  return $row;
Dries's avatar
 
Dries committed
632 633 634
}

function book_admin_view_book($nid, $depth = 1) {
Dries's avatar
 
Dries committed
635
  $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
636 637 638

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

Dries's avatar
 
Dries committed
643
  return $rows;
Dries's avatar
 
Dries committed
644 645 646 647 648 649
}

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

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

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

Dries's avatar
 
Dries committed
652 653 654 655 656
  $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
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
  $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
690 691 692 693 694 695 696 697 698 699
}

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
700 701 702 703 704
  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
705
        $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
706
      }
Dries's avatar
 
Dries committed
707
    }
Dries's avatar
 
Dries committed
708
    $output .= "</table>";
Dries's avatar
 
Dries committed
709 710 711 712 713 714 715 716 717
  }

  return $output;
}

function book_admin_links() {
}

function book_admin() {
Dries's avatar
 
Dries committed
718
  global $op, $edit;
Dries's avatar
 
Dries committed
719 720

  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
721 722 723 724
    if (empty($op)) {
      $op = arg(2);
    }

Dries's avatar
 
Dries committed
725
    switch ($op) {
Dries's avatar
 
Dries committed
726 727 728 729 730 731
      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
732 733 734
      case "orphan":
        print book_admin_orphan();
        break;
Dries's avatar
 
Dries committed
735
      case t("Save book pages");
Dries's avatar
 
Dries committed
736
        print status(book_admin_save(arg(3), $edit));
Dries's avatar
 
Dries committed
737
        // fall through:
Dries's avatar
 
Dries committed
738
      case "view":
Dries's avatar
 
Dries committed
739
        print book_admin_view(arg(3));
Dries's avatar
 
Dries committed
740
        break;
741 742 743
      case "help":
        book_help();
        break;
Dries's avatar
 
Dries committed
744 745 746 747 748
      default:
    }
  }
}

749 750
function book_help() {
  ?>
Dries's avatar
 
Dries committed
751
<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>
752

Dries's avatar
 
Dries committed
753 754 755 756
<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
757
<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
758

Dries's avatar
 
Dries committed
759
<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>
760

Dries's avatar
Dries committed
761
<a name="faq"></a><h3>Maintain a FAQ using a collaborative book</h3>
Dries's avatar
 
Dries committed
762 763 764

<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
765
<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
766 767

<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>
768 769 770

<p>Notes:</p>
<ul>
Dries's avatar
 
Dries committed
771 772 773
 <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
774
 <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
775
 <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>
776 777
</ul>
  <?php
778
}
Dries's avatar
 
Dries committed
779
?>