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

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

9
/**
10
 * Implementation of hook_node_info().
11
 */
12
function book_node_info() {
13
  return array('book' => array('name' => t('book page'), 'base' => 'book'));
Dries's avatar
 
Dries committed
14 15
}

16 17 18
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
19
function book_perm() {
20
    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
21 22
}

23 24 25
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
26
function book_access($op, $node) {
Dries's avatar
 
Dries committed
27
  global $user;
Dries's avatar
 
Dries committed
28

29
  if ($op == 'create') {
Dries's avatar
 
Dries committed
30 31
    // Only registered users can create book pages.  Given the nature
    // of the book module this is considered to be a good/safe idea.
32
    return user_access('create book pages');
Dries's avatar
 
Dries committed
33 34
  }

35
  if ($op == 'update') {
Dries's avatar
 
Dries committed
36 37 38
    // Only registered users can update book pages.  Given the nature
    // 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
39 40
    // of that page waiting for approval.  That is, only updates that
    // don't overwrite the current or pending information are allowed.
41

42
    if ((user_access('edit book pages') && !$node->moderate) || ($node->uid == $user->uid && user_access('edit own book pages'))) {
43 44 45 46 47
      return TRUE;
    }
    else {
       // do nothing. node-access() will determine further access
    }
Dries's avatar
 
Dries committed
48
  }
Dries's avatar
 
Dries committed
49 50
}

Dries's avatar
 
Dries committed
51 52 53
/**
 * Implementation of hook_link().
 */
Dries's avatar
 
Dries committed
54
function book_link($type, $node = 0, $main = 0) {
Dries's avatar
 
Dries committed
55 56 57

  $links = array();

58
  if ($type == 'node' && isset($node->parent)) {
Dries's avatar
 
Dries committed
59
    if (!$main) {
Dries's avatar
 
Dries committed
60 61 62
      if (book_access('create', $node)) {
        $links[] = l(t('add child page'), "node/add/book/parent/$node->nid");
      }
63
      if (user_access('see printer-friendly version')) {
64 65 66
        $links[] = l(t('printer-friendly version'),
                     'book/export/html/'. $node->nid,
                     array('title' => t('Show a printer-friendly version of this book page and its sub-pages.')));
67
      }
Dries's avatar
 
Dries committed
68
    }
Dries's avatar
 
Dries committed
69 70
  }

Dries's avatar
 
Dries committed
71
  return $links;
Dries's avatar
 
Dries committed
72 73
}

Dries's avatar
 
Dries committed
74 75 76
/**
 * Implementation of hook_menu().
 */
Dries's avatar
 
Dries committed
77
function book_menu($may_cache) {
Dries's avatar
 
Dries committed
78 79
  $items = array();

Dries's avatar
 
Dries committed
80
  if ($may_cache) {
81 82 83 84 85 86 87 88 89
    $items[] = array(
      'path' => 'book',
      'title' => t('books'),
      'access' => user_access('access content'),
      'type' => MENU_NORMAL_ITEM,
      'weight' => 5);
    $items[] = array(
      'path' => 'node/add/book',
      'title' => t('book page'),
90
      'access' => user_access('create book pages'));
91 92 93
    $items[] = array(
      'path' => 'admin/node/book',
      'title' => t('books'),
Dries's avatar
 
Dries committed
94 95
      'callback' => 'book_admin',
      'access' => user_access('administer nodes'),
96 97 98 99 100 101
      'type' => MENU_LOCAL_TASK,
      'weight' => -1);
    $items[] = array(
      'path' => 'admin/node/book/list',
      'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK);
102 103 104
    $items[] = array(
      'path' => 'admin/node/book/orphan',
      '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) {
Dries's avatar
 
Dries committed
182
  global $user;
Dries's avatar
 
Dries committed
183

184
  $book = db_fetch_object(db_query('SELECT parent, weight FROM {book} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
185

Dries's avatar
 
Dries committed
186
  if (arg(2) == 'edit' && !user_access('administer nodes')) {
Dries's avatar
 
Dries committed
187 188
    // If a user is about to update a book page, we overload some
    // fields to reflect the changes.
Dries's avatar
 
Dries committed
189 190 191 192 193 194
    if ($user->uid) {
      $book->uid = $user->uid;
      $book->name = $user->name;
    }
    else {
      $book->uid = 0;
195
      $book->name = '';
Dries's avatar
 
Dries committed
196
    }
Dries's avatar
 
Dries committed
197
  }
Dries's avatar
 
Dries committed
198

Dries's avatar
 
Dries committed
199
  return $book;
Dries's avatar
 
Dries committed
200 201
}

202 203 204
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
205
function book_insert($node) {
206
  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
207
}
Dries's avatar
 
Dries committed
208

209 210 211
/**
 * Implementation of hook_update().
 */
Dries's avatar
 
Dries committed
212
function book_update($node) {
213
  if ($node->revision) {
214
    db_query("INSERT INTO {book} (nid, vid, parent, weight) VALUES (%d, %d, %d, %d)", $node->nid, $node->vid, $node->parent, $node->weight);
215 216 217 218
  }
  else {
    db_query("UPDATE {book} SET parent = %d, weight = %d WHERE vid = %d", $node->parent, $node->weight, $node->vid);
  }
Dries's avatar
 
Dries committed
219
}
Dries's avatar
 
Dries committed
220

221 222 223
/**
 * Implementation of hook_delete().
 */
224
function book_delete(&$node) {
225
  db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
Dries's avatar
 
Dries committed
226 227
}

228
/**
229
 * Implementation of hook_submit().
230
 */
231
function book_submit(&$node) {
232 233
  // Set default values for non-administrators.
  if (!user_access('administer nodes')) {
234 235 236
    $node->weight = 0;
    $node->revision = 1;
  }
237
}
238

239 240 241 242
/**
 * Implementation of hook_validate().
 */
function book_validate($node) {
243
  node_validate_title($node);
Dries's avatar
 
Dries committed
244 245
}

246 247 248
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
249
function book_form(&$node) {
250 251 252
  $form['parent'] = array('#type' => 'select',
    '#title' => t('Parent'),
    '#default_value' => ($node->parent ? $node->parent : arg(4)),
253
    '#options' => book_toc($node->nid, $node->parent),
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
    '#weight' => -4,
    '#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.'),
  );

  $form['title'] = array('#type' => 'textfield',
    '#title' => t('Title'),
    '#required' => TRUE,
    '#default_value' => $node->title,
    '#weight' => -5,
  );
  $form['body_filter']['body'] = array('#type' => 'textarea',
    '#title' => t('Body'),
    '#default_value' => $node->body,
    '#rows' => 20,
    '#required' => TRUE,
  );
270
  $form['body_filter']['format'] = filter_form($node->format);
271

272
  $form['log'] = array(
273 274 275 276 277
    '#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.'),
278
  );
Dries's avatar
 
Dries committed
279

280
  if (user_access('administer nodes')) {
281 282 283 284 285 286
    $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.'),
287
    );
Dries's avatar
 
Dries committed
288 289
  }
  else {
Dries's avatar
 
Dries committed
290 291
    // If a regular user updates a book page, we create a new revision
    // authored by that user:
292
    $form['revision'] = array('#type' => 'hidden', '#value' => 1);
Dries's avatar
 
Dries committed
293 294
  }

295
  return $form;
Dries's avatar
 
Dries committed
296 297
}

298
/**
Dries's avatar
 
Dries committed
299 300
 * Implementation of function book_outline()
 * Handles all book outline operations.
301
 */
302 303
function book_outline($nid) {
  $node = node_load($nid);
304
  $page = book_load($node);
Dries's avatar
 
Dries committed
305

306 307 308
  $form['parent'] = array('#type' => 'select',
    '#title' => t('Parent'),
    '#default_value' => $page->parent,
309
    '#options' => book_toc($node->nid, $page->parent),
310 311 312 313 314 315 316 317 318 319 320 321 322
    '#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
323

324 325 326 327 328 329 330 331 332 333 334 335
  $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
336

337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
  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
363
  }
364
  return "node/$node->nid";
Dries's avatar
 
Dries committed
365 366
}

367 368 369
/**
 * Return the path (call stack) to a certain book page.
 */
Dries's avatar
 
Dries committed
370
function book_location($node, $nodes = array()) {
371
  $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));
Dries's avatar
 
Dries committed
372 373 374 375 376 377 378
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

379 380 381
/**
 * Accumulates the nodes up to the root of the book from the given node in the $nodes array.
 */
Dries's avatar
 
Dries committed
382
function book_location_down($node, $nodes = array()) {
383
  $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.nid = b.nid WHERE n.status = 1 AND b.parent = %d ORDER BY b.weight DESC, n.title DESC'), $node->nid));
Dries's avatar
 
Dries committed
384 385 386 387 388 389 390
  if ($last_direct_child) {
    array_push($nodes, $last_direct_child);
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

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

Dries's avatar
 
Dries committed
400
  // Previous on the same level:
401
  $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 n.moderate = 0 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
402
  if ($direct_above) {
Dries's avatar
 
Dries committed
403
    // Get last leaf of $above.
Dries's avatar
 
Dries committed
404
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
405 406

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
407 408
  }
  else {
Dries's avatar
 
Dries committed
409
    // Direct parent:
410
    $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 AND n.moderate = 0'), $node->parent));
Dries's avatar
 
Dries committed
411 412 413 414
    return $prev;
  }
}

415
/**
416
 * Fetches the node object of the next page of the book.
417
 */
Dries's avatar
 
Dries committed
418 419
function book_next($node) {
  // get first direct child
420
  $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 AND n.moderate = 0 ORDER BY b.weight ASC, n.title ASC'), $node->nid));
Dries's avatar
 
Dries committed
421 422 423 424
  if ($child) {
    return $child;
  }

Dries's avatar
 
Dries committed
425 426
  // No direct child: get next for this level or any parent in this book.
  array_push($path = book_location($node), $node); // Path to top-level node including this one.
427

Dries's avatar
 
Dries committed
428
  while (($leaf = array_pop($path)) && count($path)) {
429
    $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 n.moderate = 0 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
430 431 432 433 434 435
    if ($next) {
      return $next;
    }
  }
}

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

447 448 449 450 451 452
/**
 * 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
453
function book_view(&$node, $teaser = FALSE, $page = FALSE) {
454
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
455 456
}

457
/**
Dries's avatar
 
Dries committed
458 459 460
 * Implementation of hook_nodeapi().
 *
 * Appends book navigation to all nodes in the book.
461
 */
Dries's avatar
 
Dries committed
462 463 464 465
function book_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
    case 'view':
      if (!$teaser) {
466
        $book = db_fetch_array(db_query('SELECT * FROM {book} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
467
        if ($book) {
468
          if ($node->moderate && user_access('administer nodes')) {
469
            drupal_set_message(t("The post has been submitted for moderation and won't be accessible until it has been approved."));
470 471
          }

Dries's avatar
 
Dries committed
472 473 474
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
475 476 477 478 479 480 481 482 483 484 485

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

486 487 488
          if ($page) {
            menu_set_location($node->breadcrumb);
          }
Dries's avatar
 
Dries committed
489
        }
Dries's avatar
 
Dries committed
490
      }
Dries's avatar
 
Dries committed
491
      break;
492
    case 'delete revision':
493 494
      db_query('DELETE FROM {book} WHERE vid = %d', $node->vid);
      break;
495 496 497
    case 'delete':
      db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
      break;
Dries's avatar
 
Dries committed
498
  }
Dries's avatar
 
Dries committed
499
}
Dries's avatar
 
Dries committed
500

501 502 503
/**
 * Prepares both the custom breadcrumb trail and the forward/backward
 * navigation for a node presented as a book page.
504 505
 *
 * @ingroup themeable
506
 */
507
function theme_book_navigation($node) {
508 509
  $output = '';

Dries's avatar
 
Dries committed
510
  if ($node->nid) {
511
    $tree = book_tree($node->nid);
Dries's avatar
 
Dries committed
512

Dries's avatar
 
Dries committed
513
    if ($prev = book_prev($node)) {
514
      drupal_add_link(array('rel' => 'prev', 'href' => url('node/'. $prev->nid)));
515
      $links .= l(t('‹ ') . $prev->title, 'node/'. $prev->nid, array('class' => 'page-previous', 'title' => t('Go to previous page')));
Dries's avatar
 
Dries committed
516
    }
517 518 519
    if ($node->parent) {
      drupal_add_link(array('rel' => 'index', 'href' => url('node/'. $node->parent)));
      $links .= l(t('up'), 'node/'. $node->parent, array('class' => 'page-up', 'title' => t('Go to parent page')));
Dries's avatar
 
Dries committed
520 521
    }
    if ($next = book_next($node)) {
522
      drupal_add_link(array('rel' => 'next', 'href' => url('node/'. $next->nid)));
523
      $links .= l($next->title . t(' ›'), 'node/'. $next->nid, array('class' => 'page-next', 'title' => t('Go to next page')));
Dries's avatar
 
Dries committed
524
    }
Dries's avatar
 
Dries committed
525

526 527 528 529 530 531 532 533 534 535
    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
536
  }
Dries's avatar
 
Dries committed
537

538
  return $output;
Dries's avatar
 
Dries committed
539
}
Dries's avatar
 
Dries committed
540

541 542 543
/**
 * This is a helper function for book_toc().
 */
544
function book_toc_recurse($nid, $indent, $toc, $children, $exclude) {
Dries's avatar
 
Dries committed
545 546
  if ($children[$nid]) {
    foreach ($children[$nid] as $foo => $node) {
547 548 549 550
      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
551 552 553 554 555 556
    }
  }

  return $toc;
}

557 558 559
/**
 * Returns an array of titles and nid entries of book pages in table of contents order.
 */
560
function book_toc($exclude, $parent) {
561
  $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
562

Dries's avatar
 
Dries committed
563
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
564 565 566 567
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
    array_push($children[$node->parent], $node);
Dries's avatar
 
Dries committed
568
  }
Dries's avatar
 
Dries committed
569

570
  $toc = array();
571
  // If the user has permission to create new books, add the top-level book page to the menu;
572
  if (user_access('create new books') || ($exclude && !$parent)) {
573
    $toc[0] = '<'. t('top-level') .'>';
Dries's avatar
 
Dries committed
574 575
  }

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

Dries's avatar
 
Dries committed
578 579 580
  return $toc;
}

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

  return $output;
}

614 615 616 617
/**
 * Returns an HTML nested list (wrapped in a menu-class div) representing the book nodes
 * as a tree.
 */
Dries's avatar
 
Dries committed
618
function book_tree($parent = 0, $depth = 3, $unfold = array()) {
619
  $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 AND n.moderate = 0 ORDER BY b.weight, n.title'));
Dries's avatar
 
Dries committed
620

Dries's avatar
 
Dries committed
621 622 623 624
  while ($node = db_fetch_object($result)) {
    $list = $children[$node->parent] ? $children[$node->parent] : array();
    array_push($list, $node);
    $children[$node->parent] = $list;
Dries's avatar
 
Dries committed
625
  }
Dries's avatar
 
Dries committed
626

Dries's avatar
 
Dries committed
627
  if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
628
    return '<ul class="menu">'. $tree .'</ul>';
Dries's avatar
 
Dries committed
629
  }
Dries's avatar
 
Dries committed
630 631
}

632
/**
Dries's avatar
Dries committed
633
 * Menu callback; prints a listing of all books.
634
 */
Dries's avatar
 
Dries committed
635
function book_render() {
636
  $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 AND n.moderate = 0 ORDER BY b.weight, n.title'));
Dries's avatar
 
Dries committed
637

638 639 640 641 642 643
  $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
644 645
}

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

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

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

    }
    $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>". check_plain($node->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". $output . "\n</body>\n</html>\n";
    return $html;
  }
  else {
    drupal_access_denied();
  }
}

723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
/**
 * 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;
}

740
/**
741 742 743
 * Given a node, this function returns the depth of the node in its hierarchy.
 * A root node has depth 1, and children of a node of depth n have depth (n+1).
 *
744 745
 * @param nid
 *   - the nid of the node whose depth to compute.
746 747 748
 * @return
 *   - the depth of the given node in its hierarchy.  Returns 0 if the node
 *  does not exist or is not part of a book hierarchy.
749
 */
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
function _book_get_depth($nid) {
  $depth = 0;
  if ($nid) {
    while ($nid) {
      $result = db_query(db_rewrite_sql('SELECT b.parent FROM {book} b WHERE b.nid = %d'), $nid);
      $obj =  db_fetch_object($result);
      $parent = $obj->parent;
      if ($nid == $parent->parent) {
        $nid = 0;
      }
      else {
        $nid = $parent;
      }
      $depth++;
    }
    return $depth;
  }
  else {
    return 0;
  }
Dries's avatar
 
Dries committed
770 771
}

772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
/**
 * Traverses the book tree.  Applies the $visit_pre() callback to each
 * node, is called recursively for each child of the node (in weight,
 * title order).  Finally appends the output of the $visit_post()
 * 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) {
791
  $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 AND n.moderate = 0 ORDER BY b.weight, n.title'), $nid);
Dries's avatar
 
Dries committed
792
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
793
    // Load the node:
794
    $node = node_load($page->nid);
Dries's avatar
 
Dries committed
795

Dries's avatar
 
Dries committed
796
    if ($node) {
797 798
      if (function_exists($visit_pre)) {
        $output .= call_user_func($visit_pre, $node, $depth, $nid);
Dries's avatar
 
Dries committed
799
      }
800 801
      else {
        $output .= book_node_visitor_html_pre($node, $depth, $nid);
Dries's avatar
 
Dries committed
802
      }
Dries's avatar
 
Dries committed
803

804
      $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 AND n.moderate = 0 ORDER BY b.weight, n.title'), $node->nid);
805
      while ($childpage = db_fetch_object($children)) {
806
          $childnode = node_load($childpage->nid);
807
          if ($childnode->nid != $node->nid) {
808
              $output .= book_recurse($childnode->nid, $depth + 1, $visit_pre, $visit_post);
809 810 811
          }
      }
      if (function_exists($visit_post)) {
812
        $output .= call_user_func($visit_post, $node, $depth);
813
      }
814 815
      else {
        # default
816
        $output .= book_node_visitor_html_post($node, $depth);
817
      }
Dries's avatar
 
Dries committed
818
    }
Dries's avatar
 
Dries committed
819
  }
Dries's avatar
 
Dries committed
820

Dries's avatar
 
Dries committed
821 822
  return $output;
}
Dries's avatar
 
Dries committed
823

824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
/**
 * Generates printer-friendly HTML for a node.  This function
 * 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.
 */
839
function book_node_visitor_html_pre($node, $depth, $nid) {
840 841 842 843 844
  // Output the content:
  if (node_hook($node, 'content')) {
    $node = node_invoke($node, 'content');
  }
  // Allow modules to change $node->body before viewing.
845
  node_invoke_nodeapi($node, 'print', $node->body, false);
846

847 848
  $output .= "<div id=\"node-". $node->nid ."\" class=\"section-$depth\">\n";
  $output .= "<h1 class=\"book-heading\">". check_plain($node->title) ."</h1>\n";
849 850 851 852 853 854 855 856 857 858 859 860

  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().
 */
861
function book_node_visitor_html_post($node, $depth) {
862 863 864
  return "</div>\n";
}

865 866 867 868 869 870 871 872 873 874 875
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;
876 877
}

878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
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,
    ),
894
  );
895 896 897 898 899 900 901

  $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
902 903
}

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

907
  $rows = array();
908 909 910 911 912 913 914 915 916
  foreach (element_children($form) as $key) {
    $nid = $form[$key]['nid']['#value'];
    $rows[] = array(
      '<div style="padding-left: '. (25 * $form[$key]['depth']['#value']) .'px;">'. form_render($form[$key]['title']) .'</div>',
      form_render($form[$key]['weight']),
      l(t('view'), 'node/'. $nid),
      l(t('edit'), 'node/'. $nid .'/edit'),
      l(t('delete'), 'node/'. $nid .'/delete')
    );
Dries's avatar
 
Dries committed
917 918
  }

919
  return theme('table', $header, $rows);
Dries's avatar
 
Dries committed
920 921
}

922 923 924
/**
 * Display an administrative view of the hierarchy of a book.
 */
925
function book_admin_edit($nid) {
926
  $node = node_load($nid);
927
  if ($node->nid) {
928
    drupal_set_title(check_plain($node->title));
929
    $form = array();
930

931 932 933 934 935
    $form['table'] = _book_admin_table(array($node));
    $form['save'] = array(
      '#type' => 'submit',
      '#value' => t('Save book pages'),
    );
Dries's avatar
 
Dries committed
936

937
    return drupal_get_form('book_admin_edit', $form);
Dries's avatar
 
Dries committed
938
  }
939 940 941
  else {
    drupal_not_found();
  }
Dries's avatar
 
Dries committed
942 943
}

944
/**
945
 * Menu callback; displays a listing of all orphaned book pages.
946
 */
947 948
function book_admin_orphan() {
  $result = db_query(db_rewrite_sql('SELECT n.nid, n.title, n.status, b.parent FROM {node} n INNER JOIN {book} b ON n.vid = b.vid'));
Dries's avatar
 
Dries committed
949

950 951 952 953 954 955 956 957 958 959
  $pages = array();
  while ($page = db_fetch_object($result)) {
    $pages[$page->nid] = $page;
  }

  $orphans = array();
  if (count($pages)) {
    foreach ($pages as $page) {
      if ($page->parent && empty($pages[$page->parent])) {
        $orphans[] = node_load($page->nid);
Dries's avatar
 
Dries committed
960
      }
Dries's avatar
 
Dries committed
961
    }
962
  }
Dries's avatar
 
Dries committed
963

964 965
  if (count($orphans)) {
    $form = array();
Dries's avatar
 
Dries committed
966

967 968 969 970 971 972 973 974 975 976
    $form['table'] = _book_admin_table($orphans);
    $form['save'] = array(
      '#type' => 'submit',
      '#value' => t('Save book pages'),
    );

    return drupal_get_form('book_admin_edit', $form);
  }
  else {
    return '<p>'. t('There are no orphan pages.') .'</p>';
Dries's avatar
 
Dries committed
977
  }
Dries's avatar
 
Dries committed
978 979
}