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

Dries's avatar
   
Dries committed
4
5
6
7
8
/**
 * @file
 * Allows users to collaboratively author a book.
 */

9
10
11
/**
 * Implementation of hook_node_name().
 */
Dries's avatar
   
Dries committed
12
function book_node_name($node) {
13
  return t('book page');
Dries's avatar
   
Dries committed
14
15
}

16
17
18
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
19
function book_perm() {
20
  return array('maintain books', 'edit own book pages');
Dries's avatar
   
Dries committed
21
22
}

23
24
25
/**
 * Implementation of hook_access().
 */
Dries's avatar
   
Dries committed
26
function book_access($op, $node) {
Dries's avatar
   
Dries committed
27
  global $user;
Dries's avatar
   
Dries committed
28

29
  if ($op == 'view') {
Dries's avatar
   
Dries committed
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_content() function.
34
    return ($node->status ? $node->status : ($node->uid == $user->uid && user_access('edit own book pages')));
Dries's avatar
   
Dries committed
35
36
  }

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

43
  if ($op == 'update') {
Dries's avatar
   
Dries committed
44
45
46
    // 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 update a book page if there are no suggested updates
47
48
49
50
    // of that page waiting for approval 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.

51
52
    return (user_access('maintain books') && !$node->moderate && $node->revision)
      || ($node->uid == $user->uid && user_access('edit own book pages'));
Dries's avatar
   
Dries committed
53
  }
Dries's avatar
   
Dries committed
54
55
}

Dries's avatar
   
Dries committed
56
57
58
/**
 * Implementation of hook_link().
 */
Dries's avatar
   
Dries committed
59
function book_link($type, $node = 0, $main = 0) {
Dries's avatar
   
Dries committed
60
61
62

  $links = array();

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

Dries's avatar
   
Dries committed
67
  if ($type == 'node' && $node->type == 'book') {
Dries's avatar
   
Dries committed
68
    if (!$main) {
Dries's avatar
   
Dries committed
69
      $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
70
    }
Dries's avatar
   
Dries committed
71
72
  }

Dries's avatar
   
Dries committed
73
  return $links;
Dries's avatar
   
Dries committed
74
75
}

Dries's avatar
   
Dries committed
76
77
78
/**
 * Implementation of hook_menu().
 */
Dries's avatar
   
Dries committed
79
function book_menu($may_cache) {
Dries's avatar
   
Dries committed
80
81
  $items = array();

Dries's avatar
   
Dries committed
82
83
84
85
86
87
88
89
90
91
92
  if ($may_cache) {
    $items[] = array('path' => 'node/add/book', 'title' => t('book page'),
      'access' => user_access('maintain books'));
    $items[] = array('path' => 'admin/node/book', 'title' => t('books'),
      'callback' => 'book_admin',
      'access' => user_access('administer nodes'),
      'weight' => 4);
    $items[] = array('path' => 'admin/node/book/orphan', 'title' => t('orphan pages'),
      'callback' => 'book_admin_orphan',
      'access' => user_access('administer nodes'),
      'weight' => 8);
93
    $result = db_query('SELECT n.nid, n.title FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE '. node_access_where_sql() .' AND b.parent = 0 ORDER BY b.weight, n.title');
Dries's avatar
   
Dries committed
94
95
96
    while ($book = db_fetch_object($result)) {
      $items[] = array('path' => 'admin/node/book/'. $book->nid, 'title' => t('"%title" book', array('%title' => $book->title)));
    }
Dries's avatar
   
Dries committed
97

Dries's avatar
   
Dries committed
98
99
100
101
102
103
104
105
    $items[] = array('path' => 'book', 'title' => t('books'),
      'callback' => 'book_render',
      'access' => user_access('access content'),
      'type' => MENU_SUGGESTED_ITEM);
    $items[] = array('path' => 'book/print', 'title' => t('printer-friendly version'),
      'callback' => 'book_print',
      'access' => user_access('access content'),
      'type' => MENU_CALLBACK);
Dries's avatar
   
Dries committed
106
  }
Dries's avatar
   
Dries committed
107
108
109
110
111
112
113
114
115
116
117
118
119
  else {
    // To avoid SQL overhead, check whether we are on a node page and whether the
    // user is allowed to maintain books.
    if (arg(0) == 'node' && is_numeric(arg(1)) && user_access('maintain books')) {
      // Only add the outline-tab for non-book pages:
      $result = db_query('SELECT n.nid FROM {node} n '. node_access_join_sql() .' WHERE '. node_access_where_sql() ." AND n.nid = %d AND n.type != 'book'", arg(1));
      if (db_num_rows($result) > 0) {
        $items[] = array('path' => 'node/'. arg(1) .'/outline', 'title' => t('outline'),
          'callback' => 'book_outline', 'access' => user_access('maintain books'),
          'type' => MENU_LOCAL_TASK, 'weight' => 2);
      }
    }
  }
Dries's avatar
   
Dries committed
120
121
122
123

  return $items;
}

124
125
126
/**
 * Implementation of hook_block().
 *
Dries's avatar
   
Dries committed
127
128
 * Displays the book table of contents in a block when the current page is a
 * single-node view of a book node.
129
 */
Dries's avatar
   
Dries committed
130
function book_block($op = 'list', $delta = 0) {
Dries's avatar
   
Dries committed
131
  $block = array();
Dries's avatar
   
Dries committed
132
133
134
135
  if ($op == 'list') {
    $block[0]['info'] = t('Book navigation');
  }
  else {
Dries's avatar
   
Dries committed
136
137
    // Only display this block when the user is browsing a book:
    if (arg(0) == 'node' && is_numeric(arg(1))) {
138
      $result = db_query('SELECT n.nid, n.title, b.parent FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE '. node_access_where_sql() .' AND n.nid = %d', arg(1));
Dries's avatar
   
Dries committed
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
      if (db_num_rows($result) > 0) {
        $node = db_fetch_object($result);

        $path = book_location($node);
        $path[] = $node;

        $expand = array();
        foreach ($path as $key => $node) {
          $expand[] = $node->nid;
        }

        $block['subject'] = $path[0]->title;
        $block['content'] = book_tree($expand[0], 5, $expand);
      }
    }
Dries's avatar
   
Dries committed
154
155
156
157
158
  }

   return $block;
}

159
160
161
/**
 * Implementation of hook_load().
 */
Dries's avatar
   
Dries committed
162
function book_load($node) {
Dries's avatar
   
Dries committed
163
  global $user;
Dries's avatar
   
Dries committed
164

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

Dries's avatar
   
Dries committed
167
  if (arg(2) == 'edit' && !user_access('administer nodes')) {
Dries's avatar
   
Dries committed
168
169
    // If a user is about to update a book page, we overload some
    // fields to reflect the changes.
Dries's avatar
   
Dries committed
170
171
172
173
174
175
    if ($user->uid) {
      $book->uid = $user->uid;
      $book->name = $user->name;
    }
    else {
      $book->uid = 0;
176
      $book->name = '';
Dries's avatar
   
Dries committed
177
    }
Dries's avatar
   
Dries committed
178
  }
Dries's avatar
   
Dries committed
179

Dries's avatar
   
Dries committed
180
  return $book;
Dries's avatar
   
Dries committed
181
182
}

183
184
185
/**
 * Implementation of hook_insert().
 */
Dries's avatar
   
Dries committed
186
function book_insert($node) {
187
  db_query("INSERT INTO {book} (nid, parent, weight, log) VALUES (%d, %d, %d, '%s')", $node->nid, $node->parent, $node->weight, $node->log);
Dries's avatar
   
Dries committed
188
}
Dries's avatar
   
Dries committed
189

190
191
192
/**
 * Implementation of hook_update().
 */
Dries's avatar
   
Dries committed
193
function book_update($node) {
194
  db_query("UPDATE {book} SET parent = %d, weight = %d, log = '%s' WHERE nid = %d", $node->parent, $node->weight, $node->log, $node->nid);
Dries's avatar
   
Dries committed
195
}
Dries's avatar
   
Dries committed
196

197
198
199
/**
 * Implementation of hook_delete().
 */
200
function book_delete(&$node) {
201
  db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
Dries's avatar
   
Dries committed
202
203
}

204
205
206
/**
 * Implementation of hook_validate().
 */
207
function book_validate(&$node) {
208
209
  // Set default values for non-administrators.
  if (!user_access('administer nodes')) {
210
211
212
    $node->weight = 0;
    $node->revision = 1;
  }
Dries's avatar
   
Dries committed
213
214
}

215
216
217
/**
 * Implementation of hook_form().
 */
Dries's avatar
   
Dries committed
218
function book_form(&$node) {
Dries's avatar
   
Dries committed
219
  global $user;
Dries's avatar
   
Dries committed
220

221
  $op = $_POST['op'];
222
  $output = form_select(t('Parent'), 'parent', $node->parent, book_toc($node->nid), t('The parent subject or category the page belongs in.'));
Dries's avatar
   
Dries committed
223

224
225
  if (function_exists('taxonomy_node_form')) {
    $output .= implode('', taxonomy_node_form('book', $node));
226
227
  }

228
  $output .= form_textarea(t('Body'), 'body', $node->body, 60, 20, '', NULL, TRUE);
229
  $output .= filter_form('format', $node->format);
230
  $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
231

232
233
  if (user_access('administer nodes')) {
    $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
  }
  else {
Dries's avatar
   
Dries committed
236
237
    // If a regular user updates a book page, we create a new revision
    // authored by that user:
238
    $output .= form_hidden('revision', 1);
Dries's avatar
   
Dries committed
239
240
241
242
243
  }

  return $output;
}

244
/**
Dries's avatar
   
Dries committed
245
246
 * Implementation of function book_outline()
 * Handles all book outline operations.
247
 */
Dries's avatar
   
Dries committed
248
function book_outline() {
Dries's avatar
   
Dries committed
249

250
251
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries's avatar
   
Dries committed
252
  $node = node_load(array('nid' => arg(1)));
Dries's avatar
   
Dries committed
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
  if ($node->nid) {
    switch ($op) {
      case t('Add to book outline'):
        db_query('INSERT INTO {book} (nid, parent, weight) VALUES (%d, %d, %d)', $node->nid, $edit['parent'], $edit['weight']);
        drupal_set_message(t('Added the post to the book.'));
        drupal_goto("node/$node->nid");
        break;

      case t('Update book outline'):
        db_query('UPDATE {book} SET parent = %d, weight = %d WHERE nid = %d', $edit['parent'], $edit['weight'], $node->nid);
        drupal_set_message(t('Updated the book outline.'));
        drupal_goto("node/$node->nid");
        break;

      case t('Remove from book outline'):
        db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
        drupal_set_message(t('Removed the post from the book.'));
        drupal_goto("node/$node->nid");
        break;

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

        $output  = form_select(t('Parent'), 'parent', $page->parent, book_toc($node->nid), t('The parent page in the book.'));
        $output .= form_weight(t('Weight'), 'weight', $page->weight, 15, 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'));
        }
Dries's avatar
   
Dries committed
287

Dries's avatar
   
Dries committed
288
        print theme('page', form($output), $node->title);
Dries's avatar
   
Dries committed
289
290
291
292
    }
  }
}

Dries's avatar
   
Dries committed
293

294
295
296
/**
 * Return the the most recent revision that matches the specified conditions.
 */
Dries's avatar
   
Dries committed
297
298
299
300
301
302
function book_revision_load($page, $conditions = array()) {

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

  foreach ($revisions as $revision) {

Dries's avatar
   
Dries committed
303
    // Extract the specified revision:
Dries's avatar
   
Dries committed
304
305
    $node = node_revision_load($page, $revision);

Dries's avatar
   
Dries committed
306
307
    // Check to see if the conditions are met:
    $status = TRUE;
Dries's avatar
   
Dries committed
308
309
310

    foreach ($conditions as $key => $value) {
      if ($node->$key != $value) {
Dries's avatar
   
Dries committed
311
        $status = FALSE;
Dries's avatar
   
Dries committed
312
313
314
315
316
317
318
319
320
      }
    }

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

321
322
323
/**
 * Return the path (call stack) to a certain book page.
 */
Dries's avatar
   
Dries committed
324
function book_location($node, $nodes = array()) {
325
  $parent = db_fetch_object(db_query('SELECT n.nid, n.title, b.parent FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE '. node_access_where_sql() .' AND n.nid = %d', $node->parent));
Dries's avatar
   
Dries committed
326
327
328
329
330
331
332
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

Dries's avatar
   
Dries committed
333
function book_location_down($node, $nodes = array()) {
334
  $last_direct_child = db_fetch_object(db_query('SELECT n.nid, n.title, b.parent FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE '. node_access_where_sql() .' AND b.parent = %d ORDER BY b.weight DESC, n.title DESC', $node->nid));
Dries's avatar
   
Dries committed
335
336
337
338
339
340
341
  if ($last_direct_child) {
    array_push($nodes, $last_direct_child);
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

342
343
344
/**
 * Fetch the node object of the previous page of the book.
 */
Dries's avatar
   
Dries committed
345
function book_prev($node) {
Dries's avatar
   
Dries committed
346
  // If the parent is zero, we are at the start of a book so there is no previous.
Dries's avatar
   
Dries committed
347
348
349
350
  if ($node->parent == 0) {
    return NULL;
  }

Dries's avatar
   
Dries committed
351
  // Previous on the same level:
352
  $direct_above = db_fetch_object(db_query('SELECT n.nid, n.title FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE '. node_access_where_sql() ." AND 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
353
  if ($direct_above) {
Dries's avatar
   
Dries committed
354
    // Get last leaf of $above.
Dries's avatar
   
Dries committed
355
    $path = book_location_down($direct_above);
Dries's avatar
   
Dries committed
356
357

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
   
Dries committed
358
359
  }
  else {
Dries's avatar
   
Dries committed
360
    // Direct parent:
361
    $prev = db_fetch_object(db_query('SELECT n.nid, n.title FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE '. node_access_where_sql() ." AND n.nid = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '')", $node->parent));
Dries's avatar
   
Dries committed
362
363
364
365
    return $prev;
  }
}

366
367
368
/**
 * Fetch the node object of the next page of the book.
 */
Dries's avatar
   
Dries committed
369
370
function book_next($node) {
  // get first direct child
Dries's avatar
   
Dries committed
371
  $child = db_fetch_object(db_query("SELECT DISTINCT(n.nid), n.title, b.weight FROM {node} n ". node_access_join_sql() ." INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND ". node_access_where_sql() ." AND (n.moderate = 0 OR n.revisions != '') ORDER BY b.weight ASC, n.title ASC", $node->nid));
Dries's avatar
   
Dries committed
372
373
374
375
  if ($child) {
    return $child;
  }

Dries's avatar
   
Dries committed
376
377
  // No direct child: get next for this level or any parent in this book.
  array_push($path = book_location($node), $node); // Path to top-level node including this one.
378

Dries's avatar
   
Dries committed
379
  while (($leaf = array_pop($path)) && count($path)) {
Dries's avatar
   
Dries committed
380
    $next = db_fetch_object(db_query("SELECT DISTINCT(n.nid), n.title, b.weight FROM {node} n ". node_access_join_sql() ." INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND ". node_access_where_sql() ." 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
381
382
383
384
385
386
    if ($next) {
      return $next;
    }
  }
}

387
388
389
/**
 * Implementation of hook_content().
 */
Dries's avatar
   
Dries committed
390
function book_content($node, $teaser = FALSE) {
391
  $op = $_POST['op'];
Dries's avatar
   
Dries committed
392

Dries's avatar
   
Dries committed
393
394
395
  // Always display the most recently approved revision of a node
  // (if any) unless we have to display this page in the context of
  // the moderation queue.
396
397
  if ($op != t('Preview') && $node->moderate && arg(0) != 'queue') {
    $revision = book_revision_load($node, array('moderate' => 0, 'status' => 1));
Dries's avatar
   
Dries committed
398
399
400
401

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
   
Dries committed
402
403
  }

404
405
  // Extract the page body.
  $node = node_prepare($node, $teaser);
Dries's avatar
   
Dries committed
406

Dries's avatar
   
Dries committed
407
408
409
  return $node;
}

410
411
412
413
414
415
/**
 * Implementation of hook_view().
 *
 * If not displayed on the main page, we render the node as a page in the
 * book with extra links to the previous and next pages.
 */
Dries's avatar
   
Dries committed
416
function book_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
   
Dries committed
417
  $node = book_content($node, $teaser);
Dries's avatar
   
Dries committed
418

Dries's avatar
   
Dries committed
419
420
  if (!$teaser && $node->moderate) {
    $node->body .= '<div class="log"><div class="title">'. t('Log') .':</div>'. $node->log .'</div>';
Dries's avatar
   
Dries committed
421
422
423
  }
}

424
/**
Dries's avatar
   
Dries committed
425
426
427
 * Implementation of hook_nodeapi().
 *
 * Appends book navigation to all nodes in the book.
428
 */
Dries's avatar
   
Dries committed
429
430
431
432
function book_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
    case 'view':
      if (!$teaser) {
Dries's avatar
   
Dries committed
433
        $book = db_fetch_array(db_query('SELECT * FROM {book} WHERE nid = %d', $node->nid));
Dries's avatar
   
Dries committed
434

Dries's avatar
   
Dries committed
435
436
437
438
439
        if ($book) {
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
          $node = book_navigation($node);
440
441
442
          if ($page) {
            menu_set_location($node->breadcrumb);
          }
Dries's avatar
   
Dries committed
443
        }
Dries's avatar
   
Dries committed
444
      }
Dries's avatar
   
Dries committed
445
      break;
Dries's avatar
   
Dries committed
446
  }
Dries's avatar
   
Dries committed
447
}
Dries's avatar
   
Dries committed
448

449
450
451
452
/**
 * Prepares both the custom breadcrumb trail and the forward/backward
 * navigation for a node presented as a book page.
 */
Dries's avatar
   
Dries committed
453
function book_navigation($node) {
Dries's avatar
   
Dries committed
454
  $path = book_location($node);
Dries's avatar
   
Dries committed
455

Dries's avatar
   
Dries committed
456
  // Construct the breadcrumb:
Dries's avatar
   
Dries committed
457

Dries's avatar
   
Dries committed
458
  $node->breadcrumb = array(); // Overwrite the trail with a book trail.
Dries's avatar
   
Dries committed
459
  foreach ($path as $level) {
Dries's avatar
   
Dries committed
460
    $node->breadcrumb[] = array('path' => 'node/'. $level->nid, 'title' =>  $level->title);
Dries's avatar
   
Dries committed
461
  }
Dries's avatar
   
Dries committed
462
  $node->breadcrumb[] = array('path' => 'node/'. $node->nid);
Dries's avatar
   
Dries committed
463

Dries's avatar
   
Dries committed
464
  if ($node->nid) {
465
    $output .= '<div class="book">';
Dries's avatar
   
Dries committed
466
467

    if ($tree = book_tree($node->nid)) {
Dries's avatar
   
Dries committed
468
      $output .= '<div class="tree">'. $tree .'</div>';
Dries's avatar
   
Dries committed
469
    }
Dries's avatar
   
Dries committed
470

Dries's avatar
   
Dries committed
471
    if ($prev = book_prev($node)) {
472
      $links .= '<div class="prev">';
Dries's avatar
   
Dries committed
473
      $links .= l(t('previous'), 'node/'. $prev->nid, array('title' => t('View the previous page.')));
474
      $links .= '</div>';
Dries's avatar
   
Dries committed
475
      $titles .= '<div class="prev">'. $prev->title .'</div>';
Dries's avatar
   
Dries committed
476
477
    }
    else {
Dries's avatar
   
Dries committed
478
      $links .= '<div class="prev">&nbsp;</div>'; // Make an empty div to fill the space.
Dries's avatar
   
Dries committed
479
480
    }
    if ($next = book_next($node)) {
481
      $links .= '<div class="next">';
Dries's avatar
   
Dries committed
482
      $links .= l(t('next'), 'node/'. $next->nid, array('title' => t('View the next page.')));
483
      $links .= '</div>';
Dries's avatar
   
Dries committed
484
      $titles .= '<div class="next">'. $next->title .'</div>';
Dries's avatar
   
Dries committed
485
486
    }
    else {
Dries's avatar
   
Dries committed
487
      $links .= '<div class="next">&nbsp;</div>'; // Make an empty div to fill the space.
Dries's avatar
   
Dries committed
488
489
    }
    if ($node->parent) {
490
      $links .= '<div class="up">';
Dries's avatar
   
Dries committed
491
      $links .= l(t('up'), 'node/'. $node->parent, array('title' => t('View this page\'s parent section.')));
492
      $links .= '</div>';
Dries's avatar
   
Dries committed
493
    }
Dries's avatar
   
Dries committed
494

495
    $output .= '<div class="nav">';
Dries's avatar
   
Dries committed
496
497
    $output .= ' <div class="links">'. $links .'</div>';
    $output .= ' <div class="titles">'. $titles .'</div>';
498
499
    $output .= '</div>';
    $output .= '</div>';
Dries's avatar
   
Dries committed
500
  }
Dries's avatar
   
Dries committed
501

Dries's avatar
   
Dries committed
502
  $node->body = $node->body.$output;
Dries's avatar
   
Dries committed
503

Dries's avatar
   
Dries committed
504
  return $node;
Dries's avatar
   
Dries committed
505
}
Dries's avatar
   
Dries committed
506

507
function book_toc_recurse($nid, $indent, $toc, $children, $exclude) {
Dries's avatar
   
Dries committed
508
509
  if ($children[$nid]) {
    foreach ($children[$nid] as $foo => $node) {
510
511
512
513
      if (!$exclude || $exclude != $node->nid) {
        $toc[$node->nid] = $indent .' '. $node->title;
        $toc = book_toc_recurse($node->nid, $indent .'--', $toc, $children, $exclude);
      }
Dries's avatar
   
Dries committed
514
515
516
517
518
519
    }
  }

  return $toc;
}

520
function book_toc($exclude = 0) {
Dries's avatar
   
Dries committed
521
  $result = db_query('SELECT DISTINCT(n.nid), n.title, b.parent, b.weight FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND '. node_access_where_sql() .' ORDER BY b.weight, n.title');
Dries's avatar
   
Dries committed
522

Dries's avatar
   
Dries committed
523
  while ($node = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
524
525
526
527
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
    array_push($children[$node->parent], $node);
Dries's avatar
   
Dries committed
528
  }
Dries's avatar
   
Dries committed
529

530
531
  $toc = array();

Dries's avatar
   
Dries committed
532
533
  // If the user is an administrator, add the top-level book page;
  // only administrators can start new books.
534
535
  if (user_access('administer nodes')) {
    $toc[0] = '<'. t('top-level') .'>';
Dries's avatar
   
Dries committed
536
537
  }

538
  $toc = book_toc_recurse(0, '', $toc, $children, $exclude);
Dries's avatar
   
Dries committed
539

Dries's avatar
   
Dries committed
540
541
542
  return $toc;
}

Dries's avatar
   
Dries committed
543
function book_tree_recurse($nid, $depth, $children, $unfold = array()) {
Dries's avatar
   
Dries committed
544
  if ($depth > 0) {
Dries's avatar
   
Dries committed
545
546
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
Dries's avatar
   
Dries committed
547
548
549
        if (in_array($node->nid, $unfold)) {
          if ($tree = book_tree_recurse($node->nid, $depth - 1, $children, $unfold)) {
            $output .= '<li class="expanded">';
Dries's avatar
   
Dries committed
550
551
            $output .= l($node->title, 'node/'. $node->nid);
            $output .= '<ul>'. $tree .'</ul>';
Dries's avatar
   
Dries committed
552
553
554
            $output .= '</li>';
          }
          else {
Dries's avatar
   
Dries committed
555
            $output .= '<li class="leaf">'. l($node->title, 'node/'. $node->nid) .'</li>';
Dries's avatar
   
Dries committed
556
557
558
559
          }
        }
        else {
          if ($tree = book_tree_recurse($node->nid, 1, $children)) {
Dries's avatar
   
Dries committed
560
            $output .= '<li class="collapsed">'. l($node->title, 'node/'. $node->nid) .'</li>';
Dries's avatar
   
Dries committed
561
562
          }
          else {
Dries's avatar
   
Dries committed
563
            $output .= '<li class="leaf">'. l($node->title, 'node/'. $node->nid) .'</li>';
Dries's avatar
   
Dries committed
564
          }
Dries's avatar
   
Dries committed
565
        }
Dries's avatar
   
Dries committed
566
567
      }
    }
Dries's avatar
   
Dries committed
568
569
570
571
572
  }

  return $output;
}

Dries's avatar
   
Dries committed
573
function book_tree($parent = 0, $depth = 3, $unfold = array()) {
Dries's avatar
   
Dries committed
574
  $result = db_query('SELECT DISTINCT(n.nid), n.title, b.parent, b.weight FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND '. node_access_where_sql() .' AND n.moderate = 0 ORDER BY b.weight, n.title');
Dries's avatar
   
Dries committed
575

Dries's avatar
   
Dries committed
576
577
578
579
  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
580
  }
Dries's avatar
   
Dries committed
581

Dries's avatar
   
Dries committed
582
  if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
Dries's avatar
   
Dries committed
583
    return '<ul>'. $tree .'</ul>';
Dries's avatar
   
Dries committed
584
  }
Dries's avatar
   
Dries committed
585
586
}

587
/**
Dries's avatar
Dries committed
588
 * Menu callback; prints a listing of all books.
589
 */
Dries's avatar
   
Dries committed
590
function book_render() {
591
  $result = db_query('SELECT n.nid FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE '. node_access_where_sql() .' AND 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
592

Dries's avatar
   
Dries committed
593
  while ($page = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
594
    // Load the node:
595
    $node = node_load(array('nid' => $page->nid));
Dries's avatar
   
Dries committed
596

Dries's avatar
   
Dries committed
597
    if ($node) {
Dries's avatar
   
Dries committed
598
      // Take the most recent approved revision, extract the page and check output:
599
      $node = book_content($node, TRUE);
Dries's avatar
   
Dries committed
600
      // Output the content:
601
      $output .= '<div class="book">';
Dries's avatar
   
Dries committed
602
      $output .= '<div class="title">'. l($node->title, 'node/'. $node->nid) .'</div>';
603
      $output .= '<div class="body">'. $node->teaser .'</div>';
604
      $output .= '</div>';
Dries's avatar
   
Dries committed
605
    }
Dries's avatar
   
Dries committed
606
607
  }

608
609
  drupal_set_title(t('Books'));
  print theme('page', $output);
Dries's avatar
   
Dries committed
610
611
}

612
/**
Dries's avatar
   
Dries committed
613
 * Menu callback; generates printer-friendly book page with all descendants.
614
615
 */
function book_print($nid = 0, $depth = 1) {
Dries's avatar
   
Dries committed
616
  global $base_url;
Dries's avatar
   
Dries committed
617
  $result = db_query('SELECT DISTINCT(n.nid), n.title, b.weight FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND '. node_access_where_sql() .' AND n.nid = %d AND (n.moderate = 0 OR n.revisions IS NOT NULL) ORDER BY b.weight, n.title', $nid);
Dries's avatar
   
Dries committed
618

Dries's avatar
   
Dries committed
619
620
  while ($page = db_fetch_object($result)) {
    // load the node:
621
    $node = node_load(array('nid' => $page->nid));
Dries's avatar
   
Dries committed
622

Dries's avatar
   
Dries committed
623
624
    if ($node) {
      // output the content:
625
626
      if (node_hook($node, 'content')) {
        $node = node_invoke($node, 'content');
Dries's avatar
   
Dries committed
627
      }
Dries's avatar
   
Dries committed
628
      $output .= '<h1 id="'. $node->nid .'" name="'. $node->nid .'" class="book-h'. $depth .'">'. $node->title .'</h1>';
Dries's avatar
   
Dries committed
629

Dries's avatar
   
Dries committed
630
      if ($node->body) {
Dries's avatar
   
Dries committed
631
        $output .= $node->body;
Dries's avatar
   
Dries committed
632
      }
Dries's avatar
   
Dries committed
633
    }
Dries's avatar
   
Dries committed
634
  }
Dries's avatar
   
Dries committed
635

636
  $output .= book_print_recurse($nid, $depth);
Dries's avatar
   
Dries committed
637

Dries's avatar
   
Dries committed
638
639
  $html = '<html><head><title>'. $node->title .'</title>';
  $html .= '<base href="'. $base_url .'/" />';
Dries's avatar
   
Dries committed
640
  $html .= "<style type=\"text/css\">\n@import url(misc/print.css);\n</style>";
641
  $html .= '</head><body>'. $output .'</body></html>';
Dries's avatar
   
Dries committed
642

643
  print $html;
Dries's avatar
   
Dries committed
644
645
}

646
function book_print_recurse($parent = '', $depth = 1) {
Dries's avatar
   
Dries committed
647
  $result = db_query("SELECT DISTINCT(n.nid), n.title, b.weight FROM {node} n ". node_access_join_sql() ." INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND ". node_access_where_sql() ." 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
648

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

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

Dries's avatar
   
Dries committed
658
    if ($node) {
Dries's avatar
   
Dries committed
659
      // Output the content:
660
661
      if (node_hook($node, 'content')) {
        $node = node_invoke($node, 'content');
Dries's avatar
   
Dries committed
662
      }
Dries's avatar
   
Dries committed
663
      $output .= '<h1 id="'. $node->nid .'" name="'. $node->nid .'" class="book-h'. $depth .'">'. $node->title .'</h1>';
Dries's avatar
   
Dries committed
664

Dries's avatar
   
Dries committed
665
      if ($node->body) {
666
        $output .= '<ul>'. $node->body .'</ul>';
Dries's avatar
   
Dries committed
667
      }
Dries's avatar
   
Dries committed
668

669
      $output .= book_print_recurse($node->nid, $depth + 1);
Dries's avatar
   
Dries committed
670
    }
Dries's avatar
   
Dries committed
671
  }
Dries's avatar
   
Dries committed
672

Dries's avatar
   
Dries committed
673
674
  return $output;
}
Dries's avatar
   
Dries committed
675

Dries's avatar
   
Dries committed
676
function book_admin_view_line($node, $depth = 0) {
Dries's avatar
   
Dries committed
677
  return 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->nid), l(t('edit'), 'node/'. $node->nid .'/edit'), l(t('delete'), 'admin/node/delete/'. $node->nid));
Dries's avatar
   
Dries committed
678
679
680
}

function book_admin_view_book($nid, $depth = 1) {
681
  $result = db_query('SELECT n.nid FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE '. node_access_where_sql() .' AND b.parent = %d ORDER BY b.weight, n.title', $nid);
Dries's avatar
   
Dries committed
682
683

  while ($node = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
684
    $node = node_load(array('nid' => $node->nid));
Dries's avatar
   
Dries committed
685
686
    $rows[] = book_admin_view_line($node, $depth);
    $rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
Dries's avatar
   
Dries committed
687
688
  }

Dries's avatar
   
Dries committed
689
  return $rows;
Dries's avatar
   
Dries committed
690
691
}

692
693
694
/**
 * Display an administrative view of the hierarchy of a book.
 */
Dries's avatar
   
Dries committed
695
function book_admin_view($nid, $depth = 0) {
Dries's avatar
   
Dries committed
696
  if ($nid) {
Dries's avatar
   
Dries committed
697
    $node = node_load(array('nid' => $nid));
Dries's avatar
   
Dries committed
698

Dries's avatar
   
Dries committed
699
    $output .= '<h3>'. $node->title .'</h3>';
Dries's avatar
   
Dries committed
700

Dries's avatar
   
Dries committed
701
    $header = array(t('Title'), t('Weight'), array('data' => t('Operations'), 'colspan' => 3));
Dries's avatar
   
Dries committed
702
703
    $rows[] = book_admin_view_line($node);
    $rows = array_merge($rows, book_admin_view_book($nid));
Dries's avatar
   
Dries committed
704

Dries's avatar
   
Dries committed
705
706
    $output .= theme('table', $header, $rows);
    $output .= form_submit(t('Save book pages'));
Dries's avatar
   
Dries committed
707

Dries's avatar
   
Dries committed
708
709
    return form($output);
  }
Dries's avatar
   
Dries committed
710
711
712
}

function book_admin_save($nid, $edit = array()) {
Dries's avatar
   
Dries committed
713
  if ($nid) {
Dries's avatar
   
Dries committed
714
    $book = node_load(array('nid' => $nid));
Dries's avatar
   
Dries committed
715

Dries's avatar
   
Dries committed
716
    foreach ($edit as $nid => $value) {
Dries's avatar
   
Dries committed
717
718
719
720
      // 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);
Dries's avatar
   
Dries committed
721
      }
Dries's avatar
   
Dries committed
722

Dries's avatar
   
Dries committed
723
724
725
726
      // 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);
Dries's avatar
   
Dries committed
727
      }
Dries's avatar
   
Dries committed
728
729
    }

Dries's avatar
   
Dries committed
730
    $message = t('Updated book %title.', array('%title' => "<em>$book->title</em>"));
731
    watchdog('special', $message);
Dries's avatar
   
Dries committed
732

Dries's avatar
   
Dries committed
733
734
    return $message;
  }
Dries's avatar
   
Dries committed
735
736
}

737
/**
Dries's avatar
Dries committed
738
 * Menu callback; displays a listing of all orphaned book pages.
739
 */
Dries's avatar
   
Dries committed
740
function book_admin_orphan() {
741
  $result = db_query('SELECT n.nid, n.title, n.status, b.parent FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE '. node_access_where_sql());
Dries's avatar
   
Dries committed
742
743
744
745
746

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

Dries's avatar
   
Dries committed
747
  if ($pages) {
748
    $output .= '<h3>'. t('Orphan pages') .'</h3>';
Dries's avatar
   
Dries committed
749
    $header = array(t('Title'), t('Weight'), array('data' => t('Operations'), 'colspan' => 3));
Dries's avatar
   
Dries committed
750
751
    foreach ($pages as $nid => $node) {
      if ($node->parent && empty($pages[$node->parent])) {
Dries's avatar
   
Dries committed
752
753
        $rows[] = book_admin_view_line($node, $depth);
        $rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
Dries's avatar
   
Dries committed
754
      }
Dries's avatar
   
Dries committed
755
    }
Dries's avatar
   
Dries committed
756
    $output .= theme('table', $header, $rows);
Dries's avatar
   
Dries committed
757
758
  }

Dries's avatar
   
Dries committed
759
  print theme('page', $output);
Dries's avatar
   
Dries committed
760
761
}

762
/**
Dries's avatar
Dries committed
763
 * Menu callback; displays the book administration page.
764
 */
Dries's avatar
Dries committed
765
function book_admin($nid = 0) {
Dries's avatar
   
Dries committed
766
767
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries's avatar
   
Dries committed
768

Dries's avatar
   
Dries committed
769
  switch ($op) {
Dries's avatar
   
Dries committed
770
    case t('Save book pages'):
771
      drupal_set_message(book_admin_save($nid, $edit));
Dries's avatar
   
Dries committed
772
773
      // fall through:
    default:
774
      $output .= book_admin_view($nid);
Dries's avatar
   
Dries committed
775
      break;
Dries's avatar
   
Dries committed
776
  }
Dries's avatar
   
Dries committed
777
  print theme('page', $output);
Dries's avatar
   
Dries committed
778
779
}

780
781
782
/**
 * Implementation of hook_help().
 */
Dries's avatar
   
Dries committed
783
function book_help($section) {
Dries's avatar
   
Dries committed
784
  switch ($section) {
Dries's avatar
   
Dries committed
785
    case 'admin/help#book':
Dries's avatar
   
Dries committed
786
      return t("
Dries's avatar
   
Dries committed
787
      <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>
788
      <p>A book is simply a collection of nodes that have been linked together. These nodes are usually of type <em>book page</em>, but you can insert nodes of any type into a book outline. Every node in the book has a <em>parent</em> 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 <em>weight</em> that you give them.</p>
789
      <p>Book pages contain a <em>log message</em> 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>
Dries's avatar
   
Dries committed
790
      <p>Like other node types, book submissions and edits may be subject to moderation, depending on your configuration.  Similarly, books use <a href=\"%permissions\">permissions</a> 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 <em>&lt;top-level&gt;</em>.  To include an existing node in your book, click on the \"outline\"-tab on the node's page.  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 <a href=\"%create\">create content &raquo; book page</a> link.</p>
791
      <p>Administrators may review the hierarchy of their books by clicking on the <a href=\"%collaborative-book\">collaborative book</a> 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 <em>orphans</em>. Administrators should periodically <a href=\"%orphans-book\">review their books for orphans</a> and reaffiliate those pages as desired. Finally, administrators may also <a href=\"%export-book\">export their books</a> to a single, flat HTML page which is suitable for printing.</p>
Dries's avatar
   
Dries committed
792
793
      <h3>Maintaining a FAQ using a collaborative book</h3>
      <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>
794
      <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 <a href=\"%create\">create content &raquo; book page</a> 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 <em>&lt;top-level&gt;</em> as the parent of this page. Leave the <em>log message</em> and <em>type</em> 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>
795
      <p>Whenever you come across a post which you want to include in your FAQ, click on the <em>administer</em> link. Then click on the <em>edit book outline</em> button at the bottom of the page. Then place the relevant post wherever is most appropriate in your book by selecting a <em>parent</em>. Books are quite flexible. They can have sections like <em>Flying to Estonia</em>, <em>Eating in Estonia</em> 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>
796
      <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 <em>Edit book outline</em> 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 <a href=\"%create\">create content &raquo; book page</a> link.</li><li>If you don't see the <em>administer</em> link, then you probably have insufficient <a href=\"%permissions\">permissions</a>.</li></ul>", array('%permissions' => url('admin/user/configure/permission'), "%create" => url('node/add/book'), '%collaborative-book' => url('admin/node/book'), '%orphans-book' => url('admin/node/book/orphan'), '%export-book' => url('book/print')));
Dries's avatar
   
Dries committed
797
    case 'admin/modules#description':
Dries's avatar
   
Dries committed
798
      return t('Allows users to collaboratively author a book.');
Dries's avatar
   
Dries committed
799
    case 'admin/node/book':
Dries's avatar
   
Dries committed
800
      return t('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
801
    case 'admin/node/book/orphan':
Dries's avatar
   
Dries committed
802
      return t('Pages in a book are like a tree. As pages are edited, reorganized and removed, child pages might be left with no link to the rest of the book.  Such pages are referred to as "orphan pages".  On this page, administrators can review their books for orphans and reattach those pages as desired.');
Dries's avatar
   
Dries committed
803
    case 'node/add#book':
Dries's avatar
   
Dries committed
804
      return 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
805
  }
Dries's avatar
   
Dries committed
806
807
808
809

  if (arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == 'outline') {
    return t('The outline feature allowes you to include post in the <a href="%book">book hierarchy</a>.', array('%book' => url('book')));
  }
810
}
Dries's avatar
   
Dries committed
811
812

function book_help_page() {
Dries's avatar
   
Dries committed
813
  print theme('page', book_help('admin/help#book'));
Dries's avatar
   
Dries committed
814
}
Dries's avatar
   
Dries committed
815

Dries's avatar
   
Dries committed
816
?>