book.module 32.4 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 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 69 70
      if (book_access('create', $node)) {
        $links[] = l(t('add child page'), "node/add/book/parent/$node->nid");
      }
Dries's avatar
 
Dries committed
71
      $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
72
    }
Dries's avatar
 
Dries committed
73 74
  }

Dries's avatar
 
Dries committed
75
  return $links;
Dries's avatar
 
Dries committed
76 77
}

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

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

    // 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
125
  }
Dries's avatar
 
Dries committed
126 127 128 129

  return $items;
}

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

162 163
    return $block;
  }
Dries's avatar
 
Dries committed
164 165
}

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

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

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

Dries's avatar
 
Dries committed
187
  return $book;
Dries's avatar
 
Dries committed
188 189
}

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

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

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

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

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

228
  $op = $_POST['op'];
Dries's avatar
 
Dries committed
229 230
    
  $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
231

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

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

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

  return $output;
}

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

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

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

        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
295

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

Dries's avatar
 
Dries committed
301

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

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

  foreach ($revisions as $revision) {

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

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

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

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

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

Dries's avatar
 
Dries committed
341
function book_location_down($node, $nodes = array()) {
342
  $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
343 344 345 346 347 348 349
  if ($last_direct_child) {
    array_push($nodes, $last_direct_child);
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

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

Dries's avatar
 
Dries committed
359
  // Previous on the same level:
360
  $direct_above = db_fetch_object(db_query('SELECT n.nid, n.title FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE '. node_access_where_sql() ." AND b.parent = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '') AND (b.weight < %d OR (b.weight = %d AND n.title < '%s')) ORDER BY b.weight DESC, n.title DESC", $node->parent, $node->weight, $node->weight, $node->title));
Dries's avatar
 
Dries committed
361
  if ($direct_above) {
Dries's avatar
 
Dries committed
362
    // Get last leaf of $above.
Dries's avatar
 
Dries committed
363
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
364 365

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
366 367
  }
  else {
Dries's avatar
 
Dries committed
368
    // Direct parent:
369
    $prev = db_fetch_object(db_query('SELECT n.nid, n.title FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE '. node_access_where_sql() ." AND n.nid = %d AND n.status = 1 AND (n.moderate = 0 OR n.revisions != '')", $node->parent));
Dries's avatar
 
Dries committed
370 371 372 373
    return $prev;
  }
}

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

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

Dries's avatar
 
Dries committed
387
  while (($leaf = array_pop($path)) && count($path)) {
Dries's avatar
 
Dries committed
388
    $next = db_fetch_object(db_query("SELECT DISTINCT(n.nid), n.title, b.weight FROM {node} n ". node_access_join_sql() ." INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = %d AND n.status = 1 AND ". node_access_where_sql() ." AND (n.moderate = 0 OR n.revisions != '') AND (b.weight > %d OR (b.weight = %d AND n.title > '%s')) ORDER BY b.weight ASC, n.title ASC", $leaf->parent, $leaf->weight, $leaf->weight, $leaf->title));
Dries's avatar
 
Dries committed
389 390 391 392 393 394
    if ($next) {
      return $next;
    }
  }
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $toc;
}

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

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

535 536
  $toc = array();

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

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

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

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

  return $output;
}

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

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

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

592
/**
Dries's avatar
Dries committed
593
 * Menu callback; prints a listing of all books.
594
 */
Dries's avatar
 
Dries committed
595
function book_render() {
596
  $result = db_query('SELECT n.nid FROM {node} n '. node_access_join_sql() .' INNER JOIN {book} b ON n.nid = b.nid WHERE '. node_access_where_sql() .' AND b.parent = 0 AND n.status = 1 AND (n.moderate = 0 OR n.revisions IS NOT NULL) ORDER BY b.weight, n.title');
Dries's avatar
 
Dries committed
597

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

785 786 787
/**
 * Implementation of hook_help().
 */
Dries's avatar
 
Dries committed
788
function book_help($section) {
Dries's avatar
 
Dries committed
789
  switch ($section) {
Dries's avatar
 
Dries committed
790
    case 'admin/help#book':
Dries's avatar
 
Dries committed
791
      return t("
Dries's avatar
 
Dries committed
792
      <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>