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

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

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

16 17 18
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
19
function book_perm() {
20
    return array('outline posts in books', 'create book pages', 'create new books', 'edit book pages', 'edit own book pages', 'see printer-friendly version');
Dries's avatar
 
Dries committed
21 22
}

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

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

35
  if ($op == 'update') {
Dries's avatar
 
Dries committed
36 37 38
    // Only registered users can update book pages.  Given the nature
    // of the book module this is considered to be a good/safe idea.
    // One can only update a book page if there are no suggested updates
39 40
    // of that page waiting for approval.  That is, only updates that
    // don't overwrite the current or pending information are allowed.
41

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

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

  $links = array();

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

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

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

Dries's avatar
 
Dries committed
80
  if ($may_cache) {
81 82 83 84 85 86 87 88 89
    $items[] = array(
      'path' => 'book',
      'title' => t('books'),
      'access' => user_access('access content'),
      'type' => MENU_NORMAL_ITEM,
      'weight' => 5);
    $items[] = array(
      'path' => 'node/add/book',
      'title' => t('book page'),
90
      'access' => user_access('create book pages'));
91 92 93
    $items[] = array(
      'path' => 'admin/node/book',
      'title' => t('books'),
Dries's avatar
 
Dries committed
94 95
      'callback' => 'book_admin',
      'access' => user_access('administer nodes'),
96 97 98 99 100 101
      'type' => MENU_LOCAL_TASK,
      'weight' => -1);
    $items[] = array(
      'path' => 'admin/node/book/list',
      'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK);
102 103 104
    $items[] = array(
      'path' => 'admin/node/book/orphan',
      'title' => t('orphan pages'),
Dries's avatar
 
Dries committed
105
      'callback' => 'book_admin_orphan',
106
      'type' => MENU_LOCAL_TASK,
Dries's avatar
 
Dries committed
107
      'weight' => 8);
108 109 110
    $items[] = array(
      'path' => 'book',
      'title' => t('books'),
Dries's avatar
 
Dries committed
111 112 113
      'callback' => 'book_render',
      'access' => user_access('access content'),
      'type' => MENU_SUGGESTED_ITEM);
114
    $items[] = array(
115 116
      'path' => 'book/export',
      'callback' => 'book_export',
117
      'access' => user_access('access content'),
Dries's avatar
 
Dries committed
118
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
119
  }
Dries's avatar
 
Dries committed
120 121
  else {
    // To avoid SQL overhead, check whether we are on a node page and whether the
122 123
    // user is allowed to outline posts in books.
    if (arg(0) == 'node' && is_numeric(arg(1)) && user_access('outline posts in books')) {
Dries's avatar
 
Dries committed
124
      // Only add the outline-tab for non-book pages:
125
      $result = db_query(db_rewrite_sql("SELECT n.nid FROM {node} n WHERE n.nid = %d AND n.type != 'book'"), arg(1));
Dries's avatar
 
Dries committed
126
      if (db_num_rows($result) > 0) {
127 128 129 130
        $items[] = array(
          'path' => 'node/'. arg(1) .'/outline',
          'title' => t('outline'),
          'callback' => 'book_outline',
131
          '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 parent, weight 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 241
/**
 * Implementation of hook_validate().
 */
function book_validate($node) {
242
  node_validate_title($node);
Dries's avatar
 
Dries committed
243 244
}

245 246 247
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
248
function book_form(&$node) {
249 250 251 252 253 254 255 256 257 258 259 260
  $form['parent'] =
    array(
          '#type' => 'select',
          '#title' => t('Parent'),
          '#default_value' => ($node->parent ? $node->parent : arg(4)),
          '#options' => book_toc($node->nid),
          '#weight' => -4,
          '#description' =>
            user_access('create new books') ?
              t('The parent section in which to place this page.  Note that each page whose parent is &lt;top-level&gt; is an independent, top-level book.') :
              t('The parent that this page belongs in.')
          );
Dries's avatar
 
Dries committed
261

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

266
  $form['log'] = array(
267
    '#type' => 'textarea', '#title' => t('Log message'), '#default_value' => $node->log, '#weight' => 5,
268
    '#description' => t('An explanation of the additions or updates being made to help other authors understand your motivations.')
269
  );
Dries's avatar
 
Dries committed
270

271
  if (user_access('administer nodes')) {
272
    $form['weight'] = array(
273
        '#type' => 'weight', '#title' => t('Weight'), '#default_value' => $node->weight, '#delta' => 15, '#weight' => 5,
274
        '#description' => t('Pages at a given level are ordered first by weight and then by title.')
275
    );
Dries's avatar
 
Dries committed
276 277
  }
  else {
Dries's avatar
 
Dries committed
278 279
    // If a regular user updates a book page, we create a new revision
    // authored by that user:
280
    $form['revision'] = array('#type' => 'hidden', '#value' => 1);
Dries's avatar
 
Dries committed
281 282
  }

283
  return $form;
Dries's avatar
 
Dries committed
284 285
}

286
/**
Dries's avatar
 
Dries committed
287 288
 * Implementation of function book_outline()
 * Handles all book outline operations.
289
 */
Dries's avatar
 
Dries committed
290
function book_outline() {
Dries's avatar
 
Dries committed
291

292 293
  $op = $_POST['op'];
  $edit = $_POST['edit'];
294
  $node = node_load(arg(1));
Dries's avatar
 
Dries committed
295

Dries's avatar
 
Dries committed
296 297 298
  if ($node->nid) {
    switch ($op) {
      case t('Add to book outline'):
299 300
        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);
301
        drupal_set_message(t('The post has been added to the book.'));
Dries's avatar
 
Dries committed
302 303 304 305
        drupal_goto("node/$node->nid");
        break;

      case t('Update book outline'):
306 307
        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);
308
        drupal_set_message(t('The book outline has been updated.'));
Dries's avatar
 
Dries committed
309 310 311 312 313
        drupal_goto("node/$node->nid");
        break;

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

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

321
        $form['parent'] = array(
322 323
          '#type' => 'select', '#title' => t('Parent'), '#default_value' => $page->parent,
          '#options' => book_toc($node->nid), '#description' => t('The parent page in the book.')
324
        );
325

326
        $form['weight'] = array(
327 328
          '#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.')
329
        );
330

331
        $form['log'] = array(
332
          '#type' => 'textarea', '#title' => t('Log message'),
333
          '#default_value' => $node->log, '#description' => t('An explanation to help other authors understand your motivations to put this post into the book.')
334
        );
Dries's avatar
 
Dries committed
335 336

        if ($page->nid) {
337 338
          $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
339 340
        }
        else {
341
          $form['add'] = array('#type' => 'submit', '#value' => t('Add to book outline'));
Dries's avatar
 
Dries committed
342
        }
Dries's avatar
 
Dries committed
343

344
        drupal_set_title(check_plain($node->title));
345
        return drupal_get_form('book_outline', $form);
Dries's avatar
 
Dries committed
346 347 348 349
    }
  }
}

350 351 352
/**
 * Return the path (call stack) to a certain book page.
 */
Dries's avatar
 
Dries committed
353
function book_location($node, $nodes = array()) {
354
  $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
355 356 357 358 359 360 361
  if ($parent->title) {
    $nodes = book_location($parent, $nodes);
    array_push($nodes, $parent);
  }
  return $nodes;
}

362 363 364
/**
 * Accumulates the nodes up to the root of the book from the given node in the $nodes array.
 */
Dries's avatar
 
Dries committed
365
function book_location_down($node, $nodes = array()) {
366
  $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
367 368 369 370 371 372 373
  if ($last_direct_child) {
    array_push($nodes, $last_direct_child);
    $nodes = book_location_down($last_direct_child, $nodes);
  }
  return $nodes;
}

374
/**
375
 * Fetches the node object of the previous page of the book.
376
 */
Dries's avatar
 
Dries committed
377
function book_prev($node) {
Dries's avatar
 
Dries committed
378
  // If the parent is zero, we are at the start of a book so there is no previous.
Dries's avatar
 
Dries committed
379 380 381 382
  if ($node->parent == 0) {
    return NULL;
  }

Dries's avatar
 
Dries committed
383
  // Previous on the same level:
384
  $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
385
  if ($direct_above) {
Dries's avatar
 
Dries committed
386
    // Get last leaf of $above.
Dries's avatar
 
Dries committed
387
    $path = book_location_down($direct_above);
Dries's avatar
 
Dries committed
388 389

    return $path ? (count($path) > 0 ? array_pop($path) : NULL) : $direct_above;
Dries's avatar
 
Dries committed
390 391
  }
  else {
Dries's avatar
 
Dries committed
392
    // Direct parent:
393
    $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
394 395 396 397
    return $prev;
  }
}

398
/**
399
 * Fetches the node object of the next page of the book.
400
 */
Dries's avatar
 
Dries committed
401 402
function book_next($node) {
  // get first direct child
403
  $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
404 405 406 407
  if ($child) {
    return $child;
  }

Dries's avatar
 
Dries committed
408 409
  // 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.
410

Dries's avatar
 
Dries committed
411
  while (($leaf = array_pop($path)) && count($path)) {
412
    $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
413 414 415 416 417 418
    if ($next) {
      return $next;
    }
  }
}

419 420 421 422 423 424
/**
 * 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
425
function book_content($node, $teaser = FALSE) {
426 427
  // Return the page body.
  return node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
428 429
}

430 431 432 433 434 435
/**
 * 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
436
function book_view(&$node, $teaser = FALSE, $page = FALSE) {
437
  $node = node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
438 439
}

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

Dries's avatar
 
Dries committed
455 456 457
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
458 459 460 461 462 463 464 465 466 467 468

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

469 470 471
          if ($page) {
            menu_set_location($node->breadcrumb);
          }
Dries's avatar
 
Dries committed
472
        }
Dries's avatar
 
Dries committed
473
      }
Dries's avatar
 
Dries committed
474
      break;
475
    case 'delete revision':
476 477
      db_query('DELETE FROM {book} WHERE vid = %d', $node->vid);
      break;
Dries's avatar
 
Dries committed
478
  }
Dries's avatar
 
Dries committed
479
}
Dries's avatar
 
Dries committed
480

481 482 483
/**
 * Prepares both the custom breadcrumb trail and the forward/backward
 * navigation for a node presented as a book page.
484 485
 *
 * @ingroup themeable
486
 */
487
function theme_book_navigation($node) {
488 489
  $output = '';

Dries's avatar
 
Dries committed
490
  if ($node->nid) {
491
    $tree = book_tree($node->nid);
Dries's avatar
 
Dries committed
492

Dries's avatar
 
Dries committed
493
    if ($prev = book_prev($node)) {
494
      drupal_add_link(array('rel' => 'prev', 'href' => url('node/'. $prev->nid)));
495
      $links .= l(t('‹ ') . $prev->title, 'node/'. $prev->nid, array('class' => 'page-previous', 'title' => t('Go to previous page')));
Dries's avatar
 
Dries committed
496
    }
497 498 499
    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
500 501
    }
    if ($next = book_next($node)) {
502
      drupal_add_link(array('rel' => 'next', 'href' => url('node/'. $next->nid)));
503
      $links .= l($next->title . t(' ›'), 'node/'. $next->nid, array('class' => 'page-next', 'title' => t('Go to next page')));
Dries's avatar
 
Dries committed
504
    }
Dries's avatar
 
Dries committed
505

506 507 508 509 510 511 512 513 514 515
    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
516
  }
Dries's avatar
 
Dries committed
517

518
  return $output;
Dries's avatar
 
Dries committed
519
}
Dries's avatar
 
Dries committed
520

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

  return $toc;
}

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

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

550
  $toc = array();
551 552
  // If the user has permission to create new books, add the top-level book page to the menu;
  if (user_access('create new books')) {
553
    $toc[0] = '<'. t('top-level') .'>';
Dries's avatar
 
Dries committed
554 555
  }

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

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

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

  return $output;
}

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

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

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

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

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

626
/**
627 628 629
 * Menu callback; Generates various representation of a book page with
 * all descendants and prints the requested representation to output.
 *
630 631 632 633
 * The function delegates the generation of output to helper functions.
 * The function name is derived by prepending 'book_export_' to the
 * given output type.  So, e.g., a type of 'html' results in a call to
 * the function book_export_html().
634 635 636
 *
 * @param type
 *   - a string encoding the type of output requested.
637 638 639
 *       The following types are currently supported in book module
 *          html: HTML (printer friendly output)
 *       Other types are supported in contributed modules.
640 641 642
 * @param nid
 *   - an integer representing the node id (nid) of the node to export
 *
643
 */
644
function book_export($type = 'html', $nid = 0) {
645
  $type = drupal_strtolower($type);
646 647 648 649 650
  $depth = _book_get_depth($nid);
  $export_function = 'book_export_' . $type;

  if (function_exists($export_function)) {
    print call_user_func($export_function, $nid, $depth);
651 652
  }
  else {
653
    drupal_set_message('Unknown export format');
654
    drupal_not_found();
655
  }
656
}
Dries's avatar
 
Dries committed
657

658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
/**
 * This function is called by book_export() to generate HTML for export.
 *
 * The given node is /embedded to its absolute depth in a top level
 * section/.  For example, a child node with depth 2 in the hierarchy
 * is contained in (otherwise empty) &lt;div&gt; elements
 * corresponding to depth 0 and depth 1.  This is intended to support
 * WYSIWYG output - e.g., level 3 sections always look like level 3
 * sections, no matter their depth relative to the node selected to be
 * exported as printer-friendly HTML.
 *
 * @param nid
 *   - an integer representing the node id (nid) of the node to export
 * @param depth
 * - an integer giving the depth in the book hierarchy of the node
       which is to be exported
 * @return
 * - string containing HTML representing the node and its children in
       the book hierarchy
*/
function book_export_html($nid, $depth) {
  if (user_access('see printer-friendly version')) {
    global $base_url;
    for ($i = 1; $i < $depth; $i++) {
      $output .= "<div class=\"section-$i\">\n";
    }
    $output .= book_recurse($nid, $depth, 'book_node_visitor_html_pre', 'book_node_visitor_html_post');
    for ($i = 1; $i < $depth; $i++) {
      $output .= "</div>\n";

    }
    $html = "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
    $html .= '<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">';
    $html .= "<head>\n<title>". check_plain($node->title) ."</title>\n";
    $html .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
    $html .= '<base href="'. $base_url .'/" />' . "\n";
    $html .= "<style type=\"text/css\">\n@import url(misc/print.css);\n</style>\n";
    $html .= "</head>\n<body>\n". $output . "\n</body>\n</html>\n";
    return $html;
  }
  else {
    drupal_access_denied();
  }
}

703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
/**
 * 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;
}

720
/**
721 722 723
 * 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).
 *
724 725
 * @param nid
 *   - the nid of the node whose depth to compute.
726 727 728
 * @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.
729
 */
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
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
750 751
}

752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
/**
 * 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) {
771
  $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
772
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
773
    // Load the node:
774
    $node = node_load($page->nid);
Dries's avatar
 
Dries committed
775

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

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

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

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

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

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

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

858 859 860 861 862 863 864 865 866