book.module 41.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('create book pages', 'maintain books', 'edit own book pages', 'export books', '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 43 44 45 46 47
    if ((user_access('maintain books') && !$node->moderate) || ($node->uid == $user->uid && user_access('edit own book pages'))) {
      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 64 65 66 67 68 69
      if (user_access('see printer-friendly version')) {
        $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.')));
      }
      if (user_access('export books')) {
        $links[] = l(t('export DocBook XML'), 'book/export/docbook/'. $node->nid, array('title' => t('Export this book page and its sub-pages as DocBook XML.')));
        $links[] = l(t('export OPML'), 'book/export/opml/'. $node->nid, array('title' => t('Export this book page and its sub-pages as OPML.')));
      }
Dries's avatar
 
Dries committed
70
    }
Dries's avatar
 
Dries committed
71 72
  }

Dries's avatar
 
Dries committed
73
  return $links;
Dries's avatar
 
Dries committed
74 75
}

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

Dries's avatar
 
Dries committed
82
  if ($may_cache) {
83 84 85 86 87 88 89 90 91
    $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'),
92
      'access' => user_access('create book pages'));
93 94 95
    $items[] = array(
      'path' => 'admin/node/book',
      'title' => t('books'),
Dries's avatar
 
Dries committed
96 97
      'callback' => 'book_admin',
      'access' => user_access('administer nodes'),
98 99 100 101 102 103
      'type' => MENU_LOCAL_TASK,
      'weight' => -1);
    $items[] = array(
      'path' => 'admin/node/book/list',
      'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK);
104 105 106
    $items[] = array(
      'path' => 'admin/node/book/orphan',
      'title' => t('orphan pages'),
Dries's avatar
 
Dries committed
107
      'callback' => 'book_admin_orphan',
108
      'type' => MENU_LOCAL_TASK,
Dries's avatar
 
Dries committed
109 110 111 112 113
      'weight' => 8);
    $items[] = array('path' => 'book', 'title' => t('books'),
      '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('export books') || user_access('see printer-friendly version')) && 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 122 123 124
  else {
    // To avoid SQL overhead, check whether we are on a node page and whether the
    // user is allowed to maintain books.
    if (arg(0) == 'node' && is_numeric(arg(1)) && user_access('maintain books')) {
      // 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 127 128 129 130 131 132
      if (db_num_rows($result) > 0) {
        $items[] = array('path' => 'node/'. arg(1) .'/outline', 'title' => t('outline'),
          'callback' => 'book_outline', 'access' => user_access('maintain books'),
          'type' => MENU_LOCAL_TASK, 'weight' => 2);
      }
    }
  }
Dries's avatar
 
Dries committed
133 134 135 136

  return $items;
}

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

164
        $block['subject'] = check_plain($path[0]->title);
Dries's avatar
 
Dries committed
165 166 167
        $block['content'] = book_tree($expand[0], 5, $expand);
      }
    }
Dries's avatar
 
Dries committed
168

169 170
    return $block;
  }
Dries's avatar
 
Dries committed
171 172
}

173 174 175
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
176
function book_load($node) {
Dries's avatar
 
Dries committed
177
  global $user;
Dries's avatar
 
Dries committed
178

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

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

Dries's avatar
 
Dries committed
194
  return $book;
Dries's avatar
 
Dries committed
195 196
}

197 198 199
/**
 * Implementation of hook_insert().
 */
Dries's avatar
 
Dries committed
200
function book_insert($node) {
201
  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
202
}
Dries's avatar
 
Dries committed
203

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

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

223 224 225
/**
 * Implementation of hook_validate().
 */
226
function book_validate(&$node) {
227 228
  // Set default values for non-administrators.
  if (!user_access('administer nodes')) {
229 230 231
    $node->weight = 0;
    $node->revision = 1;
  }
232 233

  node_validate_title($node);
Dries's avatar
 
Dries committed
234 235
}

236 237 238
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
239
function book_form(&$node) {
240
  $form['parent'] = array(
241 242
    '#type' => 'select', '#title' => t('Parent'), '#default_value' => ($node->parent ? $node->parent : arg(4)), '#options' => book_toc($node->nid), '#weight' => -15,
    '#description' => t('The parent that this page belongs in. Note that pages whose parent is &lt;top-level&gt; are regarded as independent, top-level books.')
243
  );
Dries's avatar
 
Dries committed
244

245
  $form['title'] = array('#type' => 'textfield', '#title' => t('Title'), '#size' => 60, '#maxlength' => 128, '#required' => TRUE, '#default_value' => $node->title);
246
  $form['body'] = array(
247
    '#type' => 'textarea', '#title' => t('Body'), '#default_value' => $node->body, '#required' => TRUE
248 249
  );
  $form = array_merge($form, filter_form($node->format));
250

251
  $form['log'] = array(
252 253 254 255
    '#type' => 'fieldset', '#title' => t('Log message'), '#collapsible' => TRUE, '#collapsed' => TRUE
  );
  $form['log']['message'] = array(
    '#type' => 'textarea', '#default_value' => $node->log, '#rows' => 5, '#weight' => 18,
256
    '#description' => t('An explanation of the additions or updates being made to help other authors understand your motivations.')
257
  );
Dries's avatar
 
Dries committed
258

259
  if (user_access('administer nodes')) {
260
    $form['weight'] = array(
261 262
        '#type' => 'weight', '#title' => t('Weight'),  '#default_value' => $node->weight, '#delta' => 15, '#weight' => -14,
        '#description' => t('Pages at a given level are ordered first by weight and then by title.')
263
    );
Dries's avatar
 
Dries committed
264 265
  }
  else {
Dries's avatar
 
Dries committed
266 267
    // If a regular user updates a book page, we create a new revision
    // authored by that user:
268
    $form['revision'] = array('#type' => 'hidden', '#value' => 1);
Dries's avatar
 
Dries committed
269 270
  }

271
  return $form;
Dries's avatar
 
Dries committed
272 273
}

274
/**
Dries's avatar
 
Dries committed
275 276
 * Implementation of function book_outline()
 * Handles all book outline operations.
277
 */
Dries's avatar
 
Dries committed
278
function book_outline() {
Dries's avatar
 
Dries committed
279

280 281
  $op = $_POST['op'];
  $edit = $_POST['edit'];
282
  $node = node_load(arg(1));
Dries's avatar
 
Dries committed
283

Dries's avatar
 
Dries committed
284 285 286
  if ($node->nid) {
    switch ($op) {
      case t('Add to book outline'):
287 288
        db_query('INSERT INTO {book} (nid, vid, parent, weight) VALUES (%d, %d, %d, %d)', $node->nid, $node->vid, $edit['parent'], $edit['weight']);
        db_query("UPDATE {node_revisions} SET log = '%s' WHERE vid = %d", $edit['log'], $node->vid);
289
        drupal_set_message(t('The post has been added to the book.'));
Dries's avatar
 
Dries committed
290 291 292 293
        drupal_goto("node/$node->nid");
        break;

      case t('Update book outline'):
294 295
        db_query('UPDATE {book} SET parent = %d, weight = %d WHERE vid = %d', $edit['parent'], $edit['weight'], $node->vid);
        db_query("UPDATE {node_revisions} SET log = '%s' WHERE vid = %d", $edit['log'], $node->vid);
296
        drupal_set_message(t('The book outline has been updated.'));
Dries's avatar
 
Dries committed
297 298 299 300 301
        drupal_goto("node/$node->nid");
        break;

      case t('Remove from book outline'):
        db_query('DELETE FROM {book} WHERE nid = %d', $node->nid);
302
        drupal_set_message(t('The post has been removed from the book.'));
Dries's avatar
 
Dries committed
303 304 305 306
        drupal_goto("node/$node->nid");
        break;

      default:
307
        $page = db_fetch_object(db_query('SELECT * FROM {book} WHERE vid = %d', $node->vid));
308

309
        $form['parent'] = array(
310 311
          '#type' => 'select', '#title' => t('Parent'), '#default_value' => $page->parent,
          '#options' => book_toc($node->nid), '#description' => t('The parent page in the book.')
312
        );
313

314
        $form['weight'] = array(
315 316
          '#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.')
317
        );
318

319
        $form['log'] = array(
320 321
          '#type' => 'textarea', '#title' => t('Log message'), '#cols' => 60, '#rows' => 5,
          '#default_value' => $node->log, '#description' => t('An explanation to help other authors understand your motivations to put this post into the book.')
322
        );
Dries's avatar
 
Dries committed
323 324

        if ($page->nid) {
325 326
          $form['update'] = array('#type' => 'submit', '#value' => t('Update book outline'));
          $form['remove'] = array('#type' => 'submit', '#value' => t('Remove from book outline'));
Dries's avatar
 
Dries committed
327 328
        }
        else {
329
          $form['add'] = array('#type' => 'submit', '#value' => t('Add to book outline'));
Dries's avatar
 
Dries committed
330
        }
Dries's avatar
 
Dries committed
331

332
        drupal_set_title(check_plain($node->title));
333
        return drupal_get_form('book_outline', $form);
Dries's avatar
 
Dries committed
334 335 336 337
    }
  }
}

338 339 340
/**
 * Return the path (call stack) to a certain book page.
 */
Dries's avatar
 
Dries committed
341
function book_location($node, $nodes = array()) {
342
  $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
343 344 345 346 347 348 349
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

350 351 352
/**
 * Accumulates the nodes up to the root of the book from the given node in the $nodes array.
 */
Dries's avatar
 
Dries committed
353
function book_location_down($node, $nodes = array()) {
354
  $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
355 356 357 358 359 360 361
  if ($last_direct_child) {
    array_push($nodes, $last_direct_child);
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

362
/**
363
 * Fetches the node object of the previous page of the book.
364
 */
Dries's avatar
 
Dries committed
365
function book_prev($node) {
Dries's avatar
 
Dries committed
366
  // If the parent is zero, we are at the start of a book so there is no previous.
Dries's avatar
 
Dries committed
367 368 369 370
  if ($node->parent == 0) {
    return NULL;
  }

Dries's avatar
 
Dries committed
371
  // Previous on the same level:
372
  $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
373
  if ($direct_above) {
Dries's avatar
 
Dries committed
374
    // Get last leaf of $above.
Dries's avatar
 
Dries committed
375
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
376 377

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
378 379
  }
  else {
Dries's avatar
 
Dries committed
380
    // Direct parent:
381
    $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
382 383 384 385
    return $prev;
  }
}

386
/**
387
 * Fetches the node object of the next page of the book.
388
 */
Dries's avatar
 
Dries committed
389 390
function book_next($node) {
  // get first direct child
391
  $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
392 393 394 395
  if ($child) {
    return $child;
  }

Dries's avatar
 
Dries committed
396 397
  // 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.
398

Dries's avatar
 
Dries committed
399
  while (($leaf = array_pop($path)) && count($path)) {
400
    $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
401 402 403 404 405 406
    if ($next) {
      return $next;
    }
  }
}

407 408 409 410 411 412
/**
 * 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
413
function book_content($node, $teaser = FALSE) {
414
  $op = $_POST['op'];
Dries's avatar
 
Dries committed
415

416 417
  // Extract the page body.
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
418

Dries's avatar
 
Dries committed
419 420 421
  return $node;
}

422 423 424 425 426 427
/**
 * 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
428
function book_view(&$node, $teaser = FALSE, $page = FALSE) {
Dries's avatar
 
Dries committed
429
  $node = book_content($node, $teaser);
Dries's avatar
 
Dries committed
430 431
}

432
/**
Dries's avatar
 
Dries committed
433 434 435
 * Implementation of hook_nodeapi().
 *
 * Appends book navigation to all nodes in the book.
436
 */
Dries's avatar
 
Dries committed
437 438 439 440
function book_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
    case 'view':
      if (!$teaser) {
441
        $book = db_fetch_array(db_query('SELECT * FROM {book} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
442
        if ($book) {
443
          if ($node->moderate && user_access('administer nodes')) {
444
            drupal_set_message(t("The post has been submitted for moderation and won't be accessible until it has been approved."));
445 446
          }

Dries's avatar
 
Dries committed
447 448 449
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
450 451 452 453 454 455 456 457 458 459 460

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

461 462 463
          if ($page) {
            menu_set_location($node->breadcrumb);
          }
Dries's avatar
 
Dries committed
464
        }
Dries's avatar
 
Dries committed
465
      }
Dries's avatar
 
Dries committed
466
      break;
Dries's avatar
 
Dries committed
467
  }
Dries's avatar
 
Dries committed
468
}
Dries's avatar
 
Dries committed
469

470 471 472
/**
 * Prepares both the custom breadcrumb trail and the forward/backward
 * navigation for a node presented as a book page.
473 474
 *
 * @ingroup themeable
475
 */
476
function theme_book_navigation($node) {
Dries's avatar
 
Dries committed
477
  if ($node->nid) {
478
    $output .= '<div class="book">';
Dries's avatar
 
Dries committed
479 480

    if ($tree = book_tree($node->nid)) {
Dries's avatar
 
Dries committed
481
      $output .= '<div class="tree">'. $tree .'</div>';
Dries's avatar
 
Dries committed
482
    }
Dries's avatar
 
Dries committed
483

Dries's avatar
 
Dries committed
484
    if ($prev = book_prev($node)) {
485
      $links .= '<div class="prev">';
Dries's avatar
 
Dries committed
486
      $links .= l(t('previous'), 'node/'. $prev->nid, array('title' => t('View the previous page.')));
487
      $links .= '</div>';
488
      $titles .= '<div class="prev">'. check_plain($prev->title) .'</div>';
Dries's avatar
 
Dries committed
489 490
    }
    else {
Dries's avatar
 
Dries committed
491
      $links .= '<div class="prev">&nbsp;</div>'; // Make an empty div to fill the space.
Dries's avatar
 
Dries committed
492 493
    }
    if ($next = book_next($node)) {
494
      $links .= '<div class="next">';
Dries's avatar
 
Dries committed
495
      $links .= l(t('next'), 'node/'. $next->nid, array('title' => t('View the next page.')));
496
      $links .= '</div>';
497
      $titles .= '<div class="next">'. check_plain($next->title) .'</div>';
Dries's avatar
 
Dries committed
498 499
    }
    else {
Dries's avatar
 
Dries committed
500
      $links .= '<div class="next">&nbsp;</div>'; // Make an empty div to fill the space.
Dries's avatar
 
Dries committed
501 502
    }
    if ($node->parent) {
503
      $links .= '<div class="up">';
Dries's avatar
 
Dries committed
504
      $links .= l(t('up'), 'node/'. $node->parent, array('title' => t('View this page\'s parent section.')));
505
      $links .= '</div>';
Dries's avatar
 
Dries committed
506
    }
Dries's avatar
 
Dries committed
507

508
    $output .= '<div class="nav">';
Dries's avatar
 
Dries committed
509 510
    $output .= ' <div class="links">'. $links .'</div>';
    $output .= ' <div class="titles">'. $titles .'</div>';
511 512
    $output .= '</div>';
    $output .= '</div>';
Dries's avatar
 
Dries committed
513
  }
Dries's avatar
 
Dries committed
514

515
  return $output;
Dries's avatar
 
Dries committed
516
}
Dries's avatar
 
Dries committed
517

518 519 520
/**
 * This is a helper function for book_toc().
 */
521
function book_toc_recurse($nid, $indent, $toc, $children, $exclude) {
Dries's avatar
 
Dries committed
522 523
  if ($children[$nid]) {
    foreach ($children[$nid] as $foo => $node) {
524 525 526 527
      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
528 529 530 531 532 533
    }
  }

  return $toc;
}

534 535 536
/**
 * Returns an array of titles and nid entries of book pages in table of contents order.
 */
537
function book_toc($exclude = 0) {
538
  $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
539

Dries's avatar
 
Dries committed
540
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
541 542 543 544
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
    array_push($children[$node->parent], $node);
Dries's avatar
 
Dries committed
545
  }
Dries's avatar
 
Dries committed
546

547 548
  $toc = array();

Dries's avatar
 
Dries committed
549 550
  // If the user is an administrator, add the top-level book page;
  // only administrators can start new books.
551 552
  if (user_access('administer nodes')) {
    $toc[0] = '<'. t('top-level') .'>';
Dries's avatar
 
Dries committed
553 554
  }

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

Dries's avatar
 
Dries committed
557 558 559
  return $toc;
}

560 561 562
/**
 * This is a helper function for book_tree()
 */
Dries's avatar
 
Dries committed
563
function book_tree_recurse($nid, $depth, $children, $unfold = array()) {
Dries's avatar
 
Dries committed
564
  if ($depth > 0) {
Dries's avatar
 
Dries committed
565 566
    if ($children[$nid]) {
      foreach ($children[$nid] as $foo => $node) {
Dries's avatar
 
Dries committed
567 568 569
        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
570 571
            $output .= l($node->title, 'node/'. $node->nid);
            $output .= '<ul>'. $tree .'</ul>';
Dries's avatar
 
Dries committed
572 573 574
            $output .= '</li>';
          }
          else {
Dries's avatar
 
Dries committed
575
            $output .= '<li class="leaf">'. l($node->title, 'node/'. $node->nid) .'</li>';
Dries's avatar
 
Dries committed
576 577 578 579
          }
        }
        else {
          if ($tree = book_tree_recurse($node->nid, 1, $children)) {
Dries's avatar
 
Dries committed
580
            $output .= '<li class="collapsed">'. l($node->title, 'node/'. $node->nid) .'</li>';
Dries's avatar
 
Dries committed
581 582
          }
          else {
Dries's avatar
 
Dries committed
583
            $output .= '<li class="leaf">'. l($node->title, 'node/'. $node->nid) .'</li>';
Dries's avatar
 
Dries committed
584
          }
Dries's avatar
 
Dries committed
585
        }
Dries's avatar
 
Dries committed
586 587
      }
    }
Dries's avatar
 
Dries committed
588 589 590 591 592
  }

  return $output;
}

593 594 595 596
/**
 * Returns an HTML nested list (wrapped in a menu-class div) representing the book nodes
 * as a tree.
 */
Dries's avatar
 
Dries committed
597
function book_tree($parent = 0, $depth = 3, $unfold = array()) {
598
  $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
599

Dries's avatar
 
Dries committed
600 601 602 603
  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
604
  }
Dries's avatar
 
Dries committed
605

Dries's avatar
 
Dries committed
606
  if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
607
    return '<div class="menu"><ul>'. $tree .'</ul></div>';
Dries's avatar
 
Dries committed
608
  }
Dries's avatar
 
Dries committed
609 610
}

611
/**
Dries's avatar
Dries committed
612
 * Menu callback; prints a listing of all books.
613
 */
Dries's avatar
 
Dries committed
614
function book_render() {
615
  $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
616

617 618 619 620 621 622
  $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
623 624
}

625
/**
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
 * Menu callback; Generates various representation of a book page with
 * all descendants and prints the requested representation to output.
 *
 * Notes: For HTML output, 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) <div>
 * 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.
 *
 * DocBook XML and OPML outputs do not attempt to embed a node to its
 * absolute level in the parent book.

 *    For DocBook output, the exported node will be a document fragment
 * unless the node is a level 0 node (book), specifically
 *    <ul>
 *      <li>a <chapter> for level 1 elements, </li>
 *      <li>a <section> for levels 2 and deeper.</li>
 *    </ul>
 *
 *    For OPML output, the exported node will be the top level element
 * in the OPML outline.
 *
 * @param type
 *   - a string encoding the type of output requested.
 *       The following types are supported:
 *          1) HTML (printer friendly output)
 *          2) DocBook XML
 *          3) OPML (Outline Processor Markup Language) outlines
 * @param nid
 *   - an integer representing the node id (nid) of the node to export
 *
659
 */
660
function book_export($type = 'html', $nid = FALSE) {
661
  $type = drupal_strtolower($type);
662 663
  $node = node_load($nid);
  if ($node) {
664 665 666
    $depth = _book_get_depth($nid);
    switch ($type) {
      case 'docbook':
667 668 669 670 671 672 673 674 675 676
        if (user_access('export books')) {
          $xml = "<?xml version='1.0'?>\n";
          $xml .= "<!DOCTYPE book PUBLIC \"-//OASIS//DTD Docbook XML V4.1.2//EN\" \"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd\">\n";
          $xml .= book_recurse($nid, $depth, 'book_node_visitor_xml_pre', 'book_node_visitor_xml_post');
          drupal_set_header('Content-Type: text/xml; charset=utf-8');
          print $xml;
        }
        else {
          drupal_access_denied();
        }
677 678
        break;
      case 'html':
679 680 681 682 683 684 685 686
        if (user_access('see printer-friendly version')) {
          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";
          }
687
          print theme('book_export_html', check_plain($node->title), $output);
688
        }
689 690
        else {
          drupal_access_denied();
691 692 693
        }
        break;
      case 'opml':
694 695 696 697 698 699 700 701 702 703 704 705
        if (user_access('export books')) {
          $output .= book_recurse($nid, $depth, 'book_node_visitor_opml_pre', 'book_node_visitor_opml_post');
          $opml  = "<?xml version='1.0'?>\n";
          $opml .= "<opml version='1.0'>\n";
          $opml .= "<head>\n<title>". check_plain($node->title) ."</title>\n";
          $opml .= "</head>\n<body>\n". $output . "\n</body>\n</opml>\n";
          drupal_set_header('Content-Type: text/xml; charset=utf-8');
          print $opml;
        }
        else {
          drupal_access_denied();
        }
706 707 708 709 710 711 712
        break;
      default:
        drupal_not_found();
    }
  }
  else {
    drupal_not_found();
713
  }
714
}
Dries's avatar
 
Dries committed
715

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

733
/**
734 735 736 737 738 739 740 741
 * 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).
 *
 * @param node
 *   - the node whose depth to compute.
 * @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.
742
 */
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
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
763 764
}

765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
/**
 * 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) {
784
  $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
785
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
786
    // Load the node:
787
    $node = node_load($page->nid);
Dries's avatar
 
Dries committed
788

Dries's avatar
 
Dries committed
789
    if ($node) {
790 791
      if (function_exists($visit_pre)) {
        $output .= call_user_func($visit_pre, $node, $depth, $nid);
Dries's avatar
 
Dries committed
792
      }
793 794
      else {
        $output .= book_node_visitor_html_pre($node, $depth, $nid);
Dries's avatar
 
Dries committed
795
      }
Dries's avatar
 
Dries committed
796

797
      $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);
798
      while ($childpage = db_fetch_object($children)) {
799
          $childnode = node_load($childpage->nid);
800 801 802 803 804
          if ($childnode->nid != $node->nid) {
              $output .= book_recurse($childnode->nid, $depth+1, $visit_pre, $visit_post);
          }
      }
      if (function_exists($visit_post)) {
805
        $output .= call_user_func($visit_post, $node, $depth);
806 807
      }
      else { # default
808
        $output .= book_node_visitor_html_post($node, $depth);
809
      }
Dries's avatar
 
Dries committed
810
    }
Dries's avatar
 
Dries committed
811
  }
Dries's avatar
 
Dries committed
812

Dries's avatar
 
Dries committed
813 814
  return $output;
}
Dries's avatar
 
Dries committed
815

816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
/**
 * 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.
 */
831
function book_node_visitor_html_pre($node, $depth, $nid) {
832 833 834 835 836
  // Output the content:
  if (node_hook($node, 'content')) {
    $node = node_invoke($node, 'content');
  }
  // Allow modules to change $node->body before viewing.
837
  node_invoke_nodeapi($node, 'print', $node->body, false);
838

839 840
  $output .= "<div id=\"node-". $node->nid ."\" class=\"section-$depth\">\n";
  $output .= "<h1 class=\"book-heading\">". check_plain($node->title) ."</h1>\n";
841 842 843 844 845 846 847 848 849 850 851 852

  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().
 */
853
function book_node_visitor_html_post($node, $depth) {
854 855 856 857 858
  return "</div>\n";
}

/**
 * Generates XML for a given node. This function is a 'pre-node'
859 860 861 862 863 864 865
 * visitor function for book_recurse().  The generated XML is valid
 * DocBook, but each node's HTML content is wrapped in a CDATA
 * section, and put inside a <literallayout> element.  The node body
 * has an md5-hash applied; the value of this is stored as node
 * metadata to allow importing code to determine if contents have
 * changed.  The weight of a node is also stored as metadata to
 * allow the node to be properly re-imported.
866 867 868 869 870 871 872 873
 *
 * @param $node
 *   - the node to generate output for.
 * @param $depth
 *   - the depth of the given node in the hierarchy. This
 *   is currently not used.
 * @param $nid
 *   - the node id (nid) of the given node. This
874
 *   is used only for generating output (e.g., id attribute)
875 876 877 878 879 880 881 882 883
 * @return
 *   - the generated XML for the given node.
 */
function book_node_visitor_xml_pre($node, $depth, $nid) {
  // Output the content:
  if (node_hook($node, 'content')) {
    $node = node_invoke($node, 'content');
  }
  // Allow modules to change $node->body before viewing.
884 885 886 887 888 889 890 891 892 893
  node_invoke_nodeapi($node, 'export_xml', $node->body, false);

  $releaseinfo  = "<releaseinfo>\n";
  $releaseinfo .= "md5-hash:" . md5($node->body) . "\n";
  $releaseinfo .= "weight:". $node->weight . "\n";
  $releaseinfo .= "depth:". $depth . "\n";
  $releaseinfo .= "</releaseinfo>\n";

  $title = "<title>". check_plain($node->title) ."</title>\n";

894
  // wrap the node body in a CDATA declaration
895 896
  $content = "<literallayout>";
  $content .= "<![CDATA[";
897
  if ($node->body) {
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
    $content .= $node->body;
  }
  $content .= "]]>";
  $content .= "</literallayout>\n";

  if ($depth == 1) {
      $output .= "<book>\n";
      $output .= $title;
      $output .= "<bookinfo>\n$releaseinfo</bookinfo>\n";
      $output .= "<preface>\n";
      $output .= "<title>Preface</title>\n";
      $output .= $content;
      $output .= "</preface>\n";
  }
  else if ($depth == 2) {
      $output .= "<chapter id=\"node-".$node->nid ."\">\n";
      $output .= "<chapterinfo>\n$releaseinfo</chapterinfo>\n";
      $output .= $title;
      $output .= $content;
  }
  else {
      $output .= "<section id=\"node-".$node->nid ."\">\n";
      $output .= "<sectioninfo>\n$releaseinfo</sectioninfo>\n";
      $output .= $title;
      $output .= $content;
923
  }
924

925 926 927 928
  return $output;
}

/**
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
 * Completes the XML generation for the node. This function is a
 * 'post-node' visitor function for book_recurse().
 */
function book_node_visitor_xml_post($node, $depth) {
  if ($depth == 1) {
    return "</book>\n";
  }
  else if ($depth == 2) {
    return "</chapter>\n";
  }
  else {
    return "</section>\n";
  }
}

/**
 * Generates OPML 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 OPML generated for the given node.
 */
function book_node_visitor_opml_pre($node, $depth, $nid) {
  // Output the content:
  if (node_hook($node, 'content')) {
    $node = node_invoke($node, 'content');
  }

  $output .= "<outline type=\"id:node-". $node->nid ."\"\n";
  $text = check_plain($node->title);
  $output .= "text=\"$text\">\n";
  return $output;
}

/**
 * Finishes up generation of OPML after visiting a node. This function
 * is a 'post-node' visitor function for book_recurse().
974
 */
975 976
function book_node_visitor_opml_post($node, $depth) {
  return "</outline>\n";
977 978 979 980 981
}

/**
 * Creates a row for the 'admin' view of a book.  Each row represents a page in the book, in the tree representing the book
 */
982
function book_admin_edit_line($node, $depth = 0) {
983 984 985 986 987
  $form['#tree'] = TRUE;
  $form[$node<