book.module 36.3 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') {
30
    // Only registered users can create book pages. Given the nature
Dries's avatar
 
Dries committed
31
    // 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') {
36
    // Only registered users can update book pages. Given the nature
Dries's avatar
 
Dries committed
37 38
    // 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
    // of that page waiting for approval. That is, only updates that
40
    // 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
      if (book_access('create', $node)) {
61 62 63 64
        $links['book_add_child'] = array(
          '#title' => t('add child page'),
          '#href' => "node/add/book/parent/$node->nid"
        );
Dries's avatar
 
Dries committed
65
      }
66
      if (user_access('see printer-friendly version')) {
67 68 69 70 71
        $links['book_printer'] = array(
          '#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.'))
        );
72
      }
Dries's avatar
 
Dries committed
73
    }
Dries's avatar
 
Dries committed
74 75
  }

Dries's avatar
 
Dries committed
76
  return $links;
Dries's avatar
 
Dries committed
77 78
}

Dries's avatar
 
Dries committed
79 80 81
/**
 * Implementation of hook_menu().
 */
Dries's avatar
 
Dries committed
82
function book_menu($may_cache) {
Dries's avatar
 
Dries committed
83 84
  $items = array();

Dries's avatar
 
Dries committed
85
  if ($may_cache) {
86 87 88
    $items[] = array(
      'path' => 'node/add/book',
      'title' => t('book page'),
89
      'access' => user_access('create book pages'));
90 91 92
    $items[] = array(
      'path' => 'admin/node/book',
      'title' => t('books'),
Dries's avatar
 
Dries committed
93 94
      'callback' => 'book_admin',
      'access' => user_access('administer nodes'),
95 96 97 98 99 100
      'type' => MENU_LOCAL_TASK,
      'weight' => -1);
    $items[] = array(
      'path' => 'admin/node/book/list',
      'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK);
101 102 103
    $items[] = array(
      'path' => 'admin/node/book/orphan',
      'title' => t('orphan pages'),
Dries's avatar
 
Dries committed
104
      'callback' => 'book_admin_orphan',
105
      'type' => MENU_LOCAL_TASK,
Dries's avatar
 
Dries committed
106
      'weight' => 8);
107 108 109
    $items[] = array(
      'path' => 'book',
      'title' => t('books'),
Dries's avatar
 
Dries committed
110 111 112
      'callback' => 'book_render',
      'access' => user_access('access content'),
      'type' => MENU_SUGGESTED_ITEM);
113
    $items[] = array(
114 115
      'path' => 'book/export',
      'callback' => 'book_export',
116
      'access' => user_access('access content'),
Dries's avatar
 
Dries committed
117
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
118
  }
Dries's avatar
 
Dries committed
119 120
  else {
    // To avoid SQL overhead, check whether we are on a node page and whether the
121 122
    // 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
123
      // Only add the outline-tab for non-book pages:
124
      $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
125
      if (db_num_rows($result) > 0) {
126 127 128 129
        $items[] = array(
          'path' => 'node/'. arg(1) .'/outline',
          'title' => t('outline'),
          'callback' => 'book_outline',
130
          'callback arguments' => array(arg(1)),
131
          'access' => user_access('outline posts in books'),
132 133
          'type' => MENU_LOCAL_TASK,
          'weight' => 2);
Dries's avatar
 
Dries committed
134 135 136
      }
    }
  }
Dries's avatar
 
Dries committed
137 138 139 140

  return $items;
}

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

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

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

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

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

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

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

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

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

  $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,
  );
253
  $form['body_filter']['format'] = filter_form($node->format);
254

255
  $form['log'] = array(
256 257 258 259 260
    '#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.'),
261
  );
Dries's avatar
 
Dries committed
262

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

278
  return $form;
Dries's avatar
 
Dries committed
279 280
}

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

289 290 291
  $form['parent'] = array('#type' => 'select',
    '#title' => t('Parent'),
    '#default_value' => $page->parent,
292
    '#options' => book_toc($node->nid),
293 294 295 296 297 298 299 300 301 302 303 304 305
    '#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
306

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

320 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
  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
346
  }
347
  return "node/$node->nid";
Dries's avatar
 
Dries committed
348 349
}

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

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

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

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

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

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

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

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

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

440 441 442 443 444 445
/**
 * 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
446
function book_view(&$node, $teaser = FALSE, $page = FALSE) {
447
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
448 449
}

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

Dries's avatar
 
Dries committed
465 466 467
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
468 469 470 471 472 473 474 475 476 477 478

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

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

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

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

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

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

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

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

  return $toc;
}

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

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

  return $output;
}

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

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

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

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

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

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

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

675 676 677 678
/**
 * 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
679
 * section/. For example, a child node with depth 2 in the hierarchy
680
 * is contained in (otherwise empty) &lt;div&gt; elements
681
 * corresponding to depth 0 and depth 1. This is intended to support
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
 * 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();
  }
}

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

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

Dries's avatar
 
Dries committed
761
    if ($node) {
762 763
      if (function_exists($visit_pre)) {
        $output .= call_user_func($visit_pre, $node, $depth, $nid);
Dries's avatar
 
Dries committed
764
      }
765 766
      else {
        $output .= book_node_visitor_html_pre($node, $depth, $nid);
Dries's avatar
 
Dries committed
767
      }
Dries's avatar
 
Dries committed
768

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

Dries's avatar
 
Dries committed
786 787
  return $output;
}
Dries's avatar
 
Dries committed
788

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

812 813
  $output .= "<div id=\"node-". $node->nid ."\" class=\"section-$depth\">\n";
  $output .= "<h1 class=\"book-heading\">". check_plain($node->title) ."</h1>\n";
814 815 816 817 818 819 820 821 822 823 824 825

  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().
 */
826
function book_node_visitor_html_post($node, $depth) {
827 828 829
  return "</div>\n";
}

830 831 832 833 834 835 836 837 838 839 840
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;
841 842
}

843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
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,
    ),
859
  );
860 861 862 863 864 865 866

  $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
867 868
}

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

872
  $rows = array();
873 874
  foreach (element_children($form) as $key) {
    $nid = $form[$key]['nid']['#value'];
875
    $pid = $form[0]['nid']['#value'];
876 877 878 879 880
    $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'),
881
      l(t('delete'), 'node/'. $nid .'/delete', NULL, 'destination=admin/node/book'. (arg(3) == 'orphan' ? '/orphan' : '') . ($pid != $nid ? '/'.$pid : ''))
882
    );
Dries's avatar
 
Dries committed
883 884
  }

885
  return theme('table', $header, $rows);
Dries's avatar
 
Dries committed
886 887
}

888 889 890
/**
 * Display an administrative view of the hierarchy of a book.
 */
891
function book_admin_edit($nid) {
892
  $node = node_load($nid);
893
  if ($node->nid) {
894
    drupal_set_title(check_plain($node->title));
895
    $form = array();
896

897 898 899 900 901
    $form['table'] = _book_admin_table(array($node));
    $form['save'] = array(
      '#type' => 'submit',
      '#value' => t('Save book pages'),
    );
Dries's avatar
 
Dries committed
902

903
    return drupal_get_form('book_admin_edit', $form);
Dries's avatar
 
Dries committed
904
  }
905 906 907
  else {
    drupal_not_found();
  }
Dries's avatar
 
Dries committed
908 909
}

910
/**
911
 * Menu callback; displays a listing of all orphaned book pages.
912
 */
913 914
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