system.install 100 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
3

4
5
/**
 * Test and report Drupal installation requirements.
6
7
8
9
10
 *
 * @param $phase
 *   The current system installation phase.
 * @return
 *   An array of system requirements.
11
12
13
14
 */
function system_requirements($phase) {
  $requirements = array();
  // Ensure translations don't break at install time
15
  $t = get_t();
16
17
18
19
20
21

  // Report Drupal version
  if ($phase == 'runtime') {
    $requirements['drupal'] = array(
      'title' => $t('Drupal'),
      'value' => VERSION,
Steven Wittens's avatar
Steven Wittens committed
22
23
      'severity' => REQUIREMENT_INFO,
      'weight' => -10,
24
25
26
27
    );
  }

  // Test web server
Steven Wittens's avatar
Steven Wittens committed
28
  $software = $_SERVER['SERVER_SOFTWARE'];
29
30
  $requirements['webserver'] = array(
    'title' => $t('Web server'),
Steven Wittens's avatar
Steven Wittens committed
31
    'value' => $software,
32
33
  );
  // Use server info string, if present.
Steven Wittens's avatar
Steven Wittens committed
34
35
  if ($software && preg_match('![0-9]!', $software)) {
    list($server, $version) = split('[ /]', $software);
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
    switch ($server) {
      case 'Apache':
        if (version_compare($version, DRUPAL_MINIMUM_APACHE) < 0) {
          $requirements['webserver']['description'] = $t('Your Apache server is too old. Drupal requires at least Apache %version.', array('%version' => DRUPAL_MINIMUM_APACHE));
          $requirements['webserver']['severity'] = REQUIREMENT_ERROR;
        }
        break;

      default:
        $requirements['webserver']['description'] = $t('The web server you\'re using has not been tested with Drupal and might not work properly.');
        $requirements['webserver']['severity'] = REQUIREMENT_WARNING;
        break;
    }
  }
  else {
Steven Wittens's avatar
Steven Wittens committed
51
52
    $requirements['webserver']['value'] = $software ? $software : $t('Unknown');
    $requirements['webserver']['description'] = $t('Unable to determine your web server type and version. Drupal might not work properly.');
53
54
55
56
57
58
    $requirements['webserver']['severity'] = REQUIREMENT_WARNING;
  }

  // Test PHP version
  $requirements['php'] = array(
    'title' => $t('PHP'),
59
    'value' => ($phase == 'runtime') ? l(phpversion(), 'admin/reports/status/php') : phpversion(),
60
61
62
63
64
  );
  if (version_compare(phpversion(), DRUPAL_MINIMUM_PHP) < 0) {
    $requirements['php']['description'] = $t('Your PHP installation is too old. Drupal requires at least PHP %version.', array('%version' => DRUPAL_MINIMUM_PHP));
    $requirements['php']['severity'] = REQUIREMENT_ERROR;
  }
65
66
  
  // Test PHP memory_limit
67
  $memory_limit = ini_get('memory_limit');
68
69
  $requirements['php_memory_limit'] = array(
    'title' => $t('PHP memory limit'),
70
    'value' => $memory_limit,
71
  );
72

73
74
75
76
  if ($memory_limit && parse_size($memory_limit) < parse_size(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT)) {
    $description = '';
    if ($phase == 'install') {
      $description = $t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the installation process.', array('%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
77
78
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
    }
79
80
    elseif ($phase == 'runtime') {
      $description = $t('Depending on your configuration, Drupal can run with a %memory_limit PHP memory limit. However, a %memory_minimum_limit PHP memory limit or above is recommended, especially if your site uses additional custom or contributed modules.', array('%memory_limit' => $memory_limit, '%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
81
82
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
    }
83
84
85
86
87
88
89
90
91
92
93
  
    if (!empty($description)) {
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
        $description .= ' '. $t('Increase the memory limit by editing the memory_limit parameter in the file %configuration-file and then restart your web server (or contact your system administrator or hosting provider for assistance).', array('%configuration-file' => $php_ini_path));
      }
      else {
        $description .= ' '. $t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
      }
      
      $requirements['php_memory_limit']['description'] = $description .' '. $t('See the <a href="@url">Drupal requirements</a> for more information.', array('@url' => 'http://drupal.org/requirements'));
    }
94
95
  }
  
96
97
98
99
100
101
102
103
  // Test DB version
  global $db_type;
  if (function_exists('db_status_report')) {
    $requirements += db_status_report($phase);
  }

  // Test settings.php file writability
  if ($phase == 'runtime') {
104
105
106
    $conf_dir = drupal_verify_install_file(conf_path(), FILE_NOT_WRITABLE, 'dir');
    $conf_file = drupal_verify_install_file(conf_path() .'/settings.php', FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE);
    if (!$conf_dir || !$conf_file) {
107
108
109
      $requirements['settings.php'] = array(
        'value' => $t('Not protected'),
        'severity' => REQUIREMENT_ERROR,
110
        'description' => '',
111
      );
112
113
114
115
116
117
      if (!$conf_dir) {
        $requirements['settings.php']['description'] .= $t('The directory %file is not protected from modifications and poses a security risk. You must change the directory\'s permissions to be non-writable. ', array('%file' => conf_path()));
      }
      if (!$conf_file) {
        $requirements['settings.php']['description'] .= $t('The file %file is not protected from modifications and poses a security risk. You must change the file\'s permissions to be non-writable.', array('%file' => conf_path() .'/settings.php'));
      }
118
119
120
121
122
123
124
125
126
    }
    else {
      $requirements['settings.php'] = array(
        'value' => $t('Protected'),
      );
    }
    $requirements['settings.php']['title'] = $t('Configuration file');
  }

127
  // Report cron status.
128
  if ($phase == 'runtime') {
129
130
131
132
133
    // Cron warning threshold defaults to two days.
    $threshold_warning = variable_get('cron_threshold_warning', 172800);
    // Cron error threshold defaults to two weeks.
    $threshold_error = variable_get('cron_threshold_error', 1209600);
    // Cron configuration help text.
134
    $help = $t('For more information, see the online handbook entry for <a href="@cron-handbook">configuring cron jobs</a>.', array('@cron-handbook' => 'http://drupal.org/cron'));
135
136
137

    // Determine when cron last ran. If never, use the install time to
    // determine the warning or error status.
138
    $cron_last = variable_get('cron_last', NULL);
139
140
141
142
143
    $never_run = FALSE;
    if (!is_numeric($cron_last)) {
      $never_run = TRUE;
      $cron_last = variable_get('install_time', 0);
    }
144

145
146
147
148
    // Determine severity based on time since cron last ran.
    $severity = REQUIREMENT_OK;
    if (time() - $cron_last > $threshold_error) {
      $severity = REQUIREMENT_ERROR;
149
    }
150
    else if ($never_run || (time() - $cron_last > $threshold_warning)) {
151
152
153
154
155
156
      $severity = REQUIREMENT_WARNING;
    }

    // If cron hasn't been run, and the user is viewing the main
    // administration page, instead of an error, we display a helpful reminder
    // to configure cron jobs.
157
    if ($never_run && $severity != REQUIREMENT_ERROR && $_GET['q'] == 'admin' && user_access('administer site configuration')) {
158
      drupal_set_message($t('Cron has not run. Please visit the <a href="@status">status report</a> for more information.', array('@status' => url('admin/reports/status'))));
159
160
    }

161
162
163
164
165
166
167
168
169
170
171
172
    // Set summary and description based on values determined above.
    if ($never_run) {
      $summary = $t('Never run');
      $description = $t('Cron has not run.') .' '. $help;
    }
    else {
      $summary = $t('Last run !time ago', array('!time' => format_interval(time() - $cron_last)));
      $description = '';
      if ($severity != REQUIREMENT_OK) {
        $description = $t('Cron has not run recently.') .' '. $help;
      }
    }
173

174
175
176
177
    $requirements['cron'] = array(
      'title' => $t('Cron maintenance tasks'),
      'severity' => $severity,
      'value' => $summary,
178
      'description' => $description .' '. $t('You can <a href="@cron">run cron manually</a>.', array('@cron' => url('admin/reports/status/run-cron'))),
179
    );
180
181
  }

182
  // Test files directory
183
  $directory = file_directory_path();
184
185
186
187
188
189

  // For installer, create the directory if possible.
  if ($phase == 'install' && !is_dir($directory) && @mkdir($directory)) {
    @chmod($directory, 0775); // Necessary for non-webserver users.
  }

190
191
192
193
194
  $is_writable = is_writable($directory);
  $is_directory = is_dir($directory);
  if (!$is_writable || !$is_directory) {
    if (!$is_directory) {
      $error = $t('The directory %directory does not exist.', array('%directory' => $directory));
195
196
    }
    else {
197
198
199
200
201
202
203
204
205
206
207
208
      $error = $t('The directory %directory is not writable.', array('%directory' => $directory));
    }
    $requirements['file system'] = array(
      'value' => $t('Not writable'),
      'severity' => REQUIREMENT_ERROR,
    );
    if ($phase == 'runtime') {
      $requirements['file system']['description'] = $error .' '. $t('You may need to set the correct directory at the <a href="@admin-file-system">file system settings page</a> or change the current directory\'s permissions so that it is writable.', array('@admin-file-system' => url('admin/settings/file-system')));
    }
    else if ($phase == 'install') {
      // For the installer UI, we need different wording. 'value' will
      // be treated as version, so provide none there.
209
      $requirements['file system']['description'] = $error .' '. $t('An automated attempt to create this directory failed, possibly due to a permissions problem. To proceed with the installation, either create the directory and modify its permissions manually, or ensure that the installer has the permissions to create it automatically. For more information, please see INSTALL.txt or the <a href="@handbook_url">on-line handbook</a>.', array('@handbook_url' => 'http://drupal.org/server-permissions'));
210
211
212
213
214
215
216
217
218
      $requirements['file system']['value'] = '';
    }
  }
  else {
    if (variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC) == FILE_DOWNLOADS_PUBLIC) {
      $requirements['file system']['value'] = $t('Writable (<em>public</em> download method)');
    }
    else {
      $requirements['file system']['value'] = $t('Writable (<em>private</em> download method)');
219
220
    }
  }
221
  $requirements['file system']['title'] = $t('File system');
222

223
224
225
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
226
      'title' => $t('Database updates'),
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
      'severity' => REQUIREMENT_OK,
      'value' => $t('Up to date'),
    );

    // Check installed modules.
    foreach (module_list() as $module) {
      $updates = drupal_get_schema_versions($module);
      if ($updates !== FALSE) {
        $default = drupal_get_installed_schema_version($module);
        if (max($updates) > $default) {
          $requirements['update']['severity'] = REQUIREMENT_ERROR;
          $requirements['update']['value'] = $t('Out of date');
          $requirements['update']['description'] = $t('Some modules have database schema updates to install. You should run the <a href="@update">database update script</a> immediately.', array('@update' => base_path() .'update.php'));
          break;
        }
      }
    }
  }

246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
  // Verify the update.php access setting
  if ($phase == 'runtime') {
    if (!empty($GLOBALS['update_free_access'])) {
      $requirements['update access'] = array(
        'value' => $t('Not protected'),
        'severity' => REQUIREMENT_ERROR,
        'description' => $t('The update.php script is accessible to everyone without authentication check, which is a security risk. You must change the $update_free_access value in your settings.php back to FALSE.'),
      );
    }
    else {
      $requirements['update access'] = array(
        'value' => $t('Protected'),
      );
    }
    $requirements['update access']['title'] = $t('Access to update.php');
  }

263
264
265
266
  // Test Unicode library
  include_once './includes/unicode.inc';
  $requirements = array_merge($requirements, unicode_requirements());

267
268
269
270
271
272
273
274
275
276
277
278
279
  // Check for update status module.
  if ($phase == 'runtime') {
    if (!module_exists('update')) {
      $requirements['update status'] = array(
        'value' => $t('Not enabled'),
        'severity' => REQUIREMENT_ERROR,
        'description' => $t('Update notifications are not enabled. It is <strong>highly recommended</strong> that you enable the update status module from the <a href="@module">module administration page</a> in order to stay up-to-date on new releases. For more information please read the <a href="@update">Update status handbook page</a>.', array('@update' => 'http://drupal.org/handbook/modules/update', '@module' => url('admin/build/modules'))),
      );
    }
    else {
      $requirements['update status'] = array(
        'value' => $t('Enabled'),
      );
280
281
282
283
284
285
286
287
      if (variable_get('drupal_http_request_fails', FALSE)) {
        $requirements['http requests'] = array(
          'title' => $t('HTTP request status'),
          'value' => $t('Fails'),
          'severity' => REQUIREMENT_ERROR,
          'description' => $t('Your system or network configuration does not allow Drupal to access web pages, resulting in reduced functionality. This could be due to your webserver configuration or PHP settings, and should be resolved in order to download information about available updates, fetch aggregator feeds, sign in via OpenID, or use other network-dependent services.'),
        );
      }
288
289
290
291
    }
    $requirements['update status']['title'] = $t('Update notifications');
  }

292
293
294
  return $requirements;
}

295
296
297
/**
 * Implementation of hook_install().
 */
298
function system_install() {
299
  if ($GLOBALS['db_type'] == 'pgsql') {
300
    // Create unsigned types.
301
302
303
    db_query("CREATE DOMAIN int_unsigned integer CHECK (VALUE >= 0)");
    db_query("CREATE DOMAIN smallint_unsigned smallint CHECK (VALUE >= 0)");
    db_query("CREATE DOMAIN bigint_unsigned bigint CHECK (VALUE >= 0)");
304

305
    // Create functions.
306
307
308
309
310
311
312
313
314
315
316
    db_query('CREATE OR REPLACE FUNCTION "greatest"(numeric, numeric) RETURNS numeric AS
      \'SELECT CASE WHEN (($1 > $2) OR ($2 IS NULL)) THEN $1 ELSE $2 END;\'
      LANGUAGE \'sql\''
    );
    db_query('CREATE OR REPLACE FUNCTION "greatest"(numeric, numeric, numeric) RETURNS numeric AS
      \'SELECT greatest($1, greatest($2, $3));\'
      LANGUAGE \'sql\''
    );
    if (!db_result(db_query("SELECT COUNT(*) FROM pg_proc WHERE proname = 'rand'"))) {
      db_query('CREATE OR REPLACE FUNCTION "rand"() RETURNS float AS
        \'SELECT random();\'
317
318
        LANGUAGE \'sql\''
      );
319
    }
320

321
322
323
    if (!db_result(db_query("SELECT COUNT(*) FROM pg_proc WHERE proname = 'concat'"))) {
      db_query('CREATE OR REPLACE FUNCTION "concat"(text, text) RETURNS text AS
        \'SELECT $1 || $2;\'
324
325
        LANGUAGE \'sql\''
      );
326
327
328
329
330
331
332
333
334
    }
    db_query('CREATE OR REPLACE FUNCTION "if"(boolean, text, text) RETURNS text AS
      \'SELECT CASE WHEN $1 THEN $2 ELSE $3 END;\'
      LANGUAGE \'sql\''
    );
    db_query('CREATE OR REPLACE FUNCTION "if"(boolean, integer, integer) RETURNS integer AS
      \'SELECT CASE WHEN $1 THEN $2 ELSE $3 END;\'
      LANGUAGE \'sql\''
    );
335
  }
336

337
  // Create tables.
338
  $modules = array('system', 'filter', 'block', 'user', 'node', 'comment', 'taxonomy');
339
340
  foreach ($modules as $module) {
    drupal_install_schema($module);
341
  }
342

343
344
  // Load system theme data appropriately.
  system_theme_data();
345

346
347
348
349
350
351
352
353
354
355
  // Inserting uid 0 here confuses MySQL -- the next user might be created as
  // uid 2 which is not what we want. So we insert the first user here, the
  // anonymous user. uid is 1 here for now, but very soon it will be changed
  // to 0.
  db_query("INSERT INTO {users} (name, mail) VALUES('%s', '%s')", '', '');
  // We need some placeholders here as name and mail are uniques and data is
  // presumed to be a serialized array. Install will change uid 1 immediately
  // anyways. So we insert the superuser here, the uid is 2 here for now, but
  // very soon it will be changed to 1.
  db_query("INSERT INTO {users} (name, mail, created, data) VALUES('%s', '%s', %d, '%s')", 'placeholder-for-uid-1', 'placeholder-for-uid-1', time(), serialize(array()));
356
357
358
359
360
  // This sets the above two users uid 0 (anonymous). We avoid an explicit 0
  // otherwise MySQL might insert the next auto_increment value.
  db_query("UPDATE {users} SET uid = uid - uid WHERE name = '%s'", '');
  // This sets uid 1 (superuser). We skip uid 2 but that's not a big problem.
  db_query("UPDATE {users} SET uid = 1 WHERE name = '%s'", 'placeholder-for-uid-1');
361

362
363
  db_query("INSERT INTO {role} (name) VALUES ('%s')", 'anonymous user');
  db_query("INSERT INTO {role} (name) VALUES ('%s')", 'authenticated user');
364

365
366
  db_query("INSERT INTO {permission} (rid, perm, tid) VALUES (%d, '%s', %d)", 1, 'access content', 0);
  db_query("INSERT INTO {permission} (rid, perm, tid) VALUES (%d, '%s', %d)", 2, 'access comments, access content, post comments, post comments without approval', 0);
367

368
369
  db_query("INSERT INTO {variable} (name, value) VALUES ('%s', '%s')", 'theme_default', 's:7:"garland";');
  db_query("UPDATE {system} SET status = %d WHERE type = '%s' AND name = '%s'", 1, 'theme', 'garland');
370
371
372
  db_query("INSERT INTO {blocks} (module, delta, theme, status, weight, region, pages) VALUES ('%s', '%s', '%s', %d, %d, '%s', '%s')", 'user', '0', 'garland', 1, 0, 'left', '');
  db_query("INSERT INTO {blocks} (module, delta, theme, status, weight, region, pages) VALUES ('%s', '%s', '%s', %d, %d, '%s', '%s')", 'user', '1', 'garland', 1, 0, 'left', '');
  db_query("INSERT INTO {blocks} (module, delta, theme, status, weight, region, pages) VALUES ('%s', '%s', '%s', %d, %d, '%s', '%s')", 'system', '0', 'garland', 1, 10, 'footer', '');
373

374
  db_query("INSERT INTO {node_access} (nid, gid, realm, grant_view, grant_update, grant_delete) VALUES (%d, %d, '%s', %d, %d, %d)", 0, 0, 'all', 1, 0, 0);
375

376
  // Add input formats.
377
378
  db_query("INSERT INTO {filter_formats} (name, roles, cache) VALUES ('%s', '%s', %d)", 'Filtered HTML', ',1,2,', 1);
  db_query("INSERT INTO {filter_formats} (name, roles, cache) VALUES ('%s', '%s', %d)", 'Full HTML', '', 1);
379
380
381
382
383

  // Enable filters for each input format.

  // Filtered HTML:
  // URL filter.
384
  db_query("INSERT INTO {filters} (format, module, delta, weight) VALUES (%d, '%s', %d, %d)", 1, 'filter', 2, 0);
385
  // HTML filter.
386
  db_query("INSERT INTO {filters} (format, module, delta, weight) VALUES (%d, '%s', %d, %d)", 1, 'filter', 0, 1);
387
  // Line break filter.
388
  db_query("INSERT INTO {filters} (format, module, delta, weight) VALUES (%d, '%s', %d, %d)", 1, 'filter', 1, 2);
389
  // HTML corrector filter.
390
  db_query("INSERT INTO {filters} (format, module, delta, weight) VALUES (%d, '%s', %d, %d)", 1, 'filter', 3, 10);
391
392
393

  // Full HTML:
  // URL filter.
394
  db_query("INSERT INTO {filters} (format, module, delta, weight) VALUES (%d, '%s', %d, %d)", 2, 'filter', 2, 0);
395
  // Line break filter.
396
  db_query("INSERT INTO {filters} (format, module, delta, weight) VALUES (%d, '%s', %d, %d)", 2, 'filter', 1, 1);
397
  // HTML corrector filter.
398
  db_query("INSERT INTO {filters} (format, module, delta, weight) VALUES (%d, '%s', %d, %d)", 2, 'filter', 3, 10);
399

400
  db_query("INSERT INTO {variable} (name, value) VALUES ('%s','%s')", 'filter_html_1', 'i:1;');
401

402
  db_query("INSERT INTO {variable} (name, value) VALUES ('%s', '%s')", 'node_options_forum', 'a:1:{i:0;s:6:"status";}');
403
404
}

405
406
407
408
409
410
411
412
/**
 * Implementation of hook_schema().
 */
function system_schema() {
  // NOTE: {variable} needs to be created before all other tables, as
  // some database drivers, e.g. Oracle and DB2, will require variable_get()
  // and variable_set() for overcoming some database specific limitations.
  $schema['variable'] = array(
413
    'description' => t('Named variable/value pairs created by Drupal core or any other module or theme. All variables are cached in memory at the start of every Drupal request so developers should not be careless about what is stored here.'),
414
    'fields' => array(
415
416
417
418
419
420
421
422
423
424
425
426
      'name' => array(
        'description' => t('The name of the variable.'),
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => ''),
      'value' => array(
        'description' => t('The value of the variable.'),
        'type' => 'text',
        'not null' => TRUE,
        'size' => 'big'),
      ),
427
    'primary key' => array('name'),
428
    );
429
430

  $schema['actions'] = array(
431
    'description' => t('Stores action information.'),
432
    'fields' => array(
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
      'aid' => array(
        'description' => t('Primary Key: Unique actions ID.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '0'),
      'type' => array(
        'description' => t('The object that that action acts on (node, user, comment, system or custom types.)'),
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
        'default' => ''),
      'callback' => array(
        'description' => t('The callback function that executes when the action runs.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'parameters' => array(
        'description' => t('Parameters to be passed to the callback function.'),
        'type' => 'text',
        'not null' => TRUE,
        'size' => 'big'),
      'description' => array(
        'description' => t('Description of the action.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '0'),
      ),
463
    'primary key' => array('aid'),
464
    );
465
466

  $schema['actions_aid'] = array(
467
    'description' => t('Stores action IDs for non-default actions.'),
468
    'fields' => array(
469
470
471
472
473
474
      'aid' => array(
        'description' => t('Primary Key: Unique actions ID.'),
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE),
      ),
475
    'primary key' => array('aid'),
476
    );
477
478

  $schema['batch'] = array(
479
    'description' => t('Stores details about batches (processes that run in multiple HTTP requests).'),
480
    'fields' => array(
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
      'bid' => array(
        'description' => t('Primary Key: Unique batch ID.'),
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE),
      'token' => array(
        'description' => t("A string token generated against the current user's session id and the batch id, used to ensure that only the user who submitted the batch can effectively access it."),
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE),
      'timestamp' => array(
        'description' => t('A Unix timestamp indicating when this batch was submitted for processing. Stale batches are purged at cron time.'),
        'type' => 'int',
        'not null' => TRUE),
      'batch' => array(
        'description' => t('A serialized array containing the processing data for the batch.'),
        'type' => 'text',
        'not null' => FALSE,
        'size' => 'big')
      ),
501
502
    'primary key' => array('bid'),
    'indexes' => array('token' => array('token')),
503
    );
504
505

  $schema['cache'] = array(
506
    'description' => t('Generic cache table for caching things not separated out into their own tables. Contributed modules may also use this to store cached items.'),
507
    'fields' => array(
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
      'cid' => array(
        'description' => t('Primary Key: Unique cache ID.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'data' => array(
        'description' => t('A collection of data to cache.'),
        'type' => 'blob',
        'not null' => FALSE,
        'size' => 'big'),
      'expire' => array(
        'description' => t('A Unix timestamp indicating when the cache entry should expire, or 0 for never.'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0),
      'created' => array(
        'description' => t('A Unix timestamp indicating when the cache entry was created.'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0),
      'headers' => array(
        'description' => t('Any custom HTTP headers to be added to cached data.'),
        'type' => 'text',
        'not null' => FALSE),
      'serialized' => array(
        'description' => t('A flag to indicate whether content is serialized (1) or not (0).'),
        'type' => 'int',
        'size' => 'small',
        'not null' => TRUE,
        'default' => 0)
      ),
540
541
    'indexes' => array('expire' => array('expire')),
    'primary key' => array('cid'),
542
    );
543
544

  $schema['cache_form'] = $schema['cache'];
545
  $schema['cache_form']['description'] = t('Cache table for the form system to store recently built forms and their storage data, to be used in subsequent page requests.');
546
  $schema['cache_page'] = $schema['cache'];
547
  $schema['cache_page']['description'] = t('Cache table used to store compressed pages for anonymous users, if page caching is enabled.');
548
  $schema['cache_menu'] = $schema['cache'];
549
  $schema['cache_menu']['description'] = t('Cache table for the menu system to store router information as well as generated link trees for various menu/page/user combinations.');
550
551

  $schema['files'] = array(
552
    'description' => t('Stores information for uploaded files.'),
553
    'fields' => array(
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
      'fid' => array(
        'description' => t('Primary Key: Unique files ID.'),
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE),
      'uid' => array(
        'description' => t('The {users}.uid of the user who is associated with the file.'),
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0),
      'filename' => array(
        'description' => t('Name of the file.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'filepath' => array(
        'description' => t('Path of the file relative to Drupal root.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'filemime' => array(
        'description' => t('The file MIME type.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'filesize' => array(
        'description' => t('The size of the file in bytes.'),
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0),
      'status' => array(
        'description' => t('A flag indicating whether file is temporary (1) or permanent (0).'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0),
      'timestamp' => array(
        'description' => t('UNIX timestamp for when the file was added.'),
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0),
      ),
601
    'indexes' => array(
602
603
      'uid' => array('uid'),
      'status' => array('status'),
604
      'timestamp' => array('timestamp'),
605
      ),
606
    'primary key' => array('fid'),
607
    );
608
609

  $schema['flood'] = array(
610
    'description' => t('Flood controls the threshold of events, such as the number of contact attempts.'),
611
    'fields' => array(
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
      'fid' => array(
        'description' => t('Unique flood event ID.'),
        'type' => 'serial',
        'not null' => TRUE),
      'event' => array(
        'description' => t('Name of event (e.g. contact).'),
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
        'default' => ''),
      'hostname' => array(
        'description' => t('Hostname of the visitor.'),
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => ''),
      'timestamp' => array(
        'description' => t('Timestamp of the event.'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0)
      ),
634
    'primary key' => array('fid'),
635
636
637
    'indexes' => array(
      'allow' => array('event', 'hostname', 'timestamp'),
    ),
638
    );
639
640

  $schema['history'] = array(
641
    'description' => t('A record of which {users} have read which {node}s.'),
642
    'fields' => array(
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
      'uid' => array(
        'description' => t('The {users}.uid that read the {node} nid.'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0),
      'nid' => array(
        'description' => t('The {node}.nid that was read.'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0),
      'timestamp' => array(
        'description' => t('The Unix timestamp at which the read occurred.'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0)
      ),
659
    'primary key' => array('uid', 'nid'),
660
661
662
    'indexes' => array(
      'nid' => array('nid'),
    ),
663
    );
664
  $schema['menu_router'] = array(
665
    'description' => t('Maps paths to various callbacks (access, page and title)'),
666
    'fields' => array(
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
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
      'path' => array(
        'description' => t('Primary Key: the Drupal path this entry describes'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'load_functions' => array(
        'description' => t('A serialized array of function names (like node_load) to be called to load an object corresponding to a part of the current path.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'to_arg_functions' => array(
        'description' => t('A serialized array of function names (like user_current_to_arg) to be called to replace a part of the router path with another string.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'access_callback' => array(
        'description' => t('The callback which determines the access to this router path. Defaults to user_access.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'access_arguments' => array(
        'description' => t('A serialized array of arguments for the access callback.'),
        'type' => 'text',
        'not null' => FALSE),
      'page_callback' => array(
        'description' => t('The name of the function that renders the page.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'page_arguments' => array(
        'description' => t('A serialized array of arguments for the page callback.'),
        'type' => 'text',
        'not null' => FALSE),
      'fit' => array(
        'description' => t('A numeric representation of how specific the path is.'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0),
      'number_parts' => array(
        'description' => t('Number of parts in this router path.'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'size' => 'small'),
      'tab_parent' => array(
        'description' => t('Only for local tasks (tabs) - the router path of the parent page (which may also be a local task).'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'tab_root' => array(
723
        'description' => t('Router path of the closest non-tab parent page. For pages that are not local tasks, this will be the same as the path.'),
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'title' => array(
        'description' => t('The title for the current page, or the title for the tab if this is a local task.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'title_callback' => array(
        'description' => t('A function which will alter the title. Defaults to t()'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'title_arguments' => array(
741
        'description' => t('A serialized array of arguments for the title callback. If empty, the title will be used as the sole argument for the title callback.'),
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'type' => array(
        'description' => t('Numeric representation of the type of the menu item, like MENU_LOCAL_TASK.'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0),
      'block_callback' => array(
        'description' => t('Name of a function used to render the block on the system administration page for this item.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'description' => array(
        'description' => t('A description of this item.'),
        'type' => 'text',
        'not null' => TRUE),
      'position' => array(
        'description' => t('The position of the block (left or right) on the system administration page for this item.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'weight' => array(
        'description' => t('Weight of the element. Lighter weights are higher up, heavier weights go down.'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0),
      'file' => array(
        'description' => t('The file to include for this element, usually the page callback function lives in this file.'),
        'type' => 'text',
        'size' => 'medium')
      ),
777
    'indexes' => array(
778
      'fit' => array('fit'),
779
      'tab_parent' => array('tab_parent')
780
      ),
781
    'primary key' => array('path'),
782
    );
783
784

  $schema['menu_links'] = array(
785
    'description' => t('Contains the individual links within a menu.'),
786
    'fields' => array(
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
     'menu_name' => array(
        'description' => t("The menu name. All links with the same menu name (such as 'navigation') are part of the same menu."),
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
        'default' => ''),
      'mlid' => array(
        'description' => t('The menu link ID (mlid) is the integer primary key.'),
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE),
      'plid' => array(
        'description' => t('The parent link ID (plid) is the mlid of the link above in the hierarchy, or zero if the link is at the top level in its menu.'),
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0),
      'link_path' => array(
805
        'description' => t('The Drupal path or external path this link points to.'),
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'router_path' => array(
        'description' => t('For links corresponding to a Drupal path (external = 0), this connects the link to a {menu_router}.path for joins.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'link_title' => array(
      'description' => t('The text displayed for the link, which may be modified by a title callback stored in {menu_router}.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'options' => array(
        'description' => t('A serialized array of options to be passed to the url() or l() function, such as a query string or HTML attributes.'),
        'type' => 'text',
        'not null' => FALSE),
      'module' => array(
        'description' => t('The name of the module that generated this link.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => 'system'),
      'hidden' => array(
        'description' => t('A flag for whether the link should be rendered in menus. (1 = a disabled menu item that may be shown on admin screens, -1 = a menu callback, 0 = a normal, visible link)'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'size' => 'small'),
      'external' => array(
        'description' => t('A flag to indicate if the link points to a full URL starting with a protocol, like http:// (1 = external, 0 = internal).'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'size' => 'small'),
      'has_children' => array(
        'description' => t('Flag indicating whether any links have this link as a parent (1 = children exist, 0 = no children).'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'size' => 'small'),
      'expanded' => array(
        'description' => t('Flag for whether this link should be rendered as expanded in menus - expanded links always have their child links displayed, instead of only when the link is in the active trail (1 = expanded, 0 = not expanded)'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'size' => 'small'),
      'weight' => array(
        'description' => t('Link weight among links in the same menu at the same depth.'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0),
      'depth' => array(
        'description' => t('The depth relative to the top level. A link with plid == 0 will have depth == 1.'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'size' => 'small'),
      'customized' => array(
        'description' => t('A flag to indicate that the user has manually created or edited the link (1 = customized, 0 = not customized).'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'size' => 'small'),
      'p1' => array(
874
        'description' => t('The first mlid in the materialized path. If N = depth, then pN must equal the mlid. If depth > 1 then p(N-1) must equal the plid. All pX where X > depth must equal zero. The columns p1 .. p9 are also called the parents.'),
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0),
      'p2' => array(
        'description' => t('The second mlid in the materialized path. See p1.'),
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0),
      'p3' => array(
        'description' => t('The third mlid in the materialized path. See p1.'),
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0),
      'p4' => array(
        'description' => t('The fourth mlid in the materialized path. See p1.'),
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0),
      'p5' => array(
        'description' => t('The fifth mlid in the materialized path. See p1.'),
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0),
      'p6' => array(
        'description' => t('The sixth mlid in the materialized path. See p1.'),
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0),
      'p7' => array(
        'description' => t('The seventh mlid in the materialized path. See p1.'),
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0),
      'p8' => array(
        'description' => t('The eighth mlid in the materialized path. See p1.'),
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0),
      'p9' => array(
        'description' => t('The ninth mlid in the materialized path. See p1.'),
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0),
      'updated' => array(
        'description' => t('Flag that indicates that this link was generated during the update from Drupal 5.'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'size' => 'small'),
      ),
934
    'indexes' => array(
935
936
937
938
939
940
941
      'path_menu' => array(array('link_path', 128), 'menu_name'),
      'menu_plid_expand_child' => array(
        'menu_name', 'plid', 'expanded', 'has_children'),
      'menu_parents' => array(
        'menu_name', 'p1', 'p2', 'p3', 'p4', 'p5', 'p6', 'p7', 'p8', 'p9'),
      'router_path' => array(array('router_path', 128)),
      ),
942
    'primary key' => array('mlid'),
943
    );
944
945

  $schema['sessions'] = array(
946
    'description' => t("Drupal's session handlers read and write into the sessions table. Each record represents a user session, either anonymous or authenticated."),
947
    'fields' => array(
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
      'uid' => array(
        'description' => t('The {users}.uid corresponding to a session, or 0 for anonymous user.'),
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE),
      'sid' => array(
        'description' => t("Primary key: A session ID. The value is generated by PHP's Session API."),
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
        'default' => ''),
      'hostname' => array(
        'description' => t('The IP address that last used this session ID (sid).'),
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => ''),
      'timestamp' => array(
        'description' => t('The Unix timestamp when this session last requested a page. Old records are purged by PHP automatically.'),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0),
      'cache' => array(
        'description' => t("The time of this user's last post. This is used when the site has specified a minimum_cache_lifetime. See cache_get()."),
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0),
      'session' => array(
976
        'description' => t('The serialized contents of $_SESSION, an array of name/value pairs that persists across page requests by this session ID. Drupal loads $_SESSION from here at the start of each request and saves it at the end.'),
977
978
979
980
        'type' => 'text',
        'not null' => FALSE,
        'size' => 'big')
      ),
981
982
983
    'primary key' => array('sid'),
    'indexes' => array(
      'timestamp' => array('timestamp'),
984
985
986
      'uid' => array('uid')
      ),
    );
987
988

  $schema['system'] = array(
989
    'description' => t("A list of all modules, themes, and theme engines that are or have been installed in Drupal's file system."),
990
    'fields' => array(
991
992
993
994
995
996
997
998
999
1000
      'filename' => array(
        'description' => t('The path of the primary file for this item, relative to the Drupal root; e.g. modules/node/node.module.'),
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''),
      'name' => array(
        'description' => t('The name of the item; e.g. node.'),
        'type' => 'varchar',
        'length' => 255,
For faster browsing, not all history is shown. View entire blame