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

Dries's avatar
 
Dries committed
4 5 6
function book_node($field) {
  global $user;

Dries's avatar
 
Dries committed
7
  $info["name"] = t("book page");
Dries's avatar
 
Dries committed
8
  $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
9 10 11 12 13

  return $info[$field];
}

function book_access($op, $node) {
Dries's avatar
 
Dries committed
14
  global $user;
Dries's avatar
 
Dries committed
15 16

  if ($op == "view") {
Dries's avatar
 
Dries committed
17 18 19 20 21 22 23 24
    /*
    ** 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
25 26
  }

Dries's avatar
 
Dries committed
27
  if ($op == "create") {
Dries's avatar
 
Dries committed
28 29 30 31 32 33
    /*
    ** Only registered users can create book pages.  Given the nature
    ** of the book module this is considered to be a good/safe idea.
    */

    return $user->uid;
Dries's avatar
 
Dries committed
34 35 36
  }

  if ($op == "update") {
Dries's avatar
 
Dries committed
37
    /*
Dries's avatar
 
Dries committed
38 39 40 41 42 43 44
    ** 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
45
    */
Dries's avatar
 
Dries committed
46 47

    return $user->uid && !$node->moderate && !$node->format && $node->revision;
Dries's avatar
 
Dries committed
48
  }
Dries's avatar
 
Dries committed
49 50
}

Dries's avatar
 
Dries committed
51
function book_save($op, $node) {
Dries's avatar
 
Dries committed
52
  global $user;
Dries's avatar
 
Dries committed
53 54 55 56 57 58

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

  if ($op == "create") {
Dries's avatar
 
Dries committed
59
    if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
60 61 62 63 64
      return array("format", "parent", "weight");
    }
    else {
      return array("format", "moderate" => 1, "parent", "promote" => 0, "status" => 1, "weight");
    }
Dries's avatar
 
Dries committed
65 66 67 68 69 70 71
  }

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

  if ($op == "update") {
Dries's avatar
 
Dries committed
72
    if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
73
      /*
Dries's avatar
 
Dries committed
74 75
      ** 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
76 77
      */

Dries's avatar
 
Dries committed
78
      return array("format", "parent", "weight");
Dries's avatar
 
Dries committed
79
    }
Dries's avatar
 
Dries committed
80
    else {
Dries's avatar
 
Dries committed
81
      /*
Dries's avatar
 
Dries committed
82 83 84
      ** 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
85 86
      */

Dries's avatar
 
Dries committed
87
      return array("created" => time(), "format", "moderate" => 1, "parent", "promote" => 0, "score" => 0, "status" => 1, "users" => "", "revisions", "votes" => 0, "weight");
Dries's avatar
 
Dries committed
88 89 90 91 92
    }
  }

}

Dries's avatar
 
Dries committed
93
function book_link($type, $node = 0, $main = 0) {
Dries's avatar
 
Dries committed
94
  if ($type == "page" && user_access("access content")) {
Dries's avatar
 
Dries committed
95 96 97
    $links[] = "<a href=\"module.php?mod=book\" title=\"". t("Read and contribute to the collaborative books.") ."\">". t("collaborative book") ."</a>";
  }

98
  if ($type == "menu.create" && user_access("post content")) {
Dries's avatar
 
Dries committed
99
    $links[] = "<a href=\"module.php?mod=node&op=add&type=book\" title=\"". t("Add a new book page.") ."\">". t("create book page") ."</a>";
Dries's avatar
 
Dries committed
100
  }
Dries's avatar
 
Dries committed
101

Dries's avatar
 
Dries committed
102 103 104 105
  if ($type == "admin" && user_access("administer nodes")) {
    $links[] = "<a href=\"admin.php?mod=book\">". t("collaborative book") ."</a>";
  }

Dries's avatar
 
Dries committed
106
  if ($type == "node" && $node->type == "book" && book_access("update", $node)) {
Dries's avatar
 
Dries committed
107
    $links[] = "<a href=\"module.php?mod=node&op=edit&id=$node->nid\" title=\"". t("Suggest an update for this book page.") ."\">". t("edit this page") ."</a>";
Dries's avatar
 
Dries committed
108 109
  }

Dries's avatar
 
Dries committed
110
  return $links ? $links : array();
Dries's avatar
 
Dries committed
111 112
}

Dries's avatar
 
Dries committed
113
function book_load($node) {
Dries's avatar
 
Dries committed
114 115
  global $user, $REQUEST_URI;

Dries's avatar
 
Dries committed
116
  $book = db_fetch_object(db_query("SELECT format, parent, weight FROM book WHERE nid = '$node->nid'"));
Dries's avatar
 
Dries committed
117 118

  if (strstr($REQUEST_URI, "module.php?mod=node&op=edit")) {
Dries's avatar
 
Dries committed
119

Dries's avatar
 
Dries committed
120 121 122 123 124 125 126
    /*
    ** 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
127 128 129 130 131 132 133 134
    if ($user->uid) {
      $book->uid = $user->uid;
      $book->name = $user->name;
    }
    else {
      $book->uid = 0;
      $book->name = "";
    }
Dries's avatar
 
Dries committed
135
  }
Dries's avatar
 
Dries committed
136

Dries's avatar
 
Dries committed
137 138 139
  /*
  ** 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
140
  ** always such that the "edit this page"-links appear.
Dries's avatar
 
Dries committed
141
  */
Dries's avatar
 
Dries committed
142

Dries's avatar
 
Dries committed
143
  $book->revision = 1;
Dries's avatar
 
Dries committed
144

Dries's avatar
 
Dries committed
145
  return $book;
Dries's avatar
 
Dries committed
146 147
}

Dries's avatar
 
Dries committed
148
function book_insert($node) {
Dries's avatar
 
Dries committed
149 150 151 152 153 154
  if (!user_access("administer nodes")) {
    $node->format = 0;
    $node->weight = 0;
  }

  db_query("INSERT INTO book (nid, format, parent, weight) VALUES ('$node->nid', '$node->format', '$node->parent', '$node->weight')");
Dries's avatar
 
Dries committed
155
}
Dries's avatar
 
Dries committed
156

Dries's avatar
 
Dries committed
157
function book_update($node) {
Dries's avatar
 
Dries committed
158 159 160 161 162 163
  if (!user_access("administer nodes")) {
    $node->format = 0;
    $node->weight = 0;
  }

  db_query("UPDATE book SET format = '$node->format', parent = '$node->parent', weight = '$node->weight' WHERE nid = '$node->nid'");
Dries's avatar
 
Dries committed
164
}
Dries's avatar
 
Dries committed
165

166
function book_delete(&$node) {
Dries's avatar
 
Dries committed
167
  db_query("DELETE FROM book WHERE nid = '$node->nid'");
Dries's avatar
 
Dries committed
168 169
}

170
function book_form(&$node, &$help, &$error) {
Dries's avatar
 
Dries committed
171
  global $user, $op;
Dries's avatar
 
Dries committed
172 173

  $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
174

Dries's avatar
 
Dries committed
175 176 177 178 179 180 181 182 183
  if ($node->format) {
    if ($op != t("Preview")) {
      $node->body = addslashes($node->body);
    }
  }
  else {
    if ($node->teaser) {
      $output .= form_textarea(t("Teaser"), "teaser", $node->teaser, 60, 5, $error["teaser"]);
    }
Dries's avatar
 
Dries committed
184 185 186
  }

  $output .= form_textarea(t("Body"), "body", $node->body, 60, 20, t("Allowed HTML tags") .": ". htmlspecialchars(variable_get("allowed_html", "")));
Dries's avatar
 
Dries committed
187 188 189
  $output .= form_textarea(t("Log message"), "history", $node->history, 60, 5, t("An explanation of the additions or updates being made to help the group understand your motivations."));

  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
190 191
    $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."));
    $output .= form_select("Type", "format", $node->format, array(0 => "HTML / text", 1 => "PHP"));
Dries's avatar
 
Dries committed
192 193 194 195 196 197 198
  }
  else {

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

Dries's avatar
 
Dries committed
199 200
    $help = book_node("description");

Dries's avatar
 
Dries committed
201 202 203 204 205 206 207 208 209 210 211
    /*
    ** 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
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
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")) {
      db_query("INSERT INTO book (nid, parent, weight) VALUES ('$node->nid', '". check_query($edit["parent"]) ."', '". check_query($edit["weight"]) ."')");
      $output .= status(t("added the node to the book."));
    }

    if ($op == t("Update book outline")) {
      db_query("UPDATE book SET parent = '". check_query($edit["parent"]) ."', weight = '". check_query($edit["weight"]) ."' WHERE nid = '$node->nid'");
      $output .= status(t("updated the book outline."));
    }

    if ($op == t("Remove from book outline")) {
      db_query("DELETE FROM book WHERE nid = '$node->nid'");
      $output .= status(t("removed the node form the book."));
    }

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

    if ($edit["nid"]) {
      $page = db_fetch_object(db_query("SELECT * FROM book WHERE nid = '$node->nid'"));

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

    return form($output, "post", "admin.php?mod=book&op=outline");
  }
}

Dries's avatar
 
Dries committed
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 292 293 294 295 296 297 298 299 300 301
/*
** 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
302
function book_location($node, $nodes = array()) {
Dries's avatar
 
Dries committed
303
  $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 = '$node->parent'"));
Dries's avatar
 
Dries committed
304 305 306 307 308 309 310
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

Dries's avatar
 
Dries committed
311 312 313 314 315 316 317 318
function book_body($node) {
  global $theme, $op;

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

Dries's avatar
 
Dries committed
319
    if ($op == t("Preview")) {
Dries's avatar
 
Dries committed
320
      if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
321 322 323 324 325
        $node->body = stripslashes($node->body);  // see also book_form()
      }
      else {
        return;
      }
Dries's avatar
 
Dries committed
326 327 328 329 330 331 332 333
    }

    ob_start();
    eval($node->body);
    $output = ob_get_contents();
    ob_end_clean();
  }
  else {
Dries's avatar
 
Dries committed
334
    $output = check_output(filter($node->body), 1);
Dries's avatar
 
Dries committed
335 336 337 338 339
  }

  return $output;
}

Dries's avatar
 
Dries committed
340
function book_view($node, $main = 0) {
Dries's avatar
 
Dries committed
341 342 343 344
  global $theme, $mod;

  /*
  ** Always display the most recently approved revision of a node
Dries's avatar
 
Dries committed
345 346
  ** (if any) unless we have to display this page in the context of
  ** the moderation queue.
Dries's avatar
 
Dries committed
347 348 349
  */

  if ($node->moderate && $mod != "queue") {
Dries's avatar
 
Dries committed
350 351 352 353 354
    $revision = book_revision_load($node, array("moderate" => 0, "status" => 1));

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
 
Dries committed
355 356
  }

Dries's avatar
 
Dries committed
357 358 359 360 361 362 363
  /*
  ** 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
364 365 366 367 368
  /*
  ** 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
369

Dries's avatar
 
Dries committed
370 371
  if ($main) {
    $theme->node($node, $main);
Dries's avatar
 
Dries committed
372
  }
Dries's avatar
 
Dries committed
373
  else {
Dries's avatar
 
Dries committed
374 375 376 377
    /*
    ** Construct the "next" and "previous" links:
    */

Dries's avatar
 
Dries committed
378
    if ($node->nid && $node->parent) {
379 380
      $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 = '$node->parent' AND (b.weight > '$node->weight' OR (b.weight = '$node->weight' AND n.title > '". check_query($node->title) ."')) AND (n.moderate = 0 OR n.revisions != '') ORDER BY b.weight ASC, n.title ASC"));
      $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 = '$node->parent' AND (b.weight < '$node->weight' OR (b.weight = '$node->weight' AND n.title < '". check_query($node->title) ."')) AND (n.moderate = 0 OR n.revisions != '') ORDER BY b.weight DESC, n.title DESC"));
Dries's avatar
 
Dries committed
381
    }
Dries's avatar
 
Dries committed
382

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

Dries's avatar
 
Dries committed
385 386
    if ($node->title) {
      foreach (book_location($node) as $level) {
Dries's avatar
 
Dries committed
387
        $location .= "$indent <a href=\"node.php?id=$level->nid\">$level->title</a><br />";
Dries's avatar
 
Dries committed
388 389
        $indent .= "-";
      }
Dries's avatar
 
Dries committed
390

Dries's avatar
 
Dries committed
391
      $output .= " <tr><td colspan=\"3\">$location</td></tr>";
Dries's avatar
 
Dries committed
392
      $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
393
      $output .= " <tr><td colspan=\"3\"><b><big>". check_output($node->title) ."</big></b>". ($node->body ? "<br /><small><i>". strtr(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
394
    }
Dries's avatar
 
Dries committed
395

Dries's avatar
 
Dries committed
396
    if ($node->body) {
Dries's avatar
 
Dries committed
397
      $output .= " <tr><td colspan=\"3\"><br />$node->body</td></tr>";
Dries's avatar
 
Dries committed
398
    }
Dries's avatar
 
Dries committed
399

Dries's avatar
 
Dries committed
400
    if ($node->nid) {
Dries's avatar
 
Dries committed
401
      $output .= " <tr><td colspan=\"3\"><br />". book_tree($node->nid) ."</td></tr>";
Dries's avatar
 
Dries committed
402
    }
Dries's avatar
 
Dries committed
403

Dries's avatar
 
Dries committed
404
    $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
Dries's avatar
 
Dries committed
405
    $output .= " <tr><td align=\"left\" width=\"33%\">". ($prev ? "<a href=\"node.php?id=$prev->nid\" title=\"". t("View the previous page in this book.") ."\">". t("previous") ."</a>" : t("previous")) ."</td><td align=\"center\" width=\"34%\"><a href=\"module.php?mod=book\" title=\"". t("View this book's table of contents.") ."\">index</a></td><td align=\"right\" width=\"33%\">". ($next ? "<a href=\"node.php?id=$next->nid\" title=\"". t("View the next page in this book.") ."\">". t("next") ."</a>" : t("next")) ."</td></tr>";
Dries's avatar
 
Dries committed
406
    $output .= " <tr><td align=\"left\" width=\"33%\">". ($prev ? "<small>". check_output($prev->title) ."</small>" : "&nbsp;") ."</td><td align=\"center\" width=\"34%\">". ($node->parent ? "<a href=\"node.php?id=$node->parent\" title=\"". t("View this page's parent section.") ."\">". t("up") ."</a>" : t("up")) ."</td><td align=\"right\" width=\"33%\">". ($next ? "<small>". check_output($next->title) ."</small>" : "&nbsp;") ."</td></tr>";
Dries's avatar
 
Dries committed
407 408
    $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
    $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
409
    $output .= "</table>";
Dries's avatar
 
Dries committed
410

Dries's avatar
 
Dries committed
411 412
    $theme->box(t("Handbook"), $output);
  }
Dries's avatar
 
Dries committed
413 414
}

Dries's avatar
 
Dries committed
415 416 417 418 419 420 421 422 423 424 425 426
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
427
function book_toc($parent = 0, $indent = "", $toc = array()) {
Dries's avatar
 
Dries committed
428

429
  $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
430

Dries's avatar
 
Dries committed
431 432 433 434 435
  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
436 437

  /*
Dries's avatar
 
Dries committed
438 439
  ** If the user is an administrator, add the root node; only
  ** administrators can start new books.
Dries's avatar
 
Dries committed
440
  */
Dries's avatar
 
Dries committed
441

Dries's avatar
 
Dries committed
442
  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
443
    $toc[0] = "<root>";
Dries's avatar
 
Dries committed
444 445
  }

Dries's avatar
 
Dries committed
446
  /*
Dries's avatar
 
Dries committed
447
  ** Iterate root book nodes:
Dries's avatar
 
Dries committed
448 449
  */

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

Dries's avatar
 
Dries committed
452 453 454
  return $toc;
}

Dries's avatar
 
Dries committed
455

Dries's avatar
 
Dries committed
456
function book_tree_recurse($nid, $depth, $children) {
Dries's avatar
 
Dries committed
457

Dries's avatar
 
Dries committed
458
  if ($depth > 0) {
Dries's avatar
 
Dries committed
459 460
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
Dries's avatar
 
Dries committed
461
        $output .= "<li><a href=\"node.php?id=$node->nid\">". check_output($node->title) ."</a></li>";
Dries's avatar
 
Dries committed
462 463 464 465

        if ($tree = book_tree_recurse($node->nid, $depth - 1, $children)) {
          $output .= "<ul>$tree</ul>";
        }
Dries's avatar
 
Dries committed
466 467
      }
    }
Dries's avatar
 
Dries committed
468 469 470 471 472
  }

  return $output;
}

Dries's avatar
 
Dries committed
473

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

476
  $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
477

Dries's avatar
 
Dries committed
478 479 480 481
  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
482
  }
Dries's avatar
 
Dries committed
483

Dries's avatar
 
Dries committed
484 485
  $output = book_tree_recurse($parent, $depth, $children);
  $output = "<ul>$output</ul>";
Dries's avatar
 
Dries committed
486

Dries's avatar
 
Dries committed
487 488 489
  return $output;
}

Dries's avatar
 
Dries committed
490

Dries's avatar
 
Dries committed
491
function book_render() {
Dries's avatar
 
Dries committed
492
  global $theme;
Dries's avatar
Dries committed
493

494
  $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");
Dries's avatar
 
Dries committed
495

Dries's avatar
 
Dries committed
496 497 498 499 500 501
  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
502
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
503 504
    }

Dries's avatar
 
Dries committed
505 506
    if ($node) {
      // output the content:
Dries's avatar
 
Dries committed
507
      $output .= "<dt><a href=\"node.php?id=$node->nid\">". check_output($node->title) ."</a></dt><dd>". book_body($node) ."<br /><br /></dd>";
Dries's avatar
 
Dries committed
508
    }
Dries's avatar
 
Dries committed
509 510 511
  }

  $theme->header();
Dries's avatar
 
Dries committed
512
  $theme->box(t("Handbook"), "<dl>$output</dl>");
Dries's avatar
 
Dries committed
513 514 515 516 517 518
  $theme->footer();
}

function book_page() {
  global $op, $id, $theme;

Dries's avatar
 
Dries committed
519
  if (user_access("access content")) {
Dries's avatar
 
Dries committed
520 521
    switch ($op) {
      case "feed":
Dries's avatar
 
Dries committed
522
        print book_export_html($id, $depth = 1);
Dries's avatar
 
Dries committed
523 524 525
        break;
      default:
        book_render();
Dries's avatar
 
Dries committed
526 527 528 529 530 531 532
    }
  }
  else {
    $theme->header();
    $theme->box(t("Access denied"), message_access());
    $theme->footer();
  }
Dries's avatar
 
Dries committed
533 534
}

Dries's avatar
 
Dries committed
535
function book_export_html($id = "", $depth = 1) {
Dries's avatar
 
Dries committed
536
  $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 = '". check_input($id) ." AND (n.moderate = 0 OR n.revisions != '')'");
Dries's avatar
 
Dries committed
537

Dries's avatar
 
Dries committed
538 539 540
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));
Dries's avatar
 
Dries committed
541

Dries's avatar
 
Dries committed
542 543
    // take the most recent approved revision:
    if ($node->moderate) {
Dries's avatar
 
Dries committed
544
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
545 546
    }

Dries's avatar
 
Dries committed
547 548 549
    if ($node) {
      // output the content:
      $output .= "<h$depth>". check_output($node->title) ."</h$depth>";
Dries's avatar
 
Dries committed
550

Dries's avatar
 
Dries committed
551
      if ($node->body) {
Dries's avatar
 
Dries committed
552
        $output .= "<ul>". book_body($node) ."</ul>";
Dries's avatar
 
Dries committed
553
      }
Dries's avatar
 
Dries committed
554
    }
Dries's avatar
 
Dries committed
555
  }
Dries's avatar
 
Dries committed
556

Dries's avatar
 
Dries committed
557
  $output .= book_export_html_recurse($id, $depth);
Dries's avatar
 
Dries committed
558 559 560 561

  return $output;
}

Dries's avatar
 
Dries committed
562
function book_export_html_recurse($parent = "", $depth = 1) {
Dries's avatar
 
Dries committed
563
  $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");
Dries's avatar
 
Dries committed
564

Dries's avatar
 
Dries committed
565 566 567 568 569 570
  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
571
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
572 573
    }

Dries's avatar
 
Dries committed
574 575 576
    if ($node) {
      // output the content:
      $output .= "<h$depth>". check_output($node->title) ."</h$depth>";
Dries's avatar
 
Dries committed
577

Dries's avatar
 
Dries committed
578
      if ($node->body) {
Dries's avatar
 
Dries committed
579
        $output .= "<ul>". book_body($node) ."</ul>";
Dries's avatar
 
Dries committed
580
      }
Dries's avatar
 
Dries committed
581

Dries's avatar
 
Dries committed
582
      $output .= book_export_html_recurse($node->nid, $depth + 1);
Dries's avatar
 
Dries committed
583
    }
Dries's avatar
 
Dries committed
584
  }
Dries's avatar
 
Dries committed
585

Dries's avatar
 
Dries committed
586 587
  return $output;
}
Dries's avatar
 
Dries committed
588

Dries's avatar
 
Dries committed
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
function book_admin_view_line($node, $depth = 0) {

  /*
  ** Extract the revision number:
  */

  if ($list = node_revision_list($node)) {
    $revision = end($list);
  }
  else {
    $revision = 0;
  }

  /*
  ** Diplay the book page:
  */

  $output .= "<tr>";
  $output .= " <td><div style=\"padding-left: ". (25 * $depth) ."px;\"><a href=\"node.php?id=$node->nid\">". check_output($node->title) ."</a></div></td>";
  $output .= " <td align=\"center\">$revision</td>";
609
  $output .= " <td><a href=\"admin.php?mod=node&op=edit&id=$node->nid\">". t("edit node") ."</td>";
610
  //TODO: get this link to work. Must pass $nid along so it is received by book_node_link()
611 612
  //$output .= " <td><a href=\"admin.php?mod=book&nid=$node->nid&op=Edit+book+outline\">". t("edit book outline") ."</td>";
  $output .= " <td><a href=\"admin.php?mod=node&op=delete&id=$node->nid\">". t("delete node") ."</td>";
Dries's avatar
 
Dries committed
613 614 615 616 617 618
  $output .= "</tr>";

  return $output;
}

function book_admin_view_book($nid, $depth = 1) {
Dries's avatar
 
Dries committed
619 620
  $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);

Dries's avatar
 
Dries committed
621
  $result = db_query("SELECT n.nid FROM node n LEFT JOIN book b ON n.nid = b.nid WHERE b.parent = '$nid' ORDER BY b.weight, n.title");
Dries's avatar
 
Dries committed
622 623 624

  while ($node = db_fetch_object($result)) {
    $node = node_load(array("nid" => $node->nid));
Dries's avatar
 
Dries committed
625 626
    $output .= book_admin_view_line($node, $depth);
    $output .= book_admin_view_book($node->nid, $depth + 1);
Dries's avatar
 
Dries committed
627 628 629 630 631 632 633 634 635 636 637
  }

  return $output;
}

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

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

  $output .= "<h3>". check_output($node->title) ."</h3>";
  $output .= "<table border=\"1\" cellpadding=\"2\" cellspacing=\"2\">";
638
  //TODO: change colspan below to 3 after adding new link in book_admin_view_line()
Dries's avatar
 
Dries committed
639
  $output .= " <tr><th>title</th><th>rev</th><th colspan=\"2\">operations</th></tr>";
Dries's avatar
 
Dries committed
640 641
  $output .= book_admin_view_line($node);
  $output .= book_admin_view_book($nid);
Dries's avatar
 
Dries committed
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
  $output .= "</table>";

  return $output;
}

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

  $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])) {
      $output .= "<tr><td><a href=\"node.php?id=$node->nid\">". check_output($node->title) ."</a></td><td><a href=\"admin.php?mod=node&op=edit&id=$node->nid\">". t("edit page") ."</td><td><a href=\"admin.php?mod=node&op=delete&id=$node->nid\">". t("delete page") ."</td>";
    }
  }
  $output .= "</table>";

  return $output;
}

function book_admin_links() {
  $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)) {
    $links[] = "<a href=\"admin.php?mod=book&op=view&id=$book->nid\">". t("book") .": <i>". check_output($book->title) ."</i></a>";
  }
673 674 675
  $links[] = "<a href=\"admin.php?mod=book&op=orphan\">". t("orphan pages") ."</a>";
  $links[] = "<a href=\"module.php?mod=book&op=feed\" title=\"" . t("display all books in a single HTML page") . ".\">" . t("export to HTML") . "</a>";
  $links[] = "<a href=\"admin.php?mod=book&op=help\">" . t("help") . "</a>";
Dries's avatar
 
Dries committed
676 677 678 679 680 681 682 683 684 685 686 687 688
  return $links;
}

function book_admin() {
  global $id, $op;

  if (user_access("administer nodes")) {

    /*
    ** Compile a list of the administrative links:
    */

    $links = book_admin_links();
689

Dries's avatar
 
Dries committed
690 691 692
    print "<small>". implode(" &middot; ", $links) ."</small><hr />";

    switch ($op) {
Dries's avatar
 
Dries committed
693 694 695 696 697 698
      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
699 700 701 702 703 704
      case "orphan":
        print book_admin_orphan();
        break;
      case "view":
        print book_admin_view($id);
        break;
705 706 707
      case "help":
        book_help();
        break;
Dries's avatar
 
Dries committed
708 709 710 711 712
      default:
    }
  }
}

713 714
function book_help() {
  ?>
715

716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
<p>The Collaborative Book is a magnificient mechanism for organizing content authored by many users.
You may use it to organize a Manual (e.g. <a href="http://www.drupal.org">Drupal Handbook</a>),
to <a href="#faq">maintain an 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>

<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 'Log Message'
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>

<p>Like other node types, Book submissions and edits may be subject to moderation, depending on your configuration.
Similarly, Books use <a href="/admin.php?mod=user&op=permission">permissions</a> 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 Admin 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>

<p>Administrators may review the hierarchy of their books by clicking on the <a href="/admin.php?mod=book">Collaborative Book link</a>
in the Admin center. 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 <a href="/admin.php?mod=book&op=orphan">
review their books for orphans</a> and reaffiliate those pages as desired. Finally, administrators may also
<a href="/admin.php?mod=book&op=feed">export their books</a> to a single, flat HTML page which is suitable for printing.</p>

<a name="faq"></a><h3>Maintain an FAQ with <i>Collaborative Book</i></h3>

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

<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><root></i> as the Parent of this page. Leave
the <i>Log Message</i> and <i>Type</i> fields blank for now. After you've
submitted this book page, you are ready to begin filling up your book with
Questions that are Frequently Asked.</p>

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

<p>Notes:</p>
<ul>
<li>any comments attached to those relevant posts which you designate as book
pages will also be transported into your book. This is a great feature, since
much wisdom is shared via comments. 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>
<li>If you don't see the <i>administer</i> link, then you probably have
insufficient <a
href="/admin.php?mod=user&op=permission">permissions</a>.</li>
<li>If you want to get really fancy, note that Books are one of the few
content types which allow raw PHP in their <i>body</i>. So you've got lots of
geeky possibilities there.</li>
</ul>

  <?php
795 796

}
Dries's avatar
 
Dries committed
797
?>