book.install 10.4 KB
Newer Older
1
<?php
2
// $Id$
3

4
5
6
/**
 * Implementation of hook_install().
 */
7
function book_install() {
8
9
  // Create tables.
  drupal_install_schema('book');
Dries's avatar
Dries committed
10
11
  // Add the node type.
  _book_install_type_create();
12
}
13
14
15
16
17

/**
 * Implementation of hook_uninstall().
 */
function book_uninstall() {
Dries's avatar
Dries committed
18
19
20
  // Delete menu links.
  db_query("DELETE FROM {menu_links} WHERE module = 'book'");
  menu_cache_clear_all();
21
22
  // Remove tables.
  drupal_uninstall_schema('book');
23
}
Dries's avatar
Dries committed
24
25

function _book_install_type_create() {
26
  // Create an additional node type.
Dries's avatar
Dries committed
27
28
29
  $book_node_type = array(
    'type' => 'book',
    'name' => t('Book page'),
30
    'base' => 'node_content',
31
    'description' => t('A <em>book page</em> is a page of content, organized into a collection of related entries collectively known as a <em>book</em>. A <em>book page</em> automatically displays links to adjacent pages, providing a simple navigation system for organizing and reviewing structured content.'),
32
33
34
    'custom' => 1,
    'modified' => 1,
    'locked' => 0,
Dries's avatar
Dries committed
35
36
  );

37
  $book_node_type = node_type_set_defaults($book_node_type);
Dries's avatar
Dries committed
38
39
40
41
42
43
44
45
  node_type_save($book_node_type);
  // Default to not promoted.
  variable_set('node_options_book', array('status'));
  // Use this default type for adding content to books.
  variable_set('book_allowed_types', array('book'));
  variable_set('book_child_type', 'book');
}

46
47
48
49
/**
 * Drupal 5.x to 6.x update.
 *
 * This function moves any existing book hierarchy into the new structure used
50
 * in the 6.x module. Rather than storing the hierarchy in the {book} table,
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 * the menu API is used to store the hierarchy in the {menu_links} table and the
 * {book} table serves to uniquely connect a node to a menu link.
 *
 * In order to accomplish this, the current hierarchy is processed using a stack.
 * The stack insures that each parent is processed before any of its children
 * in the book hierarchy, and is compatible with batched update processing.
 *
 */
function book_update_6000() {
  $ret = array();

  // Set up for a multi-part update.
  if (!isset($_SESSION['book_update_6000'])) {

    $schema['book'] = array(
      'fields' => array(
        'mlid'    => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
        'nid'     => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
        'bid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
      ),
71
72
73
74
      'primary key' => array('mlid'),
      'unique keys' => array(
        'nid' => array('nid'),
      ),
75
      'indexes' => array(
76
        'bid' => array('bid'),
77
78
79
80
81
82
83
84
85
86
87
      ),
    );
    // Add the node type.
    _book_install_type_create();

    // Fix role permissions to account for the changed names
    // Setup the array holding strings to match and the corresponding
    // strings to replace them with.
    $replace = array(
      'outline posts in books' => 'administer book outlines',
      'create book pages' => 'create book content',
88
      'edit book pages' => 'edit any book content',
89
90
91
92
93
94
95
96
97
98
      'edit own book pages' => 'edit own book content',
      'see printer-friendly version' => 'access printer-friendly version',
    );

    // Loop over all the roles, and do the necessary transformations.
    $query = db_query("SELECT rid, perm FROM {permission} ORDER BY rid");
    while ($role = db_fetch_object($query)) {
      // Replace all the old permissions with the corresponding new permissions.
      $fixed_perm = strtr($role->perm, $replace);
      // If the user could previously create book pages, they should get the new
Dries's avatar
Dries committed
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
      // 'add content to books' permission.
      if (strpos($role->perm, 'create book pages') !== FALSE) {
        $fixed_perm .= ', add content to books';
      }
      // Only save if the permissions have changed.
      if ($fixed_perm != $role->perm) {
        $ret[] = update_sql("UPDATE {permission} SET perm = '$fixed_perm' WHERE rid = $role->rid");
      }
    }

    // Determine whether there are any existing nodes in the book hierarchy.
    if (db_result(db_query("SELECT COUNT(*) FROM {book}"))) {
      // Temporary table for the old book hierarchy; we'll discard revision info.
      $schema['book_temp'] = array(
        'fields' => array(
          'nid'    => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0),
          'parent' => array('type' => 'int', 'not null' => TRUE, 'default' => 0),
          'weight' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny')
        ),
        'indexes' => array(
          'parent' => array('parent')
        ),
        'primary key' => array('nid'),
      );

      db_create_table($ret, 'book_temp', $schema['book_temp']);

      // Insert each node in the old table into the temporary table.
      $ret[] = update_sql("INSERT INTO {book_temp} (nid, parent, weight) SELECT b.nid, b.parent, b.weight FROM {book} b INNER JOIN {node} n on b.vid = n.vid");
      $ret[] = update_sql("DROP TABLE {book}");

      db_create_table($ret, 'book', $schema['book']);

132
133
      drupal_set_session('book_update_6000_orphans', array('from' => 0));
      drupal_set_session('book_update_6000', array());
Dries's avatar
Dries committed
134
135
136
137
138
139
140
141
142
143
      $result = db_query("SELECT * from {book_temp} WHERE parent = 0");

      // Collect all books - top-level nodes.
      while ($a = db_fetch_array($result)) {
        $_SESSION['book_update_6000'][] = $a;
      }
      $ret['#finished'] = FALSE;
      return $ret;
    }
    else {
144
      // No existing nodes in the hierarchy, so drop the table and re-create it.
Dries's avatar
Dries committed
145
146
147
148
149
150
151
      $ret[] = update_sql("DROP TABLE {book}");
      db_create_table($ret, 'book', $schema['book']);
      return $ret;
    }
  }
  elseif ($_SESSION['book_update_6000_orphans']) {
    // Do the first batched part of the update - collect orphans.
152
    $update_count = 400; // Update this many at a time.
Dries's avatar
Dries committed
153
154

    $result = db_query_range("SELECT * FROM {book_temp}", $_SESSION['book_update_6000_orphans']['from'], $update_count);
155
    $has_rows = FALSE;
Dries's avatar
Dries committed
156
157
    // Go through the next $update_count book pages and locate the orphans.
    while ($book = db_fetch_array($result)) {
158
      $has_rows = TRUE;
Dries's avatar
Dries committed
159
160
161
162
163
164
      // Orphans are defined as nodes whose parent does not exist in the table.
      if ($book['parent'] && !db_result(db_query("SELECT COUNT(*) FROM {book_temp} WHERE nid = %d", $book['parent']))) {
        if (empty($_SESSION['book_update_6000_orphans']['book'])) {
          // The first orphan becomes the parent for all other orphans.
          $book['parent'] = 0;
          $_SESSION['book_update_6000_orphans']['book'] = $book;
165
          $ret[] = array('success' => TRUE, 'query' => 'Relocated orphan book pages.');
Dries's avatar
Dries committed
166
167
168
169
170
171
172
173
        }
        else {
          // Re-assign the parent value of the book, and add it to the stack.
          $book['parent'] = $_SESSION['book_update_6000_orphans']['book']['nid'];
          $_SESSION['book_update_6000'][] = $book;
        }
      }
    }
174
175
176
177
178
179
180
181
182
183
    if ($has_rows) {
      $_SESSION['book_update_6000_orphans']['from'] += $update_count;
    }
    else {
      if (!empty($_SESSION['book_update_6000_orphans']['book'])) {
        // The orphans' parent is added last, so it will be processed first.
        $_SESSION['book_update_6000'][] = $_SESSION['book_update_6000_orphans']['book'];
      }
      $_SESSION['book_update_6000_orphans'] = FALSE;
    }
Dries's avatar
Dries committed
184
    $ret['#finished'] = FALSE;
185

Dries's avatar
Dries committed
186
187
188
    return $ret;
  }
  else {
189
    // Run the next batched part of the update.
Dries's avatar
Dries committed
190
191
192
193
194
195
    $update_count = 100; // Update this many at a time

    while ($update_count && $_SESSION['book_update_6000']) {
      // Get the last node off the stack.
      $book = array_pop($_SESSION['book_update_6000']);

196
      // Add all of this node's children to the stack.
Dries's avatar
Dries committed
197
198
199
200
201
202
203
204
205
206
207
      $result = db_query("SELECT * FROM {book_temp} WHERE parent = %d", $book['nid']);
      while ($a = db_fetch_array($result)) {
        $_SESSION['book_update_6000'][] = $a;
      }

      if ($book['parent']) {
        // If its not a top level page, get its parent's mlid.
        $parent = db_fetch_array(db_query("SELECT b.mlid AS plid, b.bid FROM {book} b WHERE b.nid = %d", $book['parent']));
        $book = array_merge($book, $parent);
      }
      else {
208
        // There is no parent - this is a new book.
Dries's avatar
Dries committed
209
210
211
212
213
214
        $book['plid'] = 0;
        $book['bid'] = $book['nid'];
      }

      $book += array(
        'module' => 'book',
215
        'link_path' => 'node/' . $book['nid'],
Dries's avatar
Dries committed
216
        'router_path' => 'node/%',
217
        'menu_name' => 'book-toc-' . $book['bid'],
Dries's avatar
Dries committed
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
      );
      $book = array_merge($book, db_fetch_array(db_query("SELECT title AS link_title FROM {node} WHERE nid = %d", $book['nid'])));

      // Items with depth > MENU_MAX_DEPTH cannot be saved.
      if (menu_link_save($book)) {
        db_query("INSERT INTO {book} (mlid, nid, bid) VALUES (%d, %d, %d)", $book['mlid'], $book['nid'], $book['bid']);
      }
      else {
        // The depth was greater then MENU_MAX_DEPTH, so attach it to the
        // closest valid parent.
        $book['plid'] = db_result(db_query("SELECT plid FROM {menu_links} WHERE mlid = %d", $book['plid']));
        if (menu_link_save($book)) {
          db_query("INSERT INTO {book} (mlid, nid, bid) VALUES (%d, %d, %d)", $book['mlid'], $book['nid'], $book['bid']);
        }
      }
      $update_count--;
    }
    $ret['#finished'] = FALSE;
  }

  if (empty($_SESSION['book_update_6000'])) {
    $ret['#finished'] = TRUE;
240
    $ret[] = array('success' => TRUE, 'query' => 'Relocated existing book pages.');
Dries's avatar
Dries committed
241
242
243
244
245
246
247
248
    $ret[] = update_sql("DROP TABLE {book_temp}");
    unset($_SESSION['book_update_6000']);
    unset($_SESSION['book_update_6000_orphans']);
  }

  return $ret;
}

249
250
251
252
253
/**
 * Implementation of hook_schema().
 */
function book_schema() {
  $schema['book'] = array(
254
  'description' => 'Stores book outline information. Uniquely connects each node in the outline to a link in {menu_links}',
255
    'fields' => array(
256
257
258
259
260
      'mlid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
261
        'description' => "The book page's {menu_links}.mlid.",
262
263
264
265
266
267
      ),
      'nid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
268
        'description' => "The book page's {node}.nid.",
269
270
271
272
273
274
      ),
      'bid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
275
        'description' => "The book ID is the {book}.nid of the top-level page.",
276
      ),
277
    ),
278
279
280
281
    'primary key' => array('mlid'),
    'unique keys' => array(
      'nid' => array('nid'),
    ),
282
    'indexes' => array(
283
      'bid' => array('bid'),
284
285
286
287
288
    ),
  );

  return $schema;
}