book.module 28.6 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 18

  return $info[$field];
}

function book_access($op, $node) {
Dries's avatar
 
Dries committed
19
  global $user;
Dries's avatar
 
Dries committed
20 21

  if ($op == "view") {
Dries's avatar
 
Dries committed
22 23 24 25 26 27 28 29
    /*
    ** 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
30 31
  }

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

  if ($op == "update") {
Dries's avatar
 
Dries committed
42
    /*
Dries's avatar
 
Dries committed
43 44 45 46 47 48 49
    ** 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
50
    */
Dries's avatar
 
Dries committed
51 52

    return $user->uid && !$node->moderate && !$node->format && $node->revision;
Dries's avatar
 
Dries committed
53
  }
Dries's avatar
 
Dries committed
54 55
}

Dries's avatar
 
Dries committed
56
function book_save($op, $node) {
Dries's avatar
 
Dries committed
57
  global $user;
Dries's avatar
 
Dries committed
58 59 60 61 62 63

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

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

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

  if ($op == "update") {
Dries's avatar
 
Dries committed
77
    if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
78
      /*
Dries's avatar
 
Dries committed
79 80
      ** 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
81 82
      */

83
      return array("body" => filter($node->body), "teaser" => filter($node->teaser), "format", "parent", "weight", "log");
Dries's avatar
 
Dries committed
84
    }
Dries's avatar
 
Dries committed
85
    else {
Dries's avatar
 
Dries committed
86
      /*
Dries's avatar
 
Dries committed
87 88 89
      ** 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
90 91
      */

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

}

Dries's avatar
 
Dries committed
98
function book_link($type, $node = 0, $main = 0) {
Dries's avatar
 
Dries committed
99
  if ($type == "page" && user_access("access content")) {
Kjartan's avatar
Kjartan committed
100
    $links[] = lm(t("collaborative book"), array("mod" => "book"), "", array("title" => t("Read and contribute to the collaborative books.")));
Dries's avatar
 
Dries committed
101 102
  }

103
  if ($type == "menu.create" && user_access("post content")) {
Kjartan's avatar
Kjartan committed
104
    $links[] = lm(t("create book page"), array("mod" => "node", "op" => "add", "type" => "book"), "", array("title" => t("Add a new book page.")));
Dries's avatar
 
Dries committed
105
  }
Dries's avatar
 
Dries committed
106

Dries's avatar
 
Dries committed
107
  if ($type == "admin" && user_access("administer nodes")) {
Dries's avatar
 
Dries committed
108
    $links[] = la(t("collaborative book"), array("mod" => "book"));
Dries's avatar
 
Dries committed
109 110
  }

Dries's avatar
 
Dries committed
111
  if ($type == "node" && $node->type == "book" && book_access("update", $node)) {
Kjartan's avatar
Kjartan committed
112
    $links[] = lm(t("edit this page"), array("mod" => "node", "op" => "edit", "id" => $node->nid), "", array("title" => t("Suggest an update for this book page.")));
Dries's avatar
 
Dries committed
113
    $links[] = lm(t("printer-friendly version"), array("mod" => "book", "op" => "print", "id" => $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
  return $links ? $links : array();
Dries's avatar
 
Dries committed
117 118
}

Dries's avatar
 
Dries committed
119
function book_load($node) {
Dries's avatar
 
Dries committed
120
  global $user;
Dries's avatar
 
Dries committed
121

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

Dries's avatar
 
Dries committed
124
  if (strstr(request_uri(), drupal_url(array("mod" => "node", "op" => "edit"), "module"))) {
Dries's avatar
 
Dries committed
125

Dries's avatar
 
Dries committed
126 127 128 129 130 131 132
    /*
    ** 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
133 134 135 136 137 138 139 140
    if ($user->uid) {
      $book->uid = $user->uid;
      $book->name = $user->name;
    }
    else {
      $book->uid = 0;
      $book->name = "";
    }
Dries's avatar
 
Dries committed
141
  }
Dries's avatar
 
Dries committed
142

Dries's avatar
 
Dries committed
143 144 145
  /*
  ** 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
146
  ** always such that the "edit this page"-links appear.
Dries's avatar
 
Dries committed
147
  */
Dries's avatar
 
Dries committed
148

Dries's avatar
 
Dries committed
149
  $book->revision = 1;
Dries's avatar
 
Dries committed
150

Dries's avatar
 
Dries committed
151
  return $book;
Dries's avatar
 
Dries committed
152 153
}

Dries's avatar
 
Dries committed
154
function book_insert($node) {
Dries's avatar
 
Dries committed
155 156 157 158 159
  if (!user_access("administer nodes")) {
    $node->format = 0;
    $node->weight = 0;
  }

Dries's avatar
 
Dries committed
160
  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
161
}
Dries's avatar
 
Dries committed
162

Dries's avatar
 
Dries committed
163
function book_update($node) {
Dries's avatar
 
Dries committed
164 165 166 167 168
  if (!user_access("administer nodes")) {
    $node->format = 0;
    $node->weight = 0;
  }

Dries's avatar
 
Dries committed
169
  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
170
}
Dries's avatar
 
Dries committed
171

172
function book_delete(&$node) {
Dries's avatar
 
Dries committed
173
  db_query("DELETE FROM book WHERE nid = '%d'", $node->nid);
Dries's avatar
 
Dries committed
174 175
}

176
function book_form(&$node, &$help, &$error) {
Dries's avatar
 
Dries committed
177
  global $user, $op;
Dries's avatar
 
Dries committed
178

179
  $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
180

Dries's avatar
 
Dries committed
181 182 183 184 185 186 187 188 189
  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
190 191
  }

192 193 194 195
  if (function_exists("taxonomy_node_form")) {
    $output .= implode("", taxonomy_node_form("book", $node));
  }

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

  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
200 201
    $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
202 203 204 205 206 207 208
  }
  else {

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

Dries's avatar
 
Dries committed
209 210
    $help = book_node("description");

Dries's avatar
 
Dries committed
211 212 213 214 215 216 217 218 219 220 221
    /*
    ** 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
222 223 224 225 226 227 228 229 230 231
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
232
      db_query("INSERT INTO book (nid, parent, weight) VALUES ('%d', '%s', '%s')", $node->nid, $edit["parent"], $edit["weight"]);
Dries's avatar
 
Dries committed
233 234 235 236
      $output .= status(t("added the node to the book."));
    }

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

    if ($op == t("Remove from book outline")) {
Dries's avatar
 
Dries committed
242
      db_query("DELETE FROM book WHERE nid = '%d'", $node->nid);
Dries's avatar
 
Dries committed
243 244 245 246 247 248
      $output .= status(t("removed the node form the book."));
    }

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

    if ($edit["nid"]) {
Dries's avatar
 
Dries committed
249
      $page = db_fetch_object(db_query("SELECT * FROM book WHERE nid = '%d'", $node->nid));
Dries's avatar
 
Dries committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268

      $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
269
    return form($output, "post", drupal_url(array("mod" => "book", "op" => "outline"), "admin"));
Dries's avatar
 
Dries committed
270 271 272
  }
}

Dries's avatar
 
Dries committed
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 302 303 304 305 306 307 308 309 310 311
/*
** 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
312
function book_location($node, $nodes = array()) {
Dries's avatar
 
Dries committed
313
  $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
314 315 316 317 318 319 320
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

Dries's avatar
 
Dries committed
321 322 323 324 325 326 327 328
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
329
    if ($op == t("Preview")) {
Dries's avatar
 
Dries committed
330
      if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
331 332 333 334 335
        $node->body = stripslashes($node->body);  // see also book_form()
      }
      else {
        return;
      }
Dries's avatar
 
Dries committed
336 337 338 339 340 341 342 343
    }

    ob_start();
    eval($node->body);
    $output = ob_get_contents();
    ob_end_clean();
  }
  else {
Dries's avatar
 
Dries committed
344
    $output = check_output(filter($node->body), 1);
Dries's avatar
 
Dries committed
345 346 347 348 349
  }

  return $output;
}

Dries's avatar
 
Dries committed
350
function book_view($node, $main = 0) {
Dries's avatar
 
Dries committed
351 352 353 354
  global $theme, $mod;

  /*
  ** Always display the most recently approved revision of a node
Dries's avatar
 
Dries committed
355 356
  ** (if any) unless we have to display this page in the context of
  ** the moderation queue.
Dries's avatar
 
Dries committed
357 358 359
  */

  if ($node->moderate && $mod != "queue") {
Dries's avatar
 
Dries committed
360 361 362 363 364
    $revision = book_revision_load($node, array("moderate" => 0, "status" => 1));

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
 
Dries committed
365 366
  }

Dries's avatar
 
Dries committed
367 368 369 370 371 372 373
  /*
  ** 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
374 375 376 377 378
  /*
  ** 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
379

Dries's avatar
 
Dries committed
380 381
  if ($main) {
    $theme->node($node, $main);
Dries's avatar
 
Dries committed
382
  }
Dries's avatar
 
Dries committed
383
  else {
Dries's avatar
 
Dries committed
384 385 386 387
    /*
    ** Construct the "next" and "previous" links:
    */

Dries's avatar
 
Dries committed
388
    if ($node->nid && $node->parent) {
Dries's avatar
 
Dries committed
389 390
      $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
391
    }
Dries's avatar
 
Dries committed
392

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

Dries's avatar
 
Dries committed
395 396
    if ($node->title) {
      foreach (book_location($node) as $level) {
Kjartan's avatar
Kjartan committed
397
        $location .= "$indent ". l($level->title, array("id" => $level->nid)) ."<br />";
Dries's avatar
 
Dries committed
398 399
        $indent .= "-";
      }
Dries's avatar
 
Dries committed
400

Dries's avatar
 
Dries committed
401
      $output .= " <tr><td colspan=\"3\">$location</td></tr>";
Dries's avatar
 
Dries committed
402
      $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
Dries's avatar
 
Dries committed
403
      $output .= " <tr><td colspan=\"3\"><b><big>". check_output($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
404
    }
Dries's avatar
 
Dries committed
405

Dries's avatar
 
Dries committed
406
    if ($node->body) {
Dries's avatar
 
Dries committed
407
      $output .= " <tr><td colspan=\"3\"><br />$node->body</td></tr>";
Dries's avatar
 
Dries committed
408
    }
Dries's avatar
 
Dries committed
409

410 411 412 413
    if ($node->moderate) {
      $output .= " <tr><td colspan=\"3\"><hr /><b>". t("Log") .":</b><br />$node->log</td></tr>";
    }

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

Dries's avatar
 
Dries committed
418
    $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
Kjartan's avatar
Kjartan committed
419
    $output .= " <tr><td align=\"left\" width=\"33%\">". ($prev ? l(t("previous"), array("id" => $prev->nid), "node", "", array("title" => t("View the previous page in this book."))) : t("previous")) ."</td><td align=\"center\" width=\"34%\">". lm(t("index"), array("mod" => "book"), "", array("title" => t("View this book's table of contents."))) ."</td><td align=\"right\" width=\"33%\">". ($next ? l(t("next"), array("id" => $next->nid), "node", "", array("title" => t("View the next page in this book."))) : t("next")) ."</td></tr>";
Kjartan's avatar
Kjartan committed
420
    $output .= " <tr><td align=\"left\" width=\"33%\">". ($prev ? "<small>". check_output($prev->title) ."</small>" : "&nbsp;") ."</td><td align=\"center\" width=\"34%\">". ($node->parent ? l(t("up"), array("id" => $node->parent), "node", "", array("title" => t("View this page's parent section."))) : t("up")) ."</td><td align=\"right\" width=\"33%\">". ($next ? "<small>". check_output($next->title) ."</small>" : "&nbsp;") ."</td></tr>";
Dries's avatar
 
Dries committed
421 422
    $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
423
    $output .= "</table>";
Dries's avatar
 
Dries committed
424

Dries's avatar
 
Dries committed
425 426
    $theme->box(t("Handbook"), $output);
  }
Dries's avatar
 
Dries committed
427 428
}

Dries's avatar
 
Dries committed
429 430 431 432 433 434 435 436 437 438 439 440
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
441
function book_toc($parent = 0, $indent = "", $toc = array()) {
Dries's avatar
 
Dries committed
442

443
  $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
444

Dries's avatar
 
Dries committed
445 446 447 448 449
  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
450 451

  /*
Dries's avatar
 
Dries committed
452 453
  ** If the user is an administrator, add the root node; only
  ** administrators can start new books.
Dries's avatar
 
Dries committed
454
  */
Dries's avatar
 
Dries committed
455

Dries's avatar
 
Dries committed
456
  if (user_access("administer nodes")) {
Dries's avatar
 
Dries committed
457
    $toc[0] = "<root>";
Dries's avatar
 
Dries committed
458 459
  }

Dries's avatar
 
Dries committed
460
  /*
Dries's avatar
 
Dries committed
461
  ** Iterate root book nodes:
Dries's avatar
 
Dries committed
462 463
  */

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

Dries's avatar
 
Dries committed
466 467 468
  return $toc;
}

Dries's avatar
 
Dries committed
469

Dries's avatar
 
Dries committed
470
function book_tree_recurse($nid, $depth, $children) {
Dries's avatar
 
Dries committed
471

Dries's avatar
 
Dries committed
472
  if ($depth > 0) {
Dries's avatar
 
Dries committed
473 474
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
Kjartan's avatar
Kjartan committed
475
        $output .= "<li>". l(check_output($node->title), array("id" => $node->nid)) ."</li>";
Dries's avatar
 
Dries committed
476 477 478 479

        if ($tree = book_tree_recurse($node->nid, $depth - 1, $children)) {
          $output .= "<ul>$tree</ul>";
        }
Dries's avatar
 
Dries committed
480 481
      }
    }
Dries's avatar
 
Dries committed
482 483 484 485 486
  }

  return $output;
}

Dries's avatar
 
Dries committed
487

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

490
  $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
491

Dries's avatar
 
Dries committed
492 493 494 495
  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
496
  }
Dries's avatar
 
Dries committed
497

Dries's avatar
 
Dries committed
498 499
  $output = book_tree_recurse($parent, $depth, $children);
  $output = "<ul>$output</ul>";
Dries's avatar
 
Dries committed
500

Dries's avatar
 
Dries committed
501 502 503
  return $output;
}

Dries's avatar
 
Dries committed
504

Dries's avatar
 
Dries committed
505
function book_render() {
Dries's avatar
 
Dries committed
506
  global $theme;
Dries's avatar
Dries committed
507

508
  $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
509

Dries's avatar
 
Dries committed
510 511 512 513 514 515
  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
516
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
517 518
    }

Dries's avatar
 
Dries committed
519 520
    if ($node) {
      // output the content:
Kjartan's avatar
Kjartan committed
521
      $output .= "<dt>". l(check_output($node->title), array("id" => $node->nid)) ."</dt><dd>". book_body($node) ."<br /><br /></dd>";
Dries's avatar
 
Dries committed
522
    }
Dries's avatar
 
Dries committed
523 524 525
  }

  $theme->header();
Dries's avatar
 
Dries committed
526
  $theme->box(t("Handbook"), "<dl>$output</dl>");
Dries's avatar
 
Dries committed
527 528 529 530 531 532
  $theme->footer();
}

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

Dries's avatar
 
Dries committed
533
  if (user_access("access content")) {
Dries's avatar
 
Dries committed
534
    switch ($op) {
Dries's avatar
 
Dries committed
535
      case "print":
Dries's avatar
 
Dries committed
536
        print book_export_html($id, $depth = 1);
Dries's avatar
 
Dries committed
537 538 539
        break;
      default:
        book_render();
Dries's avatar
 
Dries committed
540 541 542 543 544 545 546
    }
  }
  else {
    $theme->header();
    $theme->box(t("Access denied"), message_access());
    $theme->footer();
  }
Dries's avatar
 
Dries committed
547 548
}

Dries's avatar
 
Dries committed
549
function book_export_html($id = "", $depth = 1) {
Dries's avatar
 
Dries committed
550
  $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 != '')", $id);
Dries's avatar
 
Dries committed
551

Dries's avatar
 
Dries committed
552 553 554
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));
Dries's avatar
 
Dries committed
555

Dries's avatar
 
Dries committed
556 557
    // take the most recent approved revision:
    if ($node->moderate) {
Dries's avatar
 
Dries committed
558
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
559 560
    }

Dries's avatar
 
Dries committed
561 562 563
    if ($node) {
      // output the content:
      $output .= "<h$depth>". check_output($node->title) ."</h$depth>";
Dries's avatar
 
Dries committed
564

Dries's avatar
 
Dries committed
565
      if ($node->body) {
Dries's avatar
 
Dries committed
566
        $output .= "<ul>". book_body($node) ."</ul>";
Dries's avatar
 
Dries committed
567
      }
Dries's avatar
 
Dries committed
568
    }
Dries's avatar
 
Dries committed
569
  }
Dries's avatar
 
Dries committed
570

Dries's avatar
 
Dries committed
571
  $output .= book_export_html_recurse($id, $depth);
Dries's avatar
 
Dries committed
572 573 574 575

  return $output;
}

Dries's avatar
 
Dries committed
576
function book_export_html_recurse($parent = "", $depth = 1) {
Dries's avatar
 
Dries committed
577
  $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
578

Dries's avatar
 
Dries committed
579 580 581 582 583 584
  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
585
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
 
Dries committed
586 587
    }

Dries's avatar
 
Dries committed
588 589 590
    if ($node) {
      // output the content:
      $output .= "<h$depth>". check_output($node->title) ."</h$depth>";
Dries's avatar
 
Dries committed
591

Dries's avatar
 
Dries committed
592
      if ($node->body) {
Dries's avatar
 
Dries committed
593
        $output .= "<ul>". book_body($node) ."</ul>";
Dries's avatar
 
Dries committed
594
      }
Dries's avatar
 
Dries committed
595

Dries's avatar
 
Dries committed
596
      $output .= book_export_html_recurse($node->nid, $depth + 1);
Dries's avatar
 
Dries committed
597
    }
Dries's avatar
 
Dries committed
598
  }
Dries's avatar
 
Dries committed
599

Dries's avatar
 
Dries committed
600 601
  return $output;
}
Dries's avatar
 
Dries committed
602

Dries's avatar
 
Dries committed
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
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>";
Kjartan's avatar
Kjartan committed
621
  $output .= " <td><div style=\"padding-left: ". (25 * $depth) ."px;\">". l(check_output($node->title), array("id" => $node->nid)) ."</div></td>";
Dries's avatar
 
Dries committed
622
  $output .= " <td align=\"center\">$revision</td>";
Kjartan's avatar
Kjartan committed
623
  $output .= " <td>". la(t("edit node"), array("mod" => "node", "op" => "edit", "id" => $node->nid)) ."</td>";
624
  //TODO: get this link to work. Must pass $nid along so it is received by book_node_link()
Kjartan's avatar
Kjartan committed
625 626
  //$output .= " <td>". la(t("edit book outline"), array("mod" => "book", "nid" => $node->nid, "op" => "Edit+book+outline")) ."</td>";
  $output .= " <td>". la(t("delete node"), array("mod" => "node", "op" => "delete", "id" => $node->nid)) ."</td>";
Dries's avatar
 
Dries committed
627 628 629 630 631 632
  $output .= "</tr>";

  return $output;
}

function book_admin_view_book($nid, $depth = 1) {
Dries's avatar
 
Dries committed
633 634
  $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
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
    $output .= book_admin_view_line($node, $depth);
    $output .= book_admin_view_book($node->nid, $depth + 1);
Dries's avatar
 
Dries committed
641 642 643 644 645 646 647 648 649 650 651
  }

  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\">";
652
  //TODO: change colspan below to 3 after adding new link in book_admin_view_line()
Dries's avatar
 
Dries committed
653
  $output .= " <tr><th>title</th><th>rev</th><th colspan=\"2\">operations</th></tr>";
Dries's avatar
 
Dries committed
654 655
  $output .= book_admin_view_line($node);
  $output .= book_admin_view_book($nid);
Dries's avatar
 
Dries committed
656 657 658 659 660 661 662 663 664 665 666 667 668
  $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;
  }

Dries's avatar
 
Dries committed
669 670 671 672 673 674 675
  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])) {
        $output .= "<tr><td>". l(check_output($node->title), array("id" => $node->nid)) ."</td><td>". la(t("edit page"), array("mod" => "node", "op" => "edit", "id" => $node->nid)) ."</td><td>". la(t("delete page"), array("mod" => "node", "op" => "delete", "id" => $node->nid)) ."</td>";
      }
Dries's avatar
 
Dries committed
676
    }
Dries's avatar
 
Dries committed
677
    $output .= "</table>";
Dries's avatar
 
Dries committed
678 679 680 681 682 683 684 685 686
  }

  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)) {
Dries's avatar
 
Dries committed
687
    $links[] = la(t("book") .": <i>". check_output($book->title) ."</i>", array("mod" => "book", "op" => "view", "id" => $book->nid));
Dries's avatar
 
Dries committed
688
  }
Dries's avatar
 
Dries committed
689 690
  $links[] = la(t("orphan pages"), array("mod" => "book", "op" => "orphan"));
  $links[] = la(t("help"), array("mod" => "book", "op" => "help"));
Dries's avatar
 
Dries committed
691 692 693 694 695 696 697 698 699 700 701 702 703
  return $links;
}

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

  if (user_access("administer nodes")) {

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

    $links = book_admin_links();
704

Dries's avatar
 
Dries committed
705 706 707
    print "<small>". implode(" &middot; ", $links) ."</small><hr />";

    switch ($op) {
Dries's avatar
 
Dries committed
708 709 710 711 712 713
      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
714 715 716 717 718 719
      case "orphan":
        print book_admin_orphan();
        break;
      case "view":
        print book_admin_view($id);
        break;
720 721 722
      case "help":
        book_help();
        break;
Dries's avatar
 
Dries committed
723 724 725 726 727
      default:
    }
  }
}

728 729
function book_help() {
  ?>
Dries's avatar
 
Dries committed
730
<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>
731

Dries's avatar
 
Dries committed
732 733 734 735 736 737 738
<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>

<p>Like other node types, book submissions and edits may be subject to moderation, depending on your configuration.  Similarly, books use <? echo la("permissions", array("mod" => "user", "op" => "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>

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

Dries's avatar
 
Dries committed
742 743 744 745 746 747 748
<a name="faq"></a><h3>Maintain a FAQ using a 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 have 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>
749 750 751

<p>Notes:</p>
<ul>
Dries's avatar
 
Dries committed
752 753 754 755 756
 <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 <? echo la("permissions", array("mod" => "user", "op" => "permission")) ?>.</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>
757 758
</ul>
  <?php
759
}
Dries's avatar
 
Dries committed
760
?>