book.module 35 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().
 */
Dries's avatar
 
Dries committed
88
function book_menu($may_cache) {
Dries's avatar
 
Dries committed
89 90
  $items = array();

Dries's avatar
 
Dries committed
91
  if ($may_cache) {
92
    $items[] = array(
93
      'path' => 'admin/content/book',
94
      'title' => t('Books'),
95
      'description' => t("Manage site's books and orphaned book pages."),
Dries's avatar
 
Dries committed
96
      'callback' => 'book_admin',
97
      'access' => user_access('administer nodes'));
98
    $items[] = array(
99
      'path' => 'admin/content/book/list',
100
      'title' => t('List'),
101
      'type' => MENU_DEFAULT_LOCAL_TASK);
102
    $items[] = array(
103
      'path' => 'admin/content/book/orphan',
104
      'title' => t('Orphan pages'),
105 106
      'callback' => 'drupal_get_form',
      'callback arguments' => array('book_admin_orphan'),
107
      'type' => MENU_LOCAL_TASK,
Dries's avatar
 
Dries committed
108
      'weight' => 8);
109 110
    $items[] = array(
      'path' => 'book',
111
      'title' => t('Books'),
Dries's avatar
 
Dries committed
112 113 114
      'callback' => 'book_render',
      'access' => user_access('access content'),
      'type' => MENU_SUGGESTED_ITEM);
115
    $items[] = array(
116 117
      'path' => 'book/export',
      'callback' => 'book_export',
118
      'access' => user_access('access content'),
Dries's avatar
 
Dries committed
119
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
120
  }
Dries's avatar
 
Dries committed
121
  else {
122 123 124 125
    // Add the CSS for this module
    // We put this in !$may_cache so it's only added once per request
    drupal_add_css(drupal_get_path('module', 'book') .'/book.css');

Dries's avatar
 
Dries committed
126
    // To avoid SQL overhead, check whether we are on a node page and whether the
127 128
    // user is allowed to outline posts in books.
    if (arg(0) == 'node' && is_numeric(arg(1)) && user_access('outline posts in books')) {
Dries's avatar
 
Dries committed
129
      // Only add the outline-tab for non-book pages:
130
      $result = db_query(db_rewrite_sql("SELECT n.nid FROM {node} n WHERE n.nid = %d AND n.type != 'book'"), arg(1));
Dries's avatar
 
Dries committed
131
      if (db_num_rows($result) > 0) {
132 133
        $items[] = array(
          'path' => 'node/'. arg(1) .'/outline',
134
          'title' => t('Outline'),
135 136
          'callback' => 'drupal_get_form',
          'callback arguments' => array('book_outline', arg(1)),
137
          'access' => user_access('outline posts in books'),
138 139
          'type' => MENU_LOCAL_TASK,
          'weight' => 2);
Dries's avatar
 
Dries committed
140 141 142
      }
    }
  }
Dries's avatar
 
Dries committed
143 144 145 146

  return $items;
}

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

174
        $block['subject'] = check_plain($path[0]->title);
Dries's avatar
 
Dries committed
175 176 177
        $block['content'] = book_tree($expand[0], 5, $expand);
      }
    }
Dries's avatar
 
Dries committed
178

179 180
    return $block;
  }
Dries's avatar
 
Dries committed
181 182
}

183 184 185 186 187
/**
 * 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
188
}
Dries's avatar
 
Dries committed
189

190
/**
191
 * Implementation of hook_submit().
192
 */
193
function book_submit(&$node) {
194
  global $user;
195 196 197
  // Set default values for non-administrators.
  if (!user_access('administer nodes')) {
    $node->revision = 1;
198
    $node->uid = $user->uid;
199 200
  }
}
201

202 203 204 205
/**
 * Implementation of hook_form().
 */
function book_form(&$node) {
206
  $type = node_get_types('type', $node);
207
  if ($node->nid && !$node->parent && !user_access('create new books')) {
208
    $form['parent'] = array('#type' => 'value', '#value' => $node->parent);
209 210 211 212 213 214 215
  }
  else {
    $form['parent'] = array('#type' => 'select',
      '#title' => t('Parent'),
      '#default_value' => ($node->parent ? $node->parent : arg(4)),
      '#options' => book_toc($node->nid),
      '#weight' => -4,
216
      '#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.'),
217 218
    );
  }
219 220

  $form['title'] = array('#type' => 'textfield',
221
    '#title' => check_plain($type->title_label),
222 223 224 225 226
    '#required' => TRUE,
    '#default_value' => $node->title,
    '#weight' => -5,
  );
  $form['body_filter']['body'] = array('#type' => 'textarea',
227
    '#title' => check_plain($type->body_label),
228 229 230 231
    '#default_value' => $node->body,
    '#rows' => 20,
    '#required' => TRUE,
  );
232
  $form['body_filter']['format'] = filter_form($node->format);
233

234 235 236 237 238 239 240 241 242 243
  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 {
244 245 246 247 248 249
    // 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
250 251
  }

252
  return $form;
Dries's avatar
 
Dries committed
253 254
}

255
/**
Dries's avatar
 
Dries committed
256 257
 * Implementation of function book_outline()
 * Handles all book outline operations.
258
 */
259 260
function book_outline($nid) {
  $node = node_load($nid);
Dries's avatar
 
Dries committed
261

262 263
  $form['parent'] = array('#type' => 'select',
    '#title' => t('Parent'),
264
    '#default_value' => $node->parent,
265
    '#options' => book_toc($node->nid),
266 267 268 269
    '#description' => t('The parent page in the book.'),
  );
  $form['weight'] = array('#type' => 'weight',
    '#title' => t('Weight'),
270
    '#default_value' => $node->weight,
271 272 273 274 275 276 277
    '#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
278

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

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

/**
 * Handles book outline form submissions.
 */
function book_outline_submit($form_id, $form_values) {
300
  $op = $form_values['op'];
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
  $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
318
  }
319
  return "node/$node->nid";
Dries's avatar
 
Dries committed
320 321
}

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

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

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

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

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

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

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

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

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

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

444 445 446 447
          $node->content['book_navigation'] = array(
            '#value' => theme('book_navigation', $node),
            '#weight' => 100,
          );
448

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

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

Dries's avatar
 
Dries committed
484
  if ($node->nid) {
485
    $tree = book_tree($node->nid);
Dries's avatar
 
Dries committed
486

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

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

512
  return $output;
Dries's avatar
 
Dries committed
513
}
Dries's avatar
 
Dries committed
514

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

  return $toc;
}

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

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

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

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

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

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

  return $output;
}

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

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

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

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

614 615 616 617 618 619
  $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
620 621
}

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

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

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

696 697 698 699 700 701 702 703 704 705 706 707 708
/**
 * 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";
709
  $html .= "</head>\n<body>\n". $content ."\n</body>\n</html>\n";
710 711 712
  return $html;
}

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

Dries's avatar
 
Dries committed
739
    if ($node) {
740 741
      if (function_exists($visit_pre)) {
        $output .= call_user_func($visit_pre, $node, $depth, $nid);
Dries's avatar
 
Dries committed
742
      }
743 744
      else {
        $output .= book_node_visitor_html_pre($node, $depth, $nid);
Dries's avatar
 
Dries committed
745
      }
Dries's avatar
 
Dries committed
746

747
      $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);
748
      while ($childpage = db_fetch_object($children)) {
749
          $childnode = node_load($childpage->nid);
750
          if ($childnode->nid != $node->nid) {
751
              $output .= book_recurse($childnode->nid, $depth + 1, $visit_pre, $visit_post);
752 753 754
          }
      }
      if (function_exists($visit_post)) {
755
        $output .= call_user_func($visit_post, $node, $depth);
756
      }
757 758
      else {
        # default
759
        $output .= book_node_visitor_html_post($node, $depth);
760
      }
Dries's avatar
 
Dries committed
761
    }
Dries's avatar
 
Dries committed
762
  }
Dries's avatar
 
Dries committed
763

Dries's avatar
 
Dries committed
764 765
  return $output;
}
Dries's avatar
 
Dries committed
766

767
/**
768
 * Generates printer-friendly HTML for a node. This function
769 770 771 772 773 774 775 776 777 778 779 780 781
 * 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.
 */
782
function book_node_visitor_html_pre($node, $depth, $nid) {
783
  // Remove the delimiter (if any) that separates the teaser from the body.
784
  $node->body = str_replace('<!--break-->', '', $node->body);
785 786 787 788 789 790 791 792

  // 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);
793
  }
794 795 796

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

798 799
  $output .= "<div id=\"node-". $node->nid ."\" class=\"section-$depth\">\n";
  $output .= "<h1 class=\"book-heading\">". check_plain($node->title) ."</h1>\n";
800
  $output .= drupal_render($node->content);
801 802 803 804 805 806 807 808 809

  return $output;
}

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

814 815 816 817 818 819 820 821 822 823 824
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;
825 826
}

827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
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,
    ),
843
  );
844

845
  $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);
846 847 848 849 850
  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
851 852
}

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

856
  $rows = array();