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

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

9
/**
10
 * Implementation of hook_node_info().
11
 */
12
function book_node_info() {
13 14 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 121
  else {
    // To avoid SQL overhead, check whether we are on a node page and whether the
122 123
    // 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
124
      // Only add the outline-tab for non-book pages:
125
      $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
126
      if (db_num_rows($result) > 0) {
127 128 129 130
        $items[] = array(
          'path' => 'node/'. arg(1) .'/outline',
          'title' => t('outline'),
          'callback' => 'book_outline',
131
          'callback arguments' => array(arg(1)),
132
          'access' => user_access('outline posts in books'),
133 134
          'type' => MENU_LOCAL_TASK,
          'weight' => 2);
Dries's avatar
 
Dries committed
135 136 137
      }
    }
  }
Dries's avatar
 
Dries committed
138 139 140 141

  return $items;
}

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

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

174 175
    return $block;
  }
Dries's avatar
 
Dries committed
176 177
}

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

185 186 187
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
188
function book_insert($node) {
189
  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
190
}
Dries's avatar
 
Dries committed
191

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

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

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

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

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

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

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

280
  return $form;
Dries's avatar
 
Dries committed
281 282
}

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

291 292 293
  $form['parent'] = array('#type' => 'select',
    '#title' => t('Parent'),
    '#default_value' => $page->parent,
294
    '#options' => book_toc($node->nid),
295 296 297 298 299 300 301 302 303 304 305 306 307
    '#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'),
    '#default_value' => $node->log,
    '#description' => t('An explanation to help other authors understand your motivations to put this post into the book.'),
  );
Dries's avatar
 
Dries committed
308

309 310 311 312 313 314 315 316 317 318 319 320
  $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
321

322 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
  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
348
  }
349
  return "node/$node->nid";
Dries's avatar
 
Dries committed
350 351
}

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

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

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

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

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

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

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

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

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

442 443 444 445 446 447
/**
 * Implementation of hook_view().
 *
 * If not displayed on the main page, we render the node as a page in the
 * book with extra links to the previous and next pages.
 */
Dries's avatar
 
Dries committed
448
function book_view(&$node, $teaser = FALSE, $page = FALSE) {
449
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
450 451
}

452
/**
Dries's avatar
 
Dries committed
453 454 455
 * Implementation of hook_nodeapi().
 *
 * Appends book navigation to all nodes in the book.
456
 */
Dries's avatar
 
Dries committed
457 458 459 460
function book_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
    case 'view':
      if (!$teaser) {
461
        $book = db_fetch_array(db_query('SELECT * FROM {book} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
462 463 464 465
        if ($book) {
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
466 467 468 469 470 471 472 473 474 475 476

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

          $node->body .= theme('book_navigation', $node);

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

492
/**
493
 * Prepares the links to children (TOC) and forward/backward
494
 * navigation for a node presented as a book page.
495 496
 *
 * @ingroup themeable
497
 */
498
function theme_book_navigation($node) {
499
  $output = '';
500
  $links = '';
501

Dries's avatar
 
Dries committed
502
  if ($node->nid) {
503
    $tree = book_tree($node->nid);
Dries's avatar
 
Dries committed
504

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

518 519 520 521 522 523 524 525 526 527
    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
528
  }
Dries's avatar
 
Dries committed
529

530
  return $output;
Dries's avatar
 
Dries committed
531
}
Dries's avatar
 
Dries committed
532

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

  return $toc;
}

549 550 551
/**
 * Returns an array of titles and nid entries of book pages in table of contents order.
 */
552
function book_toc($exclude = 0) {
553
  $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
554

555
  $children = array();
Dries's avatar
 
Dries committed
556
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
557 558 559
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
560
    $children[$node->parent][] = $node;
Dries's avatar
 
Dries committed
561
  }
Dries's avatar
 
Dries committed
562

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

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

Dries's avatar
 
Dries committed
571 572 573
  return $toc;
}

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

  return $output;
}

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

Dries's avatar
 
Dries committed
615
  while ($node = db_fetch_object($result)) {
616
    $list = isset($children[$node->parent]) ? $children[$node->parent] : array();
617
    $list[] = $node;
Dries's avatar
 
Dries committed
618
    $children[$node->parent] = $list;
Dries's avatar
 
Dries committed
619
  }
Dries's avatar
 
Dries committed
620

Dries's avatar
 
Dries committed
621
  if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
622
    return '<ul class="menu">'. $tree .'</ul>';
Dries's avatar
 
Dries committed
623
  }
Dries's avatar
 
Dries committed
624 625
}

626
/**
Dries's avatar
Dries committed
627
 * Menu callback; prints a listing of all books.
628
 */
Dries's avatar
 
Dries committed
629
function book_render() {
630
  $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
631

632 633 634 635 636 637
  $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
638 639
}

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

  if (function_exists($export_function)) {
    print call_user_func($export_function, $nid, $depth);
669 670
  }
  else {
671
    drupal_set_message(t('Unknown export format.'));
672
    drupal_not_found();
673
  }
674
}
Dries's avatar
 
Dries committed
675

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

714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
/**
 * 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;
}

731
/**
732
 * Traverses the book tree. Applies the $visit_pre() callback to each
733
 * node, is called recursively for each child of the node (in weight,
734
 * title order). Finally appends the output of the $visit_post()
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
 * 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) {
750
  $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
751
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
752
    // Load the node:
753
    $node = node_load($page->nid);
Dries's avatar
 
Dries committed
754

Dries's avatar
 
Dries committed
755
    if ($node) {
756 757
      if (function_exists($visit_pre)) {
        $output .= call_user_func($visit_pre, $node, $depth, $nid);
Dries's avatar
 
Dries committed
758
      }
759 760
      else {
        $output .= book_node_visitor_html_pre($node, $depth, $nid);
Dries's avatar
 
Dries committed
761
      }
Dries's avatar
 
Dries committed
762

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

Dries's avatar
 
Dries committed
780 781
  return $output;
}
Dries's avatar
 
Dries committed
782

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

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

  if ($node->body) {
    $output .= $node->body;
  }
  return $output;
}

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

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

837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
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,
    ),
853
  );
854 855 856 857 858 859 860

  $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
861 862
}

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

866
  $rows = array();
867 868
  foreach (element_children($form) as $key) {
    $nid = $form[$key]['nid']['#value'];
869
    $pid = $form[0]['nid']['#value'];
870 871 872 873