book.module 32.2 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('create book pages', '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('create book pages');
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
    return ((user_access('maintain books') && !$node->moderate && $node->revision) || ($node->uid == $user->uid && user_access('edit own book pages')));
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
  if ($type == 'node' && $node->type == 'book') {
Dries's avatar
 
Dries committed
63
    if (!$main) {
Dries's avatar
 
Dries committed
64 65 66
      if (book_access('create', $node)) {
        $links[] = l(t('add child page'), "node/add/book/parent/$node->nid");
      }
Dries's avatar
 
Dries committed
67
      $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
68
    }
Dries's avatar
 
Dries committed
69 70
  }

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

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

Dries's avatar
 
Dries committed
80
  if ($may_cache) {
Dries's avatar
 
Dries committed
81 82
    $items[] = array('path' => 'book', 'title' => t('books'),
      'access' => user_access('access content'), 'type' => MENU_NORMAL_ITEM, 'weight' => 5);
Dries's avatar
 
Dries committed
83
    $items[] = array('path' => 'node/add/book', 'title' => t('book page'),
84
      'access' => user_access('create book pages'));
Dries's avatar
 
Dries committed
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
    $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
101
  }
Dries's avatar
 
Dries committed
102 103 104 105 106 107 108 109 110 111 112 113
  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
114 115 116 117 118 119 120 121 122

    // 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') {
      $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');
      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
123
  }
Dries's avatar
 
Dries committed
124 125 126 127

  return $items;
}

128 129 130
/**
 * Implementation of hook_block().
 *
Dries's avatar
 
Dries committed
131 132
 * Displays the book table of contents in a block when the current page is a
 * single-node view of a book node.
133
 */
Dries's avatar
 
Dries committed
134
function book_block($op = 'list', $delta = 0) {
Dries's avatar
 
Dries committed
135
  $block = array();
Dries's avatar
 
Dries committed
136 137
  if ($op == 'list') {
    $block[0]['info'] = t('Book navigation');
138
    return $block;
Dries's avatar
 
Dries committed
139
  }
140
  else if ($op == 'view') {
Dries's avatar
 
Dries committed
141 142
    // Only display this block when the user is browsing a book:
    if (arg(0) == 'node' && is_numeric(arg(1))) {
143
      $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
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
      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
159

160 161
    return $block;
  }
Dries's avatar
 
Dries committed
162 163
}

164 165 166
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
167
function book_load($node) {
Dries's avatar
 
Dries committed
168
  global $user;
Dries's avatar
 
Dries committed
169

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

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

Dries's avatar
 
Dries committed
185
  return $book;
Dries's avatar
 
Dries committed
186 187
}

188 189 190
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
191
function book_insert($node) {
192
  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
193
}
Dries's avatar
 
Dries committed
194

195 196 197
/**
 * Implementation of hook_update().
 */
Dries's avatar
 
Dries committed
198
function book_update($node) {
199
  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
200
}
Dries's avatar
 
Dries committed
201

202 203 204
/**
 * Implementation of hook_delete().
 */
205
function book_delete(&$node) {
206
  db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
207 208
}

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

220 221 222
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
223
function book_form(&$node) {
Dries's avatar
 
Dries committed
224
  global $user;
Dries's avatar
 
Dries committed
225

226
  $op = $_POST['op'];
Dries's avatar
 
Dries committed
227

Dries's avatar
 
Dries committed
228
  $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
229

230 231
  if (function_exists('taxonomy_node_form')) {
    $output .= implode('', taxonomy_node_form('book', $node));
232 233
  }

234
  $output .= form_textarea(t('Body'), 'body', $node->body, 60, 20, '', NULL, TRUE);
235
  $output .= filter_form('format', $node->format);
Dries's avatar
 
Dries committed
236
  $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
237

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

  return $output;
}

250
/**
Dries's avatar
 
Dries committed
251 252
 * Implementation of function book_outline()
 * Handles all book outline operations.
253
 */
Dries's avatar
 
Dries committed
254
function book_outline() {
Dries's avatar
 
Dries committed
255

256 257
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries's avatar
 
Dries committed
258
  $node = node_load(array('nid' => arg(1)));
Dries's avatar
 
Dries committed
259

Dries's avatar
 
Dries committed
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
  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.'));
Dries's avatar
 
Dries committed
284
        $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
285 286 287 288 289 290 291 292

        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
293

294 295
        drupal_set_title($node->title);
        print theme('page', form($output));
Dries's avatar
 
Dries committed
296 297 298 299
    }
  }
}

Dries's avatar
 
Dries committed
300

301 302 303
/**
 * Return the the most recent revision that matches the specified conditions.
 */
Dries's avatar
 
Dries committed
304 305 306 307 308 309
function book_revision_load($page, $conditions = array()) {

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

  foreach ($revisions as $revision) {

Dries's avatar
 
Dries committed
310
    // Extract the specified revision:
Dries's avatar
 
Dries committed
311 312
    $node = node_revision_load($page, $revision);

Dries's avatar
 
Dries committed
313 314
    // Check to see if the conditions are met:
    $status = TRUE;
Dries's avatar
 
Dries committed
315 316 317

    foreach ($conditions as $key => $value) {
      if ($node->$key != $value) {
Dries's avatar
 
Dries committed
318
        $status = FALSE;
Dries's avatar
 
Dries committed
319 320 321 322 323 324 325 326 327
      }
    }

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

328 329 330
/**
 * Return the path (call stack) to a certain book page.
 */
Dries's avatar
 
Dries committed
331
function book_location($node, $nodes = array()) {
332
  $parent = db_fetch_object(db_query('SELECT 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 '. node_access_where_sql() .' AND n.nid = %d', $node->parent));
Dries's avatar
 
Dries committed
333 334 335 336 337 338 339
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

Dries's avatar
 
Dries committed
340
function book_location_down($node, $nodes = array()) {
341
  $last_direct_child = db_fetch_object(db_query('SELECT 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 '. node_access_where_sql() .' AND b.parent = %d ORDER BY b.weight DESC, n.title DESC', $node->nid));
Dries's avatar
 
Dries committed
342 343 344 345 346 347 348
  if ($last_direct_child) {
    array_push($nodes, $last_direct_child);
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

349 350 351
/**
 * Fetch the node object of the previous page of the book.
 */
Dries's avatar
 
Dries committed
352
function book_prev($node) {
Dries's avatar
 
Dries committed
353
  // If the parent is zero, we are at the start of a book so there is no previous.
Dries's avatar
 
Dries committed
354 355 356 357
  if ($node->parent == 0) {
    return NULL;
  }

Dries's avatar
 
Dries committed
358
  // Previous on the same level:
359
  $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 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
360
  if ($direct_above) {
Dries's avatar
 
Dries committed
361
    // Get last leaf of $above.
Dries's avatar
 
Dries committed
362
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
363 364

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
365 366
  }
  else {
Dries's avatar
 
Dries committed
367
    // Direct parent:
368
    $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", $node->parent));
Dries's avatar
 
Dries committed
369 370 371 372
    return $prev;
  }
}

373 374 375
/**
 * Fetch the node object of the next page of the book.
 */
Dries's avatar
 
Dries committed
376 377
function book_next($node) {
  // get first direct child
378
  $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 ORDER BY b.weight ASC, n.title ASC", $node->nid));
Dries's avatar
 
Dries committed
379 380 381 382
  if ($child) {
    return $child;
  }

Dries's avatar
 
Dries committed
383 384
  // 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.
385

Dries's avatar
 
Dries committed
386
  while (($leaf = array_pop($path)) && count($path)) {
387
    $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 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
388 389 390 391 392 393
    if ($next) {
      return $next;
    }
  }
}

Dries's avatar
 
Dries committed
394
function book_content($node, $teaser = FALSE) {
395
  $op = $_POST['op'];
Dries's avatar
 
Dries committed
396

Dries's avatar
 
Dries committed
397 398 399
  // 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.
400 401
  if ($op != t('Preview') && $node->moderate && arg(0) != 'queue') {
    $revision = book_revision_load($node, array('moderate' => 0, 'status' => 1));
Dries's avatar
 
Dries committed
402 403 404 405

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
 
Dries committed
406 407
  }

408 409
  // Extract the page body.
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
410

Dries's avatar
 
Dries committed
411 412 413
  return $node;
}

414 415 416 417 418 419
/**
 * 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
420
function book_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
 
Dries committed
421
  $node = book_content($node, $teaser);
Dries's avatar
 
Dries committed
422

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

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

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

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

Dries's avatar
 
Dries committed
460
  // Construct the breadcrumb:
Dries's avatar
 
Dries committed
461

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

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

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

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

499
    $output .= '<div class="nav">';
Dries's avatar
 
Dries committed
500 501
    $output .= ' <div class="links">'. $links .'</div>';
    $output .= ' <div class="titles">'. $titles .'</div>';
502 503
    $output .= '</div>';
    $output .= '</div>';
Dries's avatar
 
Dries committed
504
  }
Dries's avatar
 
Dries committed
505

Dries's avatar
 
Dries committed
506
  $node->body = $node->body.$output;
Dries's avatar
 
Dries committed
507

Dries's avatar
 
Dries committed
508
  return $node;
Dries's avatar
 
Dries committed
509
}
Dries's avatar
 
Dries committed
510

511
function book_toc_recurse($nid, $indent, $toc, $children, $exclude) {
Dries's avatar
 
Dries committed
512 513
  if ($children[$nid]) {
    foreach ($children[$nid] as $foo => $node) {
514 515 516 517
      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
518 519 520 521 522 523
    }
  }

  return $toc;
}

524
function book_toc($exclude = 0) {
Dries's avatar
 
Dries committed
525
  $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
526

Dries's avatar
 
Dries committed
527
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
528 529 530 531
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
    array_push($children[$node->parent], $node);
Dries's avatar
 
Dries committed
532
  }
Dries's avatar
 
Dries committed
533

534 535
  $toc = array();

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

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

Dries's avatar
 
Dries committed
544 545 546
  return $toc;
}

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

  return $output;
}

Dries's avatar
 
Dries committed
577
function book_tree($parent = 0, $depth = 3, $unfold = array()) {
Dries's avatar
 
Dries committed
578
  $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
579

Dries's avatar
 
Dries committed
580 581 582 583
  while ($node = db_fetch_object($result)) {
    $list = $children[$node->parent] ? $children[$node->parent] : array();
    array_push($list, $node);
    $children[$node->parent] = $list;
Dries's avatar
 
Dries committed
584
  }
Dries's avatar
 
Dries committed
585

Dries's avatar
 
Dries committed
586
  if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
Dries's avatar
 
Dries committed
587
    return '<ul>'. $tree .'</ul>';
Dries's avatar
 
Dries committed
588
  }
Dries's avatar
 
Dries committed
589 590
}

591
/**
Dries's avatar
Dries committed
592
 * Menu callback; prints a listing of all books.
593
 */
Dries's avatar
 
Dries committed
594
function book_render() {
595
  $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 ORDER BY b.weight, n.title');
Dries's avatar
 
Dries committed
596

Dries's avatar
 
Dries committed
597
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
598
    // Load the node:
599
    $node = node_load(array('nid' => $page->nid));
Dries's avatar
 
Dries committed
600

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

612 613
  drupal_set_title(t('Books'));
  print theme('page', $output);
Dries's avatar
 
Dries committed
614 615
}

616
/**
Dries's avatar
 
Dries committed
617
 * Menu callback; generates printer-friendly book page with all descendants.
618 619
 */
function book_print($nid = 0, $depth = 1) {
Dries's avatar
 
Dries committed
620
  global $base_url;
621
  $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 ORDER BY b.weight, n.title', $nid);
Dries's avatar
 
Dries committed
622

Dries's avatar
 
Dries committed
623 624
  while ($page = db_fetch_object($result)) {
    // load the node:
625
    $node = node_load(array('nid' => $page->nid));
Dries's avatar
 
Dries committed
626

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

Dries's avatar
 
Dries committed
634
      if ($node->body) {
Dries's avatar
 
Dries committed
635
        $output .= $node->body;
Dries's avatar
 
Dries committed
636
      }
Dries's avatar
 
Dries committed
637
    }
Dries's avatar
 
Dries committed
638
  }
Dries's avatar
 
Dries committed
639

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

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

647
  print $html;
Dries's avatar
 
Dries committed
648 649
}

650
function book_print_recurse($parent = '', $depth = 1) {
651
  $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 ORDER BY b.weight, n.title");
Dries's avatar
 
Dries committed
652

Dries's avatar
 
Dries committed
653
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
654
    // Load the node:
655
    $node = node_load(array('nid' => $page->nid));
Dries's avatar
 
Dries committed
656

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

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

Dries's avatar
 
Dries committed
669
      if ($node->body) {
670
        $output .= '<ul>'. $node->body .'</ul>';
Dries's avatar
 
Dries committed
671
      }
Dries's avatar
 
Dries committed
672

673
      $output .= book_print_recurse($node->nid, $depth + 1);
Dries's avatar
 
Dries committed
674
    }
Dries's avatar
 
Dries committed
675
  }
Dries's avatar
 
Dries committed
676

Dries's avatar
 
Dries committed
677 678
  return $output;
}
Dries's avatar
 
Dries committed
679

Dries's avatar
 
Dries committed
680
function book_admin_view_line($node, $depth = 0) {
Dries's avatar
 
Dries committed
681
  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
682 683 684
}

function book_admin_view_book($nid, $depth = 1) {
685
  $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
686 687

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

Dries's avatar
 
Dries committed
693
  return $rows;
Dries's avatar
 
Dries committed
694 695
}

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

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

Dries's avatar
 
Dries committed
705
    $header = array(t('Title'), t('Weight'), array('data' => t('Operations'), 'colspan' => '3'));
Dries's avatar
 
Dries committed
706 707
    $rows[] = book_admin_view_line($node);
    $rows = array_merge($rows, book_admin_view_book($nid));
Dries's avatar
 
Dries committed
708

Dries's avatar
 
Dries committed
709 710
    $output .= theme('table', $header, $rows);
    $output .= form_submit(t('Save book pages'));
Dries's avatar
 
Dries committed
711

Dries's avatar
 
Dries committed
712 713
    return form($output);
  }
Dries's avatar
 
Dries committed
714 715 716
}

function book_admin_save($nid, $edit = array()) {
Dries's avatar
 
Dries committed
717
  if ($nid) {
Dries's avatar
 
Dries committed
718
    $book = node_load(array('nid' => $nid));
Dries's avatar
 
Dries committed
719

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

Dries's avatar
 
Dries committed
727 728 729 730
      // 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
731
      }
Dries's avatar
 
Dries committed
732 733
    }

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

Dries's avatar
 
Dries committed
737 738
    return $message;
  }
Dries's avatar
 
Dries committed
739 740
}

741
/**
Dries's avatar
Dries committed
742
 * Menu callback; displays a listing of all orphaned book pages.
743
 */
Dries's avatar
 
Dries committed
744
function book_admin_orphan() {
745
  $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
746 747 748 749 750

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

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

Dries's avatar
 
Dries committed
763
  print theme('page', $output);
Dries's avatar
 
Dries committed
764 765
}

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

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

784 785 786
/**
 * Implementation of hook_help().
 */
Dries's avatar
 
Dries committed
787
function book_help($section) {
Dries's avatar
 
Dries committed
788
  switch ($section) {
Dries's avatar
 
Dries committed
789
    case 'admin/help#book':
Dries's avatar
 
Dries committed
790
      return t("
Dries's avatar
 
Dries committed
791
      <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>
792
      <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>
793
      <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
794
      <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>
795
      <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>
Dries's avatar
 
Dries committed
796 797
      <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>
798
      <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>
799
      <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>
800
      <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
801
    case 'admin/modules#description':
Dries's avatar
 
Dries committed
802
      return t('Allows users to collaboratively author a book.');
Dries's avatar
 
Dries committed
803
    case 'admin/node/book':
804
      return t('<p>The book module offers a mean to organize content, authored by many users, in an online manual, outline or FAQ.</p>');
Dries's avatar
 
Dries committed
805
    case 'admin/node/book/orphan':