book.module 34.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
 * Implementation of hook_node_info().
11
 */
12
function book_node_info() {
13 14
  return array(
    'book' => array(
15
      'name' => t('Book page'),
16 17 18 19
      'module' => 'book',
      'description' => t("A book is a collaborative writing effort: users can collaborate writing the pages of the book, positioning the pages in the right order, and reviewing or modifying pages previously written. So when you have some information to share or when you read a page of the book and you didn't like it, or if you think a certain page could have been written better, you can do something about it."),
    )
  );
Dries's avatar
 
Dries committed
20 21
}

22 23 24
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
25
function book_perm() {
26
    return array('outline posts in books', 'create book pages', 'create new books', 'edit book pages', 'edit own book pages', 'see printer-friendly version');
Dries's avatar
 
Dries committed
27 28
}

29 30 31
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
32
function book_access($op, $node) {
Dries's avatar
 
Dries committed
33
  global $user;
Dries's avatar
 
Dries committed
34

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

41
  if ($op == 'update') {
42
    // Only registered users can update book pages. Given the nature
Dries's avatar
 
Dries committed
43 44
    // 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
45
    // of that page waiting for approval. That is, only updates that
46
    // don't overwrite the current or pending information are allowed.
47

48
    if (user_access('edit book pages') || ($node->uid == $user->uid && user_access('edit own book pages'))) {
49 50 51 52 53
      return TRUE;
    }
    else {
       // do nothing. node-access() will determine further access
    }
Dries's avatar
 
Dries committed
54
  }
Dries's avatar
 
Dries committed
55 56
}

Dries's avatar
 
Dries committed
57 58 59
/**
 * Implementation of hook_link().
 */
60
function book_link($type, $node = NULL, $teaser = FALSE) {
Dries's avatar
 
Dries committed
61 62 63

  $links = array();

64
  if ($type == 'node' && isset($node->parent)) {
65
    if (!$teaser) {
66
      if (book_access('create', $node) && $node->status == 1) {
67
        $links['book_add_child'] = array(
68
          'title' => t('Add child page'),
69
          'href' => "node/add/book/parent/$node->nid"
70
        );
Dries's avatar
 
Dries committed
71
      }
72
      if (user_access('see printer-friendly version')) {
73
        $links['book_printer'] = array(
74
          'title' => t('Printer-friendly version'),
75 76
          'href' => 'book/export/html/'. $node->nid,
          'attributes' => array('title' => t('Show a printer-friendly version of this book page and its sub-pages.'))
77
        );
78
      }
Dries's avatar
 
Dries committed
79
    }
Dries's avatar
 
Dries committed
80 81
  }

Dries's avatar
 
Dries committed
82
  return $links;
Dries's avatar
 
Dries committed
83 84
}

Dries's avatar
 
Dries committed
85 86 87
/**
 * Implementation of hook_menu().
 */
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
function book_menu() {
  $items['admin/content/book'] = array(
    'title' => t('Books'),
    'description' => t("Manage site's books and orphaned book pages."),
    'page callback' => 'book_admin',
    'access arguments' => array('administer nodes'),
  );
  $items['admin/content/book/list'] = array(
    'title' => t('List'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items['admin/content/book/orphan'] = array(
    'title' => t('Orphan pages'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('book_admin_orphan'),
    'type' => MENU_LOCAL_TASK,
    'weight' => 8,
  );
  $items['book'] = array(
    'title' => t('Books'),
    'page callback' => 'book_render',
    'access arguments' => array('access content'),
    'type' => MENU_SUGGESTED_ITEM,
  );
  $items['book/export/%/%'] = array(
    'page callback' => 'book_export',
    'page arguments' => array(2, 3),
    'type' => MENU_CALLBACK,
  );
  $items['node/%/outline'] = array(
    'title' => t('Outline'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('book_outline', 1),
    'access callback' => '_book_outline_access',
    'access arguments' => array(1),
    'map arguments' => array('node_load', 1),
    'type' => MENU_LOCAL_TASK,
    'weight' => 2,
  );
Dries's avatar
 
Dries committed
127 128 129 130

  return $items;
}

131 132 133 134 135 136 137 138 139
function _book_outline_access($node) {
  // Only add the outline-tab for non-book pages:
  return user_access('outline posts in books') && $node && ($node->type != 'book');
}

function book_init() {
  drupal_add_css(drupal_get_path('module', 'book') .'/book.css');
}

140 141 142
/**
 * Implementation of hook_block().
 *
Dries's avatar
 
Dries committed
143 144
 * Displays the book table of contents in a block when the current page is a
 * single-node view of a book node.
145
 */
Dries's avatar
 
Dries committed
146
function book_block($op = 'list', $delta = 0) {
Dries's avatar
 
Dries committed
147
  $block = array();
Dries's avatar
 
Dries committed
148 149
  if ($op == 'list') {
    $block[0]['info'] = t('Book navigation');
150
    return $block;
Dries's avatar
 
Dries committed
151
  }
152
  else if ($op == 'view') {
Dries's avatar
 
Dries committed
153 154
    // Only display this block when the user is browsing a book:
    if (arg(0) == 'node' && is_numeric(arg(1))) {
155
      $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE n.nid = %d'), arg(1));
Dries's avatar
 
Dries committed
156 157 158 159 160 161 162 163 164 165 166
      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;
        }

167
        $block['subject'] = check_plain($path[0]->title);
Dries's avatar
 
Dries committed
168 169 170
        $block['content'] = book_tree($expand[0], 5, $expand);
      }
    }
Dries's avatar
 
Dries committed
171

172 173
    return $block;
  }
Dries's avatar
 
Dries committed
174 175
}

176 177 178 179 180
/**
 * Implementation of hook_insert().
 */
function book_insert($node) {
  db_query("INSERT INTO {book} (nid, vid, parent, weight) VALUES (%d, %d, %d, %d)", $node->nid, $node->vid, $node->parent, $node->weight);
Dries's avatar
 
Dries committed
181
}
Dries's avatar
 
Dries committed
182

183
/**
184
 * Implementation of hook_submit().
185
 */
186
function book_submit(&$node) {
187
  global $user;
188 189 190
  // Set default values for non-administrators.
  if (!user_access('administer nodes')) {
    $node->revision = 1;
191
    $node->uid = $user->uid;
192 193
  }
}
194

195 196 197 198
/**
 * Implementation of hook_form().
 */
function book_form(&$node) {
199
  $type = node_get_types('type', $node);
200
  if ($node->nid && !$node->parent && !user_access('create new books')) {
201
    $form['parent'] = array('#type' => 'value', '#value' => $node->parent);
202 203 204 205 206 207 208
  }
  else {
    $form['parent'] = array('#type' => 'select',
      '#title' => t('Parent'),
      '#default_value' => ($node->parent ? $node->parent : arg(4)),
      '#options' => book_toc($node->nid),
      '#weight' => -4,
209
      '#description' => user_access('create new books') ? t('The parent section in which to place this page. Note that each page whose parent is &lt;top-level&gt; is an independent, top-level book.') : t('The parent that this page belongs in.'),
210 211
    );
  }
212 213

  $form['title'] = array('#type' => 'textfield',
214
    '#title' => check_plain($type->title_label),
215 216 217 218 219
    '#required' => TRUE,
    '#default_value' => $node->title,
    '#weight' => -5,
  );
  $form['body_filter']['body'] = array('#type' => 'textarea',
220
    '#title' => check_plain($type->body_label),
221 222 223 224
    '#default_value' => $node->body,
    '#rows' => 20,
    '#required' => TRUE,
  );
225
  $form['body_filter']['format'] = filter_form($node->format);
226

227 228 229 230 231 232 233 234 235 236
  if (user_access('administer nodes')) {
    $form['weight'] = array('#type' => 'weight',
      '#title' => t('Weight'),
      '#default_value' => $node->weight,
      '#delta' => 15,
      '#weight' => 5,
      '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
    );
  }
  else {
237 238 239 240 241 242
    // If a regular user updates a book page, we preserve the node weight; otherwise
    // we use 0 as the default for new pages
    $form['weight'] = array(
      '#type' => 'value',
      '#value' => isset($node->weight) ? $node->weight : 0,
    );
Dries's avatar
 
Dries committed
243 244
  }

245
  return $form;
Dries's avatar
 
Dries committed
246 247
}

248
/**
Dries's avatar
 
Dries committed
249 250
 * Implementation of function book_outline()
 * Handles all book outline operations.
251
 */
252
function book_outline($node) {
253 254
  $form['parent'] = array('#type' => 'select',
    '#title' => t('Parent'),
255
    '#default_value' => $node->parent,
256
    '#options' => book_toc($node->nid),
257 258 259 260
    '#description' => t('The parent page in the book.'),
  );
  $form['weight'] = array('#type' => 'weight',
    '#title' => t('Weight'),
261
    '#default_value' => $node->weight,
262 263 264 265 266 267 268
    '#delta' => 15,
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );
  $form['log'] = array('#type' => 'textarea',
    '#title' => t('Log message'),
    '#description' => t('An explanation to help other authors understand your motivations to put this post into the book.'),
  );
Dries's avatar
 
Dries committed
269

270
  $form['nid'] = array('#type' => 'value', '#value' => $nid);
271
  if ($node->parent) {
272 273 274 275 276 277 278 279 280 281
    $form['update'] = array('#type' => 'submit',
      '#value' => t('Update book outline'),
    );
    $form['remove'] = array('#type' => 'submit',
      '#value' => t('Remove from book outline'),
    );
  }
  else {
    $form['add'] = array('#type' => 'submit', '#value' => t('Add to book outline'));
  }
Dries's avatar
 
Dries committed
282

283
  drupal_set_title(check_plain($node->title));
284
  return $form;
285 286 287 288 289 290
}

/**
 * Handles book outline form submissions.
 */
function book_outline_submit($form_id, $form_values) {
291
  $op = $form_values['op'];
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
  $node = node_load($form_values['nid']);

  switch ($op) {
    case t('Add to book outline'):
      db_query('INSERT INTO {book} (nid, vid, parent, weight) VALUES (%d, %d, %d, %d)', $node->nid, $node->vid, $form_values['parent'], $form_values['weight']);
      db_query("UPDATE {node_revisions} SET log = '%s' WHERE vid = %d", $form_values['log'], $node->vid);
      drupal_set_message(t('The post has been added to the book.'));
      break;
    case t('Update book outline'):
      db_query('UPDATE {book} SET parent = %d, weight = %d WHERE vid = %d', $form_values['parent'], $form_values['weight'], $node->vid);
      db_query("UPDATE {node_revisions} SET log = '%s' WHERE vid = %d", $form_values['log'], $node->vid);
      drupal_set_message(t('The book outline has been updated.'));
      break;
    case t('Remove from book outline'):
      db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
      drupal_set_message(t('The post has been removed from the book.'));
      break;
Dries's avatar
 
Dries committed
309
  }
310
  return "node/$node->nid";
Dries's avatar
 
Dries committed
311 312
}

313
/**
Dries's avatar
Dries committed
314 315
 * Given a node, this function returns an array of 'book node' objects
 * representing the path in the book tree from the root to the
316
 * parent of the given node.
Dries's avatar
Dries committed
317
 *
318 319
 * @param $node
 *   A book node object for which to compute the path.
320
 *
321 322 323 324
 * @return
 *   An array of book node objects representing the path nodes root to
 *   parent of the given node. Returns an empty array if the node does
 *   not exist or is not part of a book hierarchy.
325
 */
Dries's avatar
 
Dries committed
326
function book_location($node, $nodes = array()) {
327
  $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.vid = b.vid WHERE n.nid = %d'), $node->parent));
328
  if (isset($parent->title)) {
Dries's avatar
 
Dries committed
329
    $nodes = book_location($parent, $nodes);
330
    $nodes[] = $parent;
Dries's avatar
 
Dries committed
331 332 333 334
  }
  return $nodes;
}

335
/**
336 337 338 339 340 341 342 343 344 345 346
 * Given a node, this function returns an array of 'book node' objects
 * representing the path in the book tree from the given node down to
 * the last sibling of it.
 *
 * @param $node
 *   A book node object where the path starts.
 *
 * @return
 *   An array of book node objects representing the path nodes from the
 *   given node. Returns an empty array if the node does not exist or
 *   is not part of a book hierarchy or there are no siblings.
347
 */
Dries's avatar
 
Dries committed
348
function book_location_down($node, $nodes = array()) {
349
  $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.vid = b.vid WHERE n.status = 1 AND b.parent = %d ORDER BY b.weight DESC, n.title DESC'), $node->nid));
Dries's avatar
 
Dries committed
350
  if ($last_direct_child) {
351
    $nodes[] = $last_direct_child;
Dries's avatar
 
Dries committed
352 353 354 355 356
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

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

Dries's avatar
 
Dries committed
366
  // Previous on the same level:
367
  $direct_above = db_fetch_object(db_query(db_rewrite_sql("SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE b.parent = %d AND n.status = 1 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
368
  if ($direct_above) {
Dries's avatar
 
Dries committed
369
    // Get last leaf of $above.
Dries's avatar
 
Dries committed
370
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
371 372

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
373 374
  }
  else {
Dries's avatar
 
Dries committed
375
    // Direct parent:
376
    $prev = db_fetch_object(db_query(db_rewrite_sql('SELECT n.nid, n.title FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE n.nid = %d AND n.status = 1'), $node->parent));
Dries's avatar
 
Dries committed
377 378 379 380
    return $prev;
  }
}

381
/**
382
 * Fetches the node object of the next page of the book.
383
 */
Dries's avatar
 
Dries committed
384 385
function book_next($node) {
  // get first direct child
386
  $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.vid = b.vid WHERE b.parent = %d AND n.status = 1 ORDER BY b.weight ASC, n.title ASC'), $node->nid));
Dries's avatar
 
Dries committed
387 388 389 390
  if ($child) {
    return $child;
  }

Dries's avatar
 
Dries committed
391
  // No direct child: get next for this level or any parent in this book.
392
  $path = book_location($node); // Path to top-level node including this one.
393
  $path[] = $node;
394

Dries's avatar
 
Dries committed
395
  while (($leaf = array_pop($path)) && count($path)) {
396
    $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.vid = b.vid WHERE b.parent = %d AND n.status = 1 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
397 398 399 400 401 402
    if ($next) {
      return $next;
    }
  }
}

403
/**
404
 * Returns the content of a given node. If $teaser if TRUE, returns
405
 * the teaser rather than full content. Displays the most recently
406 407 408
 * 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
409
function book_content($node, $teaser = FALSE) {
410 411
  // Return the page body.
  return node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
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
function book_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
421 422 423
    case 'load':
      return db_fetch_array(db_query('SELECT parent, weight FROM {book} WHERE vid = %d', $node->vid));
      break;
Dries's avatar
 
Dries committed
424 425
    case 'view':
      if (!$teaser) {
426
        if (isset($node->parent)) {
427 428 429 430 431 432 433 434
          $path = book_location($node);
          // Construct the breadcrumb:
          $node->breadcrumb = array(); // Overwrite the trail with a book trail.
          foreach ($path as $level) {
            $node->breadcrumb[] = array('path' => 'node/'. $level->nid, 'title' =>  $level->title);
          }
          $node->breadcrumb[] = array('path' => 'node/'. $node->nid);

435 436 437 438
          $node->content['book_navigation'] = array(
            '#value' => theme('book_navigation', $node),
            '#weight' => 100,
          );
439

440 441 442
          if ($page) {
            menu_set_location($node->breadcrumb);
          }
Dries's avatar
 
Dries committed
443
        }
Dries's avatar
 
Dries committed
444
      }
Dries's avatar
 
Dries committed
445
      break;
446 447
    case 'update':
      if (isset($node->parent)) {
448
        if (!empty($node->revision)) {
449 450 451 452 453 454 455
          db_query("INSERT INTO {book} (nid, vid, parent, weight) VALUES (%d, %d, %d, %d)", $node->nid, $node->vid, $node->parent, $node->weight);
        }
        else {
          db_query("UPDATE {book} SET parent = %d, weight = %d WHERE vid = %d", $node->parent, $node->weight, $node->vid);
        }
      }
      break;
456
    case 'delete revision':
457 458
      db_query('DELETE FROM {book} WHERE vid = %d', $node->vid);
      break;
459 460 461
    case 'delete':
      db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
      break;
Dries's avatar
 
Dries committed
462
  }
Dries's avatar
 
Dries committed
463
}
Dries's avatar
 
Dries committed
464

465
/**
466
 * Prepares the links to children (TOC) and forward/backward
467
 * navigation for a node presented as a book page.
468 469
 *
 * @ingroup themeable
470
 */
471
function theme_book_navigation($node) {
472
  $output = '';
473
  $links = '';
474

Dries's avatar
 
Dries committed
475
  if ($node->nid) {
476
    $tree = book_tree($node->nid);
Dries's avatar
 
Dries committed
477

Dries's avatar
 
Dries committed
478
    if ($prev = book_prev($node)) {
479
      drupal_add_link(array('rel' => 'prev', 'href' => url('node/'. $prev->nid)));
480
      $links .= l(t('‹ ') . $prev->title, 'node/'. $prev->nid, array('class' => 'page-previous', 'title' => t('Go to previous page')));
Dries's avatar
 
Dries committed
481
    }
482
    if ($node->parent) {
483
      drupal_add_link(array('rel' => 'up', 'href' => url('node/'. $node->parent)));
484
      $links .= l(t('up'), 'node/'. $node->parent, array('class' => 'page-up', 'title' => t('Go to parent page')));
Dries's avatar
 
Dries committed
485 486
    }
    if ($next = book_next($node)) {
487
      drupal_add_link(array('rel' => 'next', 'href' => url('node/'. $next->nid)));
488
      $links .= l($next->title . t(' ›'), 'node/'. $next->nid, array('class' => 'page-next', 'title' => t('Go to next page')));
Dries's avatar
 
Dries committed
489
    }
Dries's avatar
 
Dries committed
490

491 492 493 494 495 496
    if (isset($tree) || isset($links)) {
      $output = '<div class="book-navigation">';
      if (isset($tree)) {
        $output .= $tree;
      }
      if (isset($links)) {
497
        $output .= '<div class="page-links clear-block">'. $links .'</div>';
498 499 500
      }
      $output .= '</div>';
    }
Dries's avatar
 
Dries committed
501
  }
Dries's avatar
 
Dries committed
502

503
  return $output;
Dries's avatar
 
Dries committed
504
}
Dries's avatar
 
Dries committed
505

506 507 508
/**
 * This is a helper function for book_toc().
 */
509
function book_toc_recurse($nid, $indent, $toc, $children, $exclude) {
510
  if (!empty($children[$nid])) {
Dries's avatar
 
Dries committed
511
    foreach ($children[$nid] as $foo => $node) {
512 513 514 515
      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
516 517 518 519 520 521
    }
  }

  return $toc;
}

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

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

536
  $toc = array();
537
  // If the user has permission to create new books, add the top-level book page to the menu;
538
  if (user_access('create new books')) {
539
    $toc[0] = '<'. t('top-level') .'>';
Dries's avatar
 
Dries committed
540 541
  }

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

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

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

  return $output;
}

581 582 583 584
/**
 * Returns an HTML nested list (wrapped in a menu-class div) representing the book nodes
 * as a tree.
 */
Dries's avatar
 
Dries committed
585
function book_tree($parent = 0, $depth = 3, $unfold = array()) {
586
  $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE n.status = 1 ORDER BY b.weight, n.title'));
Dries's avatar
 
Dries committed
587

Dries's avatar
 
Dries committed
588
  while ($node = db_fetch_object($result)) {
589
    $list = isset($children[$node->parent]) ? $children[$node->parent] : array();
590
    $list[] = $node;
Dries's avatar
 
Dries committed
591
    $children[$node->parent] = $list;
Dries's avatar
 
Dries committed
592
  }
Dries's avatar
 
Dries committed
593

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

599
/**
Dries's avatar
Dries committed
600
 * Menu callback; prints a listing of all books.
601
 */
Dries's avatar
 
Dries committed
602
function book_render() {
603
  $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE b.parent = 0 AND n.status = 1 ORDER BY b.weight, n.title'));
Dries's avatar
 
Dries committed
604

605 606 607 608 609 610
  $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
611 612
}

613
/**
614 615 616
 * Menu callback; Generates various representation of a book page with
 * all descendants and prints the requested representation to output.
 *
617 618
 * The function delegates the generation of output to helper functions.
 * The function name is derived by prepending 'book_export_' to the
619
 * given output type. So, e.g., a type of 'html' results in a call to
620
 * the function book_export_html().
621 622 623
 *
 * @param type
 *   - a string encoding the type of output requested.
624 625 626
 *       The following types are currently supported in book module
 *          html: HTML (printer friendly output)
 *       Other types are supported in contributed modules.
627 628 629
 * @param nid
 *   - an integer representing the node id (nid) of the node to export
 *
630
 */
631
function book_export($type, $nid) {
632
  $type = drupal_strtolower($type);
633 634 635 636 637
  $node_result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.parent FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE n.nid = %d'), $nid);
  if (db_num_rows($node_result) > 0) {
      $node = db_fetch_object($node_result);
  }
  $depth = count(book_location($node)) + 1;
638
  $export_function = 'book_export_'. $type;
639 640 641

  if (function_exists($export_function)) {
    print call_user_func($export_function, $nid, $depth);
642 643
  }
  else {
644
    drupal_set_message(t('Unknown export format.'));
645
    drupal_not_found();
646
  }
647
}
Dries's avatar
 
Dries committed
648

649 650 651 652
/**
 * This function is called by book_export() to generate HTML for export.
 *
 * The given node is /embedded to its absolute depth in a top level
653
 * section/. For example, a child node with depth 2 in the hierarchy
654
 * is contained in (otherwise empty) &lt;div&gt; elements
655
 * corresponding to depth 0 and depth 1. This is intended to support
656 657 658 659 660 661 662
 * 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.
 *
 * @param nid
 *   - an integer representing the node id (nid) of the node to export
 * @param depth
663 664 665
 *   - an integer giving the depth in the book hierarchy of the node
 *     which is to be exported
 *
666
 * @return
667 668
 *   - string containing HTML representing the node and its children in
 *     the book hierarchy
669 670 671
*/
function book_export_html($nid, $depth) {
  if (user_access('see printer-friendly version')) {
672
    $node = node_load($nid);
673
    for ($i = 1; $i < $depth; $i++) {
674
      $content .= "<div class=\"section-$i\">\n";
675
    }
676
    $content .= book_recurse($nid, $depth, 'book_node_visitor_html_pre', 'book_node_visitor_html_post');
677
    for ($i = 1; $i < $depth; $i++) {
678
      $content .= "</div>\n";
679
    }
680
    return theme('book_export_html', check_plain($node->title), $content);
681 682 683 684 685 686
  }
  else {
    drupal_access_denied();
  }
}

687 688 689 690 691 692 693 694 695 696 697 698 699
/**
 * How the book's HTML export should be themed
 *
 * @ingroup themeable
 */
function theme_book_export_html($title, $content) {
  global $base_url;
  $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>". $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";
700
  $html .= "</head>\n<body>\n". $content ."\n</body>\n</html>\n";
701 702 703
  return $html;
}

704
/**
705
 * Traverses the book tree. Applies the $visit_pre() callback to each
706
 * node, is called recursively for each child of the node (in weight,
707
 * title order). Finally appends the output of the $visit_post()
708 709
 * callback to the output before returning the generated output.
 *
710 711
 * @todo This is duplicitous with node_build_content().
 *
712 713 714 715 716 717 718 719 720 721 722 723 724
 * @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) {
725
  $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE n.status = 1 AND n.nid = %d ORDER BY b.weight, n.title'), $nid);
Dries's avatar
 
Dries committed
726
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
727
    // Load the node:
728
    $node = node_load($page->nid);
Dries's avatar
 
Dries committed
729

Dries's avatar
 
Dries committed
730
    if ($node) {
731 732
      if (function_exists($visit_pre)) {
        $output .= call_user_func($visit_pre, $node, $depth, $nid);
Dries's avatar
 
Dries committed
733
      }
734 735
      else {
        $output .= book_node_visitor_html_pre($node, $depth, $nid);
Dries's avatar
 
Dries committed
736
      }
Dries's avatar
 
Dries committed
737

738
      $children = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE n.status = 1 AND b.parent = %d ORDER BY b.weight, n.title'), $node->nid);
739
      while ($childpage = db_fetch_object($children)) {
740
          $childnode = node_load($childpage->nid);
741
          if ($childnode->nid != $node->nid) {
742
              $output .= book_recurse($childnode->nid, $depth + 1, $visit_pre, $visit_post);
743 744 745
          }
      }
      if (function_exists($visit_post)) {
746
        $output .= call_user_func($visit_post, $node, $depth);
747
      }
748 749
      else {
        # default
750
        $output .= book_node_visitor_html_post($node, $depth);
751
      }
Dries's avatar
 
Dries committed
752
    }
Dries's avatar
 
Dries committed
753
  }
Dries's avatar
 
Dries committed
754

Dries's avatar
 
Dries committed
755 756
  return $output;
}
Dries's avatar
 
Dries committed
757

758
/**
759
 * Generates printer-friendly HTML for a node. This function
760 761 762 763 764 765 766 767 768 769 770 771 772
 * 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.
 */
773
function book_node_visitor_html_pre($node, $depth, $nid) {
774
  // Remove the delimiter (if any) that separates the teaser from the body.
775
  $node->body = str_replace('<!--break-->', '', $node->body);
776 777 778 779 780 781 782 783

  // The 'view' hook can be implemented to overwrite the default function
  // to display nodes.
  if (node_hook($node, 'view')) {
    $node = node_invoke($node, 'view', FALSE, FALSE);
  }
  else {
    $node = node_prepare($node, FALSE);
784
  }
785 786 787

  // Allow modules to make their own additions to the node.
  node_invoke_nodeapi($node, 'print');
788

789 790
  $output .= "<div id=\"node-". $node->nid ."\" class=\"section-$depth\">\n";
  $output .= "<h1 class=\"book-heading\">". check_plain($node->title) ."</h1>\n";
791
  $output .= drupal_render($node->content);
792 793 794 795 796 797 798 799 800

  return $output;
}

/**
 * Finishes up generation of printer-friendly HTML after visiting a
 * node. This function is a 'post-node' visitor function for
 * book_recurse().
 */
801
function book_node_visitor_html_post($node, $depth) {
802 803 804
  return "</div>\n";
}

805 806 807 808 809 810 811 812 813 814 815
function _book_admin_table($nodes = array()) {
  $form = array(
    '#theme' => 'book_admin_table',
    '#tree' => TRUE,
  );

  foreach ($nodes as $node) {
    $form = array_merge($form, _book_admin_table_tree($node, 0));
  }

  return $form;
816 817
}

818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
function _book_admin_table_tree($node, $depth) {
  $form = array();

  $form[] = array(
    'nid' => array('#type' => 'value', '#value' => $node->nid),
    'depth' => array('#type' => 'value', '#value' => $depth),
    'title' => array(
      '#type' => 'textfield',
      '#default_value' => $node->title,
      '#maxlength' => 255,
    ),
    'weight' => array(
      '#type' => 'weight',
      '#default_value' => $node->weight,
      '#delta' => 15,
    ),
834
  );
835

836
  $children = db_query(db_rewrite_sql('SELECT n.nid, n.title, b.weight FROM {node} n INNER JOIN {book} b ON n.vid = b.vid WHERE b.parent = %d ORDER BY b.weight, n.title'), $node->nid);
837 838 839 840 841
  while ($child = db_fetch_object($children)) {
    $form = array_merge($form, _book_admin_table_tree(node_load($child->nid), $depth + 1));
  }

  return $form;
Dries's avatar
 
Dries committed
842 843
}

844 845
function theme_book_admin_table($form) {
  $header = array(t('Title'), t('Weight'), array('data' => t('Operations'), 'colspan' => '3'));
Dries's avatar
 
Dries committed
846

847
  $rows = array();
848 849
  foreach (element_children($form) as $key) {
    $nid = $form[$key]['nid']['#value'];
850
    $pid = $form[0]['nid']['#value'];
851
    $rows[] = array(
852 853
      '<div style="padding-left: '. (25 * $form[$key]['depth']['#value']) .'px;">'. drupal_render($form[$key]['title']) .'</div>',
      drupal_render($form[$key]['weight']),
854 855
      l(t('view'), 'node/'. $nid),
      l(t('edit'), 'node/'. $nid .'/edit'),
856
      l(t('delete'), 'node/'. $nid .'/delete', NULL, 'destination=admin/content/book'. (arg(3) == 'orphan' ? '/orphan' : '') . ($pid != $nid ? '/'.$pid : ''))
857
    );
Dries's avatar
 
Dries committed
858 859
  }

860
  return theme('table', $header, $rows);
Dries's avatar
 
Dries committed
861 862
}

863 864 865
/**
 * Display an administrative view of the hierarchy of a book.
 */
866
function book_admin_edit($nid) {
867
  $node = node_load($nid);
868
  if ($node->nid) {
869
    drupal_set_title(check_plain($node->title));
870
    $form = array();
871

872 873 874 875 876
    $form['table'] = _book_admin_table(array($node));
    $form['save'] = array(
      '#type' => 'submit',
      '#value' => t('Save book pages'),
    );
Dries's avatar
 
Dries committed
877

878
    return $form;
Dries's avatar
 
Dries committed
879
  }
880 881 882
  else {
    drupal_not_found();
  }
Dries's avatar
 
Dries committed
883 884
}

885
/**
886
 * Menu callback; displays a listing of all orphaned book pages.
887
 */