book.module 34.7 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
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,
  );
117
  $items['node/%node/outline'] = array(
118 119 120 121 122 123 124 125
    'title' => t('Outline'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('book_outline', 1),
    'access callback' => '_book_outline_access',
    'access arguments' => array(1),
    'type' => MENU_LOCAL_TASK,
    'weight' => 2,
  );
Dries's avatar
 
Dries committed
126 127 128 129

  return $items;
}

130 131 132 133 134 135 136 137 138
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');
}

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

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

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

175 176 177 178 179
/**
 * 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
180
}
Dries's avatar
 
Dries committed
181

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

194 195 196 197
/**
 * Implementation of hook_form().
 */
function book_form(&$node) {
198
  $type = node_get_types('type', $node);
199
  if (!empty($node->nid) && !$node->parent && !user_access('create new books')) {
200
    $form['parent'] = array('#type' => 'value', '#value' => $node->parent);
201 202 203 204
  }
  else {
    $form['parent'] = array('#type' => 'select',
      '#title' => t('Parent'),
205 206
      '#default_value' => (isset($node->parent) ? $node->parent : arg(4)),
      '#options' => book_toc(isset($node->nid) ? $node->nid : 0),
207
      '#weight' => -4,
208
      '#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.'),
209 210
    );
  }
211 212

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

226 227 228
  if (user_access('administer nodes')) {
    $form['weight'] = array('#type' => 'weight',
      '#title' => t('Weight'),
229
      '#default_value' => isset($node->weight) ? $node->weight : 0,
230 231 232 233 234 235
      '#delta' => 15,
      '#weight' => 5,
      '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
    );
  }
  else {
236 237 238 239 240 241
    // 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
242 243
  }

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

247
/**
Dries's avatar
 
Dries committed
248 249
 * Implementation of function book_outline()
 * Handles all book outline operations.
250
 */
251
function book_outline($node) {
252 253
  $form['parent'] = array('#type' => 'select',
    '#title' => t('Parent'),
254
    '#default_value' => isset($node->parent) ? $node->parent : 0,
255
    '#options' => book_toc($node->nid),
256 257 258 259
    '#description' => t('The parent page in the book.'),
  );
  $form['weight'] = array('#type' => 'weight',
    '#title' => t('Weight'),
260
    '#default_value' => isset($node->weight) ? $node->weight : 0,
261 262 263 264 265 266 267
    '#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
268

269
  $form['nid'] = array('#type' => 'value', '#value' => isset($node->nid) ? $node->nid : 0);
270
  if (isset($node->parent)) {
271 272 273 274 275 276 277 278 279 280
    $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
281

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

/**
 * Handles book outline form submissions.
 */
function book_outline_submit($form_id, $form_values) {
290
  $op = $form_values['op'];
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
  $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
308
  }
309
  return "node/$node->nid";
Dries's avatar
 
Dries committed
310 311
}

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

334
/**
335 336 337 338 339 340 341 342 343 344 345
 * 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.
346
 */
Dries's avatar
 
Dries committed
347
function book_location_down($node, $nodes = array()) {
348
  $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
349
  if ($last_direct_child) {
350
    $nodes[] = $last_direct_child;
Dries's avatar
 
Dries committed
351 352 353 354 355
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

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

Dries's avatar
 
Dries committed
365
  // Previous on the same level:
366
  $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
367
  if ($direct_above) {
Dries's avatar
 
Dries committed
368
    // Get last leaf of $above.
Dries's avatar
 
Dries committed
369
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
370 371

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
372 373
  }
  else {
Dries's avatar
 
Dries committed
374
    // Direct parent:
375
    $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
376 377 378 379
    return $prev;
  }
}

380
/**
381
 * Fetches the node object of the next page of the book.
382
 */
Dries's avatar
 
Dries committed
383 384
function book_next($node) {
  // get first direct child
385
  $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
386 387 388 389
  if ($child) {
    return $child;
  }

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

Dries's avatar
 
Dries committed
394
  while (($leaf = array_pop($path)) && count($path)) {
395
    $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
396 397 398 399 400 401
    if ($next) {
      return $next;
    }
  }
}

402
/**
403
 * Returns the content of a given node. If $teaser if TRUE, returns
404
 * the teaser rather than full content. Displays the most recently
405 406 407
 * 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
408
function book_content($node, $teaser = FALSE) {
409 410
  // Return the page body.
  return node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
411 412
}

413
/**
Dries's avatar
 
Dries committed
414 415 416
 * Implementation of hook_nodeapi().
 *
 * Appends book navigation to all nodes in the book.
417
 */
Dries's avatar
 
Dries committed
418 419
function book_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
420 421 422
    case 'load':
      return db_fetch_array(db_query('SELECT parent, weight FROM {book} WHERE vid = %d', $node->vid));
      break;
Dries's avatar
 
Dries committed
423 424
    case 'view':
      if (!$teaser) {
425
        if (isset($node->parent)) {
426 427 428 429 430 431 432 433
          $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);

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

439 440 441
          if ($page) {
            menu_set_location($node->breadcrumb);
          }
Dries's avatar
 
Dries committed
442
        }
Dries's avatar
 
Dries committed
443
      }
Dries's avatar
 
Dries committed
444
      break;
445 446
    case 'update':
      if (isset($node->parent)) {
447
        if (!empty($node->revision)) {
448 449 450 451 452 453 454
          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;
455
    case 'delete revision':
456 457
      db_query('DELETE FROM {book} WHERE vid = %d', $node->vid);
      break;
458 459 460
    case 'delete':
      db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
      break;
Dries's avatar
 
Dries committed
461
  }
Dries's avatar
 
Dries committed
462
}
Dries's avatar
 
Dries committed
463

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

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

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

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

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

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

  return $toc;
}

521 522 523
/**
 * Returns an array of titles and nid entries of book pages in table of contents order.
 */
524
function book_toc($exclude = 0) {
525
  $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
526

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

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

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

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

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

  return $output;
}

580 581 582 583
/**
 * Returns an HTML nested list (wrapped in a menu-class div) representing the book nodes
 * as a tree.
 */
Dries's avatar
 
Dries committed
584
function book_tree($parent = 0, $depth = 3, $unfold = array()) {
585
  $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
586

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

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

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

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

612
/**
613 614 615
 * Menu callback; Generates various representation of a book page with
 * all descendants and prints the requested representation to output.
 *
616 617
 * The function delegates the generation of output to helper functions.
 * The function name is derived by prepending 'book_export_' to the
618
 * given output type. So, e.g., a type of 'html' results in a call to
619
 * the function book_export_html().
620 621 622
 *
 * @param type
 *   - a string encoding the type of output requested.
623 624 625
 *       The following types are currently supported in book module
 *          html: HTML (printer friendly output)
 *       Other types are supported in contributed modules.
626 627 628
 * @param nid
 *   - an integer representing the node id (nid) of the node to export
 *
629
 */
630
function book_export($type, $nid) {
631
  $type = drupal_strtolower($type);
632 633 634 635 636
  $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;
637
  $export_function = 'book_export_'. $type;
638 639 640

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

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

686 687 688 689 690 691 692 693 694 695 696 697 698
/**
 * 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";
699
  $html .= "</head>\n<body>\n". $content ."\n</body>\n</html>\n";
700 701 702
  return $html;
}

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

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

737
      $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);
738
      while ($childpage = db_fetch_object($children)) {
739
          $childnode = node_load($childpage->nid);
740
          if ($childnode->nid != $node->nid) {
741
              $output .= book_recurse($childnode->nid, $depth + 1, $visit_pre, $visit_post);
742 743 744
          }
      }
      if (function_exists($visit_post)) {
745
        $output .= call_user_func($visit_post, $node, $depth);
746
      }
747 748
      else {
        # default
749
        $output .= book_node_visitor_html_post($node, $depth);
750
      }
Dries's avatar
 
Dries committed
751
    }
Dries's avatar
 
Dries committed
752
  }
Dries's avatar
 
Dries committed
753

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

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

  // 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);
783
  }
784 785 786

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

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

  return $output;
}

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

804 805 806 807 808 809 810 811 812 813 814
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;
815 816
}

817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
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,
    ),
833
  );
834

835
  $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);
836 837 838 839 840
  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
841 842
}

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

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

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

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

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

877
    return $form;
Dries's avatar
 
Dries committed
878