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

4
function book_system($field){
Dries's avatar
   
Dries committed
5
6
7
8
9
  $output = "";

  if ($field == "description") { $output = book_help("admin/system/modules"); };
  return $output;

10
11
}

Dries's avatar
   
Dries committed
12
13
14
function book_node($field) {
  global $user;

Dries's avatar
   
Dries committed
15
  $info["name"] = t("book page");
Dries's avatar
   
Dries committed
16
  $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
17
18
19
20

  return $info[$field];
}

Dries's avatar
   
Dries committed
21
22
23
24
function book_perm() {
  return array("maintain books");
}

Dries's avatar
   
Dries committed
25
function book_access($op, $node) {
Dries's avatar
   
Dries committed
26
  global $user;
Dries's avatar
   
Dries committed
27
28

  if ($op == "view") {
Dries's avatar
   
Dries committed
29
30
31
32
33
34
35
36
    /*
    ** 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
37
38
  }

Dries's avatar
   
Dries committed
39
  if ($op == "create") {
Dries's avatar
   
Dries committed
40
41
42
43
44
    /*
    ** 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
45
    return user_access("maintain books");
Dries's avatar
   
Dries committed
46
47
48
  }

  if ($op == "update") {
Dries's avatar
   
Dries committed
49
    /*
Dries's avatar
   
Dries committed
50
51
52
53
54
55
56
    ** 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
57
    */
Dries's avatar
   
Dries committed
58

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

Dries's avatar
   
Dries committed
63
function book_link($type, $node = 0, $main = 0) {
Dries's avatar
   
Dries committed
64
65
66

  $links = array();

Dries's avatar
   
Dries committed
67
  if ($type == "page" && user_access("access content")) {
68
    $links[] = l(t("books"), "book", array("title" => t("Read and contribute to the collaborative books.")));
Dries's avatar
   
Dries committed
69
70
  }

Dries's avatar
   
Dries committed
71
  if ($type == "menu.create" && user_access("maintain books")) {
Dries's avatar
   
Dries committed
72
    $links[] = l(t("create book page"), "node/add/book", array("title" => t("Add a new book page.")));
Dries's avatar
   
Dries committed
73
  }
Dries's avatar
   
Dries committed
74

Dries's avatar
   
Dries committed
75
76
77
78
  if ($type == "node" && $node->type == "book") {
    if (book_access("update", $node)) {
      $links[] = l(t("edit this page"), "node/edit/$node->nid", array("title" => t("Suggest an update for this book page.")));
    }
Dries's avatar
   
Dries committed
79
80
81
    if (!$main) {
      $links[] = l(t("printer-friendly version"), "book/print/$node->nid", array("title" => t("Show a printer-friendly version of this book page and its sub-pages.")));
    }
Dries's avatar
   
Dries committed
82
83
  }

Dries's avatar
   
Dries committed
84
  if ($type == "admin" && user_access("maintain books")) {
85
    menu("admin/node/book", "books", "book_admin", book_help("admin/node/book"), 4);
Dries's avatar
   
Dries committed
86
    menu("admin/node/book/orphan", "orphan pages", "book_admin", book_help("admin/node/book/orphan"), 8);
Dries's avatar
   
Dries committed
87
    menu("admin/node/book/help", "help", "book_help", NULL, 9);
Dries's avatar
   
Dries committed
88

Dries's avatar
   
Dries committed
89
    $result = db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = 0 ORDER BY b.weight, n.title");
Dries's avatar
   
Dries committed
90
    while ($book = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
91
      menu("admin/node/book/$book->nid", "'$book->title' book", "book_admin");
Dries's avatar
   
Dries committed
92
93
94
    }
  }

Dries's avatar
   
Dries committed
95
  return $links;
Dries's avatar
   
Dries committed
96
97
}

Dries's avatar
   
Dries committed
98
function book_load($node) {
Dries's avatar
   
Dries committed
99
  global $user;
Dries's avatar
   
Dries committed
100

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

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

Dries's avatar
   
Dries committed
105
106
    /*
    ** If a user is about to update a book page, we overload some
107
    ** fields to reflect the changes.  We use the request URI to
Dries's avatar
   
Dries committed
108
    ** dectect this as we don't want to interfer with updating a
Dries's avatar
   
Dries committed
109
    ** book page through the admin pages.
Dries's avatar
   
Dries committed
110
111
    */

Dries's avatar
   
Dries committed
112
113
114
115
116
117
118
119
    if ($user->uid) {
      $book->uid = $user->uid;
      $book->name = $user->name;
    }
    else {
      $book->uid = 0;
      $book->name = "";
    }
Dries's avatar
   
Dries committed
120
  }
Dries's avatar
   
Dries committed
121

Dries's avatar
   
Dries committed
122
123
124
  /*
  ** 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
125
  ** always such that the "edit this page"-links appear.
Dries's avatar
   
Dries committed
126
  */
Dries's avatar
   
Dries committed
127

Dries's avatar
   
Dries committed
128
  $book->revision = 1;
Dries's avatar
   
Dries committed
129

Dries's avatar
   
Dries committed
130
  return $book;
Dries's avatar
   
Dries committed
131
132
}

Dries's avatar
   
Dries committed
133
function book_insert($node) {
Dries's avatar
   
Dries committed
134
  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
135
}
Dries's avatar
   
Dries committed
136

Dries's avatar
   
Dries committed
137
function book_update($node) {
Dries's avatar
   
Dries committed
138
  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
139
}
Dries's avatar
   
Dries committed
140

141
function book_delete(&$node) {
Dries's avatar
   
Dries committed
142
  db_query("DELETE FROM {book} WHERE nid = %d", $node->nid);
Dries's avatar
   
Dries committed
143
144
}

145
function book_validate(&$node) {
146
  if ($node->format && user_access("create php content")) {
147
148
149
150
151
152
    // Do not filter PHP code, do not auto-extract a teaser
    $node->teaser = $node->body;
  }
  else {
    $node->format = 0;
  }
Dries's avatar
   
Dries committed
153

154
155
156
157
158
159
  // Set default values for non administrators:
  if (!user_access("administer nodes")) {
    $node->format = 0;
    $node->weight = 0;
    $node->revision = 1;
  }
Dries's avatar
   
Dries committed
160
161
}

162
function book_form(&$node, &$help, &$error) {
Dries's avatar
   
Dries committed
163
  global $user;
Dries's avatar
   
Dries committed
164

Dries's avatar
   
Dries committed
165
  $op = $_POST["op"];
166
  $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
167

168
169
170
171
  if (function_exists("taxonomy_node_form")) {
    $output .= implode("", taxonomy_node_form("book", $node));
  }

Dries's avatar
   
Dries committed
172
  $output .= form_textarea(t("Body"), "body", $node->body, 60, 20, form_allowed_tags_text());
173
  $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
174
175

  if (user_access("administer nodes")) {
Dries's avatar
   
Dries committed
176
    $output .= form_weight(t("Weight"), "weight", $node->weight, 15, t("The heavier pages will sink and the lighter pages will be positioned nearer the top."));
Dries's avatar
   
Dries committed
177
178
179
    if (user_access("create php content")) {
      $output .= form_select("Type", "format", $node->format, array(0 => "HTML / text", 1 => "PHP"));
    }
Dries's avatar
   
Dries committed
180
181
182
183
184
185
186
  }
  else {

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

Dries's avatar
   
Dries committed
187
188
    $help = book_node("description");

Dries's avatar
   
Dries committed
189
190
191
192
193
194
195
196
197
198
199
    /*
    ** 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
200
function book_node_link($node = 0) {
Dries's avatar
   
Dries committed
201
202
203
204
  global $user;

  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
205
206
207
208
209
210
211
212

  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
213
      db_query("INSERT INTO {book} (nid, parent, weight) VALUES (%d, %d, %d)", $node->nid, $edit["parent"], $edit["weight"]);
Dries's avatar
   
Dries committed
214
215
216
217
      $output .= status(t("added the node to the book."));
    }

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

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

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

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

      $output .= form_select(t("Parent"), "parent", $page->parent, book_toc(), t("The parent subject or category the page belongs in."));
Dries's avatar
   
Dries committed
233
      $output .= form_weight(t("Weight"), "weight", $node->weight, 15, t("The heavier pages will sink and the lighter pages will be positioned nearer the top."));
Dries's avatar
   
Dries committed
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249

      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
250
    return form($output, "post", url("admin/node/book"));
Dries's avatar
   
Dries committed
251
252
253
  }
}

Dries's avatar
   
Dries committed
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
/*
** 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
292
function book_location($node, $nodes = array()) {
Dries's avatar
   
Dries committed
293
  $parent = db_fetch_object(db_query("SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.nid = %d", $node->parent));
Dries's avatar
   
Dries committed
294
295
296
297
298
299
300
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

Dries's avatar
   
Dries committed
301
function book_location_down($node, $nodes = array()) {
Dries's avatar
   
Dries committed
302
  $last_direct_child = db_fetch_object(db_query("SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d ORDER BY b.weight DESC, n.title DESC", $node->nid));
Dries's avatar
   
Dries committed
303
304
305
306
307
308
309
310
  if ($last_direct_child) {
    array_push($nodes, $last_direct_child);
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

function book_prev($node) {
Dries's avatar
   
Dries committed
311
312
313
314
315
  // if the parent is zero, we are at the start of a book so there is no previous
  if ($node->parent == 0) {
    return NULL;
  }

Dries's avatar
   
Dries committed
316
  // previous on the same level
Dries's avatar
   
Dries committed
317
  $direct_above = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '') AND (b.weight < %d OR (b.weight = %d AND n.title < '%s')) ORDER BY b.weight DESC, n.title DESC", $node->parent, $node->weight, $node->weight, $node->title));
Dries's avatar
   
Dries committed
318
319
320
  if ($direct_above) {
    // get last leaf of $above
    $path = book_location_down($direct_above);
Dries's avatar
   
Dries committed
321
322

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
   
Dries committed
323
324
325
  }
  else {
    // direct parent
Dries's avatar
   
Dries committed
326
    $prev = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.nid = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '')", $node->parent));
Dries's avatar
   
Dries committed
327
328
329
330
331
332
    return $prev;
  }
}

function book_next($node) {
  // get first direct child
Dries's avatar
   
Dries committed
333
  $child = db_fetch_object(db_query("SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '') ORDER BY b.weight ASC, n.title ASC", $node->nid));
Dries's avatar
   
Dries committed
334
335
336
337
  if ($child) {
    return $child;
  }

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

Dries's avatar
   
Dries committed
349
function book_body($node) {
Dries's avatar
   
Dries committed
350
  $op = $_POST["op"];
Dries's avatar
   
Dries committed
351
352

  if ($node->format == 1) {
Dries's avatar
   
Dries committed
353
354
355
    // Make sure only authorized users can preview PHP pages.
    if ($op == t("Preview") && !user_access("create php content")) {
      return;
Dries's avatar
   
Dries committed
356
357
358
359
360
361
362
363
    }

    ob_start();
    eval($node->body);
    $output = ob_get_contents();
    ob_end_clean();
  }
  else {
Dries's avatar
   
Dries committed
364
    $output = check_output($node->body);
Dries's avatar
   
Dries committed
365
366
367
368
369
  }

  return $output;
}

Dries's avatar
   
Dries committed
370
function book_view($node, $main = 0, $return = 0) {
Dries's avatar
   
Dries committed
371
372
373

  /*
  ** Always display the most recently approved revision of a node
Dries's avatar
   
Dries committed
374
375
  ** (if any) unless we have to display this page in the context of
  ** the moderation queue.
Dries's avatar
   
Dries committed
376
377
  */

Dries's avatar
   
Dries committed
378
  if ($node->moderate && arg(0) != "queue") {
Dries's avatar
   
Dries committed
379
380
381
382
383
    $revision = book_revision_load($node, array("moderate" => 0, "status" => 1));

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
   
Dries committed
384
385
  }

Dries's avatar
   
Dries committed
386
387
388
389
390
391
392
  /*
  ** 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
393
394
395
396
397
  /*
  ** 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
398

Dries's avatar
   
Dries committed
399
  if ($main) {
Dries's avatar
   
Dries committed
400
    return $node;
Dries's avatar
   
Dries committed
401
  }
Dries's avatar
   
Dries committed
402
  else {
Dries's avatar
   
Dries committed
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
    // build the tree from bottom to top to have the book index in $level for navigation later
    $path = book_location($node);
    $node->trail[] = l(t("Home"), "");
    $node->trail[] = l(t("Books"), "book");
    foreach ($path as $level) {
      $node->trail[] = l($level->title, "book/view/$level->nid");
    }
    if ($node->moderate) {
      $node->body = $node->body . "<div class=\"log\"><div class=\"title\">". t("Log") .":</div>$node->log</div>";
    }
    if (!$return) { // Add the navigation when we have a node/view and the output is for theme("node")
      $node = book_navigation($node);
    }
    return $node;
  }
}

function book_show($node, $cid) {

  $node = node_view($node,0,1);

  /*
  ** Add the book navigation
  */

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

  if ($book) {
    foreach ($book as $key => $value) {
      $node->$key = $value;
    }
    $node = book_navigation($node);
  }

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

  $node->type = "book";

  /*
  ** View the node
  */

  if (node_access("view", $node)) {
    theme("breadcrumb", $node->trail);
    theme("node",$node, 0);

    if (function_exists("comment_render") && $node->comment) {
      comment_render($node, $cid);
    }

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

Dries's avatar
   
Dries committed
462
function book_navigation($node) {
Dries's avatar
   
Dries committed
463

Dries's avatar
   
Dries committed
464
    $path = book_location($node);
Dries's avatar
   
Dries committed
465

Dries's avatar
   
Dries committed
466
467
468
469
470
471
472
473
474
475
476
    if ($node->type != "book") {
      $node->trail = ""; // Overwrite the trail with a book trail.
      $node->trail[] = l(t("Home"), "");
      $node->trail[] = l(t("Books"), "book");
      foreach ($path as $level) {
        $node->trail[] = l($level->title, "book/view/$level->nid");
      }
    }
    /*
    ** Construct the "next" and "previous" links:
    */
Dries's avatar
 
Dries committed
477

Dries's avatar
   
Dries committed
478
479
480
    if ($node->nid) {
      $prev = book_prev($node);
      $next = book_next($node);
481
482
    }

Dries's avatar
   
Dries committed
483
    if ($node->nid) {
Dries's avatar
   
Dries committed
484
      $output .= "<div class=\"book\">";
Dries's avatar
   
Dries committed
485
486
487
      $output .= "<div class=\"tree\">". book_tree($node->nid) ."</div>";
      if ($prev) {
        $links .= "<div class=\"prev\">";
Dries's avatar
   
Dries committed
488
        $links .= l(t("previous"), "book/view/$prev->nid", array("title" => t("View the previous page in this book.")));
Dries's avatar
   
Dries committed
489
490
491
492
493
        $links .= "</div>";
        $titles .= "<div class=\"prev\">$prev->title</div>";
      }
      if ($next) {
        $links .= "<div class=\"next\">";
Dries's avatar
   
Dries committed
494
        $links .= l(t("next"), "book/view/$next->nid", array("title" => t("View the next page in this book.")));
Dries's avatar
   
Dries committed
495
496
497
        $links .= "</div>";
        $titles .= "<div class=\"next\">$next->title</div>";
      }
Dries's avatar
   
Dries committed
498
499
500
      else {
        $links .= "<div class=\"next\">&nbsp;</div>"; // make an empty div to fill the space
      }
Dries's avatar
   
Dries committed
501
502
      if ($node->parent) {
        $links .= "<div class=\"up\">";
Dries's avatar
   
Dries committed
503
        $links .= l(t("up"), "book/view/$node->parent", array("title" => t("View this page's parent section.")));
Dries's avatar
   
Dries committed
504
505
506
507
508
509
        $links .= "</div>";
      }
      $output .= "<div class=\"nav\">";
      $output .= "<div class=\"links\">$links</div>";
      $output .= "<div class=\"titles\">$titles</div>";
      $output .= "</div>";
Dries's avatar
   
Dries committed
510
      $output .= "</div>";
Dries's avatar
   
Dries committed
511
    }
Dries's avatar
   
Dries committed
512
513
    $node->body = $node->body.$output;
  return $node;
Dries's avatar
   
Dries committed
514
  }
Dries's avatar
 
Dries committed
515

Dries's avatar
   
Dries committed
516
517
518
519
520
521
522
523
524
525
526
527
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
528
function book_toc($parent = 0, $indent = "", $toc = array()) {
Dries's avatar
   
Dries committed
529

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

Dries's avatar
   
Dries committed
532
533
534
535
536
  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
537
538

  /*
Dries's avatar
   
Dries committed
539
540
  ** If the user is an administrator, add the root node; only
  ** administrators can start new books.
Dries's avatar
   
Dries committed
541
  */
Dries's avatar
   
Dries committed
542

Dries's avatar
   
Dries committed
543
  if (user_access("administer nodes")) {
Dries's avatar
   
Dries committed
544
    $toc[0] = "<". t("root") .">";
Dries's avatar
   
Dries committed
545
546
  }

Dries's avatar
   
Dries committed
547
  /*
Dries's avatar
   
Dries committed
548
  ** Iterate root book nodes:
Dries's avatar
   
Dries committed
549
550
  */

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

Dries's avatar
   
Dries committed
553
554
555
  return $toc;
}

Dries's avatar
 
Dries committed
556

Dries's avatar
   
Dries committed
557
function book_tree_recurse($nid, $depth, $children) {
Dries's avatar
   
Dries committed
558

Dries's avatar
   
Dries committed
559
  if ($depth > 0) {
Dries's avatar
   
Dries committed
560
561
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
Dries's avatar
   
Dries committed
562
        $output .= "<li>";
Dries's avatar
   
Dries committed
563
        $output .= l($node->title, "book/view/$node->nid");
Dries's avatar
   
Dries committed
564
565
566
        if ($tree = book_tree_recurse($node->nid, $depth - 1, $children)) {
          $output .= "<ul>$tree</ul>";
        }
Dries's avatar
   
Dries committed
567
        $output .= "</li>";
Dries's avatar
   
Dries committed
568
569
      }
    }
Dries's avatar
   
Dries committed
570
571
572
573
574
  }

  return $output;
}

Dries's avatar
   
Dries committed
575

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

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

Dries's avatar
   
Dries committed
580
581
582
583
  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
584
  }
Dries's avatar
   
Dries committed
585

Dries's avatar
   
Dries committed
586
587
  $output = book_tree_recurse($parent, $depth, $children);
  $output = "<ul>$output</ul>";
Dries's avatar
   
Dries committed
588

Dries's avatar
   
Dries committed
589
590
591
  return $output;
}

Dries's avatar
   
Dries committed
592

Dries's avatar
   
Dries committed
593
function book_render() {
Dries's avatar
   
Dries committed
594

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

Dries's avatar
   
Dries committed
597
598
599
600
601
602
  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
603
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
   
Dries committed
604
605
    }

Dries's avatar
   
Dries committed
606
607
    if ($node) {
      // output the content:
Dries's avatar
   
Dries committed
608
      $output .= "<div class=\"book\">";
Dries's avatar
   
Dries committed
609
      $output .= "<div class=\"title\">". l($node->title, "book/view/$node->nid") ."</div>";
Dries's avatar
   
Dries committed
610
611
      $output .= "<div class=\"body\">". book_body($node) ."</div>";
      $output .= "</div>";
Dries's avatar
   
Dries committed
612
    }
Dries's avatar
   
Dries committed
613
614
  }

Dries's avatar
   
Dries committed
615
  theme("header");
616
  theme("box", t("Books"), "$output");
Dries's avatar
   
Dries committed
617
  theme("footer");
Dries's avatar
   
Dries committed
618
619
620
}

function book_page() {
Dries's avatar
   
Dries committed
621

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

644
function book_print($id = "", $depth = 1) {
Dries's avatar
   
Dries committed
645
  global $base_url;
Dries's avatar
   
Dries committed
646
  $result = db_query("SELECT n.nid FROM {node} n INNER JOIN book b ON n.nid = b.nid WHERE n.status = 1 AND n.nid = %d AND (n.moderate = 0 OR n.revisions IS NOT NULL) ORDER BY b.weight, n.title", $id);
Dries's avatar
   
Dries committed
647

Dries's avatar
   
Dries committed
648
649
650
  while ($page = db_fetch_object($result)) {
    // load the node:
    $node = node_load(array("nid" => $page->nid));
Dries's avatar
   
Dries committed
651

Dries's avatar
   
Dries committed
652
653
    // take the most recent approved revision:
    if ($node->moderate) {
Dries's avatar
   
Dries committed
654
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
   
Dries committed
655
656
    }

Dries's avatar
   
Dries committed
657
    if ($node) {
Dries's avatar
   
Dries committed
658
      $node = node_view($node, 0, 1);
Dries's avatar
   
Dries committed
659
      // output the content:
Dries's avatar
   
Dries committed
660
      $output .= "<h1 id=\"$node->nid\" name=\"$node->nid\" class=\"book-h$depth\">$node->title</h1>";
Dries's avatar
   
Dries committed
661
      if ($node->body) {
Dries's avatar
   
Dries committed
662
        $output .= $node->body;
Dries's avatar
   
Dries committed
663
      }
Dries's avatar
   
Dries committed
664
    }
Dries's avatar
   
Dries committed
665
  }
Dries's avatar
   
Dries committed
666

667
  $output .= book_print_recurse($id, $depth);
Dries's avatar
   
Dries committed
668

Dries's avatar
   
Dries committed
669
670
671
672
673
674
  $html = "<html><head><title>$node->title</title>";
  $html .= "<base href=\"$base_url/\" />";
  $html .= "<style type=\"text/css\">\n@import url(misc/print.css);\n</style>";
  $html .= "</head><body>". $output ."</body></html>";

  return $html;
Dries's avatar
   
Dries committed
675
676
}

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

Dries's avatar
   
Dries committed
680
681
682
683
684
685
  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
686
      $node = book_revision_load($node, array("moderate" => 0, "status" => 1));
Dries's avatar
   
Dries committed
687
688
    }

Dries's avatar
   
Dries committed
689
690
    if ($node) {
      // output the content:
Dries's avatar
   
Dries committed
691
      $output .= "<h1 id=\"$node->nid\" name=\"$node->nid\" class=\"book-h$depth\">$node->title</h1>";
Dries's avatar
   
Dries committed
692
      $node = node_view($node, 0, 1);
Dries's avatar
   
Dries committed
693
      if ($node->body) {
Dries's avatar
   
Dries committed
694
        $output .= "<ul>". $node->body ."</ul>";
Dries's avatar
   
Dries committed
695
      }
Dries's avatar
   
Dries committed
696

697
      $output .= book_print_recurse($node->nid, $depth + 1);
Dries's avatar
   
Dries committed
698
    }
Dries's avatar
   
Dries committed
699
  }
Dries's avatar
   
Dries committed
700

Dries's avatar
   
Dries committed
701
702
  return $output;
}
Dries's avatar
   
Dries committed
703

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

Dries's avatar
   
Dries committed
706
  $row = array("<div style=\"padding-left: ". (25 * $depth) ."px;\">". form_textfield(NULL, "$node->nid][title", $node->title, 64, 255) ."</div>", form_weight(NULL, "$node->nid][weight", $node->weight), l(t("view node"), "node/view/$node->nid"), l(t("edit node"), "admin/node/edit/$node->nid"), l(t("delete node"), "admin/node/delete/$node->nid"));
Dries's avatar
   
Dries committed
707
708

  return $row;
Dries's avatar
   
Dries committed
709
710
711
}

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

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

Dries's avatar
   
Dries committed
720
  return $rows;
Dries's avatar
   
Dries committed
721
722
723
724
}

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

Dries's avatar
   
Dries committed
725
726
  if ($nid) {
    $node = node_load(array("nid" => $nid));
Dries's avatar
   
Dries committed
727

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

Dries's avatar
   
Dries committed
730
731
732
    $header = array(t("title"), t("weight"), array("data" => t("operations"), "colspan" => 3));
    $rows[] = book_admin_view_line($node);
    $rows = array_merge($rows, book_admin_view_book($nid));
Dries's avatar
   
Dries committed
733

Dries's avatar
   
Dries committed
734
735
    $output .= table($header, $rows);
    $output .= form_submit(t("Save book pages"));
Dries's avatar
   
Dries committed
736

Dries's avatar
   
Dries committed
737
738
    return form($output);
  }
Dries's avatar
   
Dries committed
739
740
741
742
}

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

Dries's avatar
   
Dries committed
743
744
  if ($nid) {
    $book = node_load(array("nid" => $nid));
Dries's avatar
   
Dries committed
745

Dries's avatar
   
Dries committed
746
747
748
749
    foreach ($edit as $nid => $value) {
      /*
      ** Check to see whether the title needs updating:
      */
Dries's avatar
   
Dries committed
750

Dries's avatar
   
Dries committed
751
      $title = db_result(db_query("SELECT title FROM {node} WHERE nid = %d", $nid));
Dries's avatar
   
Dries committed
752
      if ($title != $value["title"]) {
Dries's avatar
   
Dries committed
753
        db_query("UPDATE {node} SET title = '%s' WHERE nid = %d", $value["title"], $nid);
Dries's avatar
   
Dries committed
754
      }
Dries's avatar
   
Dries committed
755

Dries's avatar
   
Dries committed
756
757
758
      /*
      ** Check to see whether the weight needs updating:
      */
Dries's avatar
   
Dries committed
759

Dries's avatar
   
Dries committed
760
      $weight = db_result(db_query("SELECT weight FROM {book} WHERE nid = %d", $nid));
Dries's avatar
   
Dries committed
761
      if ($weight != $value["weight"]) {
Dries's avatar
   
Dries committed
762
        db_query("UPDATE {book} SET weight = %d WHERE nid = %d", $value["weight"], $nid);
Dries's avatar
   
Dries committed
763
      }
Dries's avatar
   
Dries committed
764
765
    }

Dries's avatar
   
Dries committed
766
767
    $message = t("updated book '%title'", array("%title" => $book->title));
    watchdog("special", $message);
Dries's avatar
   
Dries committed
768

Dries's avatar
   
Dries committed
769
770
    return $message;
  }
Dries's avatar
   
Dries committed
771
772
773
774
}

function book_admin_orphan() {

Dries's avatar
   
Dries committed
775
  $result = db_query("SELECT n.nid, n.title, n.status, b.parent FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.type = 'book'");
Dries's avatar
   
Dries committed
776
777
778
779
780

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

Dries's avatar
   
Dries committed
781
  if ($pages) {
Dries's avatar
   
Dries committed
782
783
    $output .= "<h3>Orphan pages</h3>";
    $header = array(t("title"), t("weight"), array("data" => t("operations"), "colspan" => 3));
Dries's avatar
   
Dries committed
784
785
    foreach ($pages as $nid => $node) {
      if ($node->parent && empty($pages[$node->parent])) {
Dries's avatar
   
Dries committed
786
787
        $rows[] = book_admin_view_line($node, $depth);
        $rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
Dries's avatar
   
Dries committed
788
      }
Dries's avatar
   
Dries committed
789
    }
Dries's avatar
   
Dries committed
790
    $output .= table($header, $rows);
Dries's avatar
   
Dries committed
791
792
793
794
795
796
797
798
799
  }

  return $output;
}

function book_admin_links() {
}

function book_admin() {
Dries's avatar
   
Dries committed
800
801
  $op = $_POST["op"];
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
802
803

  if (user_access("administer nodes")) {
Dries's avatar
   
Dries committed
804
    if (empty($op)) {
Dries's avatar
   
Dries committed
805
      $op = arg(3);
Dries's avatar
   
Dries committed
806
807
    }

Dries's avatar
   
Dries committed
808
    switch ($op) {
Dries's avatar
   
Dries committed
809
810
811
812
      case t("Edit book outline"):
      case t("Add to book outline"):
      case t("Remove from book outline"):
      case t("Update book outline"):
Dries's avatar
   
Dries committed
813
        $output = book_node_link();
Dries's avatar
   
Dries committed
814
        break;
Dries's avatar
   
Dries committed
815
      case "orphan":
Dries's avatar
   
Dries committed
816
        $output = book_admin_orphan();
Dries's avatar
   
Dries committed
817
        break;
818
      case t("Save book pages"):
Dries's avatar
   
Dries committed
819
        $output = status(book_admin_save(arg(3), $edit));
Dries's avatar
   
Dries committed
820
        // fall through:
Dries's avatar
   
Dries committed
821
      default:
Dries's avatar
   
Dries committed
822
        $output .= book_admin_view(arg(3));
Dries's avatar
   
Dries committed
823
824
        break;
    }
Dries's avatar
   
Dries committed
825
    return $output;
Dries's avatar
   
Dries committed
826
827
828
  }
}

Dries's avatar
   
Dries committed
829
830
function book_help($section = "admin/node/book/help") {
  $output = "";
831

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

  }

  return t($output);
860
}
Dries's avatar
   
Dries committed
861
?>