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

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

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

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

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

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

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

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

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

99 100 101
  // Test for PHP extensions.
  $requirements['php_extensions'] = array(
    'title' => $t('PHP extensions'),
102
  );
103 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

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

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

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

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

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

172 173 174
    if (!$database_ok) {
      $requirements['database_extensions']['value'] = $t('Disabled');
      $requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
175
      $requirements['database_extensions']['description'] = $pdo_message;
176 177 178 179
    }
    else {
      $requirements['database_extensions']['value'] = $t('Enabled');
    }
180
  }
181 182 183 184 185 186 187 188 189 190 191 192 193
  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(),
    );
  }
194

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

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

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

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

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

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

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

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

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

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

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

294
  // Test files directories.
295 296 297 298 299
  // 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;
300
  $directories = array(
301
    variable_get('file_public_path', conf_path($require_settings, $reset_cache) . '/files'),
302 303 304
    // 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),
305
  );
306 307 308 309 310 311 312 313 314 315 316

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

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

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

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

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

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

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

458
  if ($phase == 'runtime') {
459
    // Check for update status module.
460 461 462
    if (!module_exists('update')) {
      $requirements['update status'] = array(
        'value' => $t('Not enabled'),
463
        'severity' => REQUIREMENT_WARNING,
464
        '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'))),
465 466 467 468 469 470 471 472
      );
    }
    else {
      $requirements['update status'] = array(
        'value' => $t('Enabled'),
      );
    }
    $requirements['update status']['title'] = $t('Update notifications');
473 474 475 476 477 478 479

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

485 486 487
  return $requirements;
}

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

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

503
  // Load system theme data appropriately.
504
  system_rebuild_theme_data();
505

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

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

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

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

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

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

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

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

727
  // This table's name is plural as some versions of MySQL can't create a
728 729 730 731 732 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
  // 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(
778
        'description' => 'A {language}.langcode for this format to be used with.',
779 780 781 782 783 784 785 786
        'type' => 'varchar',
        'length' => 12,
        'not null' => TRUE,
      ),
    ),
    'primary key' => array('type', 'language'),
  );

787
  $schema['file_managed'] = array(
788
    'description' => 'Stores information for uploaded files.',
789
    'fields' => array(
790
      'fid' => array(
791
        'description' => 'File ID.',
792 793
        'type' => 'serial',
        'unsigned' => TRUE,
794 795
        'not null' => TRUE,
      ),
796
      'uid' => array(
797
        'description' => 'The {users}.uid of the user who is associated with the file.',
798 799 800
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
801 802
        'default' => 0,
      ),
803
      'filename' => array(
804
        '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.',
805 806 807
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
808 809
        'default' => '',
      ),
810
      'uri' => array(
811
        'description' => 'The URI to access the file (either local or remote).',
812 813 814
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
815 816
        'default' => '',
      ),
817
      'filemime' => array(
818
        'description' => "The file's MIME type.",
819 820 821
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
822 823
        'default' => '',
      ),
824
      'filesize' => array(
825
        'description' => 'The size of the file in bytes.',
826 827 828
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
829 830
        'default' => 0,
      ),
831
      'status' => array(
832
        '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.',
833 834
        'type' => 'int',
        'not null' => TRUE,
835
        'default' => 0,
836
        'size' => 'tiny',
837
      ),
838
      'timestamp' => array(
839
        'description' => 'UNIX timestamp for when the file was added.',
840 841 842
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
843
        'default' => 0,
844
      ),
845
    ),
846
    'indexes' => array(
847 848
      'uid' => array('uid'),
      'status' => array('status'),
849
      'timestamp' => array('timestamp'),
850
    ),
851 852 853
    'unique keys' => array(
      'uri' => array('uri'),
    ),
854
    'primary key' => array('fid'),
855
    'foreign keys' => array(
856 857 858 859
      'file_owner' => array(
        'table' => 'users',
        'columns' => array('uid' => 'uid'),
      ),
860
    ),
861
  );
862

863 864 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
  $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,
      ),