book.module 28.4 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 114
  }

Dries's avatar
 
Dries committed
115
  return $links ? $links : array();
Dries's avatar
 
Dries committed
116 117
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    if ($op == t("Update book outline")) {
Dries's avatar
 
Dries committed
236
      db_query("UPDATE book SET parent = '%s', weight = '%s' WHERE nid = '$node->nid'", $edit["parent"], $edit["weight"]);
Dries's avatar
 
Dries committed
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 263 264 265 266 267
      $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);

Dries's avatar
 
Dries committed
268
    return form($output, "post", drupal_url(array("mod" => "book", "op" => "outline"), "admin"));
Dries's avatar
 
Dries committed
269 270 271
  }
}

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

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

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

  return $output;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Dries's avatar
 
Dries committed
468

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

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

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

  return $output;
}

Dries's avatar
 
Dries committed
486

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

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

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

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

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

Dries's avatar
 
Dries committed
503

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $output;
}

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

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

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

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

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

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

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

  return $output;
}

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

  while ($node = db_fetch_object($result)) {
    $node = node_load(array("nid" => $node->nid));
Dries's avatar
 
Dries committed
638 639
    $output .= book_admin_view_line($node, $depth);
    $output .= book_admin_view_book($node->nid, $depth + 1);
Dries's avatar
 
Dries committed
640 641 642 643 644 645 646 647 648 649 650
  }

  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\">";
651
  //TODO: change colspan below to 3 after adding new link in book_admin_view_line()
Dries's avatar
 
Dries committed
652
  $output .= " <tr><th>title</th><th>rev</th><th colspan=\"2\">operations</th></tr>";
Dries's avatar
 
Dries committed
653 654
  $output .= book_admin_view_line($node);
  $output .= book_admin_view_book($nid);
Dries's avatar
 
Dries committed
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
  $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])) {
Kjartan's avatar
Kjartan committed
672
      $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
673 674 675 676 677 678 679 680 681 682 683
    }
  }
  $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)) {
Dries's avatar
 
Dries committed
684
    $links[] = la(t("book") .": <i>". check_output($book->title) ."</i>", array("mod" => "book", "op" => "view", "id" => $book->nid));
Dries's avatar
 
Dries committed
685
  }
Dries's avatar
 
Dries committed
686
  $links[] = la(t("orphan pages"), array("mod" => "book", "op" => "orphan"));
Kjartan's avatar
Kjartan committed
687
  $links[] = lm(t("export to HTML"), array("mod" => "book", "op" => "feed"), "", array("title" => t("display all books in a single HTML page")));
Dries's avatar
 
Dries committed
688
  $links[] = la(t("help"), array("mod" => "book", "op" => "help"));
Dries's avatar
 
Dries committed
689 690 691 692 693 694 695 696 697 698 699 700 701
  return $links;
}

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

  if (user_access("administer nodes")) {

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

    $links = book_admin_links();
702

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

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

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

Dries's avatar
 
Dries committed
730 731 732 733 734 735 736
<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
737 738
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
<? echo la("export their books", array("mod" => "book", "op" => "feed")) ?> to a single, flat HTML page which is suitable for printing.</p>
739

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

<p>Notes:</p>
<ul>
Dries's avatar
 
Dries committed
750 751 752 753 754
 <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>
755 756
</ul>
  <?php
757
}
Dries's avatar
 
Dries committed
758
?>