book.module 31.1 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');
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.
Dries's avatar
 
Dries committed
34
    return $node->status;
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 51
    // 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.

    return user_access('maintain books') && !$node->moderate && $node->revision;
Dries's avatar
 
Dries committed
52
  }
Dries's avatar
 
Dries committed
53 54
}

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

  $links = array();

Dries's avatar
 
Dries committed
62 63
  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
64 65
  }

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

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

Dries's avatar
 
Dries committed
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
/**
 * Implementation of hook_menu().
 */
function book_menu() {
  $items = array();

  $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);
  $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');
  while ($book = db_fetch_object($result)) {
    $items[] = array('path' => 'admin/node/book/'. $book->nid, 'title' => t('"%title" book', array('%title' => $book->title)));
  }
  $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);

  return $items;
}

107 108 109
/**
 * Implementation of hook_block().
 *
Dries's avatar
 
Dries committed
110 111
 * Displays the book table of contents in a block when the current page is a
 * single-node view of a book node.
112
 */
Dries's avatar
 
Dries committed
113
function book_block($op = 'list', $delta = 0) {
Dries's avatar
 
Dries committed
114
  $block = array();
Dries's avatar
 
Dries committed
115 116 117 118
  if ($op == 'list') {
    $block[0]['info'] = t('Book navigation');
  }
  else {
Dries's avatar
 
Dries committed
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
    // Only display this block when the user is browsing a book:
    if (arg(0) == 'node' && is_numeric(arg(1))) {
      $result = 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', arg(1));
      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
137 138 139 140 141
  }

   return $block;
}

142 143 144
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
145
function book_load($node) {
Dries's avatar
 
Dries committed
146
  global $user;
Dries's avatar
 
Dries committed
147

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

Dries's avatar
 
Dries committed
150
  if (arg(2) == 'edit' && !user_access('administer nodes')) {
Dries's avatar
 
Dries committed
151 152
    // If a user is about to update a book page, we overload some
    // fields to reflect the changes.
Dries's avatar
 
Dries committed
153 154 155 156 157 158
    if ($user->uid) {
      $book->uid = $user->uid;
      $book->name = $user->name;
    }
    else {
      $book->uid = 0;
159
      $book->name = '';
Dries's avatar
 
Dries committed
160
    }
Dries's avatar
 
Dries committed
161
  }
Dries's avatar
 
Dries committed
162

Dries's avatar
 
Dries committed
163 164 165
  // We set the revision field to indicate that we have to create
  // a new revision when updating this book page.  We enable this
  // always such that the "edit this page" links appear.
Dries's avatar
 
Dries committed
166
  $book->revision = 1;
Dries's avatar
 
Dries committed
167

Dries's avatar
 
Dries committed
168
  return $book;
Dries's avatar
 
Dries committed
169 170
}

171 172 173
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
174
function book_insert($node) {
175
  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
176
}
Dries's avatar
 
Dries committed
177

178 179 180
/**
 * Implementation of hook_update().
 */
Dries's avatar
 
Dries committed
181
function book_update($node) {
182
  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
183
}
Dries's avatar
 
Dries committed
184

185 186 187
/**
 * Implementation of hook_delete().
 */
188
function book_delete(&$node) {
189
  db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
190 191
}

192 193 194
/**
 * Implementation of hook_validate().
 */
195
function book_validate(&$node) {
196 197
  // Set default values for non-administrators.
  if (!user_access('administer nodes')) {
198 199 200
    $node->weight = 0;
    $node->revision = 1;
  }
Dries's avatar
 
Dries committed
201 202
}

203 204 205
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
206
function book_form(&$node) {
Dries's avatar
 
Dries committed
207
  global $user;
Dries's avatar
 
Dries committed
208

209
  $op = $_POST['op'];
210
  $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
211

212 213
  if (function_exists('taxonomy_node_form')) {
    $output .= implode('', taxonomy_node_form('book', $node));
214 215
  }

216
  $output .= form_textarea(t('Body'), 'body', $node->body, 60, 20, '', NULL, TRUE);
217
  $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
218

219 220
  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
221 222
  }
  else {
Dries's avatar
 
Dries committed
223 224
    // If a regular user updates a book page, we create a new revision
    // authored by that user:
225
    $output .= form_hidden('revision', 1);
Dries's avatar
 
Dries committed
226 227 228 229 230
  }

  return $output;
}

231 232 233
/**
 * Implementation of hook_node_link().
 */
Dries's avatar
 
Dries committed
234
function book_node_link($node = 0) {
Dries's avatar
 
Dries committed
235 236
  global $user;

237 238
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries's avatar
 
Dries committed
239

240
  if ($node->type != 'book') {
Dries's avatar
 
Dries committed
241

242 243
    if ($edit['nid']) {
      $node = node_load(array('nid' => $edit['nid']));
Dries's avatar
 
Dries committed
244 245
    }

246 247
    if ($op == t('Add to book outline')) {
      db_query('INSERT INTO {book} (nid, parent, weight) VALUES (%d, %d, %d)', $node->nid, $edit['parent'], $edit['weight']);
Dries's avatar
 
Dries committed
248
      drupal_set_message(t('Added the node to the book.'));
Dries's avatar
 
Dries committed
249 250
    }

251 252
    if ($op == t('Update book outline')) {
      db_query('UPDATE {book} SET parent = %d, weight = %d WHERE nid = %d', $edit['parent'], $edit['weight'], $node->nid);
Dries's avatar
 
Dries committed
253
      drupal_set_message(t('Updated the book outline.'));
Dries's avatar
 
Dries committed
254 255
    }

256 257
    if ($op == t('Remove from book outline')) {
      db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
258
      drupal_set_message(t('Removed the node form the book.'));
Dries's avatar
 
Dries committed
259 260
    }

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

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

266
      $output .= form_select(t('Parent'), 'parent', $page->parent, book_toc($node->nid), t('The parent subject or category the page belongs in.'));
267
      $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
268 269

      if ($page->nid) {
270 271
        $output .= form_submit(t('Update book outline'));
        $output .= form_submit(t('Remove from book outline'));
Dries's avatar
 
Dries committed
272 273
      }
      else {
274
        $output .= form_submit(t('Add to book outline'));
Dries's avatar
 
Dries committed
275 276 277 278
      }

    }
    else {
279
      $output .= form_submit(t('Edit book outline'));
Dries's avatar
 
Dries committed
280 281
    }

282
    $output .= form_hidden('nid', $node->nid);
Dries's avatar
 
Dries committed
283

284
    return form($output, 'post', url('admin/node/book'));
Dries's avatar
 
Dries committed
285 286 287
  }
}

288 289 290
/**
 * Return the the most recent revision that matches the specified conditions.
 */
Dries's avatar
 
Dries committed
291 292 293 294 295 296
function book_revision_load($page, $conditions = array()) {

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

  foreach ($revisions as $revision) {

Dries's avatar
 
Dries committed
297
    // Extract the specified revision:
Dries's avatar
 
Dries committed
298 299
    $node = node_revision_load($page, $revision);

Dries's avatar
 
Dries committed
300 301
    // Check to see if the conditions are met:
    $status = TRUE;
Dries's avatar
 
Dries committed
302 303 304

    foreach ($conditions as $key => $value) {
      if ($node->$key != $value) {
Dries's avatar
 
Dries committed
305
        $status = FALSE;
Dries's avatar
 
Dries committed
306 307 308 309 310 311 312 313 314
      }
    }

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

315 316 317
/**
 * Return the path (call stack) to a certain book page.
 */
Dries's avatar
 
Dries committed
318
function book_location($node, $nodes = array()) {
319
  $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
320 321 322 323 324 325 326
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

Dries's avatar
 
Dries committed
327
function book_location_down($node, $nodes = array()) {
328
  $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
329 330 331 332 333 334 335
  if ($last_direct_child) {
    array_push($nodes, $last_direct_child);
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

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

Dries's avatar
 
Dries committed
345
  // Previous on the same level:
Dries's avatar
 
Dries committed
346
  $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
347
  if ($direct_above) {
Dries's avatar
 
Dries committed
348
    // Get last leaf of $above.
Dries's avatar
 
Dries committed
349
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
350 351

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
352 353
  }
  else {
Dries's avatar
 
Dries committed
354
    // Direct parent:
Dries's avatar
 
Dries committed
355
    $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
356 357 358 359
    return $prev;
  }
}

360 361 362
/**
 * Fetch the node object of the next page of the book.
 */
Dries's avatar
 
Dries committed
363 364
function book_next($node) {
  // get first direct child
Dries's avatar
 
Dries committed
365
  $child = db_fetch_object(db_query("SELECT DISTINCT(n.nid), n.title 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
366 367 368 369
  if ($child) {
    return $child;
  }

Dries's avatar
 
Dries committed
370 371
  // 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.
372

Dries's avatar
 
Dries committed
373
  while (($leaf = array_pop($path)) && count($path)) {
Dries's avatar
 
Dries committed
374
    $next = db_fetch_object(db_query("SELECT DISTINCT(n.nid), n.title 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
375 376 377 378 379 380
    if ($next) {
      return $next;
    }
  }
}

381 382 383
/**
 * Implementation of hook_content().
 */
Dries's avatar
 
Dries committed
384
function book_content($node, $teaser = FALSE) {
385
  $op = $_POST['op'];
Dries's avatar
 
Dries committed
386

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

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
 
Dries committed
396 397
  }

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

Dries's avatar
 
Dries committed
401 402 403
  return $node;
}

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

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

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

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

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

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

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

Dries's avatar
 
Dries committed
458
  if ($node->nid) {
459
    $output .= '<div class="book">';
Dries's avatar
 
Dries committed
460 461

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

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

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

Dries's avatar
 
Dries committed
496
  $node->body = $node->body.$output;
Dries's avatar
 
Dries committed
497

Dries's avatar
 
Dries committed
498
  return $node;
Dries's avatar
 
Dries committed
499
}
Dries's avatar
 
Dries committed
500

501
function book_toc_recurse($nid, $indent, $toc, $children, $exclude) {
Dries's avatar
 
Dries committed
502 503
  if ($children[$nid]) {
    foreach ($children[$nid] as $foo => $node) {
504 505 506 507
      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
508 509 510 511 512 513
    }
  }

  return $toc;
}

514
function book_toc($exclude = 0) {
Dries's avatar
 
Dries committed
515
  $result = db_query('SELECT DISTINCT(n.nid), n.title, b.parent 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
516

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

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

530
  $toc = book_toc_recurse(0, '', array(), $children, $exclude);
Dries's avatar
 
Dries committed
531

Dries's avatar
 
Dries committed
532 533 534
  return $toc;
}

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

  return $output;
}

Dries's avatar
 
Dries committed
565
function book_tree($parent = 0, $depth = 3, $unfold = array()) {
Dries's avatar
 
Dries committed
566
  $result = db_query('SELECT DISTINCT(n.nid), n.title, b.parent 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
567

Dries's avatar
 
Dries committed
568 569 570 571
  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
572
  }
Dries's avatar
 
Dries committed
573

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

579
/**
Dries's avatar
Dries committed
580
 * Menu callback; prints a listing of all books.
581
 */
Dries's avatar
 
Dries committed
582
function book_render() {
583
  $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
584

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

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

600 601
  drupal_set_title(t('Books'));
  print theme('page', $output);
Dries's avatar
 
Dries committed
602 603
}

604
/**
Dries's avatar
 
Dries committed
605
 * Menu callback; generates printer-friendly book page with all descendants.
606 607
 */
function book_print($nid = 0, $depth = 1) {
Dries's avatar
 
Dries committed
608
  global $base_url;
Dries's avatar
 
Dries committed
609
  $result = db_query('SELECT DISTINCT(n.nid) 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
610

Dries's avatar
 
Dries committed
611 612
  while ($page = db_fetch_object($result)) {
    // load the node:
613
    $node = node_load(array('nid' => $page->nid));
Dries's avatar
 
Dries committed
614

Dries's avatar
 
Dries committed
615 616
    if ($node) {
      // output the content:
617 618
      if (node_hook($node, 'content')) {
        $node = node_invoke($node, 'content');
Dries's avatar
 
Dries committed
619
      }
Dries's avatar
 
Dries committed
620
      $output .= '<h1 id="'. $node->nid .'" name="'. $node->nid .'" class="book-h'. $depth .'">'. $node->title .'</h1>';
Dries's avatar
 
Dries committed
621

Dries's avatar
 
Dries committed
622
      if ($node->body) {
Dries's avatar
 
Dries committed
623
        $output .= $node->body;
Dries's avatar
 
Dries committed
624
      }
Dries's avatar
 
Dries committed
625
    }
Dries's avatar
 
Dries committed
626
  }
Dries's avatar
 
Dries committed
627

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

Dries's avatar
 
Dries committed
630 631
  $html = '<html><head><title>'. $node->title .'</title>';
  $html .= '<base href="'. $base_url .'/" />';
Dries's avatar
 
Dries committed
632
  $html .= "<style type=\"text/css\">\n@import url(misc/print.css);\n</style>";
633
  $html .= '</head><body>'. $output .'</body></html>';
Dries's avatar
 
Dries committed
634

635
  print $html;
Dries's avatar
 
Dries committed
636 637
}

638
function book_print_recurse($parent = '', $depth = 1) {
Dries's avatar
 
Dries committed
639
  $result = db_query("SELECT DISTINCT(n.nid) 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
640

Dries's avatar
 
Dries committed
641
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
642
    // Load the node:
643
    $node = node_load(array('nid' => $page->nid));
Dries's avatar
 
Dries committed
644

Dries's avatar
 
Dries committed
645
    // Take the most recent approved revision:
Dries's avatar
 
Dries committed
646
    if ($node->moderate) {
647
      $node = book_revision_load($node, array('moderate' => 0, 'status' => 1));
Dries's avatar
 
Dries committed
648 649
    }

Dries's avatar
 
Dries committed
650
    if ($node) {
Dries's avatar
 
Dries committed
651
      // Output the content:
652 653
      if (node_hook($node, 'content')) {
        $node = node_invoke($node, 'content');
Dries's avatar
 
Dries committed
654
      }
Dries's avatar
 
Dries committed
655
      $output .= '<h1 id="'. $node->nid .'" name="'. $node->nid .'" class="book-h'. $depth .'">'. $node->title .'</h1>';
Dries's avatar
 
Dries committed
656

Dries's avatar
 
Dries committed
657
      if ($node->body) {
658
        $output .= '<ul>'. $node->body .'</ul>';
Dries's avatar
 
Dries committed
659
      }
Dries's avatar
 
Dries committed
660

661
      $output .= book_print_recurse($node->nid, $depth + 1);
Dries's avatar
 
Dries committed
662
    }
Dries's avatar
 
Dries committed
663
  }
Dries's avatar
 
Dries committed
664

Dries's avatar
 
Dries committed
665 666
  return $output;
}
Dries's avatar
 
Dries committed
667

Dries's avatar
 
Dries committed
668
function book_admin_view_line($node, $depth = 0) {
Dries's avatar
 
Dries committed
669
  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
670 671 672
}

function book_admin_view_book($nid, $depth = 1) {
Dries's avatar
 
Dries committed
673
  $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
674 675

  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
676
    $node = node_load(array('nid' => $node->nid));
Dries's avatar
 
Dries committed
677 678
    $rows[] = book_admin_view_line($node, $depth);
    $rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
Dries's avatar
 
Dries committed
679 680
  }

Dries's avatar
 
Dries committed
681
  return $rows;
Dries's avatar
 
Dries committed
682 683
}

684 685 686
/**
 * Display an administrative view of the hierarchy of a book.
 */
Dries's avatar
 
Dries committed
687
function book_admin_view($nid, $depth = 0) {
Dries's avatar
 
Dries committed
688
  if ($nid) {
Dries's avatar
 
Dries committed
689
    $node = node_load(array('nid' => $nid));
Dries's avatar
 
Dries committed
690

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

Dries's avatar
 
Dries committed
693
    $header = array(t('Title'), t('Weight'), array('data' => t('Operations'), 'colspan' => 3));
Dries's avatar
 
Dries committed
694 695
    $rows[] = book_admin_view_line($node);
    $rows = array_merge($rows, book_admin_view_book($nid));
Dries's avatar
 
Dries committed
696

Dries's avatar
 
Dries committed
697 698
    $output .= theme('table', $header, $rows);
    $output .= form_submit(t('Save book pages'));
Dries's avatar
 
Dries committed
699

Dries's avatar
 
Dries committed
700 701
    return form($output);
  }
Dries's avatar
 
Dries committed
702 703 704
}

function book_admin_save($nid, $edit = array()) {
Dries's avatar
 
Dries committed
705
  if ($nid) {
Dries's avatar
 
Dries committed
706
    $book = node_load(array('nid' => $nid));
Dries's avatar
 
Dries committed
707

Dries's avatar
 
Dries committed
708
    foreach ($edit as $nid => $value) {
Dries's avatar
 
Dries committed
709 710 711 712
      // 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
713
      }
Dries's avatar
 
Dries committed
714

Dries's avatar
 
Dries committed
715 716 717 718
      // 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
719
      }
Dries's avatar
 
Dries committed
720 721
    }

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

Dries's avatar
 
Dries committed
725 726
    return $message;
  }
Dries's avatar
 
Dries committed
727 728
}

729
/**
Dries's avatar
Dries committed
730
 * Menu callback; displays a listing of all orphaned book pages.
731
 */
Dries's avatar
 
Dries committed
732
function book_admin_orphan() {
Dries's avatar
 
Dries committed
733
  $result = db_query('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
734 735 736 737 738

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

Dries's avatar
 
Dries committed
739
  if ($pages) {
740
    $output .= '<h3>'. t('Orphan pages') .'</h3>';
Dries's avatar
 
Dries committed
741
    $header = array(t('Title'), t('Weight'), array('data' => t('Operations'), 'colspan' => 3));
Dries's avatar
 
Dries committed
742 743
    foreach ($pages as $nid => $node) {
      if ($node->parent && empty($pages[$node->parent])) {
Dries's avatar
 
Dries committed
744 745
        $rows[] = book_admin_view_line($node, $depth);
        $rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
Dries's avatar
 
Dries committed
746
      }
Dries's avatar
 
Dries committed
747
    }
Dries's avatar
 
Dries committed
748
    $output .= theme('table', $header, $rows);
Dries's avatar
 
Dries committed
749 750
  }

Dries's avatar
 
Dries committed
751
  print theme('page', $output);
Dries's avatar
 
Dries committed
752 753
}

754
/**
Dries's avatar
Dries committed
755
 * Menu callback; displays the book administration page.
756
 */
Dries's avatar
Dries committed
757
function book_admin($nid = 0) {
Dries's avatar
 
Dries committed
758 759
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries's avatar
 
Dries committed
760

Dries's avatar
 
Dries committed
761
  switch ($op) {
Dries's avatar
 
Dries committed
762 763 764 765
    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
766 767
      $output = book_node_link();
      break;
Dries's avatar
 
Dries committed
768
    case t('Save book pages'):
769
      drupal_set_message(book_admin_save($nid, $edit));
Dries's avatar
 
Dries committed
770 771
      // fall through:
    default:
772
      $output .= book_admin_view($nid);
Dries's avatar
 
Dries committed
773
      break;
Dries's avatar
 
Dries committed
774
  }
Dries's avatar
 
Dries committed
775
  print theme('page', $output);
Dries's avatar
 
Dries committed
776 777
}

778 779 780
/**
 * Implementation of hook_help().
 */
Dries's avatar
 
Dries committed
781
function book_help($section) {
Dries's avatar
 
Dries committed
782
  switch ($section) {
Dries's avatar
 
Dries committed
783
    case 'admin/help#book':
Dries's avatar
 
Dries committed
784
      return t("
Dries's avatar
 
Dries committed
785
      <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>
786
      <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>
787
      <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 offered to administrators, since malicious users could abuse this power. In addition, 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>
788
      <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 \"administer\"-link in that node.  At the bottom of this administration page, click on the <em>edit book outline</em> 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 <a href=\"%create\">create content &raquo; book page</a> link.</p>
789
      <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
790 791
      <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>
792
      <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>
793
      <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>
794
      <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><li>If you want to get really fancy, note that books are one of the few content types which allow raw PHP in their <em>body</em>. So you've got lots of geeky possibilities there.</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
795
    case 'admin/modules#description':
Dries's avatar
 
Dries committed
796
      return t('Allows users to collaboratively author a book.');
Dries's avatar
 
Dries committed
797
    case 'admin/node/book':
Dries's avatar
 
Dries committed
798
      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
799
    case 'admin/node/book/orphan':
Dries's avatar
 
Dries committed
800
      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
801
    case 'node/add#book':
Dries's avatar
 
Dries committed