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', 'edit own book pages');
Dries's avatar
 
Dries committed
21 22
}

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

29
  if ($op == 'view') {
Dries's avatar
 
Dries committed
30 31 32 33
    // Everyone can access all published book pages whether these pages
    // are still waiting for approval or not.  We might not always want
    // to display pages that are waiting for approval, but we take care
    // of that problem in the book_content() function.
34
    return ($node->status ? $node->status : ($node->uid == $user->uid && user_access('edit own book pages')));
Dries's avatar
 
Dries committed
35 36
  }

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

43
  if ($op == 'update') {
Dries's avatar
 
Dries committed
44 45 46
    // Only registered users can update book pages.  Given the nature
    // of the book module this is considered to be a good/safe idea.
    // One can only update a book page if there are no suggested updates
47 48 49 50
    // of that page waiting for approval and as long as the "create new
    // revision"-bit is set.  That is, only updates that don't overwrite
    // the current or pending information are allowed.

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

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

  $links = array();

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

Dries's avatar
 
Dries committed
67
  if ($type == 'node' && $node->type == 'book') {
Dries's avatar
 
Dries committed
68
    if (!$main) {
Dries's avatar
 
Dries committed
69
      $links[] = l(t('printer-friendly version'), 'book/print/'. $node->nid, array('title' => t('Show a printer-friendly version of this book page and its sub-pages.')));
Dries's avatar
 
Dries committed
70
    }
Dries's avatar
 
Dries committed
71 72
  }

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

Dries's avatar
 
Dries committed
76 77 78 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 107
/**
 * 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;
}

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

   return $block;
}

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

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

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

Dries's avatar
 
Dries committed
164
  return $book;
Dries's avatar
 
Dries committed
165 166
}

167 168 169
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
170
function book_insert($node) {
171
  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
172
}
Dries's avatar
 
Dries committed
173

174 175 176
/**
 * Implementation of hook_update().
 */
Dries's avatar
 
Dries committed
177
function book_update($node) {
178
  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
179
}
Dries's avatar
 
Dries committed
180

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

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

199 200 201
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
202
function book_form(&$node) {
Dries's avatar
 
Dries committed
203
  global $user;
Dries's avatar
 
Dries committed
204

205
  $op = $_POST['op'];
206
  $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
207

208 209
  if (function_exists('taxonomy_node_form')) {
    $output .= implode('', taxonomy_node_form('book', $node));
210 211
  }

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

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

  return $output;
}

227 228 229
/**
 * Implementation of hook_node_link().
 */
Dries's avatar
 
Dries committed
230
function book_node_link($node = 0) {
Dries's avatar
 
Dries committed
231 232
  global $user;

233 234
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries's avatar
 
Dries committed
235

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

238 239
    if ($edit['nid']) {
      $node = node_load(array('nid' => $edit['nid']));
Dries's avatar
 
Dries committed
240 241
    }

242 243
    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
244
      drupal_set_message(t('Added the node to the book.'));
Dries's avatar
 
Dries committed
245 246
    }

247 248
    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
249
      drupal_set_message(t('Updated the book outline.'));
Dries's avatar
 
Dries committed
250 251
    }

252 253
    if ($op == t('Remove from book outline')) {
      db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
254
      drupal_set_message(t('Removed the post from the book.'));
Dries's avatar
 
Dries committed
255 256
    }

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

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

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

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

    }
    else {
275
      $output .= form_submit(t('Edit book outline'));
Dries's avatar
 
Dries committed
276 277
    }

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

280
    return form($output, 'post', url('admin/node/book'));
Dries's avatar
 
Dries committed
281 282 283
  }
}

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

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

  foreach ($revisions as $revision) {

Dries's avatar
 
Dries committed
293
    // Extract the specified revision:
Dries's avatar
 
Dries committed
294 295
    $node = node_revision_load($page, $revision);

Dries's avatar
 
Dries committed
296 297
    // Check to see if the conditions are met:
    $status = TRUE;
Dries's avatar
 
Dries committed
298 299 300

    foreach ($conditions as $key => $value) {
      if ($node->$key != $value) {
Dries's avatar
 
Dries committed
301
        $status = FALSE;
Dries's avatar
 
Dries committed
302 303 304 305 306 307 308 309 310
      }
    }

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

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

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

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

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

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

356 357 358
/**
 * Fetch the node object of the next page of the book.
 */
Dries's avatar
 
Dries committed
359 360
function book_next($node) {
  // get first direct child
Dries's avatar
 
Dries committed
361
  $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
362 363 364 365
  if ($child) {
    return $child;
  }

Dries's avatar
 
Dries committed
366 367
  // 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.
368

Dries's avatar
 
Dries committed
369
  while (($leaf = array_pop($path)) && count($path)) {
Dries's avatar
 
Dries committed
370
    $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
371 372 373 374 375 376
    if ($next) {
      return $next;
    }
  }
}

377 378 379
/**
 * Implementation of hook_content().
 */
Dries's avatar
 
Dries committed
380
function book_content($node, $teaser = FALSE) {
381
  $op = $_POST['op'];
Dries's avatar
 
Dries committed
382

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

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
 
Dries committed
392 393
  }

394 395
  // Extract the page body.
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
396

Dries's avatar
 
Dries committed
397 398 399
  return $node;
}

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

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

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

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

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

Dries's avatar
 
Dries committed
446
  // Construct the breadcrumb:
Dries's avatar
 
Dries committed
447

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

Dries's avatar
 
Dries committed
454
  if ($node->nid) {
455
    $output .= '<div class="book">';
Dries's avatar
 
Dries committed
456 457

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

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

485
    $output .= '<div class="nav">';
Dries's avatar
 
Dries committed
486 487
    $output .= ' <div class="links">'. $links .'</div>';
    $output .= ' <div class="titles">'. $titles .'</div>';
488 489
    $output .= '</div>';
    $output .= '</div>';
Dries's avatar
 
Dries committed
490
  }
Dries's avatar
 
Dries committed
491

Dries's avatar
 
Dries committed
492
  $node->body = $node->body.$output;
Dries's avatar
 
Dries committed
493

Dries's avatar
 
Dries committed
494
  return $node;
Dries's avatar
 
Dries committed
495
}
Dries's avatar
 
Dries committed
496

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

  return $toc;
}

510
function book_toc($exclude = 0) {
Dries's avatar
 
Dries committed
511
  $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
512

Dries's avatar
 
Dries committed
513
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
514 515 516 517
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
    array_push($children[$node->parent], $node);
Dries's avatar
 
Dries committed
518
  }
Dries's avatar
 
Dries committed
519

520 521
  $toc = array();

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

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

Dries's avatar
 
Dries committed
530 531 532
  return $toc;
}

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

  return $output;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

633
  print $html;
Dries's avatar
 
Dries committed
634 635
}

636
function book_print_recurse($parent = '', $depth = 1) {
Dries's avatar
 
Dries committed
637
  $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
638

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

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

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

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

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

Dries's avatar
 
Dries committed
663 664
  return $output;
}
Dries's avatar
 
Dries committed
665

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

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

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

Dries's avatar
 
Dries committed
679
  return $rows;
Dries's avatar
 
Dries committed
680 681
}

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

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

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

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

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

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

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

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

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

Dries's avatar
 
Dries committed
723 724
    return $message;
  }
Dries's avatar
 
Dries committed
725 726
}

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

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

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

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

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

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

776 777 778
/**
 * Implementation of hook_help().
 */
Dries's avatar
 
Dries committed
779
function book_help($section) {
Dries's avatar
 
Dries committed
780
  switch ($section) {
Dries's avatar
 
Dries committed
781
    case 'admin/help#book':
Dries's avatar
 
Dries committed
782
      return t("
Dries's avatar
 
Dries committed
783
      <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>
784
      <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>
785
      <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>
786
      <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>
787
      <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
788 789
      <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>
790
      <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>
791
      <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>
792
      <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
793
    case 'admin/modules#description':
Dries's avatar
 
Dries committed
794
      return t('Allows users to collaboratively author a book.');
Dries's avatar
 
Dries committed
795
    case 'admin/node/book':
Dries's avatar
 
Dries committed
796
      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
797
    case 'admin/node/book/orphan':
Dries's avatar
 
Dries committed
798
      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
799
    case 'node/add#book':
Dries's avatar
 
Dries committed
800