book.module 30.8 KB
Newer Older
1
<?php
2
// $Id$
3

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.");
9 10 11 12

  return $info[$field];
}

Dries's avatar
Dries committed
13 14 15 16
function book_perm() {
  return array("maintain books");
}

17
function book_access($op, $node) {
18
  global $user;
19 20

  if ($op == "view") {
21 22 23 24 25 26 27 28
    /*
    ** 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;
29 30
  }

31
  if ($op == "create") {
Dries's avatar
Dries committed
32 33 34 35 36
    /*
    ** 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
37
    return user_access("maintain books");
38 39 40
  }

  if ($op == "update") {
Dries's avatar
Dries committed
41
    /*
Dries's avatar
Dries committed
42 43
    ** Only registered users can update book pages.  Given the nature
    ** of the book module this is considered to be a good/safe idea.
44
    ** One can only update a book page if there are no suggested updates
Dries's avatar
Dries committed
45 46 47 48
    ** 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
49
    */
Dries's avatar
Dries committed
50

Dries's avatar
Dries committed
51
    return user_access("maintain books") && !$node->moderate && !$node->format && $node->revision;
Dries's avatar
Dries committed
52
  }
53 54
}

55
function book_link($type, $node = 0, $main = 0) {
Dries's avatar
Dries committed
56 57 58

  $links = array();

59
  if ($type == "page" && user_access("access content")) {
60
    $links[] = l(t("books"), "book", array("title" => t("Read and contribute to the collaborative books.")));
61 62
  }

63 64 65 66
  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.")));
    }
67 68 69
    if (!$main) {
      $links[] = l(t("printer-friendly version"), "book/print/$node->nid", array("title" => t("Show a printer-friendly version of this book page and its sub-pages.")));
    }
70 71
  }

72 73
  if ($type == "system") {
    if (user_access("maintain books")) {
74
      menu("node/add/book", t("book page"), "book_page", 0);
75
      menu("admin/node/book", t("books"), "book_admin", 4);
76 77
      menu("admin/node/book/orphan", t("orphan pages"), "book_admin_orphan", 8);
      menu("admin/node/book/help", t("help"), "book_help", 9);
78 79 80

      $result = db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = 0 ORDER BY b.weight, n.title");
      while ($book = db_fetch_object($result)) {
81
        menu("admin/node/book/$book->nid", t("'%title' book", array("%title" => $book->title)), "book_admin");
82
      }
83
    }
84

85 86
  }

Dries's avatar
Dries committed
87
  return $links;
88 89
}

90
function book_load($node) {
91
  global $user;
92

93
  $book = db_fetch_object(db_query("SELECT format, parent, weight, log FROM {book} WHERE nid = %d", $node->nid));
94

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

97 98
    /*
    ** If a user is about to update a book page, we overload some
99
    ** fields to reflect the changes.  We use the request URI to
100
    ** dectect this as we don't want to interfer with updating a
Dries's avatar
Dries committed
101
    ** book page through the admin pages.
102 103
    */

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

Dries's avatar
Dries committed
114 115 116
  /*
  ** 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
117
  ** always such that the "edit this page"-links appear.
Dries's avatar
Dries committed
118
  */
Dries's avatar
Dries committed
119

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

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

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

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

133
function book_delete(&$node) {
134
  db_query("DELETE FROM {book} WHERE nid = %d", $node->nid);
135 136
}

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

146 147 148 149 150 151
  // Set default values for non administrators:
  if (!user_access("administer nodes")) {
    $node->format = 0;
    $node->weight = 0;
    $node->revision = 1;
  }
152 153
}

154
function book_form(&$node, &$help, &$error) {
155
  global $user;
Dries's avatar
Dries committed
156

157
  $op = $_POST["op"];
158
  $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
159

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

164
  $output .= form_textarea(t("Body"), "body", $node->body, 60, 20, form_allowed_tags_text());
165
  $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
166 167

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

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

Dries's avatar
Dries committed
179 180
    $help = book_node("description");

Dries's avatar
Dries committed
181 182 183 184 185 186 187 188 189 190 191
    /*
    ** 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
192
function book_node_link($node = 0) {
193 194 195 196
  global $user;

  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
Dries committed
197 198 199 200 201 202 203 204

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

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

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

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

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

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

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

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

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

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

246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
/*
** Return the the most recent revision that matches the specified
** conditions.
*/

function book_revision_load($page, $conditions = array()) {

  $revisions = array_reverse(node_revision_list($page));

  foreach ($revisions as $revision) {

    /*
    ** Extract the specified revision:
    */

    $node = node_revision_load($page, $revision);

    /*
    ** Check to see if the conditions are met:
    */

    $status = 1;

    foreach ($conditions as $key => $value) {
      if ($node->$key != $value) {
        $status = 0;
      }
    }

    if ($status) {
      return $node;
    }
  }
}

/*
** Return the path (call stack) to a certain book page.
*/
Dries's avatar
Dries committed
284
function book_location($node, $nodes = array()) {
285
  $parent = db_fetch_object(db_query("SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.nid = %d", $node->parent));
Dries's avatar
Dries committed
286 287 288 289 290 291 292
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

293
function book_location_down($node, $nodes = array()) {
294
  $last_direct_child = db_fetch_object(db_query("SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d ORDER BY b.weight DESC, n.title DESC", $node->nid));
295 296 297 298 299 300 301 302
  if ($last_direct_child) {
    array_push($nodes, $last_direct_child);
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

function book_prev($node) {
303 304 305 306 307
  // if the parent is zero, we are at the start of a book so there is no previous
  if ($node->parent == 0) {
    return NULL;
  }

308
  // previous on the same level
309
  $direct_above = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '') AND (b.weight < %d OR (b.weight = %d AND n.title < '%s')) ORDER BY b.weight DESC, n.title DESC", $node->parent, $node->weight, $node->weight, $node->title));
310 311 312
  if ($direct_above) {
    // get last leaf of $above
    $path = book_location_down($direct_above);
313 314

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
315 316 317
  }
  else {
    // direct parent
318
    $prev = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.nid = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '')", $node->parent));
319 320 321 322 323 324
    return $prev;
  }
}

function book_next($node) {
  // get first direct child
325
  $child = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '') ORDER BY b.weight ASC, n.title ASC", $node->nid));
326 327 328 329
  if ($child) {
    return $child;
  }

Dries's avatar
Dries committed
330
  // no direct child: get next for this level or any parent in this book
331
  array_push($path = book_location($node), $node); // path to root node including this one
Dries's avatar
Dries committed
332 333
  // loop through nodes to book root, starting with this node
  while (($leaf = array_pop($path)) && count($path)) {
334
    $next = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '') AND (b.weight > %d OR (b.weight = %d AND n.title > '%s')) ORDER BY b.weight ASC, n.title ASC", $leaf->parent, $leaf->weight, $leaf->weight, $leaf->title));
335 336 337 338 339 340
    if ($next) {
      return $next;
    }
  }
}

341
function book_content($node) {
342
  $op = $_POST["op"];
Dries's avatar
Dries committed
343

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

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

    if ($revision) {
      $node = $revision;
    }
356 357
  }

Dries's avatar
Dries committed
358 359 360 361 362
  /*
  ** Extract the page body.  If body is dynamic (using PHP code), the body
  ** will be generated.
  */

363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
  if ($node->format == 1) {
    // Make sure only authorized users can preview PHP pages.
    if ($op == t("Preview") && !user_access("create php content")) {
      return;
    }

    ob_start();
    eval($node->body);
    $node->teaser = $node->body = ob_get_contents();
    ob_end_clean();
  }
  else {
    $node->teaser = check_output($node->teaser);
    $node->body = check_output($node->body);
  }
Dries's avatar
Dries committed
378

379 380 381 382 383
  return $node;
}

function book_view($node, $main = 0) {
  $node = book_content($node);
384 385 386 387 388
  /*
  ** 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.
  */
389

390
  if ($main) {
391
    theme("node", $node, $main);
Dries's avatar
Dries committed
392
  }
393
  else {
394 395 396
    if ($node->moderate) {
      $node->body = $node->body . "<div class=\"log\"><div class=\"title\">". t("Log") .":</div>$node->log</div>";
    }
397 398
    // Add the navigation and the breadcrumb if we view a page
    if (arg(1) == "view") {
399
      $node = book_navigation($node);
400 401
      // Print the breadcrumb
      theme("breadcrumb", $node->breadcrumb);
402
    }
403 404
    // Print the node
    theme("node", $node, $main);
405 406 407 408 409
  }
}

function book_show($node, $cid) {

410
  if (node_access("view", $node)) {
411

412
    if ($node->type == "book") {
413
      book_view($node, 0);
414 415
    }
    else {
416

417 418
      if (module_hook($node->type, "content")) {
        $node = node_invoke($node, "content");
419

420 421 422
        /*
        ** Add the book navigation if the node is in the book.
        */
423

424
        $book = db_fetch_object(db_query("SELECT * FROM {book} WHERE nid = %d", $node->nid));
425

426 427 428 429 430 431
        if ($book) {
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
          $node = book_navigation($node);
        }
432

433 434 435
        /*
        ** make $node->type a book. This is for the links.
        */
436

437
        $node->type = "book";
438

439 440 441 442
        /*
        ** View the node
        */
        theme("breadcrumb", $node->breadcrumb);
443
        theme("node", $node, 0);
444 445 446 447 448 449 450 451 452 453
      }
      else {

        /*
        ** We can't get the content of the node and just view the node.
        ** We don't add breadcrums or links.
        */
        node_view($node, 0);
      }
    }
454 455 456 457
    if (function_exists("comment_render") && $node->comment) {
      comment_render($node, $cid);
    }

Dries's avatar
Dries committed
458
    /*
459
    ** Update the history table, stating that this user viewed this node.
Dries's avatar
Dries committed
460
    */
461 462 463
    node_tag_new($node->nid);
  }
}
Dries's avatar
Dries committed
464

465
function book_navigation($node) {
Dries's avatar
Dries committed
466

467
    $path = book_location($node);
Dries's avatar
Dries committed
468

469 470 471 472 473 474 475 476 477
    /*
    ** Construct the breadcrumb:
    */

    $node->breadcrumb = ""; // Overwrite the trail with a book trail.
    $node->breadcrumb[] = l(t("Home"), "");
    $node->breadcrumb[] = l(t("Books"), "book");
    foreach ($path as $level) {
      $node->breadcrumb[] = l($level->title, "book/view/$level->nid");
478
    }
479

480 481 482
    /*
    ** Construct the "next" and "previous" links:
    */
483

484 485 486
    if ($node->nid) {
      $prev = book_prev($node);
      $next = book_next($node);
487 488
    }

489
    if ($node->nid) {
490
      $output .= "<div class=\"book\">";
491 492 493
      $output .= "<div class=\"tree\">". book_tree($node->nid) ."</div>";
      if ($prev) {
        $links .= "<div class=\"prev\">";
494
        $links .= l(t("previous"), "book/view/$prev->nid", array("title" => t("View the previous page in this book.")));
495 496 497 498 499
        $links .= "</div>";
        $titles .= "<div class=\"prev\">$prev->title</div>";
      }
      if ($next) {
        $links .= "<div class=\"next\">";
500
        $links .= l(t("next"), "book/view/$next->nid", array("title" => t("View the next page in this book.")));
501 502 503
        $links .= "</div>";
        $titles .= "<div class=\"next\">$next->title</div>";
      }
504 505 506
      else {
        $links .= "<div class=\"next\">&nbsp;</div>"; // make an empty div to fill the space
      }
507 508
      if ($node->parent) {
        $links .= "<div class=\"up\">";
509
        $links .= l(t("up"), "book/view/$node->parent", array("title" => t("View this page's parent section.")));
510 511 512 513
        //if ($node->parent != $path[0]->nid) {
        //  $links .= " | ";
        //  $links .= l(t("index"), "node/view/".$path[0]->nid."", array("title" => t("View this book's table of contents.")));
        //}
514 515 516 517 518 519
        $links .= "</div>";
      }
      $output .= "<div class=\"nav\">";
      $output .= "<div class=\"links\">$links</div>";
      $output .= "<div class=\"titles\">$titles</div>";
      $output .= "</div>";
520
      $output .= "</div>";
521
    }
522 523
    $node->body = $node->body.$output;
  return $node;
524
}
525

526 527 528 529 530 531 532 533 534 535 536 537
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
538
function book_toc($parent = 0, $indent = "", $toc = array()) {
539

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

542 543 544 545 546
  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
547 548

  /*
549 550
  ** If the user is an administrator, add the root node; only
  ** administrators can start new books.
Dries's avatar
Dries committed
551
  */
552

Dries's avatar
Dries committed
553
  if (user_access("administer nodes")) {
554
    $toc[0] = "<". t("root") .">";
555 556
  }

Dries's avatar
Dries committed
557
  /*
558
  ** Iterate root book nodes:
Dries's avatar
Dries committed
559 560
  */

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

563 564 565
  return $toc;
}

566

Dries's avatar
Dries committed
567
function book_tree_recurse($nid, $depth, $children) {
568

569
  if ($depth > 0) {
Dries's avatar
Dries committed
570 571
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
572
        $output .= "<li>";
573
        $output .= l($node->title, "book/view/$node->nid");
574 575 576
        if ($tree = book_tree_recurse($node->nid, $depth - 1, $children)) {
          $output .= "<ul>$tree</ul>";
        }
577
        $output .= "</li>";
Dries's avatar
Dries committed
578 579
      }
    }
Dries's avatar
Dries committed
580 581 582 583 584
  }

  return $output;
}

Dries's avatar
Dries committed
585

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

588
  $result = db_query("SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = '1' AND n.moderate = '0' ORDER BY b.weight, n.title");
589

Dries's avatar
Dries committed
590 591 592 593
  while ($node = db_fetch_object($result)) {
    $list = $children[$node->parent] ? $children[$node->parent] : array();
    array_push($list, $node);
    $children[$node->parent] = $list;
594
  }
595

Dries's avatar
Dries committed
596 597
  $output = book_tree_recurse($parent, $depth, $children);
  $output = "<ul>$output</ul>";
Dries's avatar
Dries committed
598

599 600 601
  return $output;
}

Dries's avatar
Dries committed
602

603
function book_render() {
604

605
  $result = db_query("SELECT n.nid FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = 0 AND n.status = 1 AND (n.moderate = 0 OR n.revisions IS NOT NULL) ORDER BY b.weight, n.title");
606

607 608 609 610
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));

611
    if ($node) {
612 613
      // take the most recent approved revision, extract the page and check output:
      $node = book_content($node);
614
      // output the content:
615
      $output .= "<div class=\"book\">";
616
      $output .= "<div class=\"title\">". l($node->title, "book/view/$node->nid") ."</div>";
617
      $output .= "<div class=\"body\">". $node->body ."</div>";
618
      $output .= "</div>";
619
    }
620 621
  }

622
  theme("header");
623
  theme("box", t("Books"), "$output");
624
  theme("footer");
625 626 627
}

function book_page() {
628

Dries's avatar
Dries committed
629
  if (user_access("access content")) {
Dries's avatar
Dries committed
630
    switch (arg(1)) {
631
      case "view":
Dries's avatar
Dries committed
632
        $node = node_load(array("nid" => arg(2)));
633 634 635 636
        theme("header");
        book_show($node, arg(3));
        theme("footer");
        break;
637
      case "print":
638
        print book_print(arg(2), $depth = 1);
639 640 641
        break;
      default:
        book_render();
642 643 644
    }
  }
  else {
645 646 647
    theme("header");
    theme("box", t("Access denied"), message_access());
    theme("footer");
648
  }
649 650
}

651
function book_print($id = "", $depth = 1) {
652
  global $base_url;
653
  $result = db_query("SELECT n.nid FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND n.nid = %d AND (n.moderate = 0 OR n.revisions IS NOT NULL) ORDER BY b.weight, n.title", $id);
654

655 656 657
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));
658

659 660
    if ($node) {
      // output the content:
661 662 663
      if (module_hook($node->type, "content")) {
        $node = node_invoke($node, "content");
      }
664
      $output .= "<h1 id=\"$node->nid\" name=\"$node->nid\" class=\"book-h$depth\">$node->title</h1>";
665

666
      if ($node->body) {
667
        $output .= $node->body;
668
      }
669
    }
670
  }
671

672
  $output .= book_print_recurse($id, $depth);
673

674 675 676 677 678 679
  $html = "<html><head><title>$node->title</title>";
  $html .= "<base href=\"$base_url/\" />";
  $html .= "<style type=\"text/css\">\n@import url(misc/print.css);\n</style>";
  $html .= "</head><body>". $output ."</body></html>";

  return $html;
680 681
}

682
function book_print_recurse($parent = "", $depth = 1) {
683
  $result = db_query("SELECT n.nid FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND b.parent = '$parent' AND (n.moderate = 0 OR n.revisions IS NOT NULL) ORDER BY b.weight, n.title");
684

685 686 687 688 689 690
  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) {
691
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
692 693
    }

694 695
    if ($node) {
      // output the content:
696 697 698
      if (module_hook($node->type, "content")) {
        $node = node_invoke($node, "content");
      }
699
      $output .= "<h1 id=\"$node->nid\" name=\"$node->nid\" class=\"book-h$depth\">$node->title</h1>";
700

701
      if ($node->body) {
702
        $output .= "<ul>". $node->body ."</ul>";
703
      }
704

705
      $output .= book_print_recurse($node->nid, $depth + 1);
706
    }
707
  }
708

709 710
  return $output;
}
711

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

714
  $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"));
715 716

  return $row;
Dries's avatar
Dries committed
717 718 719
}

function book_admin_view_book($nid, $depth = 1) {
720
  $result = db_query("SELECT n.nid FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d ORDER BY b.weight, n.title", $nid);
Dries's avatar
Dries committed
721 722 723

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

728
  return $rows;
Dries's avatar
Dries committed
729 730 731 732
}

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

733 734
  if ($nid) {
    $node = node_load(array("nid" => $nid));
Dries's avatar
Dries committed
735

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

738 739 740
    $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));
741

742 743
    $output .= table($header, $rows);
    $output .= form_submit(t("Save book pages"));
744

745 746
    return form($output);
  }
747 748 749 750
}

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

751 752
  if ($nid) {
    $book = node_load(array("nid" => $nid));
753

754 755 756 757
    foreach ($edit as $nid => $value) {
      /*
      ** Check to see whether the title needs updating:
      */
758

759
      $title = db_result(db_query("SELECT title FROM {node} WHERE nid = %d", $nid));
760
      if ($title != $value["title"]) {
761
        db_query("UPDATE {node} SET title = '%s' WHERE nid = %d", $value["title"], $nid);
762
      }
763

764 765 766
      /*
      ** Check to see whether the weight needs updating:
      */
767

768
      $weight = db_result(db_query("SELECT weight FROM {book} WHERE nid = %d", $nid));
769
      if ($weight != $value["weight"]) {
770
        db_query("UPDATE {book} SET weight = %d WHERE nid = %d", $value["weight"], $nid);
771
      }
772 773
    }

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

777 778
    return $message;
  }
Dries's avatar
Dries committed
779 780 781 782
}

function book_admin_orphan() {

783
  $result = db_query("SELECT n.nid, n.title, n.status, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.type = 'book'");
Dries's avatar
Dries committed
784 785 786 787 788

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

789
  if ($pages) {
790 791
    $output .= "<h3>Orphan pages</h3>";
    $header = array(t("title"), t("weight"), array("data" => t("operations"), "colspan" => 3));
792 793
    foreach ($pages as $nid => $node) {
      if ($node->parent && empty($pages[$node->parent])) {
794 795
        $rows[] = book_admin_view_line($node, $depth);
        $rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
796
      }
Dries's avatar
Dries committed
797
    }
798
    $output .= table($header, $rows);
Dries's avatar
Dries committed
799 800 801 802 803 804 805 806 807
  }

  return $output;
}

function book_admin_links() {
}

function book_admin() {
808 809
  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
Dries committed
810 811

  if (user_access("administer nodes")) {
Dries's avatar
Dries committed
812
    if (empty($op)) {
813
      $op = arg(3);
Dries's avatar
Dries committed
814 815
    }

Dries's avatar
Dries committed
816
    switch ($op) {
Dries's avatar
Dries committed
817 818 819 820
      case t("Edit book outline"):
      case t("Add to book outline"):
      case t("Remove from book outline"):
      case t("Update book outline"):
821
        $output = book_node_link();
Dries's avatar
Dries committed
822
        break;
Dries's avatar
Dries committed
823
      case "orphan":
824
        $output = book_admin_orphan();
Dries's avatar
Dries committed
825
        break;
826
      case t("Save book pages"):
827
        $output = status(book_admin_save(arg(3), $edit));
828
        // fall through:
829
      default:
830
        $output .= book_admin_view(arg(3));
Dries's avatar
Dries committed
831 832
        break;
    }
833
    return $output;
Dries's avatar
Dries committed
834 835 836
  }
}

837
function book_help($section = "admin/help#book") {
838
  $output = "";
839

840
  switch ($section) {
841
    case 'admin/help#book':
842
      $output .= "<p>The book organises content into a nested hierarchical structure. It is particularly good for manuals, Frequently Asked Questions (FAQs) and the like, allowing you to have chapters, sections, etc.</p>";
843 844
      $output .= "<p>A book is simply a collection of nodes that have been linked together. These nodes are usually of type <i>book page</i>, but you can insert nodes of any type into a book outline. Every node in the book has a <i>parent</i> node which  \"contains\" it. This is how book.module establishes its hierarchy. At any given level in the hierarchy, a book can contain many nodes. All these sibling nodes are sorted according to the <i>weight</i> that you give them.</p>";
      $output .= "<p>A book page is a special node type that allows you to embed PHP within the body of the page. This capability is only offerred to administrators, since malicious users could abuse this power. In addiiton, book pages contain a <i>log message</i> field which helps your users understand the motivation behind an edit of a book page. Each edited version of a book page is stored as a new revision of a node. This capability makes it easy to revert to an old version of a page, should that be desirable.</p>";
845 846
      $output .= "<p>Like other node types, book submissions and edits may be subject to moderation, depending on your configuration.  Similarly, books use %permissions to determine who may read and write to them. Only administrators are allowed to create new books, which are really just nodes whose parent is <i>&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 %create link.</p>";
      $output .= "<p>Administrators may review the hierarchy of their books by clicking on the %collaborative-book link in the adminstration pages. There, nodes may be edited, reorganized, removed from book, and deleted. This behavior may change in the future. When a parent node is deleted, it may leave behind child nodes.  These nodes are now <i>orphans</i>. Administrators should periodically %orphans-book and reaffiliate those pages as desired. Finally, administrators may also %export-book to a single, flat HTML page which is suitable for printing.</p>";
847 848
      $output .= "<h3>Maintaining a FAQ using a collaborative book</h3>";
      $output .= "<p>Collaborative books let you easily set up a Frequently Asked Questions (FAQ) section on your web site. The main benefit is that you don't have to write all the questions/answers by yourself - let the community do it for you!</p>";
849
      $output .= "<p>In order to set up the FAQ, you have to create a new book which will hold all your content. To do so, click on the %create link. Give it a thoughtful title, and body. A title like \"Estonia Travel - FAQ\" is nice. You may always edit these fields later. You will probably want to designate <i>&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>";
850
      $output .= "<p>Whenever you come across a post which you want to include in your FAQ, click on the <i>administer</i> link. Then click on the <i>edit book outline</i> button at the bottom of the page. Then place the relevant post wherever is most appropriate in your book by selecting a <i>parent</i>. Books are quite flexible. They can have sections like <i>Flying to Estonia</i>, <i>Eating in Estonia</i> and so on. As you get more experienced with the book module, you can reorganize posts in your book so that it stays organized.</p>";
851 852
      $output .= "<p>Notes:</p><ul><li>Any comments attached to those relevant posts which you designate as book pages will also be transported into your book. This is a great feature, since much wisdom is shared via comments. Remember that all future comments and edits will automatically be reflected in your book.</li><li>You may wish to edit the title of posts when adding them to your FAQ. This is done on the same page as the <i>Edit book outline</i> button. Clear titles improve navigability enormously.</li><li>Book pages may come from any content type (blog, story, page, etc.). If you are creating a post solely for inclusion in your book, then use the %create link.</li><li>If you don't see the <i>administer</i> link, then you probably have insufficient %permissions.</li><li>If you want to get really fancy, note that books are one of the few content types which allow raw PHP in their <i>body</i>. So you've got lots of geeky possibilities there.</li></ul>";
      $output = t($output, array("%permissions" => l(t("permissions"), "admin/user/permission"), "%create" => l(t("submit content") ." &raquo; ". t("book page"), "node/add/book"), "%collaborative-book" => l(t("collaborative book"), "admin/node/book"), "%orphans-book" => l(t("review their books for orphans"), "admin/node/book/orphan"), "%export-book" => l(t("export their books"), "book/print")));
853
      break;
854
    case 'admin/system/modules#description':
855
      $output = t("Allows users to collaboratively author a book.");
856 857
      break;
    case 'admin/node/book':
858
      $output = t("The book module offers a mean to organize content, authored by many users, in an online manual, outline or FAQ.");
859 860
      break;
    case 'admin/node/book/orphan':
861
      $output = t("Pages in a book are like a tree. As pages are edited, reorganized and removed, child pages might be left with no link to the rest of the book.  Such pages are refered to as 'orphan pages'.  On this page, administrators can review their books for orphans and reattach those pages as desired.");
862 863 864 865
      break;

  }

866
  return $output;
867
}
868
?>