system.install 106 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

    // Display the currently active install profile, if the site
    // is not running the default install profile.
    $profile = drupal_get_profile();
35
    if ($profile != 'standard') {
36
37
38
39
40
41
42
43
44
45
46
      $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
  // 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,
69
      '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, <a href="@phpinfo">Enabling and disabling phpinfo()</a> handbook page.', array('@phpinfo' => 'http://drupal.org/node/243993')),
70
71
72
73
74
      'severity' => REQUIREMENT_INFO,
    );
  }

  if (version_compare($phpversion, DRUPAL_MINIMUM_PHP) < 0) {
75
76
    $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;
77
78
    // If PHP is old, it's not safe to continue with the requirements check.
    return $requirements;
79
  }
80
81
82
83
84
85
86
87
88
  // Check that htmlspecialchars() is secure if the site is running any PHP
  // version older than 5.2.5. We don't simply require 5.2.5, because Ubuntu
  // 8.04 ships with PHP 5.2.4, but includes the necessary security patch.
  elseif (version_compare($phpversion, '5.2.5') < 0 && strlen(@htmlspecialchars(chr(0xC0) . chr(0xAF), ENT_QUOTES, 'UTF-8'))) {
    $requirements['php']['description'] = $t('Your PHP installation is too old. Drupal requires at least PHP 5.2.5, or PHP @version with the htmlspecialchars security patch backported.', array('@version' => DRUPAL_MINIMUM_PHP));
    $requirements['php']['severity'] = REQUIREMENT_ERROR;
    // If PHP is old, it's not safe to continue with the requirements check.
    return $requirements;
  }
89

90
91
92
93
94
  // Test PHP register_globals setting.
  $requirements['php_register_globals'] = array(
    'title' => $t('PHP register globals'),
  );
  $register_globals = trim(ini_get('register_globals'));
95
  // Unfortunately, ini_get() may return many different values, and we can't
96
97
98
99
100
101
102
103
104
105
106
107
  // 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');
  }
108

109
110
111
  // Test for PHP extensions.
  $requirements['php_extensions'] = array(
    'title' => $t('PHP extensions'),
112
  );
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

  $missing_extensions = array();
  $required_extensions = array(
    'date',
    'dom',
    'filter',
    'gd',
    'hash',
    'json',
    'pcre',
    'pdo',
    'session',
    'SimpleXML',
    'SPL',
    'xml',
  );
  foreach ($required_extensions as $extension) {
    if (!extension_loaded($extension)) {
      $missing_extensions[] = $extension;
    }
  }

  if (!empty($missing_extensions)) {
    $description = $t('Drupal requires you to enable the PHP extensions in the following list (see the <a href="@system_requirements">system requirements page</a> for more information):', array(
      '@system_requirements' => 'http://drupal.org/requirements',
    ));

140
    $description .= theme('item_list', array('items' => $missing_extensions));
141
142
143
144

    $requirements['php_extensions']['value'] = $t('Disabled');
    $requirements['php_extensions']['severity'] = REQUIREMENT_ERROR;
    $requirements['php_extensions']['description'] = $description;
145
146
  }
  else {
147
    $requirements['php_extensions']['value'] = $t('Enabled');
148
  }
149

150
151
152
153
154
  if ($phase == 'install' || $phase == 'update') {
    // Test for PDO (database).
    $requirements['database_extensions'] = array(
      'title' => $t('Database support'),
    );
155

156
    // Make sure PDO is available.
157
    $database_ok = extension_loaded('pdo');
158
159
160
161
162
163
164
    if (!$database_ok) {
      $pdo_message = $t('Your web server does not appear to support PDO (PHP Data Objects). Ask your hosting provider if they support the native PDO extension. See the <a href="@link">system requirements</a> page for more information.', array(
        '@link' => 'http://drupal.org/requirements/pdo',
      ));
    }
    else {
      // Make sure at least one supported database driver exists.
165
      $drivers = drupal_detect_database_types();
166
167
168
169
170
171
172
173
174
175
176
177
178
179
      if (empty($drivers)) {
        $database_ok = FALSE;
        $pdo_message = $t('Your web server does not appear to support any common PDO database extensions. Check with your hosting provider to see if they support PDO (PHP Data Objects) and offer any databases that <a href="@drupal-databases">Drupal supports</a>.', array(
          '@drupal-databases' => 'http://drupal.org/node/270#database',
        ));
      }
      // Make sure the native PDO extension is available, not the older PEAR
      // version. (See install_verify_pdo() for details.)
      if (!defined('PDO::ATTR_DEFAULT_FETCH_MODE')) {
        $database_ok = FALSE;
        $pdo_message = $t('Your web server seems to have the wrong version of PDO installed. Drupal 7 requires the PDO extension from PHP core. This system has the older PECL version. See the <a href="@link">system requirements</a> page for more information.', array(
          '@link' => 'http://drupal.org/requirements/pdo#pecl',
        ));
      }
180
    }
181

182
183
184
    if (!$database_ok) {
      $requirements['database_extensions']['value'] = $t('Disabled');
      $requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
185
      $requirements['database_extensions']['description'] = $pdo_message;
186
187
188
189
    }
    else {
      $requirements['database_extensions']['value'] = $t('Enabled');
    }
190
  }
191
192
193
194
195
196
197
198
199
200
201
202
203
  else {
    // Database information.
    $class = 'DatabaseTasks_' . Database::getConnection()->driver();
    $tasks = new $class();
    $requirements['database_system'] = array(
      'title' => $t('Database system'),
      'value' => $tasks->name(),
    );
    $requirements['database_system_version'] = array(
      'title' => $t('Database system version'),
      'value' => Database::getConnection()->version(),
    );
  }
204

205
  // Test PHP memory_limit
206
  $memory_limit = ini_get('memory_limit');
207
208
  $requirements['php_memory_limit'] = array(
    'title' => $t('PHP memory limit'),
209
    'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
210
  );
211

212
  if ($memory_limit && $memory_limit != -1 && parse_size($memory_limit) < parse_size(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT)) {
213
214
215
    $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));
216
217
218
    }
    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));
219
    }
220
221
    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));
222
    }
223

224
225
    if (!empty($description)) {
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
226
        $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));
227
228
      }
      else {
229
        $description .= ' ' . $t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
230
      }
231

232
      $requirements['php_memory_limit']['description'] = $description . ' ' . $t('See the <a href="@url">Drupal requirements</a> for more information.', array('@url' => 'http://drupal.org/requirements'));
233
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
234
    }
235
  }
236

237
238
  // Test settings.php file writability
  if ($phase == 'runtime') {
239
    $conf_dir = drupal_verify_install_file(conf_path(), FILE_NOT_WRITABLE, 'dir');
240
    $conf_file = drupal_verify_install_file(conf_path() . '/settings.php', FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE);
241
    if (!$conf_dir || !$conf_file) {
242
243
244
      $requirements['settings.php'] = array(
        'value' => $t('Not protected'),
        'severity' => REQUIREMENT_ERROR,
245
        'description' => '',
246
      );
247
248
249
250
      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) {
251
        $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'));
252
      }
253
254
255
256
257
258
259
260
261
    }
    else {
      $requirements['settings.php'] = array(
        'value' => $t('Protected'),
      );
    }
    $requirements['settings.php']['title'] = $t('Configuration file');
  }

262
  // Report cron status.
263
  if ($phase == 'runtime') {
264
265
266
267
268
    // 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.
269
    $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'));
270

271
    // Determine when cron last ran.
272
    $cron_last = variable_get('cron_last');
273
274
275
    if (!is_numeric($cron_last)) {
      $cron_last = variable_get('install_time', 0);
    }
276

277
278
    // Determine severity based on time since cron last ran.
    $severity = REQUIREMENT_OK;
279
    if (REQUEST_TIME - $cron_last > $threshold_error) {
280
      $severity = REQUIREMENT_ERROR;
281
    }
282
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
283
284
285
286
      $severity = REQUIREMENT_WARNING;
    }

    // Set summary and description based on values determined above.
287
288
289
290
    $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;
291
    }
292

293
    $description .= ' ' . $t('You can <a href="@cron">run cron manually</a>.', array('@cron' => url('admin/reports/status/run-cron')));
294
    $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'))))));
295

296
297
298
299
    $requirements['cron'] = array(
      'title' => $t('Cron maintenance tasks'),
      'severity' => $severity,
      'value' => $summary,
300
      'description' => $description
301
    );
302
303
  }

304
305
306
  // Test files directories.
  $directories = array(
    variable_get('file_public_path', conf_path() . '/files'),
307
308
309
    // By default no private files directory is configured. For private files
    // to be secure the admin needs to provide a path outside the webroot.
    variable_get('file_private_path', FALSE),
310
  );
311
312
313
314
315
316
317
318
319
320
321

  // Do not check for the temporary files directory at install time
  // unless it has been set in settings.php. In this case the user has
  // no alternative but to fix the directory if it is not writable.
  if ($phase == 'install') {
    $directories[] = variable_get('file_temporary_path', FALSE);
  }
  else {
    $directories[] = variable_get('file_temporary_path', file_directory_temp());
  }

322
323
324
  $requirements['file system'] = array(
    'title' => $t('File system'),
  );
325

326
327
328
  $error = '';
  // For installer, create the directories if possible.
  foreach ($directories as $directory) {
329
330
331
    if (!$directory) {
      continue;
    }
332
333
    if ($phase == 'install') {
      file_prepare_directory($directory, FILE_CREATE_DIRECTORY);
334
    }
335
336
337
338
339
340
341
342
343
344
345
346
347
    $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') {
348
        $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')));
349
350
351
352
      }
      elseif ($phase == 'install') {
        // For the installer UI, we need different wording. 'value' will
        // be treated as version, so provide none there.
353
        $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, see INSTALL.txt or the <a href="@handbook_url">online handbook</a>.', array('@handbook_url' => 'http://drupal.org/server-permissions'));
354
355
356
357
358
359
        $requirements['file system']['value'] = '';
      }
      if (!empty($description)) {
        $requirements['file system']['description'] = $description;
        $requirements['file system']['severity'] = REQUIREMENT_ERROR;
      }
360
361
    }
    else {
362
      if (file_default_scheme() == 'public') {
363
364
365
366
367
        $requirements['file system']['value'] = $t('Writable (<em>public</em> download method)');
      }
      else {
        $requirements['file system']['value'] = $t('Writable (<em>private</em> download method)');
      }
368
369
370
    }
  }

371
372
373
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
374
      'title' => $t('Database updates'),
375
376
377
378
379
380
381
382
383
384
385
386
      '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');
387
          $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'));
388
389
390
391
392
393
          break;
        }
      }
    }
  }

394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
  // 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');
  }

411
412
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
413
    $profile = drupal_get_profile();
414
415
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
416
      // Ignore disabled modules and install profiles.
417
      if (!$file->status || $module == $profile) {
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
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
        continue;
      }
      // Check the module's PHP version.
      $name = $file->info['name'];
      $php = $file->info['php'];
      if (version_compare($php, PHP_VERSION, '>')) {
        $requirements['php']['description'] .= $t('@name requires at least PHP @version.', array('@name' => $name, '@version' => $php));
        $requirements['php']['severity'] = REQUIREMENT_ERROR;
      }
      // Check the module's required modules.
      foreach ($file->requires as $requirement) {
        $required_module = $requirement['name'];
        // Check if the module exists.
        if (!isset($files[$required_module])) {
          $requirements["$module-$required_module"] = array(
            'title' => $t('Unresolved dependency'),
            'description' => $t('@name requires this module.', array('@name' => $name)),
            'value' => t('@required_name (Missing)', array('@required_name' => $required_module)),
            'severity' => REQUIREMENT_ERROR,
          );
          continue;
        }
        // Check for an incompatible version.
        $required_file = $files[$required_module];
        $required_name = $required_file->info['name'];
        $version = str_replace(DRUPAL_CORE_COMPATIBILITY . '-', '', $required_file->info['version']);
        $compatibility = drupal_check_incompatibility($requirement, $version);
        if ($compatibility) {
          $compatibility = rtrim(substr($compatibility, 2), ')');
          $requirements["$module-$required_module"] = array(
            'title' => $t('Unresolved dependency'),
            'description' => $t('@name requires this module and version. Currently using @required_name version @version', array('@name' => $name, '@required_name' => $required_name, '@version' => $version)),
            'value' => t('@required_name (Version @compatibility required)', array('@required_name' => $required_name, '@compatibility' => $compatibility)),
            'severity' => REQUIREMENT_ERROR,
          );
          continue;
        }
      }
    }
  }

459
  // Test Unicode library
460
  include_once DRUPAL_ROOT . '/includes/unicode.inc';
461
462
  $requirements = array_merge($requirements, unicode_requirements());

463
  if ($phase == 'runtime') {
464
    // Check for update status module.
465
466
467
    if (!module_exists('update')) {
      $requirements['update status'] = array(
        'value' => $t('Not enabled'),
468
        'severity' => REQUIREMENT_WARNING,
469
        '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, <a href="@update">Update status handbook page</a>.', array('@update' => 'http://drupal.org/handbook/modules/update', '@module' => url('admin/modules'))),
470
471
472
473
474
475
476
477
      );
    }
    else {
      $requirements['update status'] = array(
        'value' => $t('Enabled'),
      );
    }
    $requirements['update status']['title'] = $t('Update notifications');
478
479
480
481
482
483
484

    // 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,
485
        '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.'),
486
487
      );
    }
488
489
  }

490
491
492
  return $requirements;
}

493
/**
494
 * Implements hook_install().
495
 */
496
function system_install() {
497
  // Create tables.
498
499
500
501
  drupal_install_schema('system');
  $versions = drupal_get_schema_versions('system');
  $version = $versions ? max($versions) : SCHEMA_INSTALLED;
  drupal_set_installed_schema_version('system', $version);
502

503
  // Clear out module list and hook implementation statics before calling
504
  // system_rebuild_theme_data().
505
506
507
  module_list(TRUE);
  module_implements('', FALSE, TRUE);

508
  // Load system theme data appropriately.
509
  system_rebuild_theme_data();
510

511
  // Enable the default theme.
512
  variable_set('theme_default', 'bartik');
513
514
515
  db_update('system')
    ->fields(array('status' => 1))
    ->condition('type', 'theme')
516
    ->condition('name', 'bartik')
517
518
    ->execute();

519
  // Populate the cron key variable.
520
  $cron_key = drupal_hash_base64(drupal_random_bytes(55));
521
  variable_set('cron_key', $cron_key);
522
523
}

524
/**
525
 * Implements hook_schema().
526
527
528
529
530
531
 */
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(
532
    '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.',
533
    'fields' => array(
534
      'name' => array(
535
        'description' => 'The name of the variable.',
536
537
538
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
539
540
        'default' => '',
      ),
541
      'value' => array(
542
        'description' => 'The value of the variable.',
543
        'type' => 'blob',
544
        'not null' => TRUE,
545
        'size' => 'big',
546
        'translatable' => TRUE,
547
      ),
548
    ),
549
    'primary key' => array('name'),
550
  );
551
552

  $schema['actions'] = array(
553
    'description' => 'Stores action information.',
554
    'fields' => array(
555
      'aid' => array(
556
        'description' => 'Primary Key: Unique actions ID.',
557
558
559
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
560
561
        'default' => '0',
      ),
562
      'type' => array(
563
        'description' => 'The object that that action acts on (node, user, comment, system or custom types.)',
564
565
566
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
567
568
        'default' => '',
      ),
569
      'callback' => array(
570
        'description' => 'The callback function that executes when the action runs.',
571
572
573
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
574
575
        'default' => '',
      ),
576
      'parameters' => array(
577
        'description' => 'Parameters to be passed to the callback function.',
578
        'type' => 'blob',
579
        'not null' => TRUE,
580
581
        'size' => 'big',
      ),
582
583
      'label' => array(
        'description' => 'Label of the action.',
584
585
586
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
587
        'default' => '0',
588
      ),
589
    ),
590
    'primary key' => array('aid'),
591
  );
592
593

  $schema['batch'] = array(
594
    'description' => 'Stores details about batches (processes that run in multiple HTTP requests).',
595
    'fields' => array(
596
      'bid' => array(
597
        'description' => 'Primary Key: Unique batch ID.',
598
599
600
        // This is not a serial column, to allow both progressive and
        // non-progressive batches. See batch_process().
        'type' => 'int',
601
        'unsigned' => TRUE,
602
603
        'not null' => TRUE,
      ),
604
      'token' => array(
605
        '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.",
606
607
        'type' => 'varchar',
        'length' => 64,
608
609
        'not null' => TRUE,
      ),
610
      'timestamp' => array(
611
        'description' => 'A Unix timestamp indicating when this batch was submitted for processing. Stale batches are purged at cron time.',
612
        'type' => 'int',
613
614
        'not null' => TRUE,
      ),
615
      'batch' => array(
616
        'description' => 'A serialized array containing the processing data for the batch.',
617
        'type' => 'blob',
618
        'not null' => FALSE,
619
        'size' => 'big',
620
      ),
621
    ),
622
    'primary key' => array('bid'),
623
624
625
626
    'indexes' => array(
      'token' => array('token'),
    ),
  );
627

628
  $schema['blocked_ips'] = array(
629
    'description' => 'Stores blocked IP addresses.',
630
631
    'fields' => array(
       'iid' => array(
632
        'description' => 'Primary Key: unique ID for IP addresses.',
633
634
635
636
637
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'ip' => array(
638
        'description' => 'IP address',
639
        'type' => 'varchar',
640
        'length' => 40,
641
642
643
644
645
646
647
648
649
650
        'not null' => TRUE,
        'default' => '',
      ),
    ),
    'indexes' => array(
      'blocked_ip' => array('ip'),
    ),
    'primary key' => array('iid'),
  );

651
  $schema['cache'] = array(
652
    'description' => 'Generic cache table for caching things not separated out into their own tables. Contributed modules may also use this to store cached items.',
653
    'fields' => array(
654
      'cid' => array(
655
        'description' => 'Primary Key: Unique cache ID.',
656
657
658
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
659
660
        'default' => '',
      ),
661
      'data' => array(
662
        'description' => 'A collection of data to cache.',
663
664
        'type' => 'blob',
        'not null' => FALSE,
665
666
        'size' => 'big',
      ),
667
      'expire' => array(
668
        'description' => 'A Unix timestamp indicating when the cache entry should expire, or 0 for never.',
669
670
        'type' => 'int',
        'not null' => TRUE,
671
672
        'default' => 0,
      ),
673
      'created' => array(
674
        'description' => 'A Unix timestamp indicating when the cache entry was created.',
675
676
        'type' => 'int',
        'not null' => TRUE,
677
678
        'default' => 0,
      ),
679
      'serialized' => array(
680
        'description' => 'A flag to indicate whether content is serialized (1) or not (0).',
681
682
683
        'type' => 'int',
        'size' => 'small',
        'not null' => TRUE,
684
        'default' => 0,
685
      ),
686
687
688
689
    ),
    'indexes' => array(
      'expire' => array('expire'),
    ),
690
    'primary key' => array('cid'),
691
  );
692
693
  $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.';
694
  $schema['cache_form'] = $schema['cache'];
695
  $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.';
696
  $schema['cache_page'] = $schema['cache'];
697
  $schema['cache_page']['description'] = 'Cache table used to store compressed pages for anonymous users, if page caching is enabled.';
698
  $schema['cache_menu'] = $schema['cache'];
699
  $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.';
700
701
  $schema['cache_path'] = $schema['cache'];
  $schema['cache_path']['description'] = 'Cache table for path alias lookup.';
702

703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
  $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'),
727
728
729
    'indexes' => array(
      'title' => array('title'),
    ),
730
731
  );

732
  // This table's name is plural as some versions of MySQL can't create a
733
734
735
736
737
738
739
740
741
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
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
  // 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'),
  );

792
  $schema['file_managed'] = array(
793
    'description' => 'Stores information for uploaded files.',
794
    'fields' => array(
795
      'fid' => array(
796
        'description' => 'File ID.',
797
798
        'type' => 'serial',
        'unsigned' => TRUE,
799
800
        'not null' => TRUE,
      ),
801
      'uid' => array(
802
        'description' => 'The {users}.uid of the user who is associated with the file.',
803
804
805
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
806
807
        'default' => 0,
      ),
808
      'filename' => array(
809
        'description' => 'Name of the file with no path components. This may differ from the basename of the URI if the file is renamed to avoid overwriting an existing file.',
810
811
812
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
813
814
        'default' => '',
      ),
815
      'uri' => array(
816
        'description' => 'The URI to access the file (either local or remote).',
817
818
819
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
820
821
        'default' => '',
      ),
822
      'filemime' => array(
823
        'description' => "The file's MIME type.",
824
825
826
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
827
828
        'default' => '',
      ),
829
      'filesize' => array(
830
        'description' => 'The size of the file in bytes.',
831
832
833
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
834
835
        'default' => 0,
      ),
836
      'status' => array(
837
        'description' => 'A field indicating the status of the file. Two status are defined in core: temporary (0) and permanent (1). Temporary files older than DRUPAL_MAXIMUM_TEMP_FILE_AGE will be removed during a cron run.',
838
839
        'type' => 'int',
        'not null' => TRUE,
840
        'default' => 0,
841
        'size' => 'tiny',
842
      ),
843
      'timestamp' => array(
844
        'description' => 'UNIX timestamp for when the file was added.',
845
846
847
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
848
        'default' => 0,
849
      ),
850
    ),
851
    'indexes' => array(
852
853
      'uid' => array('uid'),
      'status' => array('status'),
854
      'timestamp' => array('timestamp'),
855
    ),
856
857
858
    'unique keys' => array(
      'uri' => array('uri'),
    ),
859
    'primary key' => array('fid'),
860
    'foreign keys' => array(
861
862
863
864
      'file_owner' => array(
        'table' => 'users',
        'columns' => array('uid' => 'uid'),
      ),
865
    ),
866
  );
867

868
869
870
871
872
873
874
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
  $schema['file_usage'] = array(
    'description' => 'Track where a file is used.',
    'fields' => array(
      'fid' => array(
        'description' => 'File ID.',
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'module' => array(
        'description' => 'The name of the module that is using the file.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'type' => array(
        'description' => 'The name of the object type in which the file is used.',
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
        'default' => '',
      ),
      'id' => array(
        'description' => 'The primary key of the object using the file.',
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
      'count' => array(
        'description' => 'The number of times this file is used by this object.',
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
    ),
    'primary key' => array('fid', 'type', 'id', 'module'),
    'indexes' => array(
      'type_id' => array('type', 'id'),
      'fid_count' => array('fid', 'count'),
      'fid_module' => array('fid', 'module'),
    ),
  );

914
  $schema['flood'] = array(
915
    'description' => 'Flood controls the threshold of events, such as the number of contact attempts.',
916
    'fields' => array(
917
      'fid' => array(
918
        'description' => 'Unique flood event ID.',
919
        'type' => 'serial',
920
921
        'not null' => TRUE,
      ),
922
      'event' => array(
923
        'description' => 'Name of event (e.g. contact).',
924
925
926
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
927
928
        'default' => '',
      ),
929
930
      'identifier' => array(
        'description' => 'Identifier of the visitor, such as an IP address or hostname.',
931
932
933
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
934
935
        'default' => '',
      ),
936
      'timestamp' => array(
937
        'description' => 'Timestamp of the event.',
938
939
        'type' => 'int',
        'not null' => TRUE,
940
        'default' => 0,
941
      ),
942
943
944
945
946
947
      'expiration' => array(
        'description' => 'Expiration timestamp. Expired events are purged on cron run.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
948
    ),
949
    'primary key' => array('fid'),
950
    'indexes' => array(
951
      'allow' => array('event', 'identifier', 'timestamp'),
952
      'purge' => array('expiration'),
953
    ),
954
  );
955
956

  $schema['history'] = array(
957
    'description' => 'A record of which {users} have read which {node}s.',
958
    'fields' => array(
959
      'uid' => array(
960
        'description' => 'The {users}.uid that read the {node} nid.',
961
962
        'type' => 'int',
        'not null' => TRUE,
963
964
        'default' => 0,
      ),
965
      'nid' => array(
966
        'description' => 'The {node}.nid that was read.',
967
968
        'type' => 'int',
        'not null' => TRUE,
969
970
        'default' => 0,
      ),
971
      'timestamp' => array(
972
        'description' => 'The Unix timestamp at which the read occurred.',
973
974
        'type' => 'int',
        'not null' => TRUE,
975
        'default' => 0,
976
      ),
977
    ),
978
    'primary key' => array('uid', 'nid'),
979
980
981
    'indexes' => array(
      'nid' => array('nid'),
    ),
982
  );
983
  $schema['menu_router'] = array(
984
    'description' => 'Maps paths to various callbacks (access, page and title)',
985
    'fields' => array(
986
      'path' => array(
987
        'description' => 'Primary Key: the Drupal path this entry describes',
988
989
990
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
991
992
        'default' => '',
      ),
993
      'load_functions' => array(
994
        '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.',
995
        'type' => 'blob',
996
        'not null' => TRUE,
997
      ),
998
      'to_arg_functions' => array(
999
        '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.',
1000
        'type' => 'blob',
1001
        'not null' => TRUE,
1002
      ),
1003
      'access_callback' => array(
1004
        'description' => 'The callback which determines the access to this router path. Defaults to user_access.',
1005
1006
1007
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
1008
1009
        'default' => '',
      ),
1010
      'access_arguments' => array(
1011
        'description' => 'A serialized array of arguments for the access callback.',
1012
        'type' => 'blob',
1013
1014
        'not null' => FALSE,
      ),
1015
      'page_callback' => array(
1016
        'description' => 'The name of the function that renders the page.',