book.module 35.1 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 14 15 16 17 18 19
  return array(
    'book' => array(
      'name' => t('book page'),
      'module' => 'book',
      'description' => t("A book is a collaborative writing effort: users can collaborate writing the pages of the book, positioning the pages in the right order, and reviewing or modifying pages previously written. So when you have some information to share or when you read a page of the book and you didn't like it, or if you think a certain page could have been written better, you can do something about it."),
    )
  );
Dries's avatar
 
Dries committed
20 21
}

22 23 24
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
25
function book_perm() {
26
    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
27 28
}

29 30 31
/**
 * Implementation of hook_access().
 */
Dries's avatar
 
Dries committed
32
function book_access($op, $node) {
Dries's avatar
 
Dries committed
33
  global $user;
Dries's avatar
 
Dries committed
34

35
  if ($op == 'create') {
36
    // Only registered users can create book pages. Given the nature
Dries's avatar
 
Dries committed
37
    // of the book module this is considered to be a good/safe idea.
38
    return user_access('create book pages');
Dries's avatar
 
Dries committed
39 40
  }

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

48
    if (user_access('edit book pages') || ($node->uid == $user->uid && user_access('edit own book pages'))) {
49 50 51 52 53
      return TRUE;
    }
    else {
       // do nothing. node-access() will determine further access
    }
Dries's avatar
 
Dries committed
54
  }
Dries's avatar
 
Dries committed
55 56
}

Dries's avatar
 
Dries committed
57 58 59
/**
 * Implementation of hook_link().
 */
60
function book_link($type, $node = NULL, $teaser = FALSE) {
Dries's avatar
 
Dries committed
61 62 63

  $links = array();

64
  if ($type == 'node' && isset($node->parent)) {
65
    if (!$teaser) {
Dries's avatar
 
Dries committed
66
      if (book_access('create', $node)) {
67
        $links['book_add_child'] = array(
68 69
          'title' => t('add child page'),
          'href' => "node/add/book/parent/$node->nid"
70
        );
Dries's avatar
 
Dries committed
71
      }
72
      if (user_access('see printer-friendly version')) {
73
        $links['book_printer'] = array(
74 75 76
          '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.'))
77
        );
78
      }
Dries's avatar
 
Dries committed
79
    }
Dries's avatar
 
Dries committed
80 81
  }

Dries's avatar
 
Dries committed
82
  return $links;
Dries's avatar
 
Dries committed
83 84
}

Dries's avatar
 
Dries committed
85 86 87
/**
 * Implementation of hook_menu().
 */
Dries's avatar
 
Dries committed
88
function book_menu($may_cache) {
Dries's avatar
 
Dries committed
89 90
  $items = array();

Dries's avatar
 
Dries committed
91
  if ($may_cache) {
92
    $items[] = array(
93
      'path' => 'admin/content/book',
94
      'title' => t('books'),
95
      'description' => t('Manage site\'s books and orphaned book pages.'),
Dries's avatar
 
Dries committed
96
      'callback' => 'book_admin',
97
      'access' => user_access('administer nodes'));
98
    $items[] = array(
99
      'path' => 'admin/content/book/list',
100 101
      'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK);
102
    $items[] = array(
103
      'path' => 'admin/content/book/orphan',
104
      'title' => t('orphan pages'),
105 106
      'callback' => 'drupal_get_form',
      'callback arguments' => array('book_admin_orphan'),
107
      'type' => MENU_LOCAL_TASK,
Dries's avatar
 
Dries committed
108
      'weight' => 8);
109 110 111
    $items[] = array(
      'path' => 'book',
      'title' => t('books'),
Dries's avatar
 
Dries committed
112 113 114
      'callback' => 'book_render',
      'access' => user_access('access content'),
      'type' => MENU_SUGGESTED_ITEM);
115
    $items[] = array(
116 117
      'path' => 'book/export',
      'callback' => 'book_export',
118
      'access' => user_access('access content'),
Dries's avatar
 
Dries committed
119
      'type' => MENU_CALLBACK);
Dries's avatar
 
Dries committed
120
  }
Dries's avatar
 
Dries committed
121
  else {
122 123 124 125
    // Add the CSS for this module
    // We put this in !$may_cache so it's only added once per request
    drupal_add_css(drupal_get_path('module', 'book') .'/book.css');

Dries's avatar
 
Dries committed
126
    // To avoid SQL overhead, check whether we are on a node page and whether the
127 128
    // 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
129
      // Only add the outline-tab for non-book pages:
130
      $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
131
      if (db_num_rows($result) > 0) {
132 133 134
        $items[] = array(
          'path' => 'node/'. arg(1) .'/outline',
          'title' => t('outline'),
135 136
          'callback' => 'drupal_get_form',
          'callback arguments' => array('book_outline', arg(1)),
137
          'access' => user_access('outline posts in books'),
138 139
          'type' => MENU_LOCAL_TASK,
          'weight' => 2);
Dries's avatar
 
Dries committed
140 141 142
      }
    }
  }
Dries's avatar
 
Dries committed
143 144 145 146

  return $items;
}

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

174
        $block['subject'] = check_plain($path[0]->title);
Dries's avatar
 
Dries committed
175 176 177
        $block['content'] = book_tree($expand[0], 5, $expand);
      }
    }
Dries's avatar
 
Dries committed
178

179 180
    return $block;
  }
Dries's avatar
 
Dries committed
181 182
}

183 184 185
/**
 * Implementation of hook_load().
 */
Dries's avatar
 
Dries committed
186
function book_load($node) {
187
  return db_fetch_object(db_query('SELECT * FROM {book} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
188 189
}

190 191 192 193
function book_form_alter($form_id, &$form) {
  if ($form_id == 'node_delete_confirm') {
    $form['#submit']['book_node_delete_confirm_submit'] = array();
  }
Dries's avatar
 
Dries committed
194
}
Dries's avatar
 
Dries committed
195

196 197 198
function book_node_submit($form_id, $node) {
  $node = (object)$node;
  if ($node->is_new || $node->revision) {
199
    db_query("INSERT INTO {book} (nid, vid, parent, weight) VALUES (%d, %d, %d, %d)", $node->nid, $node->vid, $node->parent, $node->weight);
200 201 202 203
  }
  else {
    db_query("UPDATE {book} SET parent = %d, weight = %d WHERE vid = %d", $node->parent, $node->weight, $node->vid);
  }
Dries's avatar
 
Dries committed
204
}
Dries's avatar
 
Dries committed
205

206 207
function book_node_delete_confirm_submit($form_id, $form_values) {
  db_query('DELETE FROM {book} WHERE nid = %d OR parent = %d', $form_values['node']->nid, $form_values['node']->nid);
208
}
209

210 211 212
/**
 * Implementation of hook_form().
 */
Dries's avatar
 
Dries committed
213
function book_form(&$node) {
214 215
  global $user;

216
  $type = node_get_types('type', $node);
217
  if ($node->nid && !$node->parent && !user_access('create new books')) {
218
    $form['parent'] = array('#type' => 'value', '#value' => $node->parent);
219 220 221 222 223 224 225
  }
  else {
    $form['parent'] = array('#type' => 'select',
      '#title' => t('Parent'),
      '#default_value' => ($node->parent ? $node->parent : arg(4)),
      '#options' => book_toc($node->nid),
      '#weight' => -4,
226
      '#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.'),
227 228
    );
  }
229 230

  $form['title'] = array('#type' => 'textfield',
231
    '#title' => check_plain($type->title_label),
232 233 234 235 236
    '#required' => TRUE,
    '#default_value' => $node->title,
    '#weight' => -5,
  );
  $form['body_filter']['body'] = array('#type' => 'textarea',
237
    '#title' => check_plain($type->body_label),
238 239 240 241
    '#default_value' => $node->body,
    '#rows' => 20,
    '#required' => TRUE,
  );
242
  $form['body_filter']['format'] = filter_form($node->format);
243

244
  $form['log'] = array(
245 246 247 248
    '#type' => 'textarea',
    '#title' => t('Log message'),
    '#weight' => 5,
    '#description' => t('An explanation of the additions or updates being made to help other authors understand your motivations.'),
249
  );
Dries's avatar
 
Dries committed
250

251 252 253 254 255 256 257 258 259 260
  $form['weight'] = array('#type' => 'weight',
    '#title' => t('Weight'),
    '#access' => user_access('administer nodes'),
    '#default_value' => $node->weight,
    '#delta' => 15,
    '#weight' => 5,
    '#description' => t('Pages at a given level are ordered first by weight and then by title.'),
  );

  if (!user_access('administer nodes')) {
261 262 263 264 265 266
    // If a regular user updates a book page, we preserve the node weight; otherwise
    // we use 0 as the default for new pages
    $form['weight'] = array(
      '#type' => 'value',
      '#value' => isset($node->weight) ? $node->weight : 0,
    );
267
    $form['name'] = array('#type' => 'value', '#value' => $user->uid ? $user->name : '');
Dries's avatar
 
Dries committed
268 269
  }

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

273
/**
Dries's avatar
 
Dries committed
274 275
 * Implementation of function book_outline()
 * Handles all book outline operations.
276
 */
277 278
function book_outline($nid) {
  $node = node_load($nid);
279
  $page = book_load($node);
Dries's avatar
 
Dries committed
280

281 282 283
  $form['parent'] = array('#type' => 'select',
    '#title' => t('Parent'),
    '#default_value' => $page->parent,
284
    '#options' => book_toc($node->nid),
285 286 287 288 289 290 291 292 293 294 295 296
    '#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'),
    '#description' => t('An explanation to help other authors understand your motivations to put this post into the book.'),
  );
Dries's avatar
 
Dries committed
297

298 299 300 301 302 303 304 305 306 307 308 309
  $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
310

311
  drupal_set_title(check_plain($node->title));
312
  return $form;
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
}

/**
 * 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
337
  }
338
  return "node/$node->nid";
Dries's avatar
 
Dries committed
339 340
}

341
/**
Dries's avatar
Dries committed
342 343
 * Given a node, this function returns an array of 'book node' objects
 * representing the path in the book tree from the root to the
344
 * parent of the given node.
Dries's avatar
Dries committed
345
 *
346 347 348 349 350 351
 * @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.
 *
352
 */
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));
355
  if (isset($parent->title)) {
Dries's avatar
 
Dries committed
356
    $nodes = book_location($parent, $nodes);
357
    $nodes[] = $parent;
Dries's avatar
 
Dries committed
358 359 360 361
  }
  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.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
367
  if ($last_direct_child) {
368
    $nodes[] = $last_direct_child;
Dries's avatar
 
Dries committed
369 370 371 372 373
    $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 (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'), $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 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
  // No direct child: get next for this level or any parent in this book.
409
  $path = book_location($node); // Path to top-level node including this one.
410
  $path[] = $node;
411

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

420
/**
421
 * Returns the content of a given node. If $teaser if TRUE, returns
422
 * the teaser rather than full content. Displays the most recently
423 424 425
 * 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
426
function book_content($node, $teaser = FALSE) {
427 428
  // Return the page body.
  return node_prepare($node, $teaser);
Dries's avatar
 
Dries committed
429 430
}

431
/**
Dries's avatar
 
Dries committed
432 433 434
 * Implementation of hook_nodeapi().
 *
 * Appends book navigation to all nodes in the book.
435
 */
Dries's avatar
 
Dries committed
436 437 438 439
function book_nodeapi(&$node, $op, $teaser, $page) {
  switch ($op) {
    case 'view':
      if (!$teaser) {
440
        $book = db_fetch_array(db_query('SELECT * FROM {book} WHERE vid = %d', $node->vid));
Dries's avatar
 
Dries committed
441 442 443 444
        if ($book) {
          foreach ($book as $key => $value) {
            $node->$key = $value;
          }
445 446 447 448 449 450 451 452 453

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

454 455 456 457
          $node->content['book_navigation'] = array(
            '#value' => theme('book_navigation', $node),
            '#weight' => 100,
          );
458

459 460 461
          if ($page) {
            menu_set_location($node->breadcrumb);
          }
Dries's avatar
 
Dries committed
462
        }
Dries's avatar
 
Dries committed
463
      }
Dries's avatar
 
Dries committed
464
      break;
465
    case 'delete revision':
466 467
      db_query('DELETE FROM {book} WHERE vid = %d', $node->vid);
      break;
Dries's avatar
 
Dries committed
468
  }
Dries's avatar
 
Dries committed
469
}
Dries's avatar
 
Dries committed
470

471
/**
472
 * Prepares the links to children (TOC) and forward/backward
473
 * navigation for a node presented as a book page.
474 475
 *
 * @ingroup themeable
476
 */
477
function theme_book_navigation($node) {
478
  $output = '';
479
  $links = '';
480

Dries's avatar
 
Dries committed
481
  if ($node->nid) {
482
    $tree = book_tree($node->nid);
Dries's avatar
 
Dries committed
483

Dries's avatar
 
Dries committed
484
    if ($prev = book_prev($node)) {
485
      drupal_add_link(array('rel' => 'prev', 'href' => url('node/'. $prev->nid)));
486
      $links .= l(t('‹ ') . $prev->title, 'node/'. $prev->nid, array('class' => 'page-previous', 'title' => t('Go to previous page')));
Dries's avatar
 
Dries committed
487
    }
488
    if ($node->parent) {
489
      drupal_add_link(array('rel' => 'up', 'href' => url('node/'. $node->parent)));
490
      $links .= l(t('up'), 'node/'. $node->parent, array('class' => 'page-up', 'title' => t('Go to parent page')));
Dries's avatar
 
Dries committed
491 492
    }
    if ($next = book_next($node)) {
493
      drupal_add_link(array('rel' => 'next', 'href' => url('node/'. $next->nid)));
494
      $links .= l($next->title . t(' ›'), 'node/'. $next->nid, array('class' => 'page-next', 'title' => t('Go to next page')));
Dries's avatar
 
Dries committed
495
    }
Dries's avatar
 
Dries committed
496

497 498 499 500 501 502 503 504 505 506
    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
507
  }
Dries's avatar
 
Dries committed
508

509
  return $output;
Dries's avatar
 
Dries committed
510
}
Dries's avatar
 
Dries committed
511

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

  return $toc;
}

528 529 530
/**
 * Returns an array of titles and nid entries of book pages in table of contents order.
 */
531
function book_toc($exclude = 0) {
532
  $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
533

534
  $children = array();
Dries's avatar
 
Dries committed
535
  while ($node = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
536 537 538
    if (!$children[$node->parent]) {
      $children[$node->parent] = array();
    }
539
    $children[$node->parent][] = $node;
Dries's avatar
 
Dries committed
540
  }
Dries's avatar
 
Dries committed
541

542
  $toc = array();
543
  // If the user has permission to create new books, add the top-level book page to the menu;
544
  if (user_access('create new books')) {
545
    $toc[0] = '<'. t('top-level') .'>';
Dries's avatar
 
Dries committed
546 547
  }

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

Dries's avatar
 
Dries committed
550 551 552
  return $toc;
}

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

  return $output;
}

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

Dries's avatar
 
Dries committed
594
  while ($node = db_fetch_object($result)) {
595
    $list = isset($children[$node->parent]) ? $children[$node->parent] : array();
596
    $list[] = $node;
Dries's avatar
 
Dries committed
597
    $children[$node->parent] = $list;
Dries's avatar
 
Dries committed
598
  }
Dries's avatar
 
Dries committed
599

Dries's avatar
 
Dries committed
600
  if ($tree = book_tree_recurse($parent, $depth, $children, $unfold)) {
601
    return '<ul class="menu">'. $tree .'</ul>';
Dries's avatar
 
Dries committed
602
  }
Dries's avatar
 
Dries committed
603 604
}

605
/**
Dries's avatar
Dries committed
606
 * Menu callback; prints a listing of all books.
607
 */
Dries's avatar
 
Dries committed
608
function book_render() {
609
  $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 ORDER BY b.weight, n.title'));
Dries's avatar
 
Dries committed
610

611 612 613 614 615 616
  $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
617 618
}

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

  if (function_exists($export_function)) {
    print call_user_func($export_function, $nid, $depth);
648 649
  }
  else {
650
    drupal_set_message(t('Unknown export format.'));
651
    drupal_not_found();
652
  }
653
}
Dries's avatar
 
Dries committed
654

655 656 657 658
/**
 * 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
659
 * section/. For example, a child node with depth 2 in the hierarchy
660
 * is contained in (otherwise empty) &lt;div&gt; elements
661
 * corresponding to depth 0 and depth 1. This is intended to support
662 663 664 665 666 667 668
 * 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
669 670 671
 *   - an integer giving the depth in the book hierarchy of the node
 *     which is to be exported
 *
672
 * @return
673 674
 *   - string containing HTML representing the node and its children in
 *     the book hierarchy
675 676 677
*/
function book_export_html($nid, $depth) {
  if (user_access('see printer-friendly version')) {
678
    $node = node_load($nid);
679
    for ($i = 1; $i < $depth; $i++) {
680
      $content .= "<div class=\"section-$i\">\n";
681
    }
682
    $content .= book_recurse($nid, $depth, 'book_node_visitor_html_pre', 'book_node_visitor_html_post');
683
    for ($i = 1; $i < $depth; $i++) {
684
      $content .= "</div>\n";
685
    }
686
    return theme('book_export_html', check_plain($node->title), $content);
687 688 689 690 691 692
  }
  else {
    drupal_access_denied();
  }
}

693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
/**
 * 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;
}

710
/**
711
 * Traverses the book tree. Applies the $visit_pre() callback to each
712
 * node, is called recursively for each child of the node (in weight,
713
 * title order). Finally appends the output of the $visit_post()
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
 * 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) {
729
  $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 ORDER BY b.weight, n.title'), $nid);
Dries's avatar
 
Dries committed
730
  while ($page = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
731
    // Load the node:
732
    $node = node_load($page->nid);
Dries's avatar
 
Dries committed
733

Dries's avatar
 
Dries committed
734
    if ($node) {
735 736
      if (function_exists($visit_pre)) {
        $output .= call_user_func($visit_pre, $node, $depth, $nid);
Dries's avatar
 
Dries committed
737
      }
738 739
      else {
        $output .= book_node_visitor_html_pre($node, $depth, $nid);
Dries's avatar
 
Dries committed
740
      }
Dries's avatar
 
Dries committed
741

742
      $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 ORDER BY b.weight, n.title'), $node->nid);
743
      while ($childpage = db_fetch_object($children)) {
744
          $childnode = node_load($childpage->nid);
745
          if ($childnode->nid != $node->nid) {
746
              $output .= book_recurse($childnode->nid, $depth + 1, $visit_pre, $visit_post);
747 748 749
          }
      }
      if (function_exists($visit_post)) {
750
        $output .= call_user_func($visit_post, $node, $depth);
751
      }
752 753
      else {
        # default
754
        $output .= book_node_visitor_html_post($node, $depth);
755
      }
Dries's avatar
 
Dries committed
756
    }
Dries's avatar
 
Dries committed
757
  }
Dries's avatar
 
Dries committed
758

Dries's avatar
 
Dries committed
759 760
  return $output;
}
Dries's avatar
 
Dries committed
761

762
/**
763
 * Generates printer-friendly HTML for a node. This function
764 765 766 767 768 769 770 771 772 773 774 775 776
 * 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.
 */
777
function book_node_visitor_html_pre($node, $depth, $nid) {
778 779 780 781 782
  // Output the content:
  if (node_hook($node, 'content')) {
    $node = node_invoke($node, 'content');
  }
  // Allow modules to change $node->body before viewing.
783
  node_invoke_nodeapi($node, 'print', $node->body, FALSE);
784

785 786
  $output .= "<div id=\"node-". $node->nid ."\" class=\"section-$depth\">\n";
  $output .= "<h1 class=\"book-heading\">". check_plain($node->title) ."</h1>\n";
787 788

  if ($node->body) {
789
    $output .= drupal_render($node->content);
790 791 792 793 794 795 796 797 798
  }
  return $output;
}

/**
 * Finishes up generation of printer-friendly HTML after visiting a
 * node. This function is a 'post-node' visitor function for
 * book_recurse().
 */
799
function book_node_visitor_html_post($node, $depth) {
800 801 802
  return "</div>\n";
}

803 804 805 806 807 808 809 810 811 812 813
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;
814 815
}

816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
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,
    ),
832
  );
833 834 835 836 837 838 839

  $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
840 841
}

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

845
  $rows = array();
846 847
  foreach (element_children($form) as $key) {
    $nid = $form[$key]['nid']['#value'];
848
    $pid = $form[0]['nid']['#value'];
849
    $rows[] = array(
850 851
      '<div style="padding-left: '. (25 * $form[$key]['depth']['#value']) .'px;">'. drupal_render($form[$key]['title']) .'</div>',
      drupal_render($form[$key]['weight']),
852 853
      l(t('view'), 'node/'. $nid),
      l(t('edit'), 'node/'. $nid .'/edit'),
854
      l(t('delete'), 'node/'. $nid .'/delete', NULL, 'destination=admin/content/book'. (arg(3) == 'orphan' ? '/orphan' : '') . ($pid != $nid ? '/'.$pid : ''))
855
    );
Dries's avatar
 
Dries committed
856 857
  }

858
  return theme('table', $header, $rows);
Dries's avatar
 
Dries committed
859 860
}

861 862 863
/**
 * Display an administrative view of the hierarchy of a book.
 */
864
function book_admin_edit($nid) {
865
  $node = node_load($nid);
866
  if ($node->nid) {
867
    drupal_set_title(check_plain($node->title));
868
    $form = array();
869

Dries's avatar