node.install 13.5 KB
Newer Older
1
2
3
<?php
// $Id$

4
5
6
7
8
/**
 * @file
 * Install, update and uninstall functions for the node module.
 */

9
/**
10
 * Implement hook_schema().
11
12
13
 */
function node_schema() {
  $schema['node'] = array(
14
    'description' => 'The base table for nodes.',
15
    'fields' => array(
16
      'nid' => array(
17
        'description' => 'The primary identifier for a node.',
18
19
        'type' => 'serial',
        'unsigned' => TRUE,
20
21
        'not null' => TRUE,
      ),
22
      'vid' => array(
23
        'description' => 'The current {node_revision}.vid version identifier.',
24
25
26
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
27
28
        'default' => 0,
      ),
29
      'type' => array(
30
        'description' => 'The {node_type}.type of this node.',
31
32
33
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
34
35
        'default' => '',
      ),
36
      'language' => array(
37
        'description' => 'The {languages}.language of this node.',
38
39
40
        'type' => 'varchar',
        'length' => 12,
        'not null' => TRUE,
41
42
        'default' => '',
      ),
43
      'title' => array(
44
        'description' => 'The title of this node, always treated as non-markup plain text.',
45
46
47
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
48
49
        'default' => '',
      ),
50
      'uid' => array(
51
        'description' => 'The {users}.uid that owns this node; initially, this is the user that created it.',
52
53
        'type' => 'int',
        'not null' => TRUE,
54
55
        'default' => 0,
      ),
56
      'status' => array(
57
        'description' => 'Boolean indicating whether the node is published (visible to non-administrators).',
58
59
        'type' => 'int',
        'not null' => TRUE,
60
61
        'default' => 1,
      ),
62
      'created' => array(
63
        'description' => 'The Unix timestamp when the node was created.',
64
65
        'type' => 'int',
        'not null' => TRUE,
66
67
        'default' => 0,
      ),
68
      'changed' => array(
69
        'description' => 'The Unix timestamp when the node was most recently saved.',
70
71
        'type' => 'int',
        'not null' => TRUE,
72
73
        'default' => 0,
      ),
74
      'comment' => array(
75
        'description' => 'Whether comments are allowed on this node: 0 = no, 1 = closed (read only), 2 = open (read/write).',
76
77
        'type' => 'int',
        'not null' => TRUE,
78
79
        'default' => 0,
      ),
80
      'promote' => array(
81
        'description' => 'Boolean indicating whether the node should be displayed on the front page.',
82
83
        'type' => 'int',
        'not null' => TRUE,
84
85
        'default' => 0,
      ),
86
      'moderate' => array(
87
        'description' => 'Previously, a boolean indicating whether the node was "in moderation"; mostly no longer used.',
88
89
        'type' => 'int',
        'not null' => TRUE,
90
91
        'default' => 0,
      ),
92
      'sticky' => array(
93
        'description' => 'Boolean indicating whether the node should be displayed at the top of lists in which it appears.',
94
95
        'type' => 'int',
        'not null' => TRUE,
96
97
        'default' => 0,
      ),
98
      'tnid' => array(
99
        'description' => 'The translation set id for this node, which equals the node id of the source post in each set.',
100
101
102
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
103
104
        'default' => 0,
      ),
105
      'translate' => array(
106
        'description' => 'A boolean indicating whether this translation page needs to be updated.',
107
108
        'type' => 'int',
        'not null' => TRUE,
109
        'default' => 0,
110
      ),
111
    ),
112
113
114
115
    'indexes' => array(
      'node_changed'        => array('changed'),
      'node_created'        => array('created'),
      'node_moderate'       => array('moderate'),
116
      'node_frontpage'      => array('promote', 'status', 'sticky', 'created'),
117
118
119
120
121
122
      'node_status_type'    => array('status', 'type', 'nid'),
      'node_title_type'     => array('title', array('type', 4)),
      'node_type'           => array(array('type', 4)),
      'uid'                 => array('uid'),
      'tnid'                => array('tnid'),
      'translate'           => array('translate'),
123
    ),
124
    'unique keys' => array(
125
126
      'vid' => array('vid'),
    ),
127
128
129
130
    'foreign keys' => array(
      'vid' => array('node_revision' => 'vid'),
      'uid' => array('users' => 'uid'),
    ),
131
    'primary key' => array('nid'),
132
  );
133
134

  $schema['node_access'] = array(
135
    'description' => 'Identifies which realm/grant pairs a user must possess in order to view, update, or delete specific nodes.',
136
    'fields' => array(
137
      'nid' => array(
138
        'description' => 'The {node}.nid this record affects.',
139
140
141
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
142
143
        'default' => 0,
      ),
144
      'gid' => array(
145
        'description' => "The grant ID a user must possess in the specified realm to gain this row's privileges on the node.",
146
147
148
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
149
150
        'default' => 0,
      ),
151
      'realm' => array(
152
        'description' => 'The realm in which the user must possess the grant ID. Each node access node can define one or more realms.',
153
154
155
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
156
157
        'default' => '',
      ),
158
      'grant_view' => array(
159
        'description' => 'Boolean indicating whether a user with the realm/grant pair can view this node.',
160
161
162
163
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
164
165
        'size' => 'tiny',
      ),
166
      'grant_update' => array(
167
        'description' => 'Boolean indicating whether a user with the realm/grant pair can edit this node.',
168
169
170
171
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
172
173
        'size' => 'tiny',
      ),
174
      'grant_delete' => array(
175
        'description' => 'Boolean indicating whether a user with the realm/grant pair can delete this node.',
176
177
178
179
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
180
        'size' => 'tiny',
181
      ),
182
    ),
183
    'primary key' => array('nid', 'gid', 'realm'),
184
    'foreign keys' => array('node' => 'nid'),
185
  );
186

187
  $schema['node_revision'] = array(
188
    'description' => 'Stores information about each saved version of a {node}.',
189
    'fields' => array(
190
      'nid' => array(
191
        'description' => 'The {node} this version belongs to.',
192
193
194
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
195
196
        'default' => 0,
      ),
197
      'vid' => array(
198
        'description' => 'The primary identifier for this version.',
199
200
        'type' => 'serial',
        'unsigned' => TRUE,
201
202
        'not null' => TRUE,
      ),
203
      'uid' => array(
204
        'description' => 'The {users}.uid that created this version.',
205
206
        'type' => 'int',
        'not null' => TRUE,
207
208
        'default' => 0,
      ),
209
      'title' => array(
210
        'description' => 'The title of this version.',
211
212
213
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
214
215
        'default' => '',
      ),
216
      'body' => array(
217
        'description' => 'The body of this version.',
218
219
        'type' => 'text',
        'not null' => TRUE,
220
221
        'size' => 'big',
      ),
222
      'teaser' => array(
223
        'description' => 'The teaser of this version.',
224
225
        'type' => 'text',
        'not null' => TRUE,
226
227
        'size' => 'big',
      ),
228
      'log' => array(
229
        'description' => 'The log entry explaining the changes in this version.',
230
231
        'type' => 'text',
        'not null' => TRUE,
232
233
        'size' => 'big',
      ),
234
      'timestamp' => array(
235
        'description' => 'A Unix timestamp indicating when this version was created.',
236
237
        'type' => 'int',
        'not null' => TRUE,
238
239
        'default' => 0,
      ),
240
      'format' => array(
241
        'description' => "The text format used by this version's body.",
242
243
        'type' => 'int',
        'not null' => TRUE,
244
        'default' => 0,
245
      ),
246
    ),
247
248
    'indexes' => array(
      'nid' => array('nid'),
249
250
      'uid' => array('uid'),
    ),
251
    'primary key' => array('vid'),
252
253
254
255
    'foreign keys' => array(
      'node' => 'nid',
      'users' => 'uid'
    ),
256
  );
257
258

  $schema['node_type'] = array(
259
    'description' => 'Stores information about all defined {node} types.',
260
    'fields' => array(
261
      'type' => array(
262
        'description' => 'The machine-readable name of this type.',
263
264
        'type' => 'varchar',
        'length' => 32,
265
266
        'not null' => TRUE,
      ),
267
      'name' => array(
268
        'description' => 'The human-readable name of this type.',
269
270
271
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
272
273
        'default' => '',
      ),
274
      'base' => array(
275
        'description' => 'The base string used to construct callbacks corresponding to this node type.',
276
277
        'type' => 'varchar',
        'length' => 255,
278
279
280
        'not null' => TRUE,
      ),
      'description' => array(
281
        'description' => 'A brief description of this type.',
282
283
        'type' => 'text',
        'not null' => TRUE,
284
285
        'size' => 'medium',
      ),
286
      'help' => array(
287
        'description' => 'Help information shown to the user when creating a {node} of this type.',
288
289
        'type' => 'text',
        'not null' => TRUE,
290
291
        'size' => 'medium',
      ),
292
      'has_title' => array(
293
        'description' => 'Boolean indicating whether this type uses the {node}.title field.',
294
295
296
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
297
298
        'size' => 'tiny',
      ),
299
      'title_label' => array(
300
        'description' => 'The label displayed for the title field on the edit form.',
301
302
303
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
304
305
        'default' => '',
      ),
306
      'has_body' => array(
307
        'description' => 'Boolean indicating whether this type uses the {node_revision}.body field.',
308
309
310
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
311
312
        'size' => 'tiny',
      ),
313
      'body_label' => array(
314
        'description' => 'The label displayed for the body field on the edit form.',
315
316
317
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
318
319
        'default' => '',
      ),
320
      'min_word_count' => array(
321
        'description' => 'The minimum number of words the body must contain.',
322
323
324
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
325
326
        'size' => 'small',
      ),
327
      'custom' => array(
328
        'description' => 'A boolean indicating whether this type is defined by a module (FALSE) or by a user via a module like the Content Construction Kit (TRUE).',
329
330
331
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
332
333
        'size' => 'tiny',
      ),
334
      'modified' => array(
335
        'description' => 'A boolean indicating whether this type has been modified by an administrator; currently not used in any way.',
336
337
338
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
339
340
        'size' => 'tiny',
      ),
341
      'locked' => array(
342
        'description' => 'A boolean indicating whether the administrator can change the machine name of this type.',
343
344
345
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
346
347
        'size' => 'tiny',
      ),
348
      'orig_type' => array(
349
        'description' => 'The original machine-readable name of this node type. This may be different from the current type name if the locked field is 0.',
350
351
352
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
353
        'default' => '',
354
      ),
355
    ),
356
    'primary key' => array('type'),
357
  );
358
359
360

  return $schema;
}
361
362

/**
363
364
 * @defgroup updates-6.x-to-7.x System updates from 6.x to 7.x
 * @{
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 */

/**
 * Fix node type 'module' attribute to avoid name-space conflicts.
 */
function node_update_7000() {
  $ret = array();

  $ret[] = update_sql("UPDATE {node_type} SET module = 'node_content' WHERE module = 'node'");
  db_change_field($ret, 'node_type', 'module', 'base', array('type' => 'varchar', 'length' => 255, 'not null' => TRUE));

  return $ret;
}

379
380
381
382
383
384
385
386
387
/**
 * Rename {node_revisions} table to {node_revision}.
 */
function node_update_7001() {
  $ret = array();
  db_rename_table($ret, 'node_revisions', 'node_revision');
  return $ret;
}

388
389
390
391
392
393
394
395
396
397
/**
 * Extend the node_promote_status index to include all fields required for the node page query.
 */
function node_update_7002() {
  $ret = array();
  db_drop_index($ret, 'node', 'node_promote_status');
  db_add_index($ret, 'node', 'node_frontpage', array('promote', 'status', 'sticky', 'created'));
  return $ret;
}

398
/**
399
400
401
402
 * Remove the node_counter if the statistics module is uninstalled.
 */
function node_update_7003() {
  $ret = array();
403
  if (drupal_get_installed_schema_version('statistics') == SCHEMA_UNINSTALLED) {
404
405
406
407
408
    db_drop_table($ret, 'node_counter');
  }
  return $ret;
}

409
410
411
412
413
414
415
416
417
418
/**
 * Extend the existing default preview and teaser settings to all node types.
 */
function node_update_7004() {
  // Get original settings and all types.
  $original_length = variable_get('teaser_length', 600);
  $original_preview = variable_get('node_preview', 0);

  // Map old preview setting to new values order.
  $original_preview ? $original_preview = 2 : $original_preview = 1;
419
  $type_list = node_type_get_types();
420
421

  // Apply original settings to all types.
422
  foreach ($type_list as $type => $object) {
423
424
425
426
427
    variable_set('teaser_length_' . $type, $original_length);
    variable_set('node_preview_' . $type, $original_preview);
  }
  // Delete old variable but leave 'teaser_length' for aggregator module upgrade.
  variable_del('node_preview');
428
429

  return array();
430
431
}

432
433
434
/**
 * @} End of "defgroup updates-6.x-to-7.x"
 * The next series of updates should start at 8000.
435
 */