book.module 39.5 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 == 'create') {
Dries's avatar
 
Dries committed
30 31
    // Only registered users can create book pages.  Given the nature
    // of the book module this is considered to be a good/safe idea.
32
    return user_access('create book pages');
Dries's avatar
 
Dries committed
33 34
  }

35
  if ($op == 'update') {
Dries's avatar
 
Dries committed
36 37 38
    // 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
39 40
    // of that page waiting for approval.  That is, only updates that
    // don't overwrite the current or pending information are allowed.
41

42 43 44 45 46 47
    if ((user_access('maintain books') && !$node->moderate) || ($node->uid == $user->uid && user_access('edit own book pages'))) {
      return TRUE;
    }
    else {
       // do nothing. node-access() will determine further access
    }
Dries's avatar
 
Dries committed
48
  }
Dries's avatar
 
Dries committed
49 50
}

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

  $links = array();

58
  if ($type == 'node' && isset($node->parent)) {
Dries's avatar
 
Dries committed
59
    if (!$main) {
Dries's avatar
 
Dries committed
60 61 62
      if (book_access('create', $node)) {
        $links[] = l(t('add child page'), "node/add/book/parent/$node->nid");
      }
63
      $links[] = l(t('printer-friendly version'), 'book/export/html/'. $node->nid, array('title' => t('Show a printer-friendly version of this book page and its sub-pages.')));
64 65
      $links[] = l(t('export DocBook XML'), 'book/export/docbook/'. $node->nid, array('title' => t('Export this book page and its sub-pages as DocBook XML.')));
      $links[] = l(t('export OPML'), 'book/export/opml/'. $node->nid, array('title' => t('Export this book page and its sub-pages as OPML.')));
Dries's avatar
 
Dries committed
66
    }
Dries's avatar
 
Dries committed
67 68
  }

Dries's avatar
 
Dries committed
69
  return $links;
Dries's avatar
 
Dries committed
70 71
}

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

Dries's avatar
 
Dries committed
78
  if ($may_cache) {
79 80 81 82 83 84 85 86 87
    $items[] = array(
      'path' => 'book',
      'title' => t('books'),
      'access' => user_access('access content'),
      'type' => MENU_NORMAL_ITEM,
      'weight' => 5);
    $items[] = array(
      'path' => 'node/add/book',
      'title' => t('book page'),
88
      'access' => user_access('create book pages'));
89 90 91
    $items[] = array(
      'path' => 'admin/node/book',
      'title' => t('books'),
Dries's avatar
 
Dries committed
92 93 94
      'callback' => 'book_admin',
      'access' => user_access('administer nodes'),
      'weight' => 4);
95 96 97
    $items[] = array(
      'path' => 'admin/node/book/orphan',
      'title' => t('orphan pages'),
Dries's avatar
 
Dries committed
98 99 100 101 102 103 104
      '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);
105
    $items[] = array(
106 107
      'path' => 'book/export',
      'callback' => 'book_export',
Dries's avatar
 
Dries committed
108 109
      'access' => user_access('access content'),
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
110
  }
Dries's avatar
 
Dries committed
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:
116
      $result = db_query(db_rewrite_sql("SELECT n.nid FROM {node} n WHERE n.nid = %d AND n.type != 'book'"), arg(1));
Dries's avatar
 
Dries committed
117 118 119 120 121 122 123
      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
124 125 126 127

  return $items;
}

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

155
        $block['subject'] = check_plain($path[0]->title);
Dries's avatar
 
Dries committed
156 157 158
        $block['content'] = book_tree($expand[0], 5, $expand);
      }
    }
Dries's avatar
 
Dries committed
159

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

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

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

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

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

188 189 190
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
191
function book_insert($node) {
192
  db_query("INSERT INTO {book} (nid, parent, weight, log) VALUES (%d, %d, %d, '%s')", $node->nid, $node->parent, $node->weight, $node->log);
Dries's avatar
 
Dries committed
193
}
Dries's avatar
 
Dries committed
194

195 196 197
/**
 * Implementation of hook_update().
 */
Dries's avatar
 
Dries committed
198
function book_update($node) {
199
  db_query("UPDATE {book} SET parent = %d, weight = %d, log = '%s' WHERE nid = %d", $node->parent, $node->weight, $node->log, $node->nid);
Dries's avatar
 
Dries committed
200
}
Dries's avatar
 
Dries committed
201

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

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

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

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

Dries's avatar
 
Dries committed
228
  $output = form_select(t('Parent'), 'parent', ($node->parent ? $node->parent : arg(4)), book_toc($node->nid), t('The parent that this page belongs in. Note that pages whose parent is &lt;top-level&gt; are regarded as independent, top-level books.'));
Dries's avatar
 
Dries committed
229

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

234
  $output .= form_textarea(t('Body'), 'body', $node->body, 60, 20, '', NULL, TRUE);
235
  $output .= filter_form('format', $node->format);
Dries's avatar
 
Dries committed
236
  $output .= form_textarea(t('Log message'), 'log', $node->log, 60, 5, t('An explanation of the additions or updates being made to help other authors understand your motivations.'));
Dries's avatar
 
Dries committed
237

238
  if (user_access('administer nodes')) {
Dries's avatar
 
Dries committed
239
    $output .= form_weight(t('Weight'), 'weight', $node->weight, 15, t('Pages at a given level are ordered first by weight and then by title.'));
Dries's avatar
 
Dries committed
240 241
  }
  else {
Dries's avatar
 
Dries committed
242 243
    // If a regular user updates a book page, we create a new revision
    // authored by that user:
244
    $output .= form_hidden('revision', 1);
Dries's avatar
 
Dries committed
245 246 247 248 249
  }

  return $output;
}

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

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

Dries's avatar
 
Dries committed
260 261 262 263
  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']);
264
        drupal_set_message(t('The post has been added to the book.'));
Dries's avatar
 
Dries committed
265 266 267 268 269
        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);
270
        drupal_set_message(t('The book outline has been updated.'));
Dries's avatar
 
Dries committed
271 272 273 274 275
        drupal_goto("node/$node->nid");
        break;

      case t('Remove from book outline'):
        db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
276
        drupal_set_message(t('The post has been removed from the book.'));
Dries's avatar
 
Dries committed
277 278 279 280 281 282 283
        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.'));
284
        $output .= form_weight(t('Weight'), 'weight', $page->weight, 15, t('Pages at a given level are ordered first by weight and then by title.'));
Dries's avatar
 
Dries committed
285 286 287 288 289 290 291 292

        if ($page->nid) {
          $output .= form_submit(t('Update book outline'));
          $output .= form_submit(t('Remove from book outline'));
        }
        else {
          $output .= form_submit(t('Add to book outline'));
        }
Dries's avatar
 
Dries committed
293

294
        drupal_set_title(check_plain($node->title));
Dries's avatar
 
Dries committed
295
        return form($output);
Dries's avatar
 
Dries committed
296 297 298 299
    }
  }
}

Dries's avatar
 
Dries committed
300

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

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

  foreach ($revisions as $revision) {

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

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

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

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

328 329 330
/**
 * Return the path (call stack) to a certain book page.
 */
Dries's avatar
 
Dries committed
331
function book_location($node, $nodes = array()) {
332
  $parent = db_fetch_object(db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent, b.weight FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.nid = %d'), $node->parent));
Dries's avatar
 
Dries committed
333 334 335 336 337 338 339
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

340 341 342
/**
 * Accumulates the nodes up to the root of the book from the given node in the $nodes array.
 */
Dries's avatar
 
Dries committed
343
function book_location_down($node, $nodes = array()) {
344
  $last_direct_child = db_fetch_object(db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent, b.weight 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
345 346 347 348 349 350 351
  if ($last_direct_child) {
    array_push($nodes, $last_direct_child);
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

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

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

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
368 369
  }
  else {
Dries's avatar
 
Dries committed
370
    // Direct parent:
371
    $prev = db_fetch_object(db_query(db_rewrite_sql('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'), $node->parent));
Dries's avatar
 
Dries committed
372 373 374 375
    return $prev;
  }
}

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

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

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

397 398 399 400 401 402
/**
 * Returns the content of a given node.  If $teaser if true, returns
 * the teaser rather than full content.  Displays the most recently
 * approved revision of a node (if any) unless we have to display this
 * page in the context of the moderation queue.
 */
Dries's avatar
 
Dries committed
403
function book_content($node, $teaser = FALSE) {
404
  $op = $_POST['op'];
Dries's avatar
 
Dries committed
405

Dries's avatar
 
Dries committed
406 407 408
  // 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.
409 410
  if ($op != t('Preview') && $node->moderate && arg(0) != 'queue') {
    $revision = book_revision_load($node, array('moderate' => 0, 'status' => 1));
Dries's avatar
 
Dries committed
411 412 413 414

    if ($revision) {
      $node = $revision;
    }
Dries's avatar
 
Dries committed
415 416
  }

417 418
  // Extract the page body.
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
419

Dries's avatar
 
Dries committed
420 421 422
  return $node;
}

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

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

437
/**
Dries's avatar
 
Dries committed
438 439 440
 * Implementation of hook_nodeapi().
 *
 * Appends book navigation to all nodes in the book.
441
 */
Dries's avatar
 
Dries committed
442 443 444 445
function book_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
    case 'view':
      if (!$teaser) {
Dries's avatar
 
Dries committed
446
        $book = db_fetch_array(db_query('SELECT * FROM {book} WHERE nid = %d', $node->nid));
Dries's avatar
 
Dries committed
447
        if ($book) {
448
          if ($node->moderate && user_access('administer nodes')) {
449
            drupal_set_message(t("The post has been submitted for moderation and won't be accessible until it has been approved."));
450 451
          }

Dries's avatar
 
Dries committed
452 453 454
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
455
          $node = theme('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
/**
 * Prepares both the custom breadcrumb trail and the forward/backward
 * navigation for a node presented as a book page.
468 469
 *
 * @ingroup themeable
470
 */
471
function theme_book_navigation($node) {
Dries's avatar
 
Dries committed
472
  $path = book_location($node);
Dries's avatar
 
Dries committed
473

Dries's avatar
 
Dries committed
474
  // Construct the breadcrumb:
Dries's avatar
 
Dries committed
475

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

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

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

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

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

Dries's avatar
 
Dries committed
520
  $node->body = $node->body.$output;
Dries's avatar
 
Dries committed
521

Dries's avatar
 
Dries committed
522
  return $node;
Dries's avatar
 
Dries committed
523
}
Dries's avatar
 
Dries committed
524

525 526 527
/**
 * This is a helper function for book_toc().
 */
528
function book_toc_recurse($nid, $indent, $toc, $children, $exclude) {
Dries's avatar
 
Dries committed
529 530
  if ($children[$nid]) {
    foreach ($children[$nid] as $foo => $node) {
531 532 533 534
      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
535 536 537 538 539 540
    }
  }

  return $toc;
}

541 542 543
/**
 * Returns an array of titles and nid entries of book pages in table of contents order.
 */
544
function book_toc($exclude = 0) {
545
  $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent, b.weight FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 ORDER BY b.weight, n.title'));
Dries's avatar
 
Dries committed
546

Dries's avatar
 
Dries committed
547
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
548 549 550 551
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
    array_push($children[$node->parent], $node);
Dries's avatar
 
Dries committed
552
  }
Dries's avatar
 
Dries committed
553

554 555
  $toc = array();

Dries's avatar
 
Dries committed
556 557
  // If the user is an administrator, add the top-level book page;
  // only administrators can start new books.
558 559
  if (user_access('administer nodes')) {
    $toc[0] = '<'. t('top-level') .'>';
Dries's avatar
 
Dries committed
560 561
  }

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

Dries's avatar
 
Dries committed
564 565 566
  return $toc;
}

567 568 569
/**
 * This is a helper function for book_tree()
 */
Dries's avatar
 
Dries committed
570
function book_tree_recurse($nid, $depth, $children, $unfold = array()) {
Dries's avatar
 
Dries committed
571
  if ($depth > 0) {
Dries's avatar
 
Dries committed
572 573
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
Dries's avatar
 
Dries committed
574 575 576
        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
577 578
            $output .= l($node->title, 'node/'. $node->nid);
            $output .= '<ul>'. $tree .'</ul>';
Dries's avatar
 
Dries committed
579 580 581
            $output .= '</li>';
          }
          else {
Dries's avatar
 
Dries committed
582
            $output .= '<li class="leaf">'. l($node->title, 'node/'. $node->nid) .'</li>';
Dries's avatar
 
Dries committed
583 584 585 586
          }
        }
        else {
          if ($tree = book_tree_recurse($node->nid, 1, $children)) {
Dries's avatar
 
Dries committed
587
            $output .= '<li class="collapsed">'. l($node->title, 'node/'. $node->nid) .'</li>';
Dries's avatar
 
Dries committed
588 589
          }
          else {
Dries's avatar
 
Dries committed
590
            $output .= '<li class="leaf">'. l($node->title, 'node/'. $node->nid) .'</li>';
Dries's avatar
 
Dries committed
591
          }
Dries's avatar
 
Dries committed
592
        }
Dries's avatar
 
Dries committed
593 594
      }
    }
Dries's avatar
 
Dries committed
595 596 597 598 599
  }

  return $output;
}

600 601 602 603
/**
 * Returns an HTML nested list (wrapped in a menu-class div) representing the book nodes
 * as a tree.
 */
Dries's avatar
 
Dries committed
604
function book_tree($parent = 0, $depth = 3, $unfold = array()) {
605
  $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent, b.weight FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND n.moderate = 0 ORDER BY b.weight, n.title'));
Dries's avatar
 
Dries committed
606

Dries's avatar
 
Dries committed
607 608 609 610
  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
611
  }
Dries's avatar
 
Dries committed
612

Dries's avatar
 
Dries committed
613
  if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
614
    return '<div class="menu"><ul>'. $tree .'</ul></div>';
Dries's avatar
 
Dries committed
615
  }
Dries's avatar
 
Dries committed
616 617
}

618
/**
Dries's avatar
Dries committed
619
 * Menu callback; prints a listing of all books.
620
 */
Dries's avatar
 
Dries committed
621
function book_render() {
622
  $result = db_query(db_rewrite_sql('SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE b.parent = 0 AND n.status = 1 AND n.moderate = 0 ORDER BY b.weight, n.title'));
Dries's avatar
 
Dries committed
623

624 625 626 627 628 629
  $books = array();
  while ($node = db_fetch_object($result)) {
    $books[] = l($node->title, 'node/'. $node->nid);
  }

  return theme('item_list', $books);
Dries's avatar
 
Dries committed
630 631
}

632
/**
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
 * Menu callback; Generates various representation of a book page with
 * all descendants and prints the requested representation to output.
 *
 * Notes: For HTML output, the given node is /embedded to its absolute
 * depth in a top level section/.  For example, a child node with
 * depth 2 in the hierarchy is contained in (otherwise empty) <div>
 * elements corresponding to depth 0 and depth 1.  This is intended to
 * support WYSIWYG output - e.g., level 3 sections always look like
 * level 3 sections, no matter their depth relative to the node
 * selected to be exported as printer-friendly HTML.
 *
 * DocBook XML and OPML outputs do not attempt to embed a node to its
 * absolute level in the parent book.

 *    For DocBook output, the exported node will be a document fragment
 * unless the node is a level 0 node (book), specifically
 *    <ul>
 *      <li>a <chapter> for level 1 elements, </li>
 *      <li>a <section> for levels 2 and deeper.</li>
 *    </ul>
 *
 *    For OPML output, the exported node will be the top level element
 * in the OPML outline.
 *
 * @param type
 *   - a string encoding the type of output requested.
 *       The following types are supported:
 *          1) HTML (printer friendly output)
 *          2) DocBook XML
 *          3) OPML (Outline Processor Markup Language) outlines
 * @param nid
 *   - an integer representing the node id (nid) of the node to export
 *
666
 */
667
function book_export($type = 'html', $nid = 0) {
Dries's avatar
 
Dries committed
668
  global $base_url;
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
  $type = strtolower($type);
  $depth = _book_get_depth($nid);
  switch ($type) {
    case 'docbook':
      $xml = "<?xml version='1.0'?>\n";
      $xml .= "<!DOCTYPE book PUBLIC \"-//OASIS//DTD Docbook XML V4.1.2//EN\" \"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd\">\n";
      $xml .= book_recurse($nid, $depth, 'book_node_visitor_xml_pre', 'book_node_visitor_xml_post');
      drupal_set_header('Content-Type: text/xml; charset=utf-8');
      print $xml;
      break;
    case 'html':
      for ($i = 1; $i < $depth; $i++) {
        $output .= "<div class=\"section-$i\">\n";
      }
      $output .= book_recurse($nid, $depth, 'book_node_visitor_html_pre', 'book_node_visitor_html_post');
      for ($i = 1; $i < $depth; $i++) {
        $output .= "</div>\n";
      }
      $html = "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
      $html .= '<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">';
      $html .= "<head>\n<title>". check_plain($node->title) ."</title>\n";
      $html .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
      $html .= '<base href="'. $base_url .'/" />' . "\n";
      $html .= "<style type=\"text/css\">\n@import url(misc/print.css);\n</style>\n";
      $html .= "</head>\n<body>\n". $output . "\n</body>\n</html>\n";
      print $html;
      break;
    case 'opml':
      $output .= book_recurse($nid, $depth, 'book_node_visitor_opml_pre', 'book_node_visitor_opml_post');
      $ompl  = "<?xml version='1.0'?>\n";
      $opml .= "<opml version='1.0'>\n";
      $opml .= "<head>\n<title>". check_plain($node->title) ."</title>\n";
      $opml .= "</head>\n<body>\n". $output . "\n</body>\n</opml>\n";
      drupal_set_header('Content-Type: text/xml; charset=utf-8');
      print $opml;
      break;
  }
706
}
Dries's avatar
 
Dries committed
707

708
/**
709 710 711 712 713 714 715 716
 * Given a node, this function returns the depth of the node in its hierarchy.
 * A root node has depth 1, and children of a node of depth n have depth (n+1).
 *
 * @param node
 *   - the node whose depth to compute.
 * @return
 *   - the depth of the given node in its hierarchy.  Returns 0 if the node
 *  does not exist or is not part of a book hierarchy.
717
 */
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
function _book_get_depth($nid) {
  $depth = 0;
  if ($nid) {
    while ($nid) {
      $result = db_query(db_rewrite_sql('SELECT b.parent FROM {book} b WHERE b.nid = %d'), $nid);
      $obj =  db_fetch_object($result);
      $parent = $obj->parent;
      if ($nid == $parent->parent) {
        $nid = 0;
      }
      else {
        $nid = $parent;
      }
      $depth++;
    }
    return $depth;
  }
  else {
    return 0;
  }
Dries's avatar
 
Dries committed
738 739
}

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
/**
 * Traverses the book tree.  Applies the $visit_pre() callback to each
 * node, is called recursively for each child of the node (in weight,
 * title order).  Finally appends the output of the $visit_post()
 * callback to the output before returning the generated output.
 *
 * @param nid
 *  - the node id (nid) of the root node of the book hierarchy.
 * @param depth
 *  - the depth of the given node in the book hierarchy.
 * @param visit_pre
 *  - a function callback to be called upon visiting a node in the tree
 * @param visit_post
 *  - a function callback to be called after visiting a node in the tree,
 *    but before recursively visiting children.
 * @return
 *  - the output generated in visiting each node
 */
function book_recurse($nid = 0, $depth = 1, $visit_pre, $visit_post) {
  $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND n.nid = %d AND n.moderate = 0 ORDER BY b.weight, n.title'), $nid);
Dries's avatar
 
Dries committed
760
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
761
    // Load the node:
762
    $node = node_load(array('nid' => $page->nid));
Dries's avatar
 
Dries committed
763

Dries's avatar
 
Dries committed
764
    // Take the most recent approved revision:
Dries's avatar
 
Dries committed
765
    if ($node->moderate) {
766
      $node = book_revision_load($node, array('moderate' => 0, 'status' => 1));
Dries's avatar
 
Dries committed
767 768
    }

Dries's avatar
 
Dries committed
769
    if ($node) {
770 771
      if (function_exists($visit_pre)) {
        $output .= call_user_func($visit_pre, $node, $depth, $nid);
Dries's avatar
 
Dries committed
772
      }
773 774
      else {
        $output .= book_node_visitor_html_pre($node, $depth, $nid);
Dries's avatar
 
Dries committed
775
      }
Dries's avatar
 
Dries committed
776

777 778 779 780 781 782 783 784
      $children = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.nid = b.nid WHERE n.status = 1 AND b.parent = %d AND n.moderate = 0 ORDER BY b.weight, n.title'), $node->nid);
      while ($childpage = db_fetch_object($children)) {
          $childnode = node_load(array('nid' => $childpage->nid));
          if ($childnode->nid != $node->nid) {
              $output .= book_recurse($childnode->nid, $depth+1, $visit_pre, $visit_post);
          }
      }
      if (function_exists($visit_post)) {
785
        $output .= call_user_func($visit_post, $node, $depth);
786 787
      }
      else { # default
788
        $output .= book_node_visitor_html_post($node, $depth);
789
      }
Dries's avatar
 
Dries committed
790
    }
Dries's avatar
 
Dries committed
791
  }
Dries's avatar
 
Dries committed
792

Dries's avatar
 
Dries committed
793 794
  return $output;
}
Dries's avatar
 
Dries committed
795

796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
/**
 * Generates printer-friendly HTML for a node.  This function
 * is a 'pre-node' visitor function for book_recurse().
 *
 * @param $node
 *   - the node to generate output for.
 * @param $depth
 *   - the depth of the given node in the hierarchy. This
 *   is used only for generating output.
 * @param $nid
 *   - the node id (nid) of the given node. This
 *   is used only for generating output.
 * @return
 *   - the HTML generated for the given node.
 */
811
function book_node_visitor_html_pre($node, $depth, $nid) {
812 813 814 815 816
  // Output the content:
  if (node_hook($node, 'content')) {
    $node = node_invoke($node, 'content');
  }
  // Allow modules to change $node->body before viewing.
817
  node_invoke_nodeapi($node, 'print', $node->body, false);
818

819 820
  $output .= "<div id=\"node-". $node->nid ."\" class=\"section-$depth\">\n";
  $output .= "<h1 class=\"book-heading\">". check_plain($node->title) ."</h1>\n";
821 822 823 824 825 826 827 828 829 830 831 832

  if ($node->body) {
    $output .= $node->body;
  }
  return $output;
}

/**
 * Finishes up generation of printer-friendly HTML after visiting a
 * node. This function is a 'post-node' visitor function for
 * book_recurse().
 */
833
function book_node_visitor_html_post($node, $depth) {
834 835 836 837 838
  return "</div>\n";
}

/**
 * Generates XML for a given node. This function is a 'pre-node'
839 840 841 842 843 844 845
 * visitor function for book_recurse().  The generated XML is valid
 * DocBook, but each node's HTML content is wrapped in a CDATA
 * section, and put inside a <literallayout> element.  The node body
 * has an md5-hash applied; the value of this is stored as node
 * metadata to allow importing code to determine if contents have
 * changed.  The weight of a node is also stored as metadata to
 * allow the node to be properly re-imported.
846 847 848 849 850 851 852 853
 *
 * @param $node
 *   - the node to generate output for.
 * @param $depth
 *   - the depth of the given node in the hierarchy. This
 *   is currently not used.
 * @param $nid
 *   - the node id (nid) of the given node. This
854
 *   is used only for generating output (e.g., id attribute)
855 856 857 858 859 860 861 862 863
 * @return
 *   - the generated XML for the given node.
 */
function book_node_visitor_xml_pre($node, $depth, $nid) {
  // Output the content:
  if (node_hook($node, 'content')) {
    $node = node_invoke($node, 'content');
  }
  // Allow modules to change $node->body before viewing.
864 865 866 867 868 869 870 871 872 873
  node_invoke_nodeapi($node, 'export_xml', $node->body, false);

  $releaseinfo  = "<releaseinfo>\n";
  $releaseinfo .= "md5-hash:" . md5($node->body) . "\n";
  $releaseinfo .= "weight:". $node->weight . "\n";
  $releaseinfo .= "depth:". $depth . "\n";
  $releaseinfo .= "</releaseinfo>\n";

  $title = "<title>". check_plain($node->title) ."</title>\n";

874
  // wrap the node body in a CDATA declaration
875 876
  $content = "<literallayout>";
  $content .= "<![CDATA[";
877
  if ($node->body) {
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
    $content .= $node->body;
  }
  $content .= "]]>";
  $content .= "</literallayout>\n";

  if ($depth == 1) {
      $output .= "<book>\n";
      $output .= $title;
      $output .= "<bookinfo>\n$releaseinfo</bookinfo>\n";
      $output .= "<preface>\n";
      $output .= "<title>Preface</title>\n";
      $output .= $content;
      $output .= "</preface>\n";
  }
  else if ($depth == 2) {
      $output .= "<chapter id=\"node-".$node->nid ."\">\n";
      $output .= "<chapterinfo>\n$releaseinfo</chapterinfo>\n";
      $output .= $title;
      $output .= $content;
  }
  else {
      $output .= "<section id=\"node-".$node->nid ."\">\n";
      $output .= "<sectioninfo>\n$releaseinfo</sectioninfo>\n";
      $output .= $title;
      $output .= $content;
903
  }
904

905 906 907 908
  return $output;
}

/**
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
 * Completes the XML generation for the node. This function is a
 * 'post-node' visitor function for book_recurse().
 */
function book_node_visitor_xml_post($node, $depth) {
  if ($depth == 1) {
    return "</book>\n";
  }
  else if ($depth == 2) {
    return "</chapter>\n";
  }
  else {
    return "</section>\n";
  }
}

/**
 * Generates OPML for a node.  This function is a 'pre-node' visitor
 * function for book_recurse().
 *
 * @param $node
 *   - the node to generate output for.
 * @param $depth
 *   - the depth of the given node in the hierarchy. This is used only
 *   for generating output.
 * @param $nid
 *   - the node id (nid) of the given node. This is used only for
 *   generating output.
 * @return
 *   - the OPML generated for the given node.
 */
function book_node_visitor_opml_pre($node, $depth, $nid) {
  // Output the content:
  if (node_hook($node, 'content')) {
    $node = node_invoke($node, 'content');
  }

  $output .= "<outline type=\"id:node-". $node->nid ."\"\n";
  $text = check_plain($node->title);
  $output .= "text=\"$text\">\n";
  return $output;
}

/**
 * Finishes up generation of OPML after visiting a node. This function
 * is a 'post-node' visitor function for book_recurse().
954
 */
955 956
function book_node_visitor_opml_post($node, $depth) {
  return "</outline>\n";
957 958 959 960 961
}

/**
 * Creates a row for the 'admin' view of a book.  Each row represents a page in the book, in the tree representing the book
 */
962
function book_admin_edit_line($node, $depth = 0) {
963
  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, 15), l(t('view'), 'node/'. $node->nid), l(t('edit'), 'node/'. $node->nid .'/edit'), l(t('delete'), 'node/'.$node->nid.'/delete'));
Dries's avatar
 
Dries committed
964 965
}

966
function book_admin_edit_book($nid, $depth = 1) {