book.module 31.9 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

4 5 6
/**
 * Implementation of hook_node_name().
 */
Dries's avatar
 
Dries committed
7
function book_node_name($node) {
8
  return t('book page');
Dries's avatar
 
Dries committed
9 10
}

11 12 13
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
14
function book_perm() {
15
  return array('maintain books');
Dries's avatar
 
Dries committed
16 17
}

18 19 20
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
21
function book_access($op, $node) {
Dries's avatar
 
Dries committed
22
  global $user;
Dries's avatar
 
Dries committed
23

24
  if ($op == 'view') {
Dries's avatar
 
Dries committed
25 26 27 28
    // Everyone can access all published book pages whether these pages
    // are still waiting for approval or not.  We might not always want
    // to display pages that are waiting for approval, but we take care
    // of that problem in the book_content() function.
Dries's avatar
 
Dries committed
29
    return $node->status;
Dries's avatar
 
Dries committed
30 31
  }

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

38
  if ($op == 'update') {
Dries's avatar
 
Dries committed
39 40 41 42 43 44
    // 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
    // of that page waiting for approval, it is not a PHP page, and
    // the "create new revision" bit is set.  That is, only updates that
    // don't overwrite the current or pending information are allowed.
45
    return user_access('maintain books') && !$node->moderate && !$node->format && $node->revision;
Dries's avatar
 
Dries committed
46
  }
Dries's avatar
 
Dries committed
47 48
}

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

  $links = array();

Dries's avatar
 
Dries committed
56 57
  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
58 59
  }

Dries's avatar
 
Dries committed
60
  if ($type == 'node' && $node->type == 'book') {
Dries's avatar
 
Dries committed
61
    if (!$main) {
Dries's avatar
 
Dries committed
62
      $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
63
    }
Dries's avatar
 
Dries committed
64 65
  }

Dries's avatar
 
Dries committed
66
  return $links;
Dries's avatar
 
Dries committed
67 68
}

Dries's avatar
 
Dries committed
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
/**
 * 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;
}

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

   return $block;
}

136 137 138
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
139
function book_load($node) {
Dries's avatar
 
Dries committed
140
  global $user;
Dries's avatar
 
Dries committed
141

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

144
  if (arg(1) == 'edit' && !user_access('administer nodes')) {
Dries's avatar
 
Dries committed
145 146
    // If a user is about to update a book page, we overload some
    // fields to reflect the changes.
Dries's avatar
 
Dries committed
147 148 149 150 151 152
    if ($user->uid) {
      $book->uid = $user->uid;
      $book->name = $user->name;
    }
    else {
      $book->uid = 0;
153
      $book->name = '';
Dries's avatar
 
Dries committed
154
    }
Dries's avatar
 
Dries committed
155
  }
Dries's avatar
 
Dries committed
156

Dries's avatar
 
Dries committed
157 158 159
  // We set the revision field to indicate that we have to create
  // a new revision when updating this book page.  We enable this
  // always such that the "edit this page" links appear.
Dries's avatar
 
Dries committed
160
  $book->revision = 1;
Dries's avatar
 
Dries committed
161

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

165 166 167
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
168
function book_insert($node) {
Dries's avatar
 
Dries committed
169
  db_query("INSERT INTO {book} (nid, format, parent, weight, log) VALUES (%d, %d, %d, %d, '%s')", $node->nid, $node->format, $node->parent, $node->weight, $node->log);
Dries's avatar
 
Dries committed
170
}
Dries's avatar
 
Dries committed
171

172 173 174
/**
 * Implementation of hook_update().
 */
Dries's avatar
 
Dries committed
175
function book_update($node) {
Dries's avatar
 
Dries committed
176
  db_query("UPDATE {book} SET format = %d, parent = %d, weight = %d, log = '%s' WHERE nid = %d", $node->format, $node->parent, $node->weight, $node->log, $node->nid);
Dries's avatar
 
Dries committed
177
}
Dries's avatar
 
Dries committed
178

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

186 187 188
/**
 * Implementation of hook_validate().
 */
189
function book_validate(&$node) {
190 191
  if ($node->format && user_access('create php content')) {
    // Do not filter PHP code. Do not auto-extract a teaser.
192 193 194 195 196
    $node->teaser = $node->body;
  }
  else {
    $node->format = 0;
  }
Dries's avatar
 
Dries committed
197

198 199
  // Set default values for non-administrators.
  if (!user_access('administer nodes')) {
200 201 202 203
    $node->format = 0;
    $node->weight = 0;
    $node->revision = 1;
  }
Dries's avatar
 
Dries committed
204 205
}

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

212 213
  $op = $_POST['op'];
  $output = form_select(t('Parent'), 'parent', $node->parent, book_toc(), t('The parent subject or category the page belongs in.'));
Dries's avatar
 
Dries committed
214

215 216
  if (function_exists('taxonomy_node_form')) {
    $output .= implode('', taxonomy_node_form('book', $node));
217 218
  }

Dries's avatar
 
Dries committed
219
  $output .= form_textarea(t('Body'), 'body', $node->body, 60, 20, filter_tips_short(), NULL, TRUE);
220
  $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
221

222 223 224
  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.'));
    if (user_access('create php content')) {
225
      $output .= form_radios(t('Type'), 'format', $node->format, array(0 => 'HTML / text', 1 => 'PHP'));
Dries's avatar
 
Dries committed
226
    }
Dries's avatar
 
Dries committed
227 228
  }
  else {
Dries's avatar
 
Dries committed
229 230
    // If a regular user updates a book page, we create a new revision
    // authored by that user:
231
    $output .= form_hidden('revision', 1);
Dries's avatar
 
Dries committed
232 233 234 235 236
  }

  return $output;
}

237 238 239
/**
 * Implementation of hook_node_link().
 */
Dries's avatar
 
Dries committed
240
function book_node_link($node = 0) {
Dries's avatar
 
Dries committed
241 242
  global $user;

243 244
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries's avatar
 
Dries committed
245

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

248 249
    if ($edit['nid']) {
      $node = node_load(array('nid' => $edit['nid']));
Dries's avatar
 
Dries committed
250 251
    }

252 253 254
    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']);
      drupal_set_message(t('added the node to the book.'));
Dries's avatar
 
Dries committed
255 256
    }

257 258 259
    if ($op == 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.'));
Dries's avatar
 
Dries committed
260 261
    }

262 263 264
    if ($op == t('Remove from book outline')) {
      db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
      drupal_set_message(t('removed the node form the book.'));
Dries's avatar
 
Dries committed
265 266
    }

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

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

272 273
      $output .= form_select(t('Parent'), 'parent', $page->parent, book_toc(), t('The parent subject or category the page belongs in.'));
      $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
274 275

      if ($page->nid) {
276 277
        $output .= form_submit(t('Update book outline'));
        $output .= form_submit(t('Remove from book outline'));
Dries's avatar
 
Dries committed
278 279
      }
      else {
280
        $output .= form_submit(t('Add to book outline'));
Dries's avatar
 
Dries committed
281 282 283 284
      }

    }
    else {
285
      $output .= form_submit(t('Edit book outline'));
Dries's avatar
 
Dries committed
286 287
    }

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

290
    return form($output, 'post', url('admin/node/book'));
Dries's avatar
 
Dries committed
291 292 293
  }
}

294 295 296
/**
 * Return the the most recent revision that matches the specified conditions.
 */
Dries's avatar
 
Dries committed
297 298 299 300 301 302
function book_revision_load($page, $conditions = array()) {

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

  foreach ($revisions as $revision) {

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

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

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

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

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

Dries's avatar
 
Dries committed
333
function book_location_down($node, $nodes = array()) {
334
  $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
335 336 337 338 339 340 341
  if ($last_direct_child) {
    array_push($nodes, $last_direct_child);
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

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

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

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
358 359
  }
  else {
Dries's avatar
 
Dries committed
360
    // Direct parent:
Dries's avatar
 
Dries committed
361
    $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
362 363 364 365
    return $prev;
  }
}

366 367 368
/**
 * Fetch the node object of the next page of the book.
 */
Dries's avatar
 
Dries committed
369 370
function book_next($node) {
  // get first direct child
Dries's avatar
 
Dries committed
371
  $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
372 373 374 375
  if ($child) {
    return $child;
  }

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

Dries's avatar
 
Dries committed
379
  while (($leaf = array_pop($path)) && count($path)) {
Dries's avatar
 
Dries committed
380
    $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
381 382 383 384 385 386
    if ($next) {
      return $next;
    }
  }
}

387 388 389
/**
 * Implementation of hook_content().
 */
Dries's avatar
 
Dries committed
390
function book_content($node, $teaser = FALSE) {
391
  $op = $_POST['op'];
Dries's avatar
 
Dries committed
392

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

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
 
Dries committed
402 403
  }

Dries's avatar
 
Dries committed
404 405
  // Extract the page body.  If body is dynamic (using PHP code), the body
  // will be generated.
Dries's avatar
 
Dries committed
406 407
  if ($node->format == 1) {
    // Make sure only authorized users can preview PHP pages.
408
    if ($op == t('Preview') && !user_access('create php content')) {
Dries's avatar
 
Dries committed
409 410 411 412 413
      return;
    }

    ob_start();
    eval($node->body);
Dries's avatar
 
Dries committed
414
    $node->body = ob_get_contents();
Dries's avatar
 
Dries committed
415
    ob_end_clean();
Dries's avatar
 
Dries committed
416 417
    $node->teaser = node_teaser($node->body);
    $node->readmore = (strlen($node->teaser) < strlen($node->body));
Dries's avatar
 
Dries committed
418 419
  }
  else {
Dries's avatar
 
Dries committed
420
    $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
421
  }
Dries's avatar
 
Dries committed
422

Dries's avatar
 
Dries committed
423 424 425
  return $node;
}

426 427 428 429 430 431
/**
 * 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
432
function book_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
 
Dries committed
433
  $node = book_content($node, $teaser);
Dries's avatar
 
Dries committed
434

Dries's avatar
 
Dries committed
435 436
  if (!$teaser && $node->moderate) {
    $node->body .= '<div class="log"><div class="title">'. t('Log') .':</div>'. $node->log .'</div>';
Dries's avatar
 
Dries committed
437 438 439
  }
}

440
/**
Dries's avatar
 
Dries committed
441 442 443
 * Implementation of hook_nodeapi().
 *
 * Appends book navigation to all nodes in the book.
444
 */
Dries's avatar
 
Dries committed
445 446 447 448
function book_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
    case 'view':
      if (!$teaser) {
449
        $book = db_fetch_object(db_query('SELECT * FROM {book} WHERE nid = %d', $node->nid));
Dries's avatar
 
Dries committed
450

Dries's avatar
 
Dries committed
451 452 453 454 455
        if ($book) {
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
          $node = book_navigation($node);
456 457 458
          if ($page) {
            menu_set_location($node->breadcrumb);
          }
Dries's avatar
 
Dries committed
459
        }
Dries's avatar
 
Dries committed
460
      }
Dries's avatar
 
Dries committed
461
      break;
Dries's avatar
 
Dries committed
462
  }
Dries's avatar
 
Dries committed
463
}
Dries's avatar
 
Dries committed
464

465 466 467 468
/**
 * Prepares both the custom breadcrumb trail and the forward/backward
 * navigation for a node presented as a book page.
 */
Dries's avatar
 
Dries committed
469
function book_navigation($node) {
Dries's avatar
 
Dries committed
470
  $path = book_location($node);
Dries's avatar
 
Dries committed
471

Dries's avatar
 
Dries committed
472
  // Construct the breadcrumb:
Dries's avatar
 
Dries committed
473

Dries's avatar
 
Dries committed
474
  $node->breadcrumb = array(); // Overwrite the trail with a book trail.
Dries's avatar
 
Dries committed
475
  foreach ($path as $level) {
Dries's avatar
 
Dries committed
476
    $node->breadcrumb[] = array('path' => 'node/'. $level->nid, 'title' =>  $level->title);
Dries's avatar
 
Dries committed
477
  }
Dries's avatar
 
Dries committed
478
  $node->breadcrumb[] = array('path' => 'node/'. $node->nid);
Dries's avatar
 
Dries committed
479

Dries's avatar
 
Dries committed
480
  if ($node->nid) {
481
    $output .= '<div class="book">';
Dries's avatar
 
Dries committed
482 483

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

Dries's avatar
 
Dries committed
487
    if ($prev = book_prev($node)) {
488
      $links .= '<div class="prev">';
Dries's avatar
 
Dries committed
489
      $links .= l(t('previous'), 'node/'. $prev->nid, array('title' => t('View the previous page.')));
490
      $links .= '</div>';
Dries's avatar
 
Dries committed
491
      $titles .= '<div class="prev">'. $prev->title .'</div>';
Dries's avatar
 
Dries committed
492 493
    }
    else {
Dries's avatar
 
Dries committed
494
      $links .= '<div class="prev">&nbsp;</div>'; // Make an empty div to fill the space.
Dries's avatar
 
Dries committed
495 496
    }
    if ($next = book_next($node)) {
497
      $links .= '<div class="next">';
Dries's avatar
 
Dries committed
498
      $links .= l(t('next'), 'node/'. $next->nid, array('title' => t('View the next page.')));
499
      $links .= '</div>';
Dries's avatar
 
Dries committed
500
      $titles .= '<div class="next">'. $next->title .'</div>';
Dries's avatar
 
Dries committed
501 502
    }
    else {
Dries's avatar
 
Dries committed
503
      $links .= '<div class="next">&nbsp;</div>'; // Make an empty div to fill the space.
Dries's avatar
 
Dries committed
504 505
    }
    if ($node->parent) {
506
      $links .= '<div class="up">';
Dries's avatar
 
Dries committed
507
      $links .= l(t('up'), 'node/'. $node->parent, array('title' => t('View this page\'s parent section.')));
508
      $links .= '</div>';
Dries's avatar
 
Dries committed
509
    }
Dries's avatar
 
Dries committed
510

511
    $output .= '<div class="nav">';
Dries's avatar
 
Dries committed
512 513
    $output .= ' <div class="links">'. $links .'</div>';
    $output .= ' <div class="titles">'. $titles .'</div>';
514 515
    $output .= '</div>';
    $output .= '</div>';
Dries's avatar
 
Dries committed
516
  }
Dries's avatar
 
Dries committed
517

Dries's avatar
 
Dries committed
518
  $node->body = $node->body.$output;
Dries's avatar
 
Dries committed
519

Dries's avatar
 
Dries committed
520
  return $node;
Dries's avatar
 
Dries committed
521
}
Dries's avatar
 
Dries committed
522

Dries's avatar
 
Dries committed
523 524 525 526
function book_toc_recurse($nid, $indent, $toc, $children) {

  if ($children[$nid]) {
    foreach ($children[$nid] as $foo => $node) {
Dries's avatar
 
Dries committed
527 528
      $toc[$node->nid] = $indent .' '. $node->title;
      $toc = book_toc_recurse($node->nid, $indent .'--', $toc, $children);
Dries's avatar
 
Dries committed
529 530 531 532 533 534
    }
  }

  return $toc;
}

535
function book_toc($parent = 0, $indent = '', $toc = array()) {
Dries's avatar
 
Dries committed
536
  $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
537

Dries's avatar
 
Dries committed
538
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
539 540 541 542
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
    array_push($children[$node->parent], $node);
Dries's avatar
 
Dries committed
543
  }
Dries's avatar
 
Dries committed
544

Dries's avatar
 
Dries committed
545 546
  // If the user is an administrator, add the top-level book page;
  // only administrators can start new books.
547 548
  if (user_access('administer nodes')) {
    $toc[0] = '<'. t('top-level') .'>';
Dries's avatar
 
Dries committed
549 550
  }

Dries's avatar
 
Dries committed
551
  $toc = book_toc_recurse($parent, $indent, $toc, $children);
Dries's avatar
 
Dries committed
552

Dries's avatar
 
Dries committed
553 554 555
  return $toc;
}

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

  return $output;
}

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

Dries's avatar
 
Dries committed
589 590 591 592
  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
593
  }
Dries's avatar
 
Dries committed
594

Dries's avatar
 
Dries committed
595
  if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
Dries's avatar
 
Dries committed
596
    return '<ul>'. $tree .'</ul>';
Dries's avatar
 
Dries committed
597
  }
Dries's avatar
 
Dries committed
598 599
}

600
/**
Dries's avatar
Dries committed
601
 * Menu callback; prints a listing of all books.
602
 */
Dries's avatar
 
Dries committed
603
function book_render() {
604
  $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
605

Dries's avatar
 
Dries committed
606
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
607
    // Load the node:
608
    $node = node_load(array('nid' => $page->nid));
Dries's avatar
 
Dries committed
609

Dries's avatar
 
Dries committed
610
    if ($node) {
Dries's avatar
 
Dries committed
611
      // Take the most recent approved revision, extract the page and check output:
Dries's avatar
 
Dries committed
612
      $node = book_content($node);
Dries's avatar
 
Dries committed
613
      // Output the content:
614
      $output .= '<div class="book">';
Dries's avatar
 
Dries committed
615
      $output .= '<div class="title">'. l($node->title, 'node/'. $node->nid) .'</div>';
616
      $output .= '<div class="body">'. $node->teaser .'</div>';
617
      $output .= '</div>';
Dries's avatar
 
Dries committed
618
    }
Dries's avatar
 
Dries committed
619 620
  }

621 622
  drupal_set_title(t('Books'));
  print theme('page', $output);
Dries's avatar
 
Dries committed
623 624
}

625
/**
Dries's avatar
 
Dries committed
626
 * Menu callback; generates printer-friendly book page with all descendants.
627 628
 */
function book_print($nid = 0, $depth = 1) {
Dries's avatar
 
Dries committed
629
  global $base_url;
Dries's avatar
 
Dries committed
630
  $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
631

Dries's avatar
 
Dries committed
632 633
  while ($page = db_fetch_object($result)) {
    // load the node:
634
    $node = node_load(array('nid' => $page->nid));
Dries's avatar
 
Dries committed
635

Dries's avatar
 
Dries committed
636 637
    if ($node) {
      // output the content:
638 639
      if (node_hook($node, 'content')) {
        $node = node_invoke($node, 'content');
Dries's avatar
 
Dries committed
640
      }
Dries's avatar
 
Dries committed
641
      $output .= '<h1 id="'. $node->nid .'" name="'. $node->nid .'" class="book-h'. $depth .'">'. $node->title .'</h1>';
Dries's avatar
 
Dries committed
642

Dries's avatar
 
Dries committed
643
      if ($node->body) {
Dries's avatar
 
Dries committed
644
        $output .= $node->body;
Dries's avatar
 
Dries committed
645
      }
Dries's avatar
 
Dries committed
646
    }
Dries's avatar
 
Dries committed
647
  }
Dries's avatar
 
Dries committed
648

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

Dries's avatar
 
Dries committed
651 652
  $html = '<html><head><title>'. $node->title .'</title>';
  $html .= '<base href="'. $base_url .'/" />';
Dries's avatar
 
Dries committed
653
  $html .= "<style type=\"text/css\">\n@import url(misc/print.css);\n</style>";
654
  $html .= '</head><body>'. $output .'</body></html>';
Dries's avatar
 
Dries committed
655

656
  print $html;
Dries's avatar
 
Dries committed
657 658
}

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

Dries's avatar
 
Dries committed
662
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
663
    // Load the node:
664
    $node = node_load(array('nid' => $page->nid));
Dries's avatar
 
Dries committed
665

Dries's avatar
 
Dries committed
666
    // Take the most recent approved revision:
Dries's avatar
 
Dries committed
667
    if ($node->moderate) {
668
      $node = book_revision_load($node, array('moderate' => 0, 'status' => 1));
Dries's avatar
 
Dries committed
669 670
    }

Dries's avatar
 
Dries committed
671
    if ($node) {
Dries's avatar
 
Dries committed
672
      // Output the content:
673 674
      if (node_hook($node, 'content')) {
        $node = node_invoke($node, 'content');
Dries's avatar
 
Dries committed
675
      }
Dries's avatar
 
Dries committed
676
      $output .= '<h1 id="'. $node->nid .'" name="'. $node->nid .'" class="book-h'. $depth .'">'. $node->title .'</h1>';
Dries's avatar
 
Dries committed
677

Dries's avatar
 
Dries committed
678
      if ($node->body) {
679
        $output .= '<ul>'. $node->body .'</ul>';
Dries's avatar
 
Dries committed
680
      }
Dries's avatar
 
Dries committed
681

682
      $output .= book_print_recurse($node->nid, $depth + 1);
Dries's avatar
 
Dries committed
683
    }
Dries's avatar
 
Dries committed
684
  }
Dries's avatar
 
Dries committed
685

Dries's avatar
 
Dries committed
686 687
  return $output;
}
Dries's avatar
 
Dries committed
688

Dries's avatar
 
Dries committed
689
function book_admin_view_line($node, $depth = 0) {
Dries's avatar
 
Dries committed
690
  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
691 692 693
}

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

  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
697
    $node = node_load(array('nid' => $node->nid));
Dries's avatar
 
Dries committed
698 699
    $rows[] = book_admin_view_line($node, $depth);
    $rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
Dries's avatar
 
Dries committed
700 701
  }

Dries's avatar
 
Dries committed
702
  return $rows;
Dries's avatar
 
Dries committed
703 704
}

705 706 707
/**
 * Display an administrative view of the hierarchy of a book.
 */
Dries's avatar
 
Dries committed
708
function book_admin_view($nid, $depth = 0) {
Dries's avatar
 
Dries committed
709
  if ($nid) {
Dries's avatar
 
Dries committed
710
    $node = node_load(array('nid' => $nid));
Dries's avatar
 
Dries committed
711

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

Dries's avatar
 
Dries committed
714
    $header = array(t('title'), t('weight'), array('data' => t('operations'), 'colspan' => 3));
Dries's avatar
 
Dries committed
715 716
    $rows[] = book_admin_view_line($node);
    $rows = array_merge($rows, book_admin_view_book($nid));
Dries's avatar
 
Dries committed
717

Dries's avatar
 
Dries committed
718 719
    $output .= theme('table', $header, $rows);
    $output .= form_submit(t('Save book pages'));
Dries's avatar
 
Dries committed
720

Dries's avatar
 
Dries committed
721 722
    return form($output);
  }
Dries's avatar
 
Dries committed
723 724 725
}

function book_admin_save($nid, $edit = array()) {
Dries's avatar
 
Dries committed
726
  if ($nid) {
Dries's avatar
 
Dries committed
727
    $book = node_load(array('nid' => $nid));
Dries's avatar
 
Dries committed
728

Dries's avatar
 
Dries committed
729
    foreach ($edit as $nid => $value) {
Dries's avatar
 
Dries committed
730 731 732 733
      // 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
734
      }
Dries's avatar
 
Dries committed
735

Dries's avatar
 
Dries committed
736 737 738 739
      // 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
740
      }
Dries's avatar
 
Dries committed
741 742
    }

743 744
    $message = t('updated book "%title"', array('%title' => $book->title));
    watchdog('special', $message);
Dries's avatar
 
Dries committed
745

Dries's avatar
 
Dries committed
746 747
    return $message;
  }
Dries's avatar
 
Dries committed
748 749
}

750
/**
Dries's avatar
Dries committed
751
 * Menu callback; displays a listing of all orphaned book pages.
752
 */
Dries's avatar
 
Dries committed
753
function book_admin_orphan() {
Dries's avatar
 
Dries committed
754
  $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
755 756 757 758 759

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

Dries's avatar
 
Dries committed
760
  if ($pages) {
761
    $output .= '<h3>'. t('Orphan pages') .'</h3>';
Dries's avatar
 
Dries committed
762
    $header = array(t('title'), t('weight'), array('data' => t('operations'), 'colspan' => 3));
Dries's avatar
 
Dries committed
763 764
    foreach ($pages as $nid => $node) {
      if ($node->parent && empty($pages[$node->parent])) {
Dries's avatar
 
Dries committed
765 766
        $rows[] = book_admin_view_line($node, $depth);
        $rows = array_merge($rows, book_admin_view_book($node->nid, $depth + 1));
Dries's avatar
 
Dries committed
767
      }
Dries's avatar
 
Dries committed
768
    }
Dries's avatar
 
Dries committed
769
    $output .= theme('table', $header, $rows);
Dries's avatar
 
Dries committed
770 771
  }

Dries's avatar
 
Dries committed
772
  print theme('page', $output);
Dries's avatar
 
Dries committed
773 774
}

775
/**
Dries's avatar
Dries committed
776
 * Menu callback; displays the book administration page.
777
 */
Dries's avatar
Dries committed
778
function book_admin($nid = 0) {
Dries's avatar
 
Dries committed
779 780
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries's avatar
 
Dries committed
781

Dries's avatar
 
Dries committed
782
  switch ($op) {
Dries's avatar
 
Dries committed
783 784 785 786
    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
787 788
      $output = book_node_link();
      break;
Dries's avatar
 
Dries committed
789
    case t('Save book pages'):
790
      drupal_set_message(book_admin_save($nid, $edit));
Dries's avatar
 
Dries committed
791 792
      // fall through:
    default:
793
      $output .= book_admin_view($nid);
Dries's avatar
 
Dries committed
794
      break;
Dries's avatar
 
Dries committed
795
  }
Dries's avatar
 
Dries committed
796
  print theme('page', $output);
Dries's avatar
 
Dries committed
797 798
}

799 800 801
/**
 * Implementation of hook_help().
 */
Dries's avatar
 
Dries committed
802
function book_help($section) {
Dries's avatar
 
Dries committed
803
  switch ($section) {
Dries's avatar
 
Dries committed
804
    case 'admin/help#book':
Dries's avatar
 
Dries committed
805
      return t("
Dries's avatar
 
Dries committed
806
      <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>
807
      <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>
808
      <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>
809
      <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>
810
      <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
811 812
      <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>
813
      <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>
814
      <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>