system.install 71.6 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
  // 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') {
93
    $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="@url">how to change configuration settings</a>.', array('@url' => 'http://php.net/configuration.changes'));
94 95 96 97 98 99
    $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

  $missing_extensions = array();
  $required_extensions = array(
    'date',
    'dom',
    'filter',
    'gd',
    'hash',
    'json',
    'pcre',
    'pdo',
    'session',
    'SimpleXML',
    'SPL',
119
    'tokenizer',
120 121 122 123 124 125 126 127 128 129 130 131 132
    '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',
    ));

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

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

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

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

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

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

205
  if (!drupal_check_memory_limit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
206 207 208
    $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));
209 210 211
    }
    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));
212
    }
213 214
    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));
215
    }
216

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

225
      $requirements['php_memory_limit']['description'] = $description . ' ' . $t('For more information, see the online handbook entry for <a href="@memory-limit">increasing the PHP memory limit</a>.', array('@memory-limit' => 'http://drupal.org/node/207036'));
226
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
227
    }
228
  }
229

230
  // Test configuration files and directory for writability.
231
  if ($phase == 'runtime') {
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
    $conf_errors = array();
    $conf_path = conf_path();
    if (!drupal_verify_install_file($conf_path, FILE_NOT_WRITABLE, 'dir')) {
      $conf_errors[] = $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));
    }
    foreach (array('settings.php', 'settings.local.php') as $conf_file) {
      $full_path = $conf_path . '/' . $conf_file;
      if (file_exists($full_path) && !drupal_verify_install_file($full_path, FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE)) {
        $conf_errors[] = $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' => $full_path));
      }
    }
    if (!empty($conf_errors)) {
      if (count($conf_errors) == 1) {
        $description = $conf_errors[0];
      }
      else {
        $description = theme('item_list', array('items' => $conf_errors));
      }
250 251 252
      $requirements['settings.php'] = array(
        'value' => $t('Not protected'),
        'severity' => REQUIREMENT_ERROR,
253
        'description' => $description,
254 255 256 257 258 259 260
      );
    }
    else {
      $requirements['settings.php'] = array(
        'value' => $t('Protected'),
      );
    }
261
    $requirements['settings.php']['title'] = $t('Configuration files');
262 263
  }

264
  // Report cron status.
265
  if ($phase == 'runtime') {
266
    $cron_config = config('system.cron');
267
    // Cron warning threshold defaults to two days.
268
    $threshold_warning = $cron_config->get('threshold.requirements_warning');
269
    // Cron error threshold defaults to two weeks.
270
    $threshold_error = $cron_config->get('threshold.requirements_error');
271
    // Cron configuration help text.
272
    $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'));
273

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

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

    // Set summary and description based on values determined above.
290 291
    $summary = $t('Last run !time ago', array('!time' => format_interval(REQUEST_TIME - $cron_last)));
    $description = '';
292
    if ($severity != REQUIREMENT_INFO) {
293
      $description = $t('Cron has not run recently.') . ' ' . $help;
294
    }
295

296
    $description .= ' ' . $t('You can <a href="@cron">run cron manually</a>.', array('@cron' => url('admin/reports/status/run-cron')));
297
    $description .= '<br />' . $t('To run cron from outside the site, go to <a href="!cron">!cron</a>', array('!cron' => url('cron/' . $cron_config->get('key'))));
298

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

307
  // Test files directories.
308 309 310 311 312
  // 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;
313
  $directories = array(
314
    variable_get('file_public_path', conf_path($require_settings, $reset_cache) . '/files'),
315 316 317
    // 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),
318
  );
319 320 321 322 323 324 325 326 327 328 329

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

330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
  // Check the config directory if it is defined in settings.php. If it isn't
  // defined, the installer will create a valid config directory later, but
  // during runtime we must always display an error.
  if (!empty($GLOBALS['config_directory_name'])) {
    $directories[] = config_get_config_directory();
  }
  elseif ($phase != 'install') {
    $requirements['config directory'] = array(
      'title' => $t('Configuration directory'),
      'value' => $t('Not present'),
      'description' => $t('Your %file file must define the $config_directory_name variable as the name of a directory in which configuration files can be written.', array('%file' => conf_path() . '/settings.php')),
      'severity' => REQUIREMENT_ERROR,
    );
  }

345 346 347
  $requirements['file system'] = array(
    'title' => $t('File system'),
  );
348

349 350 351
  $error = '';
  // For installer, create the directories if possible.
  foreach ($directories as $directory) {
352 353 354
    if (!$directory) {
      continue;
    }
355
    if ($phase == 'install') {
356
      file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
357
    }
358 359 360 361 362 363 364 365 366 367 368 369 370
    $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') {
371
        $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')));
372 373 374 375
      }
      elseif ($phase == 'install') {
        // For the installer UI, we need different wording. 'value' will
        // be treated as version, so provide none there.
376
        $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'));
377 378 379 380 381 382
        $requirements['file system']['value'] = '';
      }
      if (!empty($description)) {
        $requirements['file system']['description'] = $description;
        $requirements['file system']['severity'] = REQUIREMENT_ERROR;
      }
383 384
    }
    else {
385
      if (file_default_scheme() == 'public') {
386 387 388 389 390
        $requirements['file system']['value'] = $t('Writable (<em>public</em> download method)');
      }
      else {
        $requirements['file system']['value'] = $t('Writable (<em>private</em> download method)');
      }
391 392 393
    }
  }

394 395 396
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
397
      'title' => $t('Database updates'),
398 399 400 401 402 403 404 405 406 407 408
      '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');
409
          $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'));
410 411 412 413 414 415
          break;
        }
      }
    }
  }

416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
  // 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');
  }

433 434
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
435
    $profile = drupal_get_profile();
436 437
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
438
      // Ignore disabled modules and install profiles.
439
      if (!$file->status || $module == $profile) {
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
        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;
        }
      }
    }
  }

481
  // Test Unicode library
482
  include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
483 484
  $requirements = array_merge($requirements, unicode_requirements());

485
  if ($phase == 'runtime') {
486
    // Check for update status module.
487 488 489
    if (!module_exists('update')) {
      $requirements['update status'] = array(
        'value' => $t('Not enabled'),
490
        'severity' => REQUIREMENT_WARNING,
491
        '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/documentation/modules/update', '@module' => url('admin/modules'))),
492 493 494 495 496 497 498 499 500 501
      );
    }
    else {
      $requirements['update status'] = array(
        'value' => $t('Enabled'),
      );
    }
    $requirements['update status']['title'] = $t('Update notifications');
  }

502 503 504
  return $requirements;
}

505
/**
506
 * Implements hook_install().
507
 */
508
function system_install() {
509
  // Enable the default theme.
510
  variable_set('theme_default', 'stark');
511 512 513
  db_update('system')
    ->fields(array('status' => 1))
    ->condition('type', 'theme')
514
    ->condition('name', 'stark')
515 516
    ->execute();

517
  // Populate the cron key variable.
518
  $cron_key = drupal_hash_base64(drupal_random_bytes(55));
519
  config('system.cron')
520
    ->set('key', $cron_key)
521
    ->save();
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 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
  $schema['cache_tags'] = array(
    'description' => 'Cache table for tracking cache tags related to the cache bin.',
    'fields' => array(
      'tag' => array(
        'description' => 'Namespace-prefixed tag string.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'invalidations' => array(
        'description' => 'Number incremented when the tag is invalidated.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
    ),
    'primary key' => array('tag'),
  );

671
  $schema['cache'] = array(
672
    'description' => 'Generic cache table for caching things not separated out into their own tables. Contributed modules may also use this to store cached items.',
673
    'fields' => array(
674
      'cid' => array(
675
        'description' => 'Primary Key: Unique cache ID.',
676 677 678
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
679 680
        'default' => '',
      ),
681
      'data' => array(
682
        'description' => 'A collection of data to cache.',
683 684
        'type' => 'blob',
        'not null' => FALSE,
685 686
        'size' => 'big',
      ),
687
      'expire' => array(
688
        'description' => 'A Unix timestamp indicating when the cache entry should expire, or 0 for never.',
689 690
        'type' => 'int',
        'not null' => TRUE,
691 692
        'default' => 0,
      ),
693
      'created' => array(
694
        'description' => 'A Unix timestamp indicating when the cache entry was created.',
695 696
        'type' => 'int',
        'not null' => TRUE,
697 698
        'default' => 0,
      ),
699
      'serialized' => array(
700
        'description' => 'A flag to indicate whether content is serialized (1) or not (0).',
701 702 703
        'type' => 'int',
        'size' => 'small',
        'not null' => TRUE,
704
        'default' => 0,
705
      ),
706 707 708 709 710 711 712 713 714 715 716 717
      'tags' => array(
        'description' => 'Space-separated list of cache tags for this entry.',
        'type' => 'text',
        'size' => 'big',
        'not null' => FALSE,
      ),
      'checksum' => array(
        'description' => 'The tag invalidation sum when this entry was saved.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
718 719 720 721
    ),
    'indexes' => array(
      'expire' => array('expire'),
    ),
722
    'primary key' => array('cid'),
723
  );
724 725
  $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.';
726
  $schema['cache_form'] = $schema['cache'];
727
  $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.';
728
  $schema['cache_page'] = $schema['cache'];
729
  $schema['cache_page']['description'] = 'Cache table used to store compressed pages for anonymous users, if page caching is enabled.';
730
  $schema['cache_menu'] = $schema['cache'];
731
  $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.';
732 733
  $schema['cache_path'] = $schema['cache'];
  $schema['cache_path']['description'] = 'Cache table for path alias lookup.';
734

735 736 737 738
  $schema['config'] = array(
    'description' => 'Default active store for the configuration system.',
    'fields' => array(
      'name' => array(
739
        'description' => 'The identifier for the configuration entry, such as module.example (the name of the file, minus the file extension).',
740 741 742 743 744 745
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'data' => array(
746
        'description' => 'The raw data for this configuration entry.',
747 748 749 750 751 752 753 754 755 756
        'type' => 'blob',
        'not null' => TRUE,
        'size' => 'big',
        'translatable' => TRUE,
      ),
    ),
    'primary key' => array('name'),
  );


757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
  $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'),
781 782 783
    'indexes' => array(
      'title' => array('title'),
    ),
784 785
  );

786
  // This table's name is plural as some versions of MySQL can't create a
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
  // 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(
837
        'description' => 'A {language}.langcode for this format to be used with.',
838 839 840 841 842 843 844 845
        'type' => 'varchar',
        'length' => 12,
        'not null' => TRUE,
      ),
    ),
    'primary key' => array('type', 'language'),
  );

846
  $schema['file_managed'] = array(
847
    'description' => 'Stores information for uploaded files.',
848
    'fields' => array(
849
      'fid' => array(
850
        'description' => 'File ID.',
851 852
        'type' => 'serial',
        'unsigned' => TRUE,
853 854
        'not null' => TRUE,
      ),
855 856 857 858 859 860
      'uuid' => array(
        'description' => 'Unique Key: Universally unique identifier for this entity.',
        'type' => 'varchar',
        'length' => 128,
        'not null' => FALSE,
      ),
861
      'uid' => array(
862
        'description' => 'The {users}.uid of the user who is associated with the file.',
863 864 865
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
866 867
        'default' => 0,
      ),
868
      'filename' => array(
869
        '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.',
870 871 872
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
873
        'default' => '',
874
        'binary' => TRUE,
875
      ),
876
      'uri' => array(
877
        'description' => 'The URI to access the file (either local or remote).',
878 879 880
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
881
        'default' => '',
882
        'binary' => TRUE,
883
      ),
884 885 886 887 888 889 890
      'langcode' => array(
        'description' => 'The {language}.langcode of this file.',
        'type' => 'varchar',
        'length' => 12,
        'not null' => TRUE,
        'default' => '',
      ),
891
      'filemime' => array(
892
        'description' => "The file's MIME type.",
893 894 895
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
896 897
        'default' => '',
      ),
898
      'filesize' => array(
899
        'description' => 'The size of the file in bytes.',
900 901 902
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
903 904
        'default' => 0,
      ),
905
      'status' => array(
906
        '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.',
907 908
        'type' => 'int',
        'not null' => TRUE,
909
        'default' => 0,
910
        'size' => 'tiny',
911
      ),
Gábor Hojtsy's avatar