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

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

9
10
/**
 * Test and report Drupal installation requirements.
11
12
13
14
15
 *
 * @param $phase
 *   The current system installation phase.
 * @return
 *   An array of system requirements.
16
17
 */
function system_requirements($phase) {
18
  global $base_url;
19
20
  $requirements = array();
  // Ensure translations don't break at install time
21
  $t = get_t();
22
23
24
25
26
27

  // Report Drupal version
  if ($phase == 'runtime') {
    $requirements['drupal'] = array(
      'title' => $t('Drupal'),
      'value' => VERSION,
Steven Wittens's avatar
Steven Wittens committed
28
29
      'severity' => REQUIREMENT_INFO,
      'weight' => -10,
30
    );
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

    // Display the currently active install profile, if the site
    // is not running the default install profile.
    $profile = drupal_get_profile();
    if ($profile != 'default') {
      $info = install_profile_info($profile);
      $requirements['install_profile'] = array(
        'title' => $t('Install profile'),
        'value' => $t('%profile_name (%profile-%version)', array(
          '%profile_name' => $info['name'],
          '%profile' => $profile,
          '%version' => $info['version']
        )),
        'severity' => REQUIREMENT_INFO,
        'weight' => -9
      );
47
    }
48
49
  }

50
  // Web server information.
Steven Wittens's avatar
Steven Wittens committed
51
  $software = $_SERVER['SERVER_SOFTWARE'];
52
53
  $requirements['webserver'] = array(
    'title' => $t('Web server'),
Steven Wittens's avatar
Steven Wittens committed
54
    'value' => $software,
55
56
  );

57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
  // Test PHP version and show link to phpinfo() if it's available
  $phpversion = phpversion();
  if (function_exists('phpinfo')) {
    $requirements['php'] = array(
      'title' => $t('PHP'),
      'value' => ($phase == 'runtime') ? $phpversion .' ('. l($t('more information'), 'admin/reports/status/php') .')' : $phpversion,
    );
  }
  else {
    $requirements['php'] = array(
      'title' => $t('PHP'),
      'value' => $phpversion,
      'description' => $t('The phpinfo() function has been disabled for security reasons. To see your server\'s phpinfo() information, change your PHP settings or contact your server administrator. For more information, please read the <a href="@phpinfo">Enabling and disabling phpinfo()</a> handbook page.', array('@phpinfo' => 'http://drupal.org/node/243993')),
      'severity' => REQUIREMENT_INFO,
    );
  }

  if (version_compare($phpversion, DRUPAL_MINIMUM_PHP) < 0) {
75
76
77
    $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;
  }
78

79
80
81
82
83
  // Test PHP register_globals setting.
  $requirements['php_register_globals'] = array(
    'title' => $t('PHP register globals'),
  );
  $register_globals = trim(ini_get('register_globals'));
84
  // Unfortunately, ini_get() may return many different values, and we can't
85
86
87
88
89
90
91
92
93
94
95
96
97
  // be certain which values mean 'on', so we instead check for 'not off'
  // since we never want to tell the user that their site is secure
  // (register_globals off), when it is in fact on. We can only guarantee
  // register_globals is off if the value returned is 'off', '', or 0.
  if (!empty($register_globals) && strtolower($register_globals) != 'off') {
    $requirements['php_register_globals']['description'] = $t('<em>register_globals</em> is enabled. Drupal requires this configuration directive to be disabled. Your site may not be secure when <em>register_globals</em> is enabled. The PHP manual has instructions for <a href="http://php.net/configuration.changes">how to change configuration settings</a>.');
    $requirements['php_register_globals']['severity'] = REQUIREMENT_ERROR;
    $requirements['php_register_globals']['value'] = $t("Enabled ('@value')", array('@value' => $register_globals));
  }
  else {
    $requirements['php_register_globals']['value'] = $t('Disabled');
  }

98
  // Test PHP memory_limit
99
  $memory_limit = ini_get('memory_limit');
100
101
  $requirements['php_memory_limit'] = array(
    'title' => $t('PHP memory limit'),
102
    'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
103
  );
104

105
  if ($memory_limit && $memory_limit != -1 && parse_size($memory_limit) < parse_size(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT)) {
106
107
108
    $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));
109
110
111
    }
    elseif ($phase == 'update') {
      $description = $t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the update process.', array('%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
112
    }
113
114
    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));
115
    }
116

117
118
    if (!empty($description)) {
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
119
        $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));
120
121
      }
      else {
122
        $description .= ' ' . $t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
123
      }
124

125
      $requirements['php_memory_limit']['description'] = $description . ' ' . $t('See the <a href="@url">Drupal requirements</a> for more information.', array('@url' => 'http://drupal.org/requirements'));
126
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
127
    }
128
  }
129

130
131
  // Test settings.php file writability
  if ($phase == 'runtime') {
132
    $conf_dir = drupal_verify_install_file(conf_path(), FILE_NOT_WRITABLE, 'dir');
133
    $conf_file = drupal_verify_install_file(conf_path() . '/settings.php', FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE);
134
    if (!$conf_dir || !$conf_file) {
135
136
137
      $requirements['settings.php'] = array(
        'value' => $t('Not protected'),
        'severity' => REQUIREMENT_ERROR,
138
        'description' => '',
139
      );
140
141
142
143
      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) {
144
        $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'));
145
      }
146
147
148
149
150
151
152
153
154
    }
    else {
      $requirements['settings.php'] = array(
        'value' => $t('Protected'),
      );
    }
    $requirements['settings.php']['title'] = $t('Configuration file');
  }

155
  // Report cron status.
156
  if ($phase == 'runtime') {
157
158
159
160
161
    // 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.
162
    $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'));
163

164
    // Determine when cron last ran.
165
    $cron_last = variable_get('cron_last');
166
167
168
    if (!is_numeric($cron_last)) {
      $cron_last = variable_get('install_time', 0);
    }
169

170
171
    // Determine severity based on time since cron last ran.
    $severity = REQUIREMENT_OK;
172
    if (REQUEST_TIME - $cron_last > $threshold_error) {
173
      $severity = REQUIREMENT_ERROR;
174
    }
175
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
176
177
178
179
      $severity = REQUIREMENT_WARNING;
    }

    // Set summary and description based on values determined above.
180
181
182
183
    $summary = $t('Last run !time ago', array('!time' => format_interval(REQUEST_TIME - $cron_last)));
    $description = '';
    if ($severity != REQUIREMENT_OK) {
      $description = $t('Cron has not run recently.') . ' ' . $help;
184
    }
185

186
    $description .= ' ' . $t('You can <a href="@cron">run cron manually</a>.', array('@cron' => url('admin/reports/status/run-cron')));
187
    $description .= '<br />' . $t('To run cron from outside the site, go to <a href="!cron">!cron</a>', array('!cron' => url($base_url . '/cron.php', array('external' => TRUE, 'query' => array('cron_key' => variable_get('cron_key', 'drupal'))))));
188

189
190
191
192
    $requirements['cron'] = array(
      'title' => $t('Cron maintenance tasks'),
      'severity' => $severity,
      'value' => $summary,
193
      'description' => $description
194
    );
195
196
  }

197
198
199
200
201
202
  // Test files directories.
  $directories = array(
    variable_get('file_public_path', conf_path() . '/files'),
    variable_get('file_private_path', conf_path() . '/private/files'),
    variable_get('file_temporary_path', conf_path() . '/private/temp'),
  );
203
204
205
  $requirements['file system'] = array(
    'title' => $t('File system'),
  );
206

207
208
209
210
211
  $error = '';
  // For installer, create the directories if possible.
  foreach ($directories as $directory) {
    if ($phase == 'install') {
      file_prepare_directory($directory, FILE_CREATE_DIRECTORY);
212
    }
213
214
215
216
217
218
219
220
221
222
223
224
225
    $is_writable = is_writable($directory);
    $is_directory = is_dir($directory);
    if (!$is_writable || !$is_directory) {
      $description = '';
      $requirements['file system']['value'] = $t('Not writable');
      if (!$is_directory) {
        $error .= $t('The directory %directory does not exist.', array('%directory' => $directory)) . ' ';
      }
      else {
        $error .= $t('The directory %directory is not writable.', array('%directory' => $directory)) . ' ';
      }
      // The files directory requirement check is done only during install and runtime.
      if ($phase == 'runtime') {
226
        $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/config/media/file-system')));
227
228
229
230
231
232
233
234
235
236
237
      }
      elseif ($phase == 'install') {
        // For the installer UI, we need different wording. 'value' will
        // be treated as version, so provide none there.
        $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">online handbook</a>.', array('@handbook_url' => 'http://drupal.org/server-permissions'));
        $requirements['file system']['value'] = '';
      }
      if (!empty($description)) {
        $requirements['file system']['description'] = $description;
        $requirements['file system']['severity'] = REQUIREMENT_ERROR;
      }
238
239
    }
    else {
240
241
242
243
244
245
      if (variable_get('file_default_scheme', 'public') == 'public') {
        $requirements['file system']['value'] = $t('Writable (<em>public</em> download method)');
      }
      else {
        $requirements['file system']['value'] = $t('Writable (<em>private</em> download method)');
      }
246
247
248
    }
  }

249
250
251
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
252
      'title' => $t('Database updates'),
253
254
255
256
257
258
259
260
261
262
263
264
      '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');
265
          $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'));
266
267
268
269
270
271
          break;
        }
      }
    }
  }

272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
  // 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');
  }

289
  // Test Unicode library
290
  include_once DRUPAL_ROOT . '/includes/unicode.inc';
291
292
  $requirements = array_merge($requirements, unicode_requirements());

293
294
295
296
297
298
299
300
301
302
303
  // Verify if the DOM PHP 5 extension is available.
  $has_dom = class_exists('DOMDocument');
  if (!$has_dom) {
    $requirements['php_dom'] = array(
      'title' => $t('PHP DOM Extension'),
      'value' => $t('Not found'),
      'severity' => REQUIREMENT_ERROR,
      'description' => $t("The DOM extension is part of PHP 5 core, but doesn't seem to be enabled on your system. You need to enable the DOM extension on your PHP installation."),
    );
  }

304
  if ($phase == 'runtime') {
305
    // Check for update status module.
306
307
308
    if (!module_exists('update')) {
      $requirements['update status'] = array(
        'value' => $t('Not enabled'),
309
        'severity' => REQUIREMENT_WARNING,
310
        '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/config/modules'))),
311
312
313
314
315
316
317
318
      );
    }
    else {
      $requirements['update status'] = array(
        'value' => $t('Enabled'),
      );
    }
    $requirements['update status']['title'] = $t('Update notifications');
319
320
321
322
323
324
325
326
327
328

    // Check that Drupal can issue HTTP requests.
    if (variable_get('drupal_http_request_fails', TRUE) && !system_check_http_request()) {
      $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.  If you are certain that Drupal can access web pages but you are still seeing this message, you may add <code>$conf[\'drupal_http_request_fails\'] = FALSE;</code> to the bottom of your settings.php file.'),
      );
    }
329
330
  }

331
332
333
  return $requirements;
}

334
/**
335
 * Implements hook_install().
336
 */
337
function system_install() {
338
  // Create tables.
339
  $modules = array('system', 'filter', 'user', 'node');
340
341
  foreach ($modules as $module) {
    drupal_install_schema($module);
342
343
344
    $versions = drupal_get_schema_versions($module);
    $version = $versions ? max($versions) : SCHEMA_INSTALLED;
    drupal_set_installed_schema_version($module, $version);
345
  }
346

347
  // Clear out module list and hook implementation statics before calling
348
  // system_rebuild_theme_data().
349
350
351
  module_list(TRUE);
  module_implements('', FALSE, TRUE);

352
  // Load system theme data appropriately.
353
  system_rebuild_theme_data();
354

355
356
  db_insert('users')
    ->fields(array(
357
      'uid' => 0,
358
359
360
361
      'name' => '',
      'mail' => '',
    ))
    ->execute();
362
  // We need some placeholders here as name and mail are uniques and data is
363
364
  // presumed to be a serialized array. This will be changed by the settings
  // form.
365
366
  db_insert('users')
    ->fields(array(
367
      'uid' => 1,
368
369
370
371
372
373
374
      'name' => 'placeholder-for-uid-1',
      'mail' => 'placeholder-for-uid-1',
      'created' => REQUEST_TIME,
      'status' => 1,
      'data' => serialize(array()),
    ))
    ->execute();
375
  // Built-in roles.
376
  $rid_anonymous = db_insert('role')
377
    ->fields(array('name' => 'anonymous user'))
378
379
380
    ->execute();

  $rid_authenticated = db_insert('role')
381
    ->fields(array('name' => 'authenticated user'))
382
383
    ->execute();

384
385
  // Sanity check to ensure the anonymous and authenticated role IDs are the
  // same as the drupal defined constants. In certain situations, this will
386
387
388
389
390
391
392
393
394
395
396
397
398
399
  // not be true.
  if ($rid_anonymous != DRUPAL_ANONYMOUS_RID) {
    db_update('role')
      ->fields(array('rid' => DRUPAL_ANONYMOUS_RID))
      ->condition('rid', $rid_anonymous)
      ->execute();
  }

  if ($rid_authenticated != DRUPAL_AUTHENTICATED_RID) {
    db_update('role')
      ->fields(array('rid' => DRUPAL_AUTHENTICATED_RID))
      ->condition('rid', $rid_authenticated)
      ->execute();
  }
400

401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
  variable_set('theme_default', 'garland');

  db_update('system')
    ->fields(array('status' => 1))
    ->condition('type', 'theme')
    ->condition('name', 'garland')
    ->execute();

  db_insert('node_access')
    ->fields(array(
      'nid' => 0,
      'gid' => 0,
      'realm' => 'all',
      'grant_view' => 1,
      'grant_update' => 0,
      'grant_delete' => 0,
    ))
    ->execute();
419

420
  $cron_key = md5(mt_rand());
421

422
  variable_set('cron_key', $cron_key);
423
424
}

425
/**
426
 * Implements hook_schema().
427
428
429
430
431
432
 */
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(
433
    'description' => '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.',
434
    'fields' => array(
435
      'name' => array(
436
        'description' => 'The name of the variable.',
437
438
439
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
440
441
        'default' => '',
      ),
442
      'value' => array(
443
        'description' => 'The value of the variable.',
444
445
        'type' => 'text',
        'not null' => TRUE,
446
        'size' => 'big',
447
        'translatable' => TRUE,
448
      ),
449
    ),
450
    'primary key' => array('name'),
451
  );
452
453

  $schema['actions'] = array(
454
    'description' => 'Stores action information.',
455
    'fields' => array(
456
      'aid' => array(
457
        'description' => 'Primary Key: Unique actions ID.',
458
459
460
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
461
462
        'default' => '0',
      ),
463
      'type' => array(
464
        'description' => 'The object that that action acts on (node, user, comment, system or custom types.)',
465
466
467
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
468
469
        'default' => '',
      ),
470
      'callback' => array(
471
        'description' => 'The callback function that executes when the action runs.',
472
473
474
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
475
476
        'default' => '',
      ),
477
      'parameters' => array(
478
        'description' => 'Parameters to be passed to the callback function.',
479
480
        'type' => 'text',
        'not null' => TRUE,
481
482
        'size' => 'big',
      ),
483
484
      'label' => array(
        'description' => 'Label of the action.',
485
486
487
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
488
        'default' => '0',
489
      ),
490
    ),
491
    'primary key' => array('aid'),
492
  );
493
494

  $schema['batch'] = array(
495
    'description' => 'Stores details about batches (processes that run in multiple HTTP requests).',
496
    'fields' => array(
497
      'bid' => array(
498
        'description' => 'Primary Key: Unique batch ID.',
499
500
        'type' => 'serial',
        'unsigned' => TRUE,
501
502
        'not null' => TRUE,
      ),
503
      'token' => array(
504
        'description' => "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.",
505
506
        'type' => 'varchar',
        'length' => 64,
507
508
        'not null' => TRUE,
      ),
509
      'timestamp' => array(
510
        'description' => 'A Unix timestamp indicating when this batch was submitted for processing. Stale batches are purged at cron time.',
511
        'type' => 'int',
512
513
        'not null' => TRUE,
      ),
514
      'batch' => array(
515
        'description' => 'A serialized array containing the processing data for the batch.',
516
517
        'type' => 'text',
        'not null' => FALSE,
518
        'size' => 'big',
519
      ),
520
    ),
521
    'primary key' => array('bid'),
522
523
524
525
    'indexes' => array(
      'token' => array('token'),
    ),
  );
526

527
  $schema['blocked_ips'] = array(
528
    'description' => 'Stores blocked IP addresses.',
529
530
    'fields' => array(
       'iid' => array(
531
        'description' => 'Primary Key: unique ID for IP addresses.',
532
533
534
535
536
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'ip' => array(
537
        'description' => 'IP address',
538
539
540
541
542
543
544
545
546
547
548
549
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
        'default' => '',
      ),
    ),
    'indexes' => array(
      'blocked_ip' => array('ip'),
    ),
    'primary key' => array('iid'),
  );

550
  $schema['cache'] = array(
551
    'description' => 'Generic cache table for caching things not separated out into their own tables. Contributed modules may also use this to store cached items.',
552
    'fields' => array(
553
      'cid' => array(
554
        'description' => 'Primary Key: Unique cache ID.',
555
556
557
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
558
559
        'default' => '',
      ),
560
      'data' => array(
561
        'description' => 'A collection of data to cache.',
562
563
        'type' => 'blob',
        'not null' => FALSE,
564
565
        'size' => 'big',
      ),
566
      'expire' => array(
567
        'description' => 'A Unix timestamp indicating when the cache entry should expire, or 0 for never.',
568
569
        'type' => 'int',
        'not null' => TRUE,
570
571
        'default' => 0,
      ),
572
      'created' => array(
573
        'description' => 'A Unix timestamp indicating when the cache entry was created.',
574
575
        'type' => 'int',
        'not null' => TRUE,
576
577
        'default' => 0,
      ),
578
      'headers' => array(
579
        'description' => 'Any custom HTTP headers to be added to cached data.',
580
        'type' => 'text',
581
582
        'not null' => FALSE,
      ),
583
      'serialized' => array(
584
        'description' => 'A flag to indicate whether content is serialized (1) or not (0).',
585
586
587
        'type' => 'int',
        'size' => 'small',
        'not null' => TRUE,
588
        'default' => 0,
589
      ),
590
591
592
593
    ),
    'indexes' => array(
      'expire' => array('expire'),
    ),
594
    'primary key' => array('cid'),
595
  );
596

597
598
  $schema['cache_bootstrap'] = $schema['cache'];
  $schema['cache_bootstrap']['description'] = 'Cache table for data required to bootstrap Drupal, may be routed to a shared memory cache.';
599
  $schema['cache_form'] = $schema['cache'];
600
  $schema['cache_form']['description'] = 'Cache table for the form system to store recently built forms and their storage data, to be used in subsequent page requests.';
601
  $schema['cache_page'] = $schema['cache'];
602
  $schema['cache_page']['description'] = 'Cache table used to store compressed pages for anonymous users, if page caching is enabled.';
603
  $schema['cache_menu'] = $schema['cache'];
604
  $schema['cache_menu']['description'] = 'Cache table for the menu system to store router information as well as generated link trees for various menu/page/user combinations.';
605
606
  $schema['cache_path'] = $schema['cache'];
  $schema['cache_path']['description'] = 'Cache table for path alias lookup.';
607

608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
  $schema['date_format_type'] = array(
    'description' => 'Stores configured date format types.',
    'fields' => array(
      'type' => array(
        'description' => 'The date format type, e.g. medium.',
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
      ),
      'title' => array(
        'description' => 'The human readable name of the format type.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
      ),
      'locked' => array(
        'description' => 'Whether or not this is a system provided format.',
        'type' => 'int',
        'size' => 'tiny',
        'default' => 0,
        'not null' => TRUE,
      ),
    ),
    'primary key' => array('type'),
  );

634
  // This table's name is plural as some versions of MySQL can't create a
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
  // table named 'date_format'.
  $schema['date_formats'] = array(
    'description' => 'Stores configured date formats.',
    'fields' => array(
      'dfid' => array(
        'description' => 'The date format identifier.',
        'type' => 'serial',
        'not null' => TRUE,
        'unsigned' => TRUE,
      ),
      'format' => array(
        'description' => 'The date format string.',
        'type' => 'varchar',
        'length' => 100,
        'not null' => TRUE,
      ),
      'type' => array(
        'description' => 'The date format type, e.g. medium.',
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
      ),
      'locked' => array(
        'description' => 'Whether or not this format can be modified.',
        'type' => 'int',
        'size' => 'tiny',
        'default' => 0,
        'not null' => TRUE,
      ),
    ),
    'primary key' => array('dfid'),
    'unique keys' => array('formats' => array('format', 'type')),
  );

  $schema['date_format_locale'] = array(
    'description' => 'Stores configured date formats for each locale.',
    'fields' => array(
      'format' => array(
        'description' => 'The date format string.',
        'type' => 'varchar',
        'length' => 100,
        'not null' => TRUE,
      ),
      'type' => array(
        'description' => 'The date format type, e.g. medium.',
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
      ),
      'language' => array(
        'description' => 'A {languages}.language for this format to be used with.',
        'type' => 'varchar',
        'length' => 12,
        'not null' => TRUE,
      ),
    ),
    'primary key' => array('type', 'language'),
  );

694
  $schema['file'] = array(
695
    'description' => 'Stores information for uploaded files.',
696
    'fields' => array(
697
      'fid' => array(
698
        'description' => 'File ID.',
699
700
        'type' => 'serial',
        'unsigned' => TRUE,
701
702
        'not null' => TRUE,
      ),
703
      'uid' => array(
704
        'description' => 'The {users}.uid of the user who is associated with the file.',
705
706
707
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
708
709
        'default' => 0,
      ),
710
      'filename' => array(
711
        'description' => 'Name of the file with no path components. This may differ from the basename of the filepath if the file is renamed to avoid overwriting an existing file.',
712
713
714
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
715
716
        'default' => '',
      ),
717
      'uri' => array(
718
        'description' => 'Path of the file relative to Drupal root.',
719
720
721
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
722
723
        'default' => '',
      ),
724
      'filemime' => array(
725
        'description' => "The file's MIME type.",
726
727
728
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
729
730
        'default' => '',
      ),
731
      'filesize' => array(
732
        'description' => 'The size of the file in bytes.',
733
734
735
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
736
737
        'default' => 0,
      ),
738
      'status' => array(
739
        'description' => 'A bitmapped field indicating the status of the file. The least significant bit indicates temporary (0) or permanent (1). Temporary files older than DRUPAL_MAXIMUM_TEMP_FILE_AGE will be removed during a cron run.',
740
741
        'type' => 'int',
        'not null' => TRUE,
742
743
        'default' => 0,
      ),
744
      'timestamp' => array(
745
        'description' => 'UNIX timestamp for when the file was added.',
746
747
748
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
749
        'default' => 0,
750
      ),
751
    ),
752
    'indexes' => array(
753
754
      'uid' => array('uid'),
      'status' => array('status'),
755
      'timestamp' => array('timestamp'),
756
    ),
757
758
759
    'unique keys' => array(
      'uri' => array('uri'),
    ),
760
    'primary key' => array('fid'),
761
762
763
    'foreign keys' => array(
      'uid' => array('users' => 'uid'),
    ),
764
  );
765
766

  $schema['flood'] = array(
767
    'description' => 'Flood controls the threshold of events, such as the number of contact attempts.',
768
    'fields' => array(
769
      'fid' => array(
770
        'description' => 'Unique flood event ID.',
771
        'type' => 'serial',
772
773
        'not null' => TRUE,
      ),
774
      'event' => array(
775
        'description' => 'Name of event (e.g. contact).',
776
777
778
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
779
780
        'default' => '',
      ),
781
782
      'identifier' => array(
        'description' => 'Identifier of the visitor, such as an IP address or hostname.',
783
784
785
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
786
787
        'default' => '',
      ),
788
      'timestamp' => array(
789
        'description' => 'Timestamp of the event.',
790
791
        'type' => 'int',
        'not null' => TRUE,
792
        'default' => 0,
793
      ),
794
795
796
797
798
799
      'expiration' => array(
        'description' => 'Expiration timestamp. Expired events are purged on cron run.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
800
    ),
801
    'primary key' => array('fid'),
802
    'indexes' => array(
803
      'allow' => array('event', 'identifier', 'timestamp'),
804
      'purge' => array('expiration'),
805
    ),
806
  );
807
808

  $schema['history'] = array(
809
    'description' => 'A record of which {users} have read which {node}s.',
810
    'fields' => array(
811
      'uid' => array(
812
        'description' => 'The {users}.uid that read the {node} nid.',
813
814
        'type' => 'int',
        'not null' => TRUE,
815
816
        'default' => 0,
      ),
817
      'nid' => array(
818
        'description' => 'The {node}.nid that was read.',
819
820
        'type' => 'int',
        'not null' => TRUE,
821
822
        'default' => 0,
      ),
823
      'timestamp' => array(
824
        'description' => 'The Unix timestamp at which the read occurred.',
825
826
        'type' => 'int',
        'not null' => TRUE,
827
        'default' => 0,
828
      ),
829
    ),
830
    'primary key' => array('uid', 'nid'),
831
832
833
    'indexes' => array(
      'nid' => array('nid'),
    ),
834
  );
835
  $schema['menu_router'] = array(
836
    'description' => 'Maps paths to various callbacks (access, page and title)',
837
    'fields' => array(
838
      'path' => array(
839
        'description' => 'Primary Key: the Drupal path this entry describes',
840
841
842
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
843
844
        'default' => '',
      ),
845
      'load_functions' => array(
846
        'description' => 'A serialized array of function names (like node_load) to be called to load an object corresponding to a part of the current path.',
847
        'type' => 'text',
848
        'not null' => TRUE,
849
      ),
850
      'to_arg_functions' => array(
851
        'description' => 'A serialized array of function names (like user_uid_optional_to_arg) to be called to replace a part of the router path with another string.',
852
        'type' => 'text',
853
        'not null' => TRUE,
854
      ),
855
      'access_callback' => array(
856
        'description' => 'The callback which determines the access to this router path. Defaults to user_access.',
857
858
859
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
860
861
        'default' => '',
      ),
862
      'access_arguments' => array(
863
        'description' => 'A serialized array of arguments for the access callback.',
864
        'type' => 'text',
865
866
        'not null' => FALSE,
      ),
867
      'page_callback' => array(
868
        'description' => 'The name of the function that renders the page.',
869
870
871
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
872
873
        'default' => '',
      ),
874
      'page_arguments' => array(
875
        'description' => 'A serialized array of arguments for the page callback.',
876
        'type' => 'text',
877
878
        'not null' => FALSE,
      ),
879
880
881
882
883
884
885
      'delivery_callback' => array(
        'description' => 'The name of the function that sends the result of the page_callback function to the browser.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
886
      'fit' => array(
887
        'description' => 'A numeric representation of how specific the path is.',
888
889
        'type' => 'int',
        'not null' => TRUE,
890
891
        'default' => 0,
      ),
892
      'number_parts' => array(
893
        'description' => 'Number of parts in this router path.',
894
895
896
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
897
898
        'size' => 'small',
      ),
899
900
901
902
903
904
      'context' => array(
        'description' => 'Only for local tasks (tabs) - the context of a local task to control its placement.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
905
      'tab_parent' => array(
906
        'description' => 'Only for local tasks (tabs) - the router path of the parent page (which may also be a local task).',
907
908
909
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
910
911
        'default' => '',
      ),
912
      'tab_root' => array(
913
        'description' => 'Router path of the closest non-tab parent page. For pages that are not local tasks, this will be the same as the path.',
914
915
916
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
917
918
        'default' => '',
      ),
919
      'title' => array(
920
        'description' => 'The title for the current page, or the title for the tab if this is a local task.',
921
922
923
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
924
925
        'default' => '',
      ),
926
      'title_callback' => array(
927
        'description' => 'A function which will alter the title. Defaults to t()',
928
929
930
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
931
932
        'default' => '',
      ),
933
      'title_arguments' => array(
934
        'description' => 'A serialized array of arguments for the title callback. If empty, the title will be used as the sole argument for the title callback.',
935
936
937
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
938
939
        'default' => '',
      ),
940
941
942
943
944
945
946
947
948
949
950
951
952
953
      'theme_callback' => array(
        'description' => 'A function which returns the name of the theme that will be used to render this page. If left empty, the default theme will be used.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'theme_arguments' => array(
        'description' => 'A serialized array of arguments for the theme callback.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
954
      'type' => array(
955
        'description' => 'Numeric representation of the type of the menu item, like MENU_LOCAL_TASK.',
956
957
        'type' => 'int',
        'not null' => TRUE,
958
959
        'default' => 0,
      ),
960
      'block_callback' => array(
961
        'description' => 'Name of a function used to render the block on the system administration page for this item.',
962
963
964
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
965
966
        'default' => '',
      ),
967
      'description' => array(
968
        'description' => 'A description of this item.',
969
        'type' => 'text',
970
971
        'not null' => TRUE,
      ),
972
      'position' => array(
973
        'description' => 'The position of the block (left or right) on the system administration page for this item.',
974
975
976
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,