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

4
5
6
7
8
function book_system($field){
  $system["description"] = t("Allows users to collaboratively author a book.");
  return $system[$field];
}

Dries's avatar
   
Dries committed
9
10
11
function book_node($field) {
  global $user;

Dries's avatar
   
Dries committed
12
  $info["name"] = t("book page");
Dries's avatar
   
Dries committed
13
  $info["description"] = t("A book is a collaborative writing effort: users can collaborate writing the pages of the book, positioning the pages in the right order, and reviewing or modifying pages previously written.  So when you have some information to share or when you read a page of the book and you didn't like it, or if you think a certain page could have been written better, you can do something about it.");
Dries's avatar
   
Dries committed
14
15
16
17

  return $info[$field];
}

Dries's avatar
   
Dries committed
18
19
20
21
function book_perm() {
  return array("maintain books");
}

Dries's avatar
   
Dries committed
22
function book_access($op, $node) {
Dries's avatar
   
Dries committed
23
  global $user;
Dries's avatar
   
Dries committed
24
25

  if ($op == "view") {
Dries's avatar
   
Dries committed
26
27
28
29
30
31
32
33
    /*
    ** Everyone can access all published book pages whether these pages
    ** are still waiting for approval or not.  We might not always want
    ** to display pages that are waiting for approval, but we take care
    ** of that problem in the book_view() function.
    */

    return $node->status;
Dries's avatar
   
Dries committed
34
35
  }

Dries's avatar
   
Dries committed
36
  if ($op == "create") {
Dries's avatar
   
Dries committed
37
38
39
40
41
    /*
    ** Only registered users can create book pages.  Given the nature
    ** of the book module this is considered to be a good/safe idea.
    */

Dries's avatar
   
Dries committed
42
    return user_access("maintain books");
Dries's avatar
   
Dries committed
43
44
45
  }

  if ($op == "update") {
Dries's avatar
   
Dries committed
46
    /*
Dries's avatar
   
Dries committed
47
48
49
50
51
52
53
    ** Only registered users can update book pages.  Given the nature
    ** of the book module this is considered to be a good/safe idea.
    ** One can only upate a book page if there are no suggested updates
    ** of that page waiting for approval, when it is not a PHP-page and
    ** as long as the "create new revision"-bit is set.  That is, only
    ** updates that don't overwrite the current or pending information
    ** are allowed.
Dries's avatar
   
Dries committed
54
    */
Dries's avatar
   
Dries committed
55

Dries's avatar
   
Dries committed
56
    return user_access("maintain books") && !$node->moderate && !$node->format && $node->revision;
Dries's avatar
   
Dries committed
57
  }
Dries's avatar
   
Dries committed
58
59
}

Dries's avatar
   
Dries committed
60
function book_save($op, $node) {
Dries's avatar
   
Dries committed
61
  global $user;
Dries's avatar
   
Dries committed
62
63
64
65
66
67

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

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

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

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

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

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

}

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

Dries's avatar
   
Dries committed
107
  if ($type == "menu.create" && user_access("maintain books")) {
Kjartan's avatar
Kjartan committed
108
    $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
109
  }
Dries's avatar
   
Dries committed
110

Dries's avatar
   
Dries committed
111
  if ($type == "admin" && user_access("maintain books")) {
Dries's avatar
   
Dries committed
112
    $links[] = la(t("collaborative book"), array("mod" => "book"));
Dries's avatar
   
Dries committed
113
114
  }

Dries's avatar
   
Dries committed
115
  if ($type == "node" && $node->type == "book" && book_access("update", $node)) {
Kjartan's avatar
Kjartan committed
116
    $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
117
    $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
118
119
  }

Dries's avatar
   
Dries committed
120
  return $links ? $links : array();
Dries's avatar
   
Dries committed
121
122
}

Dries's avatar
   
Dries committed
123
function book_load($node) {
Dries's avatar
   
Dries committed
124
  global $user;
Dries's avatar
   
Dries committed
125

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

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

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

Dries's avatar
   
Dries committed
147
148
149
  /*
  ** 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
150
  ** always such that the "edit this page"-links appear.
Dries's avatar
   
Dries committed
151
  */
Dries's avatar
   
Dries committed
152

Dries's avatar
   
Dries committed
153
  $book->revision = 1;
Dries's avatar
   
Dries committed
154

Dries's avatar
   
Dries committed
155
  return $book;
Dries's avatar
   
Dries committed
156
157
}

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

Dries's avatar
   
Dries committed
164
  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
165
}
Dries's avatar
   
Dries committed
166

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

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

176
function book_delete(&$node) {
Dries's avatar
   
Dries committed
177
  db_query("DELETE FROM book WHERE nid = '%d'", $node->nid);
Dries's avatar
   
Dries committed
178
179
}

Dries's avatar
   
Dries committed
180
181
182
183
184
185
186
187
function book_validate($node, &$error) {

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

  return $node;
}

188
function book_form(&$node, &$help, &$error) {
Dries's avatar
   
Dries committed
189
  global $user, $op;
Dries's avatar
   
Dries committed
190

191
  $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
192

Dries's avatar
   
Dries committed
193
194
195
196
197
  if ($node->format) {
    if ($op != t("Preview")) {
      $node->body = addslashes($node->body);
    }
  }
Dries's avatar
   
Dries committed
198

199
200
201
202
  if (function_exists("taxonomy_node_form")) {
    $output .= implode("", taxonomy_node_form("book", $node));
  }

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

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

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

Dries's avatar
   
Dries committed
218
219
    $help = book_node("description");

Dries's avatar
   
Dries committed
220
221
222
223
224
225
226
227
228
229
230
    /*
    ** 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
231
232
233
234
235
236
237
238
239
240
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
241
      db_query("INSERT INTO book (nid, parent, weight) VALUES ('%d', '%s', '%s')", $node->nid, $edit["parent"], $edit["weight"]);
Dries's avatar
   
Dries committed
242
243
244
245
      $output .= status(t("added the node to the book."));
    }

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

    if ($op == t("Remove from book outline")) {
Dries's avatar
   
Dries committed
251
      db_query("DELETE FROM book WHERE nid = '%d'", $node->nid);
Dries's avatar
   
Dries committed
252
253
254
255
256
257
      $output .= status(t("removed the node form the book."));
    }

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

    if ($edit["nid"]) {
Dries's avatar
   
Dries committed
258
      $page = db_fetch_object(db_query("SELECT * FROM book WHERE nid = '%d'", $node->nid));
Dries's avatar
   
Dries committed
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277

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

Dries's avatar
   
Dries committed
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
312
313
314
315
316
317
318
319
320
/*
** 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
321
function book_location($node, $nodes = array()) {
Dries's avatar
   
Dries committed
322
  $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
323
324
325
326
327
328
329
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

Dries's avatar
   
Dries committed
330
331
332
333
334
335
336
337
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
338
    if ($op == t("Preview")) {
Dries's avatar
   
Dries committed
339
      if (user_access("create php content")) {
Dries's avatar
   
Dries committed
340
341
342
343
344
        $node->body = stripslashes($node->body);  // see also book_form()
      }
      else {
        return;
      }
Dries's avatar
   
Dries committed
345
346
347
348
349
350
351
352
    }

    ob_start();
    eval($node->body);
    $output = ob_get_contents();
    ob_end_clean();
  }
  else {
Dries's avatar
   
Dries committed
353
    $output = check_output(filter($node->body), 1);
Dries's avatar
   
Dries committed
354
355
356
357
358
  }

  return $output;
}

Dries's avatar
   
Dries committed
359
function book_view($node, $main = 0) {
Dries's avatar
   
Dries committed
360
361
362
363
  global $theme, $mod;

  /*
  ** Always display the most recently approved revision of a node
Dries's avatar
   
Dries committed
364
365
  ** (if any) unless we have to display this page in the context of
  ** the moderation queue.
Dries's avatar
   
Dries committed
366
367
368
  */

  if ($node->moderate && $mod != "queue") {
Dries's avatar
   
Dries committed
369
370
371
372
373
    $revision = book_revision_load($node, array("moderate" => 0, "status" => 1));

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
   
Dries committed
374
375
  }

Dries's avatar
   
Dries committed
376
377
378
379
380
381
382
  /*
  ** 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
383
384
385
386
387
  /*
  ** 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
388

Dries's avatar
   
Dries committed
389
390
  if ($main) {
    $theme->node($node, $main);
Dries's avatar
   
Dries committed
391
  }
Dries's avatar
   
Dries committed
392
  else {
Dries's avatar
   
Dries committed
393
394
395
396
    /*
    ** Construct the "next" and "previous" links:
    */

Dries's avatar
   
Dries committed
397
    if ($node->nid && $node->parent) {
Dries's avatar
   
Dries committed
398
399
      $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
400
    }
Dries's avatar
   
Dries committed
401

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

Dries's avatar
   
Dries committed
404
405
    if ($node->title) {
      foreach (book_location($node) as $level) {
Kjartan's avatar
Kjartan committed
406
        $location .= "$indent ". l($level->title, array("id" => $level->nid)) ."<br />";
Dries's avatar
   
Dries committed
407
408
        $indent .= "-";
      }
Dries's avatar
   
Dries committed
409

Dries's avatar
   
Dries committed
410
      $output .= " <tr><td colspan=\"3\">$location</td></tr>";
Dries's avatar
   
Dries committed
411
      $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
Dries's avatar
   
Dries committed
412
      $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
413
    }
Dries's avatar
   
Dries committed
414

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

419
420
421
422
    if ($node->moderate) {
      $output .= " <tr><td colspan=\"3\"><hr /><b>". t("Log") .":</b><br />$node->log</td></tr>";
    }

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

Dries's avatar
   
Dries committed
427
    $output .= " <tr><td colspan=\"3\"><hr /></td></tr>";
Kjartan's avatar
Kjartan committed
428
    $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
429
    $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
430
431
    $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
432
    $output .= "</table>";
Dries's avatar
   
Dries committed
433

Dries's avatar
   
Dries committed
434
435
    $theme->box(t("Handbook"), $output);
  }
Dries's avatar
 
Dries committed
436
437
}

Dries's avatar
   
Dries committed
438
439
440
441
442
443
444
445
446
447
448
449
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
450
function book_toc($parent = 0, $indent = "", $toc = array()) {
Dries's avatar
   
Dries committed
451

452
  $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
453

Dries's avatar
   
Dries committed
454
455
456
457
458
  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
459
460

  /*
Dries's avatar
   
Dries committed
461
462
  ** If the user is an administrator, add the root node; only
  ** administrators can start new books.
Dries's avatar
   
Dries committed
463
  */
Dries's avatar
   
Dries committed
464

Dries's avatar
   
Dries committed
465
  if (user_access("administer nodes")) {
Dries's avatar
   
Dries committed
466
    $toc[0] = "<". t("root") .">";
Dries's avatar
   
Dries committed
467
468
  }

Dries's avatar
   
Dries committed
469
  /*
Dries's avatar
   
Dries committed
470
  ** Iterate root book nodes:
Dries's avatar
   
Dries committed
471
472
  */

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

Dries's avatar
   
Dries committed
475
476
477
  return $toc;
}

Dries's avatar
 
Dries committed
478

Dries's avatar
   
Dries committed
479
function book_tree_recurse($nid, $depth, $children) {
Dries's avatar
   
Dries committed
480

Dries's avatar
   
Dries committed
481
  if ($depth > 0) {
Dries's avatar
   
Dries committed
482
483
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
Kjartan's avatar
Kjartan committed
484
        $output .= "<li>". l(check_output($node->title), array("id" => $node->nid)) ."</li>";
Dries's avatar
   
Dries committed
485
486
487
488

        if ($tree = book_tree_recurse($node->nid, $depth - 1, $children)) {
          $output .= "<ul>$tree</ul>";
        }
Dries's avatar
   
Dries committed
489
490
      }
    }
Dries's avatar
   
Dries committed
491
492
493
494
495
  }

  return $output;
}

Dries's avatar
   
Dries committed
496

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

Dries's avatar
   
Dries committed
499
  $result = db_query("SELECT n.nid, n.title, b.parent FROM node n LEFT JOIN book b ON n.nid = b.nid WHERE n.status = '1' AND n.moderate = '0' ORDER BY b.weight, n.title");
Dries's avatar
   
Dries committed
500

Dries's avatar
   
Dries committed
501
502
503
504
  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
505
  }
Dries's avatar
   
Dries committed
506

Dries's avatar
   
Dries committed
507
508
  $output = book_tree_recurse($parent, $depth, $children);
  $output = "<ul>$output</ul>";
Dries's avatar
   
Dries committed
509

Dries's avatar
   
Dries committed
510
511
512
  return $output;
}

Dries's avatar
   
Dries committed
513

Dries's avatar
   
Dries committed
514
function book_render() {
Dries's avatar
   
Dries committed
515
  global $theme;
Dries's avatar
Dries committed
516

517
  $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
518

Dries's avatar
   
Dries committed
519
520
521
522
523
524
  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
525
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
   
Dries committed
526
527
    }

Dries's avatar
   
Dries committed
528
529
    if ($node) {
      // output the content:
Kjartan's avatar
Kjartan committed
530
      $output .= "<dt>". l(check_output($node->title), array("id" => $node->nid)) ."</dt><dd>". book_body($node) ."<br /><br /></dd>";
Dries's avatar
   
Dries committed
531
    }
Dries's avatar
   
Dries committed
532
533
534
  }

  $theme->header();
Dries's avatar
   
Dries committed
535
  $theme->box(t("Handbook"), "<dl>$output</dl>");
Dries's avatar
   
Dries committed
536
537
538
539
540
541
  $theme->footer();
}

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

Dries's avatar
   
Dries committed
542
  if (user_access("access content")) {
Dries's avatar
   
Dries committed
543
    switch ($op) {
Dries's avatar
   
Dries committed
544
      case "print":
545
        print book_print($id, $depth = 1);
Dries's avatar
   
Dries committed
546
547
548
        break;
      default:
        book_render();
Dries's avatar
   
Dries committed
549
550
551
552
553
554
555
    }
  }
  else {
    $theme->header();
    $theme->box(t("Access denied"), message_access());
    $theme->footer();
  }
Dries's avatar
 
Dries committed
556
557
}

558
559
function book_print($id = "", $depth = 1) {
  $result = db_query("SELECT n.nid FROM node n LEFT JOIN book b ON n.nid = b.nid WHERE n.status = 1 AND n.nid = '%d' AND (n.moderate = 0 OR n.revisions != '') ORDER BY b.weight, n.title", $id);
Dries's avatar
   
Dries committed
560

Dries's avatar
   
Dries committed
561
562
563
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));
Dries's avatar
   
Dries committed
564

Dries's avatar
   
Dries committed
565
566
    // take the most recent approved revision:
    if ($node->moderate) {
Dries's avatar
   
Dries committed
567
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
   
Dries committed
568
569
    }

Dries's avatar
   
Dries committed
570
571
572
    if ($node) {
      // output the content:
      $output .= "<h$depth>". check_output($node->title) ."</h$depth>";
Dries's avatar
   
Dries committed
573

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

580
  $output .= book_print_recurse($id, $depth);
Dries's avatar
   
Dries committed
581
582
583
584

  return $output;
}

585
586
function book_print_recurse($parent = "", $depth = 1) {
  $result = db_query("SELECT n.nid FROM node n LEFT JOIN book b ON n.nid = b.nid WHERE n.status = 1 AND b.parent = '$parent' AND (n.moderate = 0 OR n.revisions != '') ORDER BY b.weight, n.title");
Dries's avatar
   
Dries committed
587

Dries's avatar
   
Dries committed
588
589
590
591
592
593
  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
594
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
   
Dries committed
595
596
    }

Dries's avatar
   
Dries committed
597
598
599
    if ($node) {
      // output the content:
      $output .= "<h$depth>". check_output($node->title) ."</h$depth>";
Dries's avatar
   
Dries committed
600

Dries's avatar
   
Dries committed
601
      if ($node->body) {
Dries's avatar
   
Dries committed
602
        $output .= "<ul>". book_body($node) ."</ul>";
Dries's avatar
   
Dries committed
603
      }
Dries's avatar
   
Dries committed
604

605
      $output .= book_print_recurse($node->nid, $depth + 1);
Dries's avatar
   
Dries committed
606
    }
Dries's avatar
   
Dries committed
607
  }
Dries's avatar
   
Dries committed
608

Dries's avatar
   
Dries committed
609
610
  return $output;
}
Dries's avatar
   
Dries committed
611

Dries's avatar
   
Dries committed
612
613
614
615
616
617
618
function book_admin_view_line($node, $depth = 0) {

  /*
  ** Diplay the book page:
  */

  $output .= "<tr>";
Dries's avatar
   
Dries committed
619
620
621
  $output .= " <td><div style=\"padding-left: ". (25 * $depth) ."px;\">". form_textfield(NULL, "$node->nid][title", $node->title, 64, 255) ."</div></td>";
  $output .= " <td>". form_weight(NULL, "$node->nid][weight", $node->weight) ."</td>";
  $output .= " <td>". l(t("view node"), array("id" => $node->nid)) ."</td>";
Kjartan's avatar
Kjartan committed
622
623
  $output .= " <td>". la(t("edit node"), array("mod" => "node", "op" => "edit", "id" => $node->nid)) ."</td>";
  $output .= " <td>". la(t("delete node"), array("mod" => "node", "op" => "delete", "id" => $node->nid)) ."</td>";
Dries's avatar
   
Dries committed
624
625
626
627
628
629
  $output .= "</tr>";

  return $output;
}

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

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

  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\">";
Dries's avatar
   
Dries committed
647
  $output .= " <tr><th>title</th><th>weight</th><th colspan=\"3\">operations</th></tr>";
Dries's avatar
   
Dries committed
648
649
  $output .= book_admin_view_line($node);
  $output .= book_admin_view_book($nid);
Dries's avatar
   
Dries committed
650
  $output .= "</table><br />";
Dries's avatar
   
Dries committed
651

Dries's avatar
   
Dries committed
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
  $output .= form_submit(t("Save book pages"));

  return form($output);
}

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

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

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

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

    /*
    ** Check to see whether the weight needs updating:
    */

    $weight = db_result(db_query("SELECT weight FROM book WHERE nid = '%d'", $nid));
    if ($weight != $value["weight"]) {
      db_query("UPDATE book SET weight = '%d' WHERE nid = '%d'", $value["weight"], $nid);
    }
  }

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

  return $message;
Dries's avatar
   
Dries committed
685
686
687
688
689
690
691
692
693
694
}

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
695
696
697
698
699
700
701
  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
702
    }
Dries's avatar
   
Dries committed
703
    $output .= "</table>";
Dries's avatar
   
Dries committed
704
705
706
707
708
709
710
711
712
  }

  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
713
    $links[] = la(t("book") .": <i>". check_output($book->title) ."</i>", array("mod" => "book", "op" => "view", "id" => $book->nid));
Dries's avatar
   
Dries committed
714
  }
Dries's avatar
   
Dries committed
715
716
  $links[] = la(t("orphan pages"), array("mod" => "book", "op" => "orphan"));
  $links[] = la(t("help"), array("mod" => "book", "op" => "help"));
Dries's avatar
   
Dries committed
717
718
719
720
  return $links;
}

function book_admin() {
Dries's avatar
   
Dries committed
721
  global $id, $op, $edit;
Dries's avatar
   
Dries committed
722
723
724
725
726
727
728
729

  if (user_access("administer nodes")) {

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

    $links = book_admin_links();
730

Dries's avatar
   
Dries committed
731
    print "<small>". implode(" | ", $links) ."</small><hr />";
Dries's avatar
   
Dries committed
732
733

    switch ($op) {
Dries's avatar
   
Dries committed
734
735
736
737
738
739
      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
740
741
742
      case "orphan":
        print book_admin_orphan();
        break;
Dries's avatar
   
Dries committed
743
744
745
      case t("Save book pages");
        print status(book_admin_save($id, $edit));
        // fall through:
Dries's avatar
   
Dries committed
746
747
748
      case "view":
        print book_admin_view($id);
        break;
749
750
751
      case "help":
        book_help();
        break;
Dries's avatar
   
Dries committed
752
753
754
755
756
      default:
    }
  }
}

757
758
function book_help() {
  ?>
Dries's avatar
   
Dries committed
759
<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>
760

Dries's avatar
   
Dries committed
761
762
763
764
<p>Under the covers, a book is only an organization of nodes. These nodes are often of type <i>book page</i>, but can be of any content type. Every node in the book has a <i>Parent</i>. The parent is the node which "contains" the child node. This is how book.module establishes its hierarchy. On any given level in the hierarchy, a book can contain many nodes. Book uses the Weight field to order these sibling nodes.</p>

<p>Book pages are a special, powerful node type. These nodes are specifically designed to be included in a book.  Their special power comes from the bilility to embed PHP within the body of the page. This capability is only offerred to administrators, since malicious users could abuse this power. In addiiton, book pages contain a <i>log message</i> field which helps your users understand the motivation behind an edit of a book page. Each edited version of a book page is usually stored as a new revision of a node. This capability makes it easy to revert to an old version of a page, should that become desirable.</p>

Dries's avatar
   
Dries committed
765
<p>Like other node types, book submissions and edits may be subject to moderation, depending on your configuration.  Similarly, books use <?php 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>
Dries's avatar
   
Dries committed
766

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

Dries's avatar
   
Dries committed
771
772
773
774
775
776
777
<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>
778
779
780

<p>Notes:</p>
<ul>
Dries's avatar
   
Dries committed
781
782
783
 <li>Any comments attached to those relevant posts which you designate as book pages will also be transported into your book. This is a great feature, since much wisdom is shared via comments. And remember that all future comments and edits will automatically be reflected in your book.</li>
 <li>You may wish to edit the title and teaser of posts when adding them to your FAQ. This is done on the same page as the <i>Edit book outline</i> button. Clear titles help users navigate quickly to the information that they seek.</li>
 <li>Book pages may come from any content type (blog, story, page, etc.). If you are creating a post solely for inclusion in your book, then use the <i>Create book page</i> link.</li>
Dries's avatar
   
Dries committed
784
 <li>If you don't see the <i>administer</i> link, then you probably have insufficient <?php echo la("permissions", array("mod" => "user", "op" => "permission")) ?>.</li>
Dries's avatar
   
Dries committed
785
 <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>
786
787
</ul>
  <?php
788
}
Dries's avatar
 
Dries committed
789
?>