book.module 35.4 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 15 16 17 18 19
  return array(
    'book' => array(
      'name' => t('book page'),
      '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) {
Dries's avatar
 
Dries committed
66
      if (book_access('create', $node)) {
67
        $links['book_add_child'] = array(
68 69
          'title' => t('add child page'),
          '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 75 76
          'title' => t('printer-friendly version'),
          '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 101
      'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK);
102
    $items[] = array(
103
      'path' => 'admin/content/book/orphan',
104
      'title' => t('orphan pages'),
Dries's avatar
 
Dries committed
105
      'callback' => 'book_admin_orphan',
106
      'type' => MENU_LOCAL_TASK,
Dries's avatar
 
Dries committed
107
      'weight' => 8);
108 109 110
    $items[] = array(
      'path' => 'book',
      'title' => t('books'),
Dries's avatar
 
Dries committed
111 112 113
      'callback' => 'book_render',
      'access' => user_access('access content'),
      'type' => MENU_SUGGESTED_ITEM);
114
    $items[] = array(
115 116
      'path' => 'book/export',
      'callback' => 'book_export',
117
      'access' => user_access('access content'),
Dries's avatar
 
Dries committed
118
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
119
  }
Dries's avatar
 
Dries committed
120
  else {
121 122 123 124
    // 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
125
    // To avoid SQL overhead, check whether we are on a node page and whether the
126 127
    // 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
128
      // Only add the outline-tab for non-book pages:
129
      $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
130
      if (db_num_rows($result) > 0) {
131 132 133 134
        $items[] = array(
          'path' => 'node/'. arg(1) .'/outline',
          'title' => t('outline'),
          'callback' => 'book_outline',
135
          'callback arguments' => array(arg(1)),
136
          'access' => user_access('outline posts in books'),
137 138
          'type' => MENU_LOCAL_TASK,
          'weight' => 2);
Dries's avatar
 
Dries committed
139 140 141
      }
    }
  }
Dries's avatar
 
Dries committed
142 143 144 145

  return $items;
}

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

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

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

182 183 184
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
185
function book_load($node) {
186
  return db_fetch_object(db_query('SELECT * FROM {book} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
187 188
}

189 190 191
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
192
function book_insert($node) {
193
  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
194
}
Dries's avatar
 
Dries committed
195

196 197 198
/**
 * Implementation of hook_update().
 */
Dries's avatar
 
Dries committed
199
function book_update($node) {
200
  if ($node->revision) {
201
    db_query("INSERT INTO {book} (nid, vid, parent, weight) VALUES (%d, %d, %d, %d)", $node->nid, $node->vid, $node->parent, $node->weight);
202 203 204 205
  }
  else {
    db_query("UPDATE {book} SET parent = %d, weight = %d WHERE vid = %d", $node->parent, $node->weight, $node->vid);
  }
Dries's avatar
 
Dries committed
206
}
Dries's avatar
 
Dries committed
207

208 209 210
/**
 * Implementation of hook_delete().
 */
211
function book_delete(&$node) {
212
  db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
213 214
}

215
/**
216
 * Implementation of hook_submit().
217
 */
218
function book_submit(&$node) {
219
  global $user;
220 221
  // Set default values for non-administrators.
  if (!user_access('administer nodes')) {
222 223
    $node->weight = 0;
    $node->revision = 1;
224 225
    $book->uid = $user->uid;
    $book->name = $user->uid ? $user->name : '';
226
  }
227
}
228

229 230 231
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
232
function book_form(&$node) {
233
  $type = node_get_types('type', $node);
234
  if ($node->nid && !$node->parent && !user_access('create new books')) {
235
    $form['parent'] = array('#type' => 'value', '#value' => $node->parent);
236 237 238 239 240 241 242
  }
  else {
    $form['parent'] = array('#type' => 'select',
      '#title' => t('Parent'),
      '#default_value' => ($node->parent ? $node->parent : arg(4)),
      '#options' => book_toc($node->nid),
      '#weight' => -4,
243
      '#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.'),
244 245
    );
  }
246 247

  $form['title'] = array('#type' => 'textfield',
248
    '#title' => check_plain($type->title_label),
249 250 251 252 253
    '#required' => TRUE,
    '#default_value' => $node->title,
    '#weight' => -5,
  );
  $form['body_filter']['body'] = array('#type' => 'textarea',
254
    '#title' => check_plain($type->body_label),
255 256 257 258
    '#default_value' => $node->body,
    '#rows' => 20,
    '#required' => TRUE,
  );
259
  $form['body_filter']['format'] = filter_form($node->format);
260

261
  $form['log'] = array(
262 263 264 265
    '#type' => 'textarea',
    '#title' => t('Log message'),
    '#weight' => 5,
    '#description' => t('An explanation of the additions or updates being made to help other authors understand your motivations.'),
266
  );
Dries's avatar
 
Dries committed
267

268
  if (user_access('administer nodes')) {
269 270 271 272 273 274
    $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.'),
275
    );
Dries's avatar
 
Dries committed
276 277
  }
  else {
Dries's avatar
 
Dries committed
278 279
    // If a regular user updates a book page, we create a new revision
    // authored by that user:
280
    $form['revision'] = array('#type' => 'hidden', '#value' => 1);
Dries's avatar
 
Dries committed
281 282
  }

283
  return $form;
Dries's avatar
 
Dries committed
284 285
}

286
/**
Dries's avatar
 
Dries committed
287 288
 * Implementation of function book_outline()
 * Handles all book outline operations.
289
 */
290 291
function book_outline($nid) {
  $node = node_load($nid);
292
  $page = book_load($node);
Dries's avatar
 
Dries committed
293

294 295 296
  $form['parent'] = array('#type' => 'select',
    '#title' => t('Parent'),
    '#default_value' => $page->parent,
297
    '#options' => book_toc($node->nid),
298 299 300 301 302 303 304 305 306 307 308 309
    '#description' => t('The parent page in the book.'),
  );
  $form['weight'] = array('#type' => 'weight',
    '#title' => t('Weight'),
    '#default_value' => $page->weight,
    '#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
310

311 312 313 314 315 316 317 318 319 320 321 322
  $form['nid'] = array('#type' => 'value', '#value' => $nid);
  if ($page->nid) {
    $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
323

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
  drupal_set_title(check_plain($node->title));
  return drupal_get_form('book_outline', $form);
}

/**
 * Handles book outline form submissions.
 */
function book_outline_submit($form_id, $form_values) {
  $op = $_POST['op'];
  $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
350
  }
351
  return "node/$node->nid";
Dries's avatar
 
Dries committed
352 353
}

354
/**
Dries's avatar
Dries committed
355 356
 * Given a node, this function returns an array of 'book node' objects
 * representing the path in the book tree from the root to the
357
 * parent of the given node.
Dries's avatar
Dries committed
358
 *
359 360 361 362 363 364
 * @param node - a book node object for which to compute the path
 *
 * @return - an array of book node objects representing the path of
 * 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.
 *
365
 */
Dries's avatar
 
Dries committed
366
function book_location($node, $nodes = array()) {
367
  $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));
368
  if (isset($parent->title)) {
Dries's avatar
 
Dries committed
369
    $nodes = book_location($parent, $nodes);
370
    $nodes[] = $parent;
Dries's avatar
 
Dries committed
371 372 373 374
  }
  return $nodes;
}

375 376 377
/**
 * Accumulates the nodes up to the root of the book from the given node in the $nodes array.
 */
Dries's avatar
 
Dries committed
378
function book_location_down($node, $nodes = array()) {
379
  $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
380
  if ($last_direct_child) {
381
    $nodes[] = $last_direct_child;
Dries's avatar
 
Dries committed
382 383 384 385 386
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

387
/**
388
 * Fetches the node object of the previous page of the book.
389
 */
Dries's avatar
 
Dries committed
390
function book_prev($node) {
Dries's avatar
 
Dries committed
391
  // If the parent is zero, we are at the start of a book so there is no previous.
Dries's avatar
 
Dries committed
392 393 394 395
  if ($node->parent == 0) {
    return NULL;
  }

Dries's avatar
 
Dries committed
396
  // Previous on the same level:
397
  $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
398
  if ($direct_above) {
Dries's avatar
 
Dries committed
399
    // Get last leaf of $above.
Dries's avatar
 
Dries committed
400
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
401 402

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
403 404
  }
  else {
Dries's avatar
 
Dries committed
405
    // Direct parent:
406
    $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
407 408 409 410
    return $prev;
  }
}

411
/**
412
 * Fetches the node object of the next page of the book.
413
 */
Dries's avatar
 
Dries committed
414 415
function book_next($node) {
  // get first direct child
416
  $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
417 418 419 420
  if ($child) {
    return $child;
  }

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

Dries's avatar
 
Dries committed
425
  while (($leaf = array_pop($path)) && count($path)) {
426
    $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
427 428 429 430 431 432
    if ($next) {
      return $next;
    }
  }
}

433
/**
434
 * Returns the content of a given node. If $teaser if TRUE, returns
435
 * the teaser rather than full content. Displays the most recently
436 437 438
 * 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
439
function book_content($node, $teaser = FALSE) {
440 441
  // Return the page body.
  return node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
442 443
}

444
/**
Dries's avatar
 
Dries committed
445 446 447
 * Implementation of hook_nodeapi().
 *
 * Appends book navigation to all nodes in the book.
448
 */
Dries's avatar
 
Dries committed
449 450 451 452
function book_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
    case 'view':
      if (!$teaser) {
453
        $book = db_fetch_array(db_query('SELECT * FROM {book} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
454 455 456 457
        if ($book) {
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
458 459 460 461 462 463 464 465 466

          $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);

467 468 469 470
          $node->content['book_navigation'] = array(
            '#value' => theme('book_navigation', $node),
            '#weight' => 100,
          );
471

472 473 474
          if ($page) {
            menu_set_location($node->breadcrumb);
          }
Dries's avatar
 
Dries committed
475
        }
Dries's avatar
 
Dries committed
476
      }
Dries's avatar
 
Dries committed
477
      break;
478
    case 'delete revision':
479 480
      db_query('DELETE FROM {book} WHERE vid = %d', $node->vid);
      break;
481 482 483
    case 'delete':
      db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
      break;
Dries's avatar
 
Dries committed
484
  }
Dries's avatar
 
Dries committed
485
}
Dries's avatar
 
Dries committed
486

487
/**
488
 * Prepares the links to children (TOC) and forward/backward
489
 * navigation for a node presented as a book page.
490 491
 *
 * @ingroup themeable
492
 */
493
function theme_book_navigation($node) {
494
  $output = '';
495
  $links = '';
496

Dries's avatar
 
Dries committed
497
  if ($node->nid) {
498
    $tree = book_tree($node->nid);
Dries's avatar
 
Dries committed
499

Dries's avatar
 
Dries committed
500
    if ($prev = book_prev($node)) {
501
      drupal_add_link(array('rel' => 'prev', 'href' => url('node/'. $prev->nid)));
502
      $links .= l(t('‹ ') . $prev->title, 'node/'. $prev->nid, array('class' => 'page-previous', 'title' => t('Go to previous page')));
Dries's avatar
 
Dries committed
503
    }
504
    if ($node->parent) {
505
      drupal_add_link(array('rel' => 'up', 'href' => url('node/'. $node->parent)));
506
      $links .= l(t('up'), 'node/'. $node->parent, array('class' => 'page-up', 'title' => t('Go to parent page')));
Dries's avatar
 
Dries committed
507 508
    }
    if ($next = book_next($node)) {
509
      drupal_add_link(array('rel' => 'next', 'href' => url('node/'. $next->nid)));
510
      $links .= l($next->title . t(' ›'), 'node/'. $next->nid, array('class' => 'page-next', 'title' => t('Go to next page')));
Dries's avatar
 
Dries committed
511
    }
Dries's avatar
 
Dries committed
512

513 514 515 516 517 518 519 520 521 522
    if (isset($tree) || isset($links)) {
      $output = '<div class="book-navigation">';
      if (isset($tree)) {
        $output .= $tree;
      }
      if (isset($links)) {
        $output .= '<div class="page-links">'. $links .'</div>';
      }
      $output .= '</div>';
    }
Dries's avatar
 
Dries committed
523
  }
Dries's avatar
 
Dries committed
524

525
  return $output;
Dries's avatar
 
Dries committed
526
}
Dries's avatar
 
Dries committed
527

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

  return $toc;
}

544 545 546
/**
 * Returns an array of titles and nid entries of book pages in table of contents order.
 */
547
function book_toc($exclude = 0) {
548
  $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
549

550
  $children = array();
Dries's avatar
 
Dries committed
551
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
552 553 554
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
555
    $children[$node->parent][] = $node;
Dries's avatar
 
Dries committed
556
  }
Dries's avatar
 
Dries committed
557

558
  $toc = array();
559
  // If the user has permission to create new books, add the top-level book page to the menu;
560
  if (user_access('create new books')) {
561
    $toc[0] = '<'. t('top-level') .'>';
Dries's avatar
 
Dries committed
562 563
  }

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

Dries's avatar
 
Dries committed
566 567 568
  return $toc;
}

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

  return $output;
}

603 604 605 606
/**
 * Returns an HTML nested list (wrapped in a menu-class div) representing the book nodes
 * as a tree.
 */
Dries's avatar
 
Dries committed
607
function book_tree($parent = 0, $depth = 3, $unfold = array()) {
608
  $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
609

Dries's avatar
 
Dries committed
610
  while ($node = db_fetch_object($result)) {
611
    $list = isset($children[$node->parent]) ? $children[$node->parent] : array();
612
    $list[] = $node;
Dries's avatar
 
Dries committed
613
    $children[$node->parent] = $list;
Dries's avatar
 
Dries committed
614
  }
Dries's avatar
 
Dries committed
615

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

621
/**
Dries's avatar
Dries committed
622
 * Menu callback; prints a listing of all books.
623
 */
Dries's avatar
 
Dries committed
624
function book_render() {
625
  $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
626

627 628 629 630 631 632
  $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
633 634
}

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

  if (function_exists($export_function)) {
    print call_user_func($export_function, $nid, $depth);
664 665
  }
  else {
666
    drupal_set_message(t('Unknown export format.'));
667
    drupal_not_found();
668
  }
669
}
Dries's avatar
 
Dries committed
670

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

709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
/**
 * 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";
  $html .= "</head>\n<body>\n". $content . "\n</body>\n</html>\n";
  return $html;
}

726
/**
727
 * Traverses the book tree. Applies the $visit_pre() callback to each
728
 * node, is called recursively for each child of the node (in weight,
729
 * title order). Finally appends the output of the $visit_post()
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
 * callback to the output before returning the generated output.
 *
 * @param nid
 *  - the node id (nid) of the root node of the book hierarchy.
 * @param depth
 *  - the depth of the given node in the book hierarchy.
 * @param visit_pre
 *  - a function callback to be called upon visiting a node in the tree
 * @param visit_post
 *  - a function callback to be called after visiting a node in the tree,
 *    but before recursively visiting children.
 * @return
 *  - the output generated in visiting each node
 */
function book_recurse($nid = 0, $depth = 1, $visit_pre, $visit_post) {
745
  $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
746
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
747
    // Load the node:
748
    $node = node_load($page->nid);
Dries's avatar
 
Dries committed
749

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

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

Dries's avatar
 
Dries committed
775 776
  return $output;
}
Dries's avatar
 
Dries committed
777

778
/**
779
 * Generates printer-friendly HTML for a node. This function
780 781 782 783 784 785 786 787 788 789 790 791 792
 * 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.
 */
793
function book_node_visitor_html_pre($node, $depth, $nid) {
794 795 796 797 798
  // Output the content:
  if (node_hook($node, 'content')) {
    $node = node_invoke($node, 'content');
  }
  // Allow modules to change $node->body before viewing.
799
  node_invoke_nodeapi($node, 'print', $node->body, FALSE);
800

801 802
  $output .= "<div id=\"node-". $node->nid ."\" class=\"section-$depth\">\n";
  $output .= "<h1 class=\"book-heading\">". check_plain($node->title) ."</h1>\n";
803 804

  if ($node->body) {
805
    $output .= drupal_render($node->content);
806 807 808 809 810 811 812 813 814
  }
  return $output;
}

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

819 820 821 822 823 824 825 826 827 828 829
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;
830 831
}

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

  $children = db_query(db_rewrite_sql('SELECT n.nid, 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);
  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
856 857
}

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

861
  $rows = array();
862 863
  foreach (element_children($form) as $key) {
    $nid = $form[$key]['nid']['#value'];
864
    $pid = $form[0]['nid']['#value'];