book.module 31.2 KB
Newer Older
1
<?php
2
// $Id$
3

4 5 6 7 8
/**
 * @file
 * Allows users to collaboratively author a book.
 */

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

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

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

29
  if ($op == 'create') {
Dries's avatar
Dries committed
30 31
    // Only registered users can create book pages.  Given the nature
    // of the book module this is considered to be a good/safe idea.
32
    return user_access('create book pages');
33 34
  }

35
  if ($op == 'update') {
Dries's avatar
Dries committed
36 37 38
    // 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
39 40
    // of that page waiting for approval.  That is, only updates that
    // don't overwrite the current or pending information are allowed.
41

42
    return ((user_access('maintain books') && !$node->moderate) || ($node->uid == $user->uid && user_access('edit own book pages')));
Dries's avatar
Dries committed
43
  }
44 45
}

46 47 48
/**
 * Implementation of hook_link().
 */
49
function book_link($type, $node = 0, $main = 0) {
Dries's avatar
Dries committed
50 51 52

  $links = array();

53
  if ($type == 'node' && $node->type == 'book') {
54
    if (!$main) {
55 56 57
      if (book_access('create', $node)) {
        $links[] = l(t('add child page'), "node/add/book/parent/$node->nid");
      }
Dries's avatar
Dries committed
58
      $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.')));
59
    }
60 61
  }

Dries's avatar
Dries committed
62
  return $links;
63 64
}

Dries's avatar
Dries committed
65 66 67
/**
 * Implementation of hook_menu().
 */
68
function book_menu($may_cache) {
Dries's avatar
Dries committed
69 70
  $items = array();

71
  if ($may_cache) {
72 73
    $items[] = array('path' => 'book', 'title' => t('books'),
      'access' => user_access('access content'), 'type' => MENU_NORMAL_ITEM, 'weight' => 5);
74
    $items[] = array('path' => 'node/add/book', 'title' => t('book page'),
75
      'access' => user_access('create book pages'));
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
    $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);
    $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
92
  }
93 94 95 96 97
  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:
98
      $result = db_query(db_rewrite_sql("SELECT n.nid FROM {node} n WHERE n.nid = %d AND n.type != 'book'"), arg(1));
99 100 101 102 103 104
      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);
      }
    }
105 106 107 108

    // We don't want to cache these menu items because they could change whenever
    // a book page or outline node is edited.
    if (arg(0) == 'admin' && arg(1) == 'node' && arg(2) == 'book') {
109
      $result = db_query(db_rewrite_sql('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'));
110 111 112 113
      while ($book = db_fetch_object($result)) {
        $items[] = array('path' => 'admin/node/book/'. $book->nid, 'title' => t('"%title" book', array('%title' => $book->title)));
      }
    }
114
  }
Dries's avatar
Dries committed
115 116 117 118

  return $items;
}

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

151 152
    return $block;
  }
153 154
}

155 156 157
/**
 * Implementation of hook_load().
 */
158
function book_load($node) {
159
  global $user;
160

161
  $book = db_fetch_object(db_query('SELECT parent, weight, log FROM {book} WHERE nid = %d', $node->nid));
162

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

176
  return $book;
Dries's avatar
Dries committed
177 178
}

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

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

193 194 195
/**
 * Implementation of hook_delete().
 */
196
function book_delete(&$node) {
197
  db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
198 199
}

200 201 202
/**
 * Implementation of hook_validate().
 */
203
function book_validate(&$node) {
204 205
  // Set default values for non-administrators.
  if (!user_access('administer nodes')) {
206 207 208
    $node->weight = 0;
    $node->revision = 1;
  }
209 210
}

211 212 213
/**
 * Implementation of hook_form().
 */
214
function book_form(&$node) {
215
  global $user;
Dries's avatar
Dries committed
216

217
  $op = $_POST['op'];
218

219
  $output = form_select(t('Parent'), 'parent', ($node->parent ? $node->parent : arg(4)), book_toc($node->nid), t('The parent that this page belongs in. Note that pages whose parent is &lt;top-level&gt; are regarded as independent, top-level books.'));
Dries's avatar
Dries committed
220

221 222
  if (function_exists('taxonomy_node_form')) {
    $output .= implode('', taxonomy_node_form('book', $node));
223 224
  }

225
  $output .= form_textarea(t('Body'), 'body', $node->body, 60, 20, '', NULL, TRUE);
226
  $output .= filter_form('format', $node->format);
227
  $output .= form_textarea(t('Log message'), 'log', $node->log, 60, 5, t('An explanation of the additions or updates being made to help other authors understand your motivations.'));
Dries's avatar
Dries committed
228

229
  if (user_access('administer nodes')) {
230
    $output .= form_weight(t('Weight'), 'weight', $node->weight, 15, t('Pages at a given level are ordered first by weight and then by title.'));
Dries's avatar
Dries committed
231 232
  }
  else {
Dries's avatar
Dries committed
233 234
    // If a regular user updates a book page, we create a new revision
    // authored by that user:
235
    $output .= form_hidden('revision', 1);
Dries's avatar
Dries committed
236 237 238 239 240
  }

  return $output;
}

241
/**
242 243
 * Implementation of function book_outline()
 * Handles all book outline operations.
244
 */
245
function book_outline() {
246

247 248
  $op = $_POST['op'];
  $edit = $_POST['edit'];
249
  $node = node_load(array('nid' => arg(1)));
Dries's avatar
Dries committed
250

251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
  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.'));
275
        $output .= form_weight(t('Weight'), 'weight', $node->weight, 15, t('Pages at a given level are ordered first by weight and then by title.'));
276 277 278 279 280 281 282 283

        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
284

285 286
        drupal_set_title($node->title);
        print theme('page', form($output));
Dries's avatar
Dries committed
287 288 289 290
    }
  }
}

291

292 293 294
/**
 * Return the the most recent revision that matches the specified conditions.
 */
295 296 297 298 299 300
function book_revision_load($page, $conditions = array()) {

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

  foreach ($revisions as $revision) {

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

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

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

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

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

331
function book_location_down($node, $nodes = array()) {
332
  $last_direct_child = db_fetch_object(db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent, b.weight 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));
333 334 335 336 337 338 339
  if ($last_direct_child) {
    array_push($nodes, $last_direct_child);
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

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

Dries's avatar
Dries committed
349
  // Previous on the same level:
350
  $direct_above = db_fetch_object(db_query(db_rewrite_sql("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 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));
351
  if ($direct_above) {
Dries's avatar
Dries committed
352
    // Get last leaf of $above.
353
    $path = book_location_down($direct_above);
354 355

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
356 357
  }
  else {
Dries's avatar
Dries committed
358
    // Direct parent:
359
    $prev = db_fetch_object(db_query(db_rewrite_sql('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'), $node->parent));
360 361 362 363
    return $prev;
  }
}

364 365 366
/**
 * Fetch the node object of the next page of the book.
 */
367 368
function book_next($node) {
  // get first direct child
369
  $child = db_fetch_object(db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND n.moderate = 0 ORDER BY b.weight ASC, n.title ASC'), $node->nid));
370 371 372 373
  if ($child) {
    return $child;
  }

Dries's avatar
Dries committed
374 375
  // 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.
376

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

Dries's avatar
Dries committed
385
function book_content($node, $teaser = FALSE) {
386
  $op = $_POST['op'];
Dries's avatar
Dries committed
387

Dries's avatar
Dries committed
388 389 390
  // 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.
391 392
  if ($op != t('Preview') && $node->moderate && arg(0) != 'queue') {
    $revision = book_revision_load($node, array('moderate' => 0, 'status' => 1));
Dries's avatar
Dries committed
393 394 395 396

    if ($revision) {
      $node = $revision;
    }
397 398
  }

399 400
  // Extract the page body.
  $node = node_prepare($node, $teaser);
Dries's avatar
Dries committed
401

402 403 404
  return $node;
}

405 406 407 408 409 410
/**
 * 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
411
function book_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
Dries committed
412
  $node = book_content($node, $teaser);
413

Dries's avatar
Dries committed
414 415
  if (!$teaser && $node->moderate) {
    $node->body .= '<div class="log"><div class="title">'. t('Log') .':</div>'. $node->log .'</div>';
416 417 418
  }
}

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

430 431 432 433 434
        if ($book) {
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
          $node = book_navigation($node);
435 436 437
          if ($page) {
            menu_set_location($node->breadcrumb);
          }
Dries's avatar
Dries committed
438
        }
439
      }
Dries's avatar
Dries committed
440
      break;
441
  }
442
}
Dries's avatar
Dries committed
443

444 445 446 447
/**
 * Prepares both the custom breadcrumb trail and the forward/backward
 * navigation for a node presented as a book page.
 */
448
function book_navigation($node) {
449
  $path = book_location($node);
Dries's avatar
Dries committed
450

Dries's avatar
Dries committed
451
  // Construct the breadcrumb:
452

Dries's avatar
Dries committed
453
  $node->breadcrumb = array(); // Overwrite the trail with a book trail.
454
  foreach ($path as $level) {
Dries's avatar
Dries committed
455
    $node->breadcrumb[] = array('path' => 'node/'. $level->nid, 'title' =>  $level->title);
456
  }
457
  $node->breadcrumb[] = array('path' => 'node/'. $node->nid);
458

459
  if ($node->nid) {
460
    $output .= '<div class="book">';
461 462

    if ($tree = book_tree($node->nid)) {
463
      $output .= '<div class="tree">'. $tree .'</div>';
464
    }
465

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

490
    $output .= '<div class="nav">';
Dries's avatar
Dries committed
491 492
    $output .= ' <div class="links">'. $links .'</div>';
    $output .= ' <div class="titles">'. $titles .'</div>';
493 494
    $output .= '</div>';
    $output .= '</div>';
495
  }
496

497
  $node->body = $node->body.$output;
498

499
  return $node;
500
}
501

502
function book_toc_recurse($nid, $indent, $toc, $children, $exclude) {
503 504
  if ($children[$nid]) {
    foreach ($children[$nid] as $foo => $node) {
505 506 507 508
      if (!$exclude || $exclude != $node->nid) {
        $toc[$node->nid] = $indent .' '. $node->title;
        $toc = book_toc_recurse($node->nid, $indent .'--', $toc, $children, $exclude);
      }
509 510 511 512 513 514
    }
  }

  return $toc;
}

515
function book_toc($exclude = 0) {
516
  $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent, b.weight 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
517

518
  while ($node = db_fetch_object($result)) {
519 520 521 522
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
    array_push($children[$node->parent], $node);
523
  }
Dries's avatar
Dries committed
524

525 526
  $toc = array();

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

533
  $toc = book_toc_recurse(0, '', $toc, $children, $exclude);
534

535 536 537
  return $toc;
}

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

  return $output;
}

568
function book_tree($parent = 0, $depth = 3, $unfold = array()) {
569
  $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent, b.weight 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'));
570

Dries's avatar
Dries committed
571 572 573 574
  while ($node = db_fetch_object($result)) {
    $list = $children[$node->parent] ? $children[$node->parent] : array();
    array_push($list, $node);
    $children[$node->parent] = $list;
575
  }
576

577
  if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
Dries's avatar
Dries committed
578
    return '<ul>'. $tree .'</ul>';
579
  }
580 581
}

582
/**
583
 * Menu callback; prints a listing of all books.
584
 */
585
function book_render() {
586
  $result = db_query(db_rewrite_sql('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 ORDER BY b.weight, n.title'));
587

588
  while ($page = db_fetch_object($result)) {
Dries's avatar
Dries committed
589
    // Load the node:
590
    $node = node_load(array('nid' => $page->nid));
591

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

603 604
  drupal_set_title(t('Books'));
  print theme('page', $output);
605 606
}

607
/**
Dries's avatar
Dries committed
608
 * Menu callback; generates printer-friendly book page with all descendants.
609 610
 */
function book_print($nid = 0, $depth = 1) {
611
  global $base_url;
612
  $result = db_query(db_rewrite_sql('SELECT DISTINCT(n.nid), n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND n.nid = %d AND n.moderate = 0 ORDER BY b.weight, n.title'), $nid);
613

614 615
  while ($page = db_fetch_object($result)) {
    // load the node:
616
    $node = node_load(array('nid' => $page->nid));
617

618 619
    if ($node) {
      // output the content:
620 621
      if (node_hook($node, 'content')) {
        $node = node_invoke($node, 'content');
622
      }
623 624 625
      // Allow modules to change $node->body before viewing.
      node_invoke_nodeapi($node, 'view', $node->body, false);

Dries's avatar
Dries committed
626
      $output .= '<h1 id="'. $node->nid .'" name="'. $node->nid .'" class="book-h'. $depth .'">'. $node->title .'</h1>';
627

628
      if ($node->body) {
629
        $output .= $node->body;
630
      }
631
    }
632
  }
633

634
  $output .= book_print_recurse($nid, $depth);
635

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

641
  print $html;
642 643
}

644
function book_print_recurse($parent = '', $depth = 1) {
645
  $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND b.parent = %d AND n.moderate = 0 ORDER BY b.weight, n.title', $parent));
646

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

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

656
    if ($node) {
Dries's avatar
Dries committed
657
      // Output the content:
658 659
      if (node_hook($node, 'content')) {
        $node = node_invoke($node, 'content');
660
      }
661 662 663
      // Allow modules to change $node->body before viewing.
      node_invoke_nodeapi($node, 'view', $node->body, false);

Dries's avatar
Dries committed
664
      $output .= '<h1 id="'. $node->nid .'" name="'. $node->nid .'" class="book-h'. $depth .'">'. $node->title .'</h1>';
665

666
      if ($node->body) {
667
        $output .= '<ul>'. $node->body .'</ul>';
668
      }
669

670
      $output .= book_print_recurse($node->nid, $depth + 1);
671
    }
672
  }
673

674 675
  return $output;
}
676

Dries's avatar
Dries committed
677
function book_admin_view_line($node, $depth = 0) {
678
  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, 15), 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
679 680 681
}

function book_admin_view_book($nid, $depth = 1) {
682
  $result = db_query(db_rewrite_sql('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
683 684

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

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

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

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

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

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

709 710
    return form($output);
  }
711 712 713
}

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

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

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

731
    $message = t('Updated book %title.', array('%title' => "<em>$book->title</em>"));
732
    watchdog('content', $message);
733

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

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

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

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

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

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

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

781 782 783
/**
 * Implementation of hook_help().
 */
Dries's avatar
Dries committed
784
function book_help($section) {
785
  switch ($section) {
786
    case 'admin/help#book':
Dries's avatar
Dries committed
787
      return t("
788
      <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>
789
      <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>
790
      <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>
791
      <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>
792
      <p>Administrators may review the hierarchy of their books by clicking on the <a href=\"%collaborative-book\">collaborative book</a> link in the administration 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>
793 794
      <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>
795
      <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>
796
      <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>
797
      <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
798
    case 'admin/modules#description':
Dries's avatar
Dries committed
799
      return t('Allows users to collaboratively author a book.');
800
    case 'admin/node/book':
801
      return t('<p>The book module offers a mean to organize content, authored by many users, in an online manual, outline or FAQ.</p>');
802
    case 'admin/node/book/orphan':
803
      return t('<p>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.</p>');
804
    case 'node/add#book':
Dries's avatar
Dries committed
805
      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.");
806
  }
807 808

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

813
?>