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

Dries's avatar
 
Dries committed
4 5 6 7 8
/**
 * @file
 * Allows users to collaboratively author a book.
 */

9
/**
10
 * 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 25 26 27 28 29 30 31 32 33 34 35 36 37 38
/**
 * Implementation of hook_theme()
 */
function book_theme() {
  return array(
    'book_navigation' => array(
      'arguments' => array('node' => NULL),
    ),
    'book_export_html' => array(
      'arguments' => array('title' => NULL, 'content' => NULL),
    ),
    'book_admin_table' => array(
      'arguments' => array('form' => NULL),
    ),
  );
}

39 40 41
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
42
function book_perm() {
43
    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
44 45
}

46 47 48
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
49
function book_access($op, $node) {
Dries's avatar
 
Dries committed
50
  global $user;
Dries's avatar
 
Dries committed
51

52
  if ($op == 'create') {
53
    // Only registered users can create book pages. Given the nature
Dries's avatar
 
Dries committed
54
    // of the book module this is considered to be a good/safe idea.
55
    return user_access('create book pages');
Dries's avatar
 
Dries committed
56 57
  }

58
  if ($op == 'update') {
59
    // Only registered users can update book pages. Given the nature
Dries's avatar
 
Dries committed
60 61
    // 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
62
    // of that page waiting for approval. That is, only updates that
63
    // don't overwrite the current or pending information are allowed.
64

65
    if (user_access('edit book pages') || ($node->uid == $user->uid && user_access('edit own book pages'))) {
66 67 68 69 70
      return TRUE;
    }
    else {
       // do nothing. node-access() will determine further access
    }
Dries's avatar
 
Dries committed
71
  }
Dries's avatar
 
Dries committed
72 73
}

Dries's avatar
 
Dries committed
74 75 76
/**
 * Implementation of hook_link().
 */
77
function book_link($type, $node = NULL, $teaser = FALSE) {
Dries's avatar
 
Dries committed
78 79 80

  $links = array();

81
  if ($type == 'node' && isset($node->parent)) {
82
    if (!$teaser) {
83
      if (book_access('create', $node) && $node->status == 1) {
84
        $links['book_add_child'] = array(
85
          'title' => t('Add child page'),
86
          'href' => "node/add/book/parent/$node->nid"
87
        );
Dries's avatar
 
Dries committed
88
      }
89
      if (user_access('see printer-friendly version')) {
90
        $links['book_printer'] = array(
91
          'title' => t('Printer-friendly version'),
92 93
          'href' => 'book/export/html/'. $node->nid,
          'attributes' => array('title' => t('Show a printer-friendly version of this book page and its sub-pages.'))
94
        );
95
      }
Dries's avatar
 
Dries committed
96
    }
Dries's avatar
 
Dries committed
97 98
  }

Dries's avatar
 
Dries committed
99
  return $links;
Dries's avatar
 
Dries committed
100 101
}

Dries's avatar
 
Dries committed
102 103 104
/**
 * Implementation of hook_menu().
 */
105 106
function book_menu() {
  $items['admin/content/book'] = array(
107 108
    'title' => 'Books',
    'description' => "Manage site's books and orphaned book pages.",
109 110 111 112
    'page callback' => 'book_admin',
    'access arguments' => array('administer nodes'),
  );
  $items['admin/content/book/list'] = array(
113
    'title' => 'List',
114 115 116
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items['admin/content/book/orphan'] = array(
117
    'title' => 'Orphan pages',
118 119 120 121 122 123
    'page callback' => 'drupal_get_form',
    'page arguments' => array('book_admin_orphan'),
    'type' => MENU_LOCAL_TASK,
    'weight' => 8,
  );
  $items['book'] = array(
124
    'title' => 'Books',
125 126 127 128 129 130 131 132 133
    '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,
  );
134
  $items['node/%node/outline'] = array(
135
    'title' => 'Outline',
136 137 138 139 140 141 142
    '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
143 144 145 146

  return $items;
}

147 148 149 150 151 152 153 154 155
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');
}

156 157 158
/**
 * Implementation of hook_block().
 *
Dries's avatar
 
Dries committed
159 160
 * Displays the book table of contents in a block when the current page is a
 * single-node view of a book node.
161
 */
Dries's avatar
 
Dries committed
162
function book_block($op = 'list', $delta = 0) {
Dries's avatar
 
Dries committed
163
  $block = array();
Dries's avatar
 
Dries committed
164 165
  if ($op == 'list') {
    $block[0]['info'] = t('Book navigation');
166
    return $block;
Dries's avatar
 
Dries committed
167
  }
168
  else if ($op == 'view') {
Dries's avatar
 
Dries committed
169 170
    // Only display this block when the user is browsing a book:
    if (arg(0) == 'node' && is_numeric(arg(1))) {
171
      $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
172 173 174 175 176 177 178 179 180 181 182
      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;
        }

183
        $block['subject'] = check_plain($path[0]->title);
Dries's avatar
 
Dries committed
184 185 186
        $block['content'] = book_tree($expand[0], 5, $expand);
      }
    }
Dries's avatar
 
Dries committed
187

188 189
    return $block;
  }
Dries's avatar
 
Dries committed
190 191
}

192 193 194 195 196
/**
 * 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
197
}
Dries's avatar
 
Dries committed
198

199
/**
200
 * Implementation of hook_submit().
201
 */
202
function book_submit(&$form_values) {
203
  global $user;
204 205
  // Set default values for non-administrators.
  if (!user_access('administer nodes')) {
206 207
    $form_values['revision'] = 1;
    $form_values['uid'] = $user->uid;
208 209
  }
}
210

211 212 213 214
/**
 * Implementation of hook_form().
 */
function book_form(&$node) {
215
  $type = node_get_types('type', $node);
216
  if (!empty($node->nid) && !$node->parent && !user_access('create new books')) {
217
    $form['parent'] = array('#type' => 'value', '#value' => $node->parent);
218 219 220 221
  }
  else {
    $form['parent'] = array('#type' => 'select',
      '#title' => t('Parent'),
222 223
      '#default_value' => (isset($node->parent) ? $node->parent : arg(4)),
      '#options' => book_toc(isset($node->nid) ? $node->nid : 0),
224
      '#weight' => -4,
225
      '#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.'),
226 227
    );
  }
228 229

  $form['title'] = array('#type' => 'textfield',
230
    '#title' => check_plain($type->title_label),
231 232 233 234
    '#required' => TRUE,
    '#default_value' => $node->title,
    '#weight' => -5,
  );
235 236

  $form['body_field'] = node_body_field($node, $type->body_label, 1);
237

238 239 240
  if (user_access('administer nodes')) {
    $form['weight'] = array('#type' => 'weight',
      '#title' => t('Weight'),
241
      '#default_value' => isset($node->weight) ? $node->weight : 0,
242 243 244 245 246 247
      '#delta' => 15,
      '#weight' => 5,
      '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
    );
  }
  else {
248 249 250 251 252 253
    // 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
254 255
  }

256
  return $form;
Dries's avatar
 
Dries committed
257 258
}

259
/**
Dries's avatar
 
Dries committed
260 261
 * Implementation of function book_outline()
 * Handles all book outline operations.
262
 */
263
function book_outline($form_state, $node) {
264 265
  $form['parent'] = array('#type' => 'select',
    '#title' => t('Parent'),
266
    '#default_value' => isset($node->parent) ? $node->parent : 0,
267
    '#options' => book_toc($node->nid),
268 269 270 271
    '#description' => t('The parent page in the book.'),
  );
  $form['weight'] = array('#type' => 'weight',
    '#title' => t('Weight'),
272
    '#default_value' => isset($node->weight) ? $node->weight : 0,
273 274 275 276 277 278 279
    '#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
280

281
  $form['nid'] = array('#type' => 'value', '#value' => isset($node->nid) ? $node->nid : 0);
282
  if (isset($node->parent)) {
283 284 285 286 287 288 289 290 291 292
    $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
293

294
  drupal_set_title(check_plain($node->title));
295
  return $form;
296 297 298 299 300
}

/**
 * Handles book outline form submissions.
 */
301 302 303
function book_outline_submit($form, &$form_state) {
  $op = $form_state['values']['op'];
  $node = node_load($form_state['values']['nid']);
304 305 306

  switch ($op) {
    case t('Add to book outline'):
307 308
      db_query('INSERT INTO {book} (nid, vid, parent, weight) VALUES (%d, %d, %d, %d)', $node->nid, $node->vid, $form_state['values']['parent'], $form_state['values']['weight']);
      db_query("UPDATE {node_revisions} SET log = '%s' WHERE vid = %d", $form_state['values']['log'], $node->vid);
309 310 311
      drupal_set_message(t('The post has been added to the book.'));
      break;
    case t('Update book outline'):
312 313
      db_query('UPDATE {book} SET parent = %d, weight = %d WHERE vid = %d', $form_state['values']['parent'], $form_state['values']['weight'], $node->vid);
      db_query("UPDATE {node_revisions} SET log = '%s' WHERE vid = %d", $form_state['values']['log'], $node->vid);
314 315 316 317 318 319
      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
320
  }
321 322
  $form_state['redirect'] = "node/$node->nid";
  return;
Dries's avatar
 
Dries committed
323 324
}

325
/**
Dries's avatar
Dries committed
326 327
 * Given a node, this function returns an array of 'book node' objects
 * representing the path in the book tree from the root to the
328
 * parent of the given node.
Dries's avatar
Dries committed
329
 *
330 331
 * @param $node
 *   A book node object for which to compute the path.
332
 *
333 334 335 336
 * @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.
337
 */
Dries's avatar
 
Dries committed
338
function book_location($node, $nodes = array()) {
339
  $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));
340
  if (isset($parent->title)) {
Dries's avatar
 
Dries committed
341
    $nodes = book_location($parent, $nodes);
342
    $nodes[] = $parent;
Dries's avatar
 
Dries committed
343 344 345 346
  }
  return $nodes;
}

347
/**
348 349 350 351 352 353 354 355 356 357 358
 * 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.
359
 */
Dries's avatar
 
Dries committed
360
function book_location_down($node, $nodes = array()) {
361
  $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
362
  if ($last_direct_child) {
363
    $nodes[] = $last_direct_child;
Dries's avatar
 
Dries committed
364 365 366 367 368
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

369
/**
370
 * Fetches the node object of the previous page of the book.
371
 */
Dries's avatar
 
Dries committed
372
function book_prev($node) {
Dries's avatar
 
Dries committed
373
  // If the parent is zero, we are at the start of a book so there is no previous.
Dries's avatar
 
Dries committed
374 375 376 377
  if ($node->parent == 0) {
    return NULL;
  }

Dries's avatar
 
Dries committed
378
  // Previous on the same level:
379
  $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
380
  if ($direct_above) {
Dries's avatar
 
Dries committed
381
    // Get last leaf of $above.
Dries's avatar
 
Dries committed
382
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
383 384

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
385 386
  }
  else {
Dries's avatar
 
Dries committed
387
    // Direct parent:
388
    $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
389 390 391 392
    return $prev;
  }
}

393
/**
394
 * Fetches the node object of the next page of the book.
395
 */
Dries's avatar
 
Dries committed
396 397
function book_next($node) {
  // get first direct child
398
  $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
399 400 401 402
  if ($child) {
    return $child;
  }

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

Dries's avatar
 
Dries committed
407
  while (($leaf = array_pop($path)) && count($path)) {
408
    $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
409 410 411 412 413 414
    if ($next) {
      return $next;
    }
  }
}

415
/**
416
 * Returns the content of a given node. If $teaser if TRUE, returns
417
 * the teaser rather than full content. Displays the most recently
418 419 420
 * 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
421
function book_content($node, $teaser = FALSE) {
422 423
  // Return the page body.
  return node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
424 425
}

426
/**
Dries's avatar
 
Dries committed
427 428 429
 * Implementation of hook_nodeapi().
 *
 * Appends book navigation to all nodes in the book.
430
 */
Dries's avatar
 
Dries committed
431 432
function book_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
433 434 435
    case 'load':
      return db_fetch_array(db_query('SELECT parent, weight FROM {book} WHERE vid = %d', $node->vid));
      break;
Dries's avatar
 
Dries committed
436 437
    case 'view':
      if (!$teaser) {
438
        if (isset($node->parent)) {
439 440 441 442 443 444 445 446
          $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);

447 448 449 450
          $node->content['book_navigation'] = array(
            '#value' => theme('book_navigation', $node),
            '#weight' => 100,
          );
451

452 453 454
          if ($page) {
            menu_set_location($node->breadcrumb);
          }
Dries's avatar
 
Dries committed
455
        }
Dries's avatar
 
Dries committed
456
      }
Dries's avatar
 
Dries committed
457
      break;
458 459
    case 'update':
      if (isset($node->parent)) {
460
        if (!empty($node->revision)) {
461 462 463 464 465 466 467
          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;
468
    case 'delete revision':
469
      db_query('DELETE FROM {book} WHERE vid = %d', $node->vid);
470
      break;
471
    case 'delete':
472
      db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
473
      break;
Dries's avatar
 
Dries committed
474
  }
Dries's avatar
 
Dries committed
475
}
Dries's avatar
 
Dries committed
476

477
/**
478
 * Prepares the links to children (TOC) and forward/backward
479
 * navigation for a node presented as a book page.
480 481
 *
 * @ingroup themeable
482
 */
483
function theme_book_navigation($node) {
484
  $output = '';
485
  $links = '';
486

Dries's avatar
 
Dries committed
487
  if ($node->nid) {
488
    $tree = book_tree($node->nid);
Dries's avatar
 
Dries committed
489

Dries's avatar
 
Dries committed
490
    if ($prev = book_prev($node)) {
491
      drupal_add_link(array('rel' => 'prev', 'href' => url('node/'. $prev->nid)));
492
      $links .= l(t('‹ ') . $prev->title, 'node/'. $prev->nid, array('class' => 'page-previous', 'title' => t('Go to previous page')));
Dries's avatar
 
Dries committed
493
    }
494
    if ($node->parent) {
495
      drupal_add_link(array('rel' => 'up', 'href' => url('node/'. $node->parent)));
496
      $links .= l(t('up'), 'node/'. $node->parent, array('class' => 'page-up', 'title' => t('Go to parent page')));
Dries's avatar
 
Dries committed
497 498
    }
    if ($next = book_next($node)) {
499
      drupal_add_link(array('rel' => 'next', 'href' => url('node/'. $next->nid)));
500
      $links .= l($next->title . t(' ›'), 'node/'. $next->nid, array('class' => 'page-next', 'title' => t('Go to next page')));
Dries's avatar
 
Dries committed
501
    }
Dries's avatar
 
Dries committed
502

503 504 505 506 507 508
    if (isset($tree) || isset($links)) {
      $output = '<div class="book-navigation">';
      if (isset($tree)) {
        $output .= $tree;
      }
      if (isset($links)) {
509
        $output .= '<div class="page-links clear-block">'. $links .'</div>';
510 511 512
      }
      $output .= '</div>';
    }
Dries's avatar
 
Dries committed
513
  }
Dries's avatar
 
Dries committed
514

515
  return $output;
Dries's avatar
 
Dries committed
516
}
Dries's avatar
 
Dries committed
517

518 519 520
/**
 * This is a helper function for book_toc().
 */
521
function book_toc_recurse($nid, $indent, $toc, $children, $exclude) {
522
  if (!empty($children[$nid])) {
Dries's avatar
 
Dries committed
523
    foreach ($children[$nid] as $foo => $node) {
524 525 526 527
      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
528 529 530 531 532 533
    }
  }

  return $toc;
}

534 535 536
/**
 * Returns an array of titles and nid entries of book pages in table of contents order.
 */
537
function book_toc($exclude = 0) {
538
  $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
539

540
  $children = array();
Dries's avatar
 
Dries committed
541
  while ($node = db_fetch_object($result)) {
542
    if (empty($children[$node->parent])) {
Dries's avatar
 
Dries committed
543 544
      $children[$node->parent] = array();
    }
545
    $children[$node->parent][] = $node;
Dries's avatar
 
Dries committed
546
  }
Dries's avatar
 
Dries committed
547

548
  $toc = array();
549
  // If the user has permission to create new books, add the top-level book page to the menu;
550
  if (user_access('create new books')) {
551
    $toc[0] = '<'. t('top-level') .'>';
Dries's avatar
 
Dries committed
552 553
  }

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

Dries's avatar
 
Dries committed
556 557 558
  return $toc;
}

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

  return $output;
}

593 594 595 596
/**
 * Returns an HTML nested list (wrapped in a menu-class div) representing the book nodes
 * as a tree.
 */
Dries's avatar
 
Dries committed
597
function book_tree($parent = 0, $depth = 3, $unfold = array()) {
598
  $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
599

Dries's avatar
 
Dries committed
600
  while ($node = db_fetch_object($result)) {
601
    $list = isset($children[$node->parent]) ? $children[$node->parent] : array();
602
    $list[] = $node;
Dries's avatar
 
Dries committed
603
    $children[$node->parent] = $list;
Dries's avatar
 
Dries committed
604
  }
Dries's avatar
 
Dries committed
605

Dries's avatar
 
Dries committed
606
  if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
607
    return '<ul class="menu">'. $tree .'</ul>';
Dries's avatar
 
Dries committed
608
  }
Dries's avatar
 
Dries committed
609 610
}

611
/**
Dries's avatar
Dries committed
612
 * Menu callback; prints a listing of all books.
613
 */
Dries's avatar
 
Dries committed
614
function book_render() {
615
  $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
616

617 618 619 620 621 622
  $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
623 624
}

625
/**
626 627 628
 * Menu callback; Generates various representation of a book page with
 * all descendants and prints the requested representation to output.
 *
629 630
 * The function delegates the generation of output to helper functions.
 * The function name is derived by prepending 'book_export_' to the
631
 * given output type. So, e.g., a type of 'html' results in a call to
632
 * the function book_export_html().
633 634 635
 *
 * @param type
 *   - a string encoding the type of output requested.
636 637 638
 *       The following types are currently supported in book module
 *          html: HTML (printer friendly output)
 *       Other types are supported in contributed modules.
639 640 641
 * @param nid
 *   - an integer representing the node id (nid) of the node to export
 *
642
 */
643
function book_export($type, $nid) {
644
  $type = drupal_strtolower($type);
645 646 647 648 649
  $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;
650
  $export_function = 'book_export_'. $type;
651 652 653

  if (function_exists($export_function)) {
    print call_user_func($export_function, $nid, $depth);
654 655
  }
  else {
656
    drupal_set_message(t('Unknown export format.'));
657
    drupal_not_found();
658
  }
659
}
Dries's avatar
 
Dries committed
660

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

700 701 702 703 704 705
/**
 * How the book's HTML export should be themed
 *
 * @ingroup themeable
 */
function theme_book_export_html($title, $content) {
706
  global $base_url, $language;
707 708 709 710
  $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" />';
711
  $html .= '<base href="'. $base_url .'/" />'."\n";
712
  $html .= "<style type=\"text/css\">\n@import url(misc/print.css);\n";
713
  if (defined('LANGUAGE_RTL') && $language->direction == LANGUAGE_RTL) {
714 715 716
    $html .= "@import url(misc/print-rtl.css);\n";
  }
  $html .= "</style>\n";
717
  $html .= "</head>\n<body>\n". $content ."\n</body>\n</html>\n";
718 719 720
  return $html;
}

721
/**
722
 * Traverses the book tree. Applies the $visit_pre() callback to each
723
 * node, is called recursively for each child of the node (in weight,
724
 * title order). Finally appends the output of the $visit_post()
725 726
 * callback to the output before returning the generated output.
 *
727 728
 * @todo This is duplicitous with node_build_content().
 *
729 730 731 732 733 734 735 736 737 738 739 740 741
 * @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) {
742
  $output = '';
743
  $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
744
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
745
    // Load the node:
746
    $node = node_load($page->nid);
Dries's avatar
 
Dries committed
747

Dries's avatar
 
Dries committed
748
    if ($node) {
749 750
      if (function_exists($visit_pre)) {
        $output .= call_user_func($visit_pre, $node, $depth, $nid);
Dries's avatar
 
Dries committed
751
      }
752 753
      else {
        $output .= book_node_visitor_html_pre($node, $depth, $nid);
Dries's avatar
 
Dries committed
754
      }
Dries's avatar
 
Dries committed
755

756
      $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);
757
      while ($childpage = db_fetch_object($children)) {
758
          $childnode = node_load($childpage->nid);
759
          if ($childnode->nid != $node->nid) {
760
              $output .= book_recurse($childnode->nid, $depth + 1, $visit_pre, $visit_post);
761 762 763
          }
      }
      if (function_exists($visit_post)) {
764
        $output .= call_user_func($visit_post, $node, $depth);
765
      }
766 767
      else {
        # default
768
        $output .= book_node_visitor_html_post($node, $depth);
769
      }
Dries's avatar
 
Dries committed
770
    }
Dries's avatar
 
Dries committed
771
  }
Dries's avatar
 
Dries committed
772

Dries's avatar
 
Dries committed
773 774
  return $output;
}
Dries's avatar
 
Dries committed
775

776
/**
777
 * Generates printer-friendly HTML for a node. This function
778 779 780 781 782 783 784 785 786 787 788 789 790
 * 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.
 */
791
function book_node_visitor_html_pre($node, $depth, $nid) {
792
  // Remove the delimiter (if any) that separates the teaser from the body.
793
  $node->body = str_replace('<!--break-->', '', $node->body);
794 795 796 797 798 799 800 801

  // 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);
802
  }
803 804 805

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

807
  $output = "<div id=\"node-". $node->nid ."\" class=\"section-$depth\">\n";
808
  $output .= "<h1 class=\"book-heading\">". check_plain($node->title) ."</h1>\n";
809
  $output .= drupal_render($node->content);
810 811 812 813 814 815 816 817 818

  return $output;
}

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

823 824 825 826 827 828 829 830 831 832 833
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;
834 835
}

836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
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,
    ),
852
  );
853

854
  $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);
855 856 857 858 859
  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
860 861
}

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

865
  $rows = array();
866