system.install 62 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2

3
use Drupal\Core\Database\Database;
4

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

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

  // Report Drupal version
  if ($phase == 'runtime') {
    $requirements['drupal'] = array(
      'title' => $t('Drupal'),
      'value' => VERSION,
Steven Wittens's avatar
Steven Wittens committed
29 30
      'severity' => REQUIREMENT_INFO,
      'weight' => -10,
31
    );
32 33 34 35

    // Display the currently active install profile, if the site
    // is not running the default install profile.
    $profile = drupal_get_profile();
36
    if ($profile != 'standard') {
37
      $info = system_get_info('module', $profile);
38 39 40 41 42 43 44 45 46 47
      $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
      );
48
    }
49 50
  }

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

58 59 60 61 62 63 64 65 66 67 68 69
  // 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,
70
      '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')),
71 72 73 74 75
      'severity' => REQUIREMENT_INFO,
    );
  }

  if (version_compare($phpversion, DRUPAL_MINIMUM_PHP) < 0) {
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
    // If PHP is old, it's not safe to continue with the requirements check.
    return $requirements;
80
  }
81

82 83 84 85 86
  // Test PHP register_globals setting.
  $requirements['php_register_globals'] = array(
    'title' => $t('PHP register globals'),
  );
  $register_globals = trim(ini_get('register_globals'));
87
  // Unfortunately, ini_get() may return many different values, and we can't
88 89 90 91 92 93 94 95 96 97 98 99
  // 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');
  }
100

101 102 103
  // Test for PHP extensions.
  $requirements['php_extensions'] = array(
    'title' => $t('PHP extensions'),
104
  );
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131

  $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',
    ));

132
    $description .= theme('item_list', array('items' => $missing_extensions));
133 134 135 136

    $requirements['php_extensions']['value'] = $t('Disabled');
    $requirements['php_extensions']['severity'] = REQUIREMENT_ERROR;
    $requirements['php_extensions']['description'] = $description;
137 138
  }
  else {
139
    $requirements['php_extensions']['value'] = $t('Enabled');
140
  }
141

142 143 144 145 146
  if ($phase == 'install' || $phase == 'update') {
    // Test for PDO (database).
    $requirements['database_extensions'] = array(
      'title' => $t('Database support'),
    );
147

148
    // Make sure PDO is available.
149
    $database_ok = extension_loaded('pdo');
150 151 152 153 154 155 156
    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.
157
      $drivers = drupal_detect_database_types();
158 159 160 161 162 163 164 165 166 167 168 169 170 171
      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',
        ));
      }
172
    }
173

174 175 176
    if (!$database_ok) {
      $requirements['database_extensions']['value'] = $t('Disabled');
      $requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
177
      $requirements['database_extensions']['description'] = $pdo_message;
178 179 180 181
    }
    else {
      $requirements['database_extensions']['value'] = $t('Enabled');
    }
182
  }
183 184
  else {
    // Database information.
185
    $class = Database::getConnection()->getDriverClass('Install\\Tasks');
186 187 188 189 190 191 192 193 194 195
    $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(),
    );
  }
196

197
  // Test PHP memory_limit
198
  $memory_limit = ini_get('memory_limit');
199 200
  $requirements['php_memory_limit'] = array(
    'title' => $t('PHP memory limit'),
201
    'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
202
  );
203

204
  if ($memory_limit && $memory_limit != -1 && parse_size($memory_limit) < parse_size(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT)) {
205 206 207
    $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));
208 209 210
    }
    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));
211
    }
212 213
    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));
214
    }
215

216 217
    if (!empty($description)) {
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
218
        $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));
219 220
      }
      else {
221
        $description .= ' ' . $t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
222
      }
223

224
      $requirements['php_memory_limit']['description'] = $description . ' ' . $t('See the <a href="@url">Drupal requirements</a> for more information.', array('@url' => 'http://drupal.org/requirements'));
225
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
226
    }
227
  }
228

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

254
  // Report cron status.
255
  if ($phase == 'runtime') {
256 257 258 259 260
    // 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.
261
    $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'));
262

263
    // Determine when cron last ran.
264
    $cron_last = variable_get('cron_last');
265 266 267
    if (!is_numeric($cron_last)) {
      $cron_last = variable_get('install_time', 0);
    }
268

269 270
    // Determine severity based on time since cron last ran.
    $severity = REQUIREMENT_OK;
271
    if (REQUEST_TIME - $cron_last > $threshold_error) {
272
      $severity = REQUIREMENT_ERROR;
273
    }
274
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
275 276 277 278
      $severity = REQUIREMENT_WARNING;
    }

    // Set summary and description based on values determined above.
279 280 281 282
    $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;
283
    }
284

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

288 289 290 291
    $requirements['cron'] = array(
      'title' => $t('Cron maintenance tasks'),
      'severity' => $severity,
      'value' => $summary,
292
      'description' => $description
293
    );
294 295
  }

296
  // Test files directories.
297 298 299 300 301
  // If we are installing Drupal, the settings.php file might not exist yet in
  // the intended conf_path() directory, so don't require it. The conf_path()
  // cache must also be reset in this case.
  $require_settings = ($phase != 'install');
  $reset_cache = !$require_settings;
302
  $directories = array(
303
    variable_get('file_public_path', conf_path($require_settings, $reset_cache) . '/files'),
304 305 306
    // 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),
307
  );
308 309 310 311 312 313 314 315 316 317 318

  // 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());
  }

319 320 321
  $requirements['file system'] = array(
    'title' => $t('File system'),
  );
322

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

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

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

408 409
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
410
    $profile = drupal_get_profile();
411 412
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
413
      // Ignore disabled modules and install profiles.
414
      if (!$file->status || $module == $profile) {
415 416 417 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
        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;
        }
      }
    }
  }

456
  // Test Unicode library
457
  include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
458 459
  $requirements = array_merge($requirements, unicode_requirements());

460
  if ($phase == 'runtime') {
461
    // Check for update status module.
462 463 464
    if (!module_exists('update')) {
      $requirements['update status'] = array(
        'value' => $t('Not enabled'),
465
        'severity' => REQUIREMENT_WARNING,
466
        'description' => $t('Update notifications are not enabled. It is <strong>highly recommended</strong> that you enable the Update Manager 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'))),
467 468 469 470 471 472 473 474
      );
    }
    else {
      $requirements['update status'] = array(
        'value' => $t('Enabled'),
      );
    }
    $requirements['update status']['title'] = $t('Update notifications');
475 476 477 478 479 480 481

    // 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,
482
        '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.'),
483 484
      );
    }
485 486
  }

487 488 489
  return $requirements;
}

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

500
  // Clear out module list and hook implementation statics before calling
501
  // system_rebuild_theme_data().
502
  module_list(TRUE);
503
  module_implements_reset();
504

505
  // Load system theme data appropriately.
506
  system_rebuild_theme_data();
507

508
  // Enable the default theme.
509
  variable_set('theme_default', 'stark');
510 511 512
  db_update('system')
    ->fields(array('status' => 1))
    ->condition('type', 'theme')
513
    ->condition('name', 'stark')
514 515
    ->execute();

516
  // Populate the cron key variable.
517
  $cron_key = drupal_hash_base64(drupal_random_bytes(55));
518
  variable_set('cron_key', $cron_key);
519 520
}

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

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

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

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

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

700 701 702 703
  $schema['config'] = array(
    'description' => 'Default active store for the configuration system.',
    'fields' => array(
      'name' => array(
704
        'description' => 'The identifier for the configuration entry, such as module.example (the name of the file, minus the file extension).',
705 706 707 708 709 710
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'data' => array(
711
        'description' => 'The raw data for this configuration entry.',
712 713 714 715 716 717 718 719 720 721
        'type' => 'blob',
        'not null' => TRUE,
        'size' => 'big',
        'translatable' => TRUE,
      ),
    ),
    'primary key' => array('name'),
  );


722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
  $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'),
746 747 748
    'indexes' => array(
      'title' => array('title'),
    ),
749 750
  );

751
  // This table's name is plural as some versions of MySQL can't create a
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 792 793 794 795 796 797 798 799 800 801
  // 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(
802
        'description' => 'A {language}.langcode for this format to be used with.',
803 804 805 806 807 808 809 810
        'type' => 'varchar',
        'length' => 12,
        'not null' => TRUE,
      ),
    ),
    'primary key' => array('type', 'language'),
  );

811
  $schema['file_managed'] = array(
812
    'description' => 'Stores information for uploaded files.',
813
    'fields' => array(
814
      'fid' => array(
815
        'description' => 'File ID.',
816 817
        'type' => 'serial',
        'unsigned' => TRUE,
818 819
        'not null' => TRUE,
      ),
820
      'uid' => array(
821
        'description' => 'The {users}.uid of the user who is associated with the file.',
822 823 824
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
825 826
        'default' => 0,
      ),
827
      'filename' => array(
828
        '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.',
829 830 831
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
832 833
        'default' => '',
      ),
834
      'uri' => array(
835
        'description' => 'The URI to access the file (either local or remote).',
836 837 838
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
839 840
        'default' => '',
      ),
841
      'filemime' => array(
842
        'description' => "The file's MIME type.",
843 844 845
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
846 847
        'default' => '',
      ),
848
      'filesize' => array(
849
        'description' => 'The size of the file in bytes.',
850 851 852
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
853 854
        'default' => 0,
      ),
855
      'status' => array(
856
        '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.',
857 858
        'type' => 'int',
        'not null' => TRUE,
859
        'default' => 0,
860
        'size' => 'tiny',
861
      ),
862
      'timestamp' => array(
863
        'description' => 'UNIX timestamp for when the file was added.',
864 865 866
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
867
        'default' => 0,
868
      ),
869
    ),
870
    'indexes' => array(
871 872
      'uid' => array('uid'),
      'status' => array('status'),
873
      'timestamp' => array('timestamp'),
874
    ),
875 876 877
    'unique keys' => array(
      'uri' => array('uri'),
    ),
878
    'primary key' => array('fid'),
879
    'foreign keys' => array(
880 881 882 883
      'file_owner' => array(
        'table' => 'users',
        'columns' => array('uid' => 'uid'),
      ),
Dries's avatar