book.module 36.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
  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) {
Dries's avatar
 
Dries committed
181
  global $user;
Dries's avatar
 
Dries committed
182

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

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

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

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

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

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

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

238 239 240
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
241
function book_form(&$node) {
242
  if ($node->nid && !$node->parent && !user_access('create new books')) {
243
    $form['parent'] = array('#type' => 'value', '#value' => $node->parent);
244 245 246 247 248 249 250
  }
  else {
    $form['parent'] = array('#type' => 'select',
      '#title' => t('Parent'),
      '#default_value' => ($node->parent ? $node->parent : arg(4)),
      '#options' => book_toc($node->nid),
      '#weight' => -4,
251
      '#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.'),
252 253
    );
  }
254 255 256 257 258 259 260 261 262 263 264 265 266

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

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

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

292
  return $form;
Dries's avatar
 
Dries committed
293 294
}

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

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

321 322 323 324 325 326 327 328 329 330 331 332
  $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
333

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

364
/**
Dries's avatar
Dries committed
365 366
 * Given a node, this function returns an array of 'book node' objects
 * representing the path in the book tree from the root to the
367
 * parent of the given node.
Dries's avatar
Dries committed
368
 *
369 370 371 372 373 374
 * @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.
 *
375
 */
Dries's avatar
 
Dries committed
376
function book_location($node, $nodes = array()) {
377
  $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
378 379
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
380
    $nodes[] = $parent;
Dries's avatar
 
Dries committed
381 382 383 384
  }
  return $nodes;
}

385 386 387
/**
 * Accumulates the nodes up to the root of the book from the given node in the $nodes array.
 */
Dries's avatar
 
Dries committed
388
function book_location_down($node, $nodes = array()) {
389
  $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
390
  if ($last_direct_child) {
391
    $nodes[] = $last_direct_child;
Dries's avatar
 
Dries committed
392 393 394 395 396
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

397
/**
398
 * Fetches the node object of the previous page of the book.
399
 */
Dries's avatar
 
Dries committed
400
function book_prev($node) {
Dries's avatar
 
Dries committed
401
  // If the parent is zero, we are at the start of a book so there is no previous.
Dries's avatar
 
Dries committed
402 403 404 405
  if ($node->parent == 0) {
    return NULL;
  }

Dries's avatar
 
Dries committed
406
  // Previous on the same level:
407
  $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
408
  if ($direct_above) {
Dries's avatar
 
Dries committed
409
    // Get last leaf of $above.
Dries's avatar
 
Dries committed
410
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
411 412

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
413 414
  }
  else {
Dries's avatar
 
Dries committed
415
    // Direct parent:
416
    $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
417 418 419 420
    return $prev;
  }
}

421
/**
422
 * Fetches the node object of the next page of the book.
423
 */
Dries's avatar
 
Dries committed
424 425
function book_next($node) {
  // get first direct child
426
  $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
427 428 429 430
  if ($child) {
    return $child;
  }

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

Dries's avatar
 
Dries committed
435
  while (($leaf = array_pop($path)) && count($path)) {
436
    $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
437 438 439 440 441 442
    if ($next) {
      return $next;
    }
  }
}

443
/**
444 445
 * Returns the content of a given node. If $teaser if true, returns
 * the teaser rather than full content. Displays the most recently
446 447 448
 * 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
449
function book_content($node, $teaser = FALSE) {
450 451
  // Return the page body.
  return node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
452 453
}

454 455 456 457 458 459
/**
 * 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
460
function book_view(&$node, $teaser = FALSE, $page = FALSE) {
461
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
462 463
}

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

Dries's avatar
 
Dries committed
479 480 481
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
482 483 484 485 486 487 488 489 490 491 492

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

493 494 495
          if ($page) {
            menu_set_location($node->breadcrumb);
          }
Dries's avatar
 
Dries committed
496
        }
Dries's avatar
 
Dries committed
497
      }
Dries's avatar
 
Dries committed
498
      break;
499
    case 'delete revision':
500 501
      db_query('DELETE FROM {book} WHERE vid = %d', $node->vid);
      break;
502 503 504
    case 'delete':
      db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
      break;
Dries's avatar
 
Dries committed
505
  }
Dries's avatar
 
Dries committed
506
}
Dries's avatar
 
Dries committed
507

508
/**
509
 * Prepares the links to children (TOC) and forward/backward
510
 * navigation for a node presented as a book page.
511 512
 *
 * @ingroup themeable
513
 */
514
function theme_book_navigation($node) {
515 516
  $output = '';

Dries's avatar
 
Dries committed
517
  if ($node->nid) {
518
    $tree = book_tree($node->nid);
Dries's avatar
 
Dries committed
519

Dries's avatar
 
Dries committed
520
    if ($prev = book_prev($node)) {
521
      drupal_add_link(array('rel' => 'prev', 'href' => url('node/'. $prev->nid)));
522
      $links .= l(t('‹ ') . $prev->title, 'node/'. $prev->nid, array('class' => 'page-previous', 'title' => t('Go to previous page')));
Dries's avatar
 
Dries committed
523
    }
524 525 526
    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
527 528
    }
    if ($next = book_next($node)) {
529
      drupal_add_link(array('rel' => 'next', 'href' => url('node/'. $next->nid)));
530
      $links .= l($next->title . t(' ›'), 'node/'. $next->nid, array('class' => 'page-next', 'title' => t('Go to next page')));
Dries's avatar
 
Dries committed
531
    }
Dries's avatar
 
Dries committed
532

533 534 535 536 537 538 539 540 541 542
    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
543
  }
Dries's avatar
 
Dries committed
544

545
  return $output;
Dries's avatar
 
Dries committed
546
}
Dries's avatar
 
Dries committed
547

548 549 550
/**
 * This is a helper function for book_toc().
 */
551
function book_toc_recurse($nid, $indent, $toc, $children, $exclude) {
Dries's avatar
 
Dries committed
552 553
  if ($children[$nid]) {
    foreach ($children[$nid] as $foo => $node) {
554 555 556 557
      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
558 559 560 561 562 563
    }
  }

  return $toc;
}

564 565 566
/**
 * Returns an array of titles and nid entries of book pages in table of contents order.
 */
567
function book_toc($exclude = 0) {
568
  $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
569

Dries's avatar
 
Dries committed
570
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
571 572 573
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
574
    $children[$node->parent][] = $node;
Dries's avatar
 
Dries committed
575
  }
Dries's avatar
 
Dries committed
576

577
  $toc = array();
578
  // If the user has permission to create new books, add the top-level book page to the menu;
579
  if (user_access('create new books')) {
580
    $toc[0] = '<'. t('top-level') .'>';
Dries's avatar
 
Dries committed
581 582
  }

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

Dries's avatar
 
Dries committed
585 586 587
  return $toc;
}

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

  return $output;
}

621 622 623 624
/**
 * Returns an HTML nested list (wrapped in a menu-class div) representing the book nodes
 * as a tree.
 */
Dries's avatar
 
Dries committed
625
function book_tree($parent = 0, $depth = 3, $unfold = array()) {
626
  $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
627

Dries's avatar
 
Dries committed
628 629
  while ($node = db_fetch_object($result)) {
    $list = $children[$node->parent] ? $children[$node->parent] : array();
630
    $list[] = $node;
Dries's avatar
 
Dries committed
631
    $children[$node->parent] = $list;
Dries's avatar
 
Dries committed
632
  }
Dries's avatar
 
Dries committed
633

Dries's avatar
 
Dries committed
634
  if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
635
    return '<ul class="menu">'. $tree .'</ul>';
Dries's avatar
 
Dries committed
636
  }
Dries's avatar
 
Dries committed
637 638
}

639
/**
Dries's avatar
Dries committed
640
 * Menu callback; prints a listing of all books.
641
 */
Dries's avatar
 
Dries committed
642
function book_render() {
643
  $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
644

645 646 647 648 649 650
  $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
651 652
}

653
/**
654 655 656
 * Menu callback; Generates various representation of a book page with
 * all descendants and prints the requested representation to output.
 *
657 658
 * The function delegates the generation of output to helper functions.
 * The function name is derived by prepending 'book_export_' to the
659
 * given output type. So, e.g., a type of 'html' results in a call to
660
 * the function book_export_html().
661 662 663
 *
 * @param type
 *   - a string encoding the type of output requested.
664 665 666
 *       The following types are currently supported in book module
 *          html: HTML (printer friendly output)
 *       Other types are supported in contributed modules.
667 668 669
 * @param nid
 *   - an integer representing the node id (nid) of the node to export
 *
670
 */
671
function book_export($type = 'html', $nid = 0) {
672
  $type = drupal_strtolower($type);
673 674 675 676 677
  $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;
678 679 680 681
  $export_function = 'book_export_' . $type;

  if (function_exists($export_function)) {
    print call_user_func($export_function, $nid, $depth);
682 683
  }
  else {
684
    drupal_set_message(t('Unknown export format.'));
685
    drupal_not_found();
686
  }
687
}
Dries's avatar
 
Dries committed
688

689 690 691 692
/**
 * 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
693
 * section/. For example, a child node with depth 2 in the hierarchy
694
 * is contained in (otherwise empty) &lt;div&gt; elements
695
 * corresponding to depth 0 and depth 1. This is intended to support
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 723 724 725 726 727 728 729 730 731 732 733
 * 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();
  }
}

734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
/**
 * 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;
}

751
/**
752
 * Traverses the book tree. Applies the $visit_pre() callback to each
753
 * node, is called recursively for each child of the node (in weight,
754
 * title order). Finally appends the output of the $visit_post()
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
 * 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) {
770
  $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
771
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
772
    // Load the node:
773
    $node = node_load($page->nid);
Dries's avatar
 
Dries committed
774

Dries's avatar
 
Dries committed
775
    if ($node) {
776 777
      if (function_exists($visit_pre)) {
        $output .= call_user_func($visit_pre, $node, $depth, $nid);
Dries's avatar
 
Dries committed
778
      }
779 780
      else {
        $output .= book_node_visitor_html_pre($node, $depth, $nid);
Dries's avatar
 
Dries committed
781
      }
Dries's avatar
 
Dries committed
782

783
      $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);
784
      while ($childpage = db_fetch_object($children)) {
785
          $childnode = node_load($childpage->nid);
786
          if ($childnode->nid != $node->nid) {
787
              $output .= book_recurse($childnode->nid, $depth + 1, $visit_pre, $visit_post);
788 789 790
          }
      }
      if (function_exists($visit_post)) {
791
        $output .= call_user_func($visit_post, $node, $depth);
792
      }
793 794
      else {
        # default
795
        $output .= book_node_visitor_html_post($node, $depth);
796
      }
Dries's avatar
 
Dries committed
797
    }
Dries's avatar
 
Dries committed
798
  }
Dries's avatar
 
Dries committed
799

Dries's avatar
 
Dries committed
800 801
  return $output;
}
Dries's avatar
 
Dries committed
802

803
/**
804
 * Generates printer-friendly HTML for a node. This function
805 806 807 808 809 810 811 812 813 814 815 816 817
 * 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.
 */
818
function book_node_visitor_html_pre($node, $depth, $nid) {
819 820 821 822 823
  // Output the content:
  if (node_hook($node, 'content')) {
    $node = node_invoke($node, 'content');
  }
  // Allow modules to change $node->body before viewing.
824
  node_invoke_nodeapi($node, 'print', $node->body, false);
825

826 827
  $output .= "<div id=\"node-". $node->nid ."\" class=\"section-$depth\">\n";
  $output .= "<h1 class=\"book-heading\">". check_plain($node->title) ."</h1>\n";
828 829 830 831 832 833 834 835 836 837 838 839

  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().
 */
840
function book_node_visitor_html_post($node, $depth) {
841 842 843
  return "</div>\n";
}

844 845 846 847 848 849 850 851 852 853 854
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;
855 856
}

857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
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,
    ),
873
  );
874 875 876 877 878 879 880

  $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
881 882
}

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

886
  $rows = array();
887 888
  foreach (element_children($form) as $key) {
    $nid = $form[$key]['nid']['#value'];
889
    $pid = $form[0]['nid']['#value'];
890 891 892 893 894
    $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'),
895
      l(t('delete'), 'node/'. $nid .'/delete', NULL, 'destination=admin/node/book'. (arg(3) == 'orphan' ? '/orphan' : '') . ($pid != $nid ? '/'.$pid : ''))
896
    );
Dries's avatar
 
Dries committed
897 898
  }

899
  return theme('table', $header, $rows);
Dries's avatar
 
Dries committed
900 901
}

902 903 904
/**
 * Display an administrative view of the hierarchy of a book.
 */
905
function book_admin_edit($nid) {
906
  $node = node_load($nid);
907
  if ($node->nid) {
908
    drupal_set_title(check_plain($node->title));
909
    $form = array();
910

911 912 913 914 915
    $form['table'] = _book_admin_table(array($node));
    $form['save'] = array(
      '#type' => 'submit',
      '#value' => t('Save book pages'),
    );
Dries's avatar
 
Dries committed
916