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

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

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

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

    // Display the currently active install profile, if the site
    // is not running the default install profile.
    $profile = drupal_get_profile();
35
    if ($profile != 'standard') {
36 37 38 39 40 41 42 43 44 45 46
      $info = install_profile_info($profile);
      $requirements['install_profile'] = array(
        'title' => $t('Install profile'),
        'value' => $t('%profile_name (%profile-%version)', array(
          '%profile_name' => $info['name'],
          '%profile' => $profile,
          '%version' => $info['version']
        )),
        'severity' => REQUIREMENT_INFO,
        'weight' => -9
      );
47
    }
48 49
  }

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

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

  if (version_compare($phpversion, DRUPAL_MINIMUM_PHP) < 0) {
75 76
    $requirements['php']['description'] = $t('Your PHP installation is too old. Drupal requires at least PHP %version.', array('%version' => DRUPAL_MINIMUM_PHP));
    $requirements['php']['severity'] = REQUIREMENT_ERROR;
77 78
    // If PHP is old, it's not safe to continue with the requirements check.
    return $requirements;
79
  }
80

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

100 101 102
  // Test for PHP extensions.
  $requirements['php_extensions'] = array(
    'title' => $t('PHP extensions'),
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 130 131 132 133 134 135 136 137 138

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

    $description .= theme('item_list',  array(
      'type' => 'ul',
      'items' => $missing_extensions,
    ));

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

144 145 146
  // Test for PDO (database).
  $requirements['database_extensions'] = array(
    'title' => $t('Database support'),
147
  );
148 149 150 151 152 153 154 155 156 157 158 159 160 161

  // Test for at least one suitable PDO extension, if PDO is available.
  $database_ok = extension_loaded('pdo');
  if ($database_ok) {
    $drivers = drupal_detect_database_types();
    $database_ok = !empty($drivers);
  }

  if (!$database_ok) {
    $requirements['database_extensions']['value'] = $t('Disabled');
    $requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
    $requirements['database_extensions']['description'] = $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',
    ));
162 163
  }
  else {
164
    $requirements['database_extensions']['value'] = $t('Enabled');
165 166
  }

167
  // Test PHP memory_limit
168
  $memory_limit = ini_get('memory_limit');
169 170
  $requirements['php_memory_limit'] = array(
    'title' => $t('PHP memory limit'),
171
    'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
172
  );
173

174
  if ($memory_limit && $memory_limit != -1 && parse_size($memory_limit) < parse_size(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT)) {
175 176 177
    $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));
178 179 180
    }
    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));
181
    }
182 183
    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));
184
    }
185

186 187
    if (!empty($description)) {
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
188
        $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));
189 190
      }
      else {
191
        $description .= ' ' . $t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
192
      }
193

194
      $requirements['php_memory_limit']['description'] = $description . ' ' . $t('See the <a href="@url">Drupal requirements</a> for more information.', array('@url' => 'http://drupal.org/requirements'));
195
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
196
    }
197
  }
198

199 200
  // Test settings.php file writability
  if ($phase == 'runtime') {
201
    $conf_dir = drupal_verify_install_file(conf_path(), FILE_NOT_WRITABLE, 'dir');
202
    $conf_file = drupal_verify_install_file(conf_path() . '/settings.php', FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE);
203
    if (!$conf_dir || !$conf_file) {
204 205 206
      $requirements['settings.php'] = array(
        'value' => $t('Not protected'),
        'severity' => REQUIREMENT_ERROR,
207
        'description' => '',
208
      );
209 210 211 212
      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) {
213
        $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'));
214
      }
215 216 217 218 219 220 221 222 223
    }
    else {
      $requirements['settings.php'] = array(
        'value' => $t('Protected'),
      );
    }
    $requirements['settings.php']['title'] = $t('Configuration file');
  }

224
  // Report cron status.
225
  if ($phase == 'runtime') {
226 227 228 229 230
    // 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.
231
    $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'));
232

233
    // Determine when cron last ran.
234
    $cron_last = variable_get('cron_last');
235 236 237
    if (!is_numeric($cron_last)) {
      $cron_last = variable_get('install_time', 0);
    }
238

239 240
    // Determine severity based on time since cron last ran.
    $severity = REQUIREMENT_OK;
241
    if (REQUEST_TIME - $cron_last > $threshold_error) {
242
      $severity = REQUIREMENT_ERROR;
243
    }
244
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
245 246 247 248
      $severity = REQUIREMENT_WARNING;
    }

    // Set summary and description based on values determined above.
249 250 251 252
    $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;
253
    }
254

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

258 259 260 261
    $requirements['cron'] = array(
      'title' => $t('Cron maintenance tasks'),
      'severity' => $severity,
      'value' => $summary,
262
      'description' => $description
263
    );
264 265
  }

266 267 268
  // Test files directories.
  $directories = array(
    variable_get('file_public_path', conf_path() . '/files'),
269 270 271
    // 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),
272
  );
273 274 275 276 277 278 279 280 281 282 283

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

284 285 286
  $requirements['file system'] = array(
    'title' => $t('File system'),
  );
287

288 289 290
  $error = '';
  // For installer, create the directories if possible.
  foreach ($directories as $directory) {
291 292 293
    if (!$directory) {
      continue;
    }
294 295
    if ($phase == 'install') {
      file_prepare_directory($directory, FILE_CREATE_DIRECTORY);
296
    }
297 298 299 300 301 302 303 304 305 306 307 308 309
    $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') {
310
        $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')));
311 312 313 314
      }
      elseif ($phase == 'install') {
        // For the installer UI, we need different wording. 'value' will
        // be treated as version, so provide none there.
315
        $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'));
316 317 318 319 320 321
        $requirements['file system']['value'] = '';
      }
      if (!empty($description)) {
        $requirements['file system']['description'] = $description;
        $requirements['file system']['severity'] = REQUIREMENT_ERROR;
      }
322 323
    }
    else {
324 325 326 327 328 329
      if (variable_get('file_default_scheme', 'public') == 'public') {
        $requirements['file system']['value'] = $t('Writable (<em>public</em> download method)');
      }
      else {
        $requirements['file system']['value'] = $t('Writable (<em>private</em> download method)');
      }
330 331 332
    }
  }

333 334 335
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
336
      'title' => $t('Database updates'),
337 338 339 340 341 342 343 344 345 346 347 348
      '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');
349
          $requirements['update']['description'] = $t('Some modules have database schema updates to install. You should run the <a href="@update">database update script</a> immediately.', array('@update' => base_path() . 'update.php'));
350 351 352 353 354 355
          break;
        }
      }
    }
  }

356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
  // 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');
  }

373 374
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
375
    $profile = drupal_get_profile();
376 377
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
378
      // Ignore disabled modules and install profiles.
379
      if (!$file->status || $module == $profile) {
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
        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;
        }
        // Check for a disabled dependency.
        if (!$required_file->status) {
          $requirements["$module-$required_module"] = array(
            'title' => $t('Unresolved dependency'),
            'description' => $t('@name requires this module.', array('@name' => $name)),
            'value' => $t('@required_name (Disabled)', array('@required_name' => $required_name)),
            'severity' => REQUIREMENT_ERROR,
          );
        }
      }
    }
  }

430
  // Test Unicode library
431
  include_once DRUPAL_ROOT . '/includes/unicode.inc';
432 433
  $requirements = array_merge($requirements, unicode_requirements());

434
  if ($phase == 'runtime') {
435
    // Check for update status module.
436 437 438
    if (!module_exists('update')) {
      $requirements['update status'] = array(
        'value' => $t('Not enabled'),
439
        'severity' => REQUIREMENT_WARNING,
440
        'description' => $t('Update notifications are not enabled. It is <strong>highly recommended</strong> that you enable the update status module from the <a href="@module">module administration page</a> in order to stay up-to-date on new releases. For more information, <a href="@update">Update status handbook page</a>.', array('@update' => 'http://drupal.org/handbook/modules/update', '@module' => url('admin/modules'))),
441 442 443 444 445 446 447 448
      );
    }
    else {
      $requirements['update status'] = array(
        'value' => $t('Enabled'),
      );
    }
    $requirements['update status']['title'] = $t('Update notifications');
449 450 451 452 453 454 455

    // 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,
456
        '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.'),
457 458
      );
    }
459 460
  }

461 462 463
  return $requirements;
}

464
/**
465
 * Implements hook_install().
466
 */
467
function system_install() {
468
  // Create tables.
469 470 471 472
  drupal_install_schema('system');
  $versions = drupal_get_schema_versions('system');
  $version = $versions ? max($versions) : SCHEMA_INSTALLED;
  drupal_set_installed_schema_version('system', $version);
473

474
  // Clear out module list and hook implementation statics before calling
475
  // system_rebuild_theme_data().
476 477 478
  module_list(TRUE);
  module_implements('', FALSE, TRUE);

479
  // Load system theme data appropriately.
480
  system_rebuild_theme_data();
481

482
  // Enable the default theme.
483 484 485 486 487 488 489
  variable_set('theme_default', 'garland');
  db_update('system')
    ->fields(array('status' => 1))
    ->condition('type', 'theme')
    ->condition('name', 'garland')
    ->execute();

490
  // Populate the cron key variable.
491
  $cron_key = drupal_hash_base64(drupal_random_bytes(55));
492
  variable_set('cron_key', $cron_key);
493 494
}

495
/**
496
 * Implements hook_schema().
497 498 499 500 501 502
 */
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(
503
    '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.',
504
    'fields' => array(
505
      'name' => array(
506
        'description' => 'The name of the variable.',
507 508 509
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
510 511
        'default' => '',
      ),
512
      'value' => array(
513
        'description' => 'The value of the variable.',
514
        'type' => 'blob',
515
        'not null' => TRUE,
516
        'size' => 'big',
517
        'translatable' => TRUE,
518
      ),
519
    ),
520
    'primary key' => array('name'),
521
  );
522 523

  $schema['actions'] = array(
524
    'description' => 'Stores action information.',
525
    'fields' => array(
526
      'aid' => array(
527
        'description' => 'Primary Key: Unique actions ID.',
528 529 530
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
531 532
        'default' => '0',
      ),
533
      'type' => array(
534
        'description' => 'The object that that action acts on (node, user, comment, system or custom types.)',
535 536 537
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
538 539
        'default' => '',
      ),
540
      'callback' => array(
541
        'description' => 'The callback function that executes when the action runs.',
542 543 544
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
545 546
        'default' => '',
      ),
547
      'parameters' => array(
548
        'description' => 'Parameters to be passed to the callback function.',
549
        'type' => 'blob',
550
        'not null' => TRUE,
551 552
        'size' => 'big',
      ),
553 554
      'label' => array(
        'description' => 'Label of the action.',
555 556 557
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
558
        'default' => '0',
559
      ),
560
    ),
561
    'primary key' => array('aid'),
562
  );
563 564

  $schema['batch'] = array(
565
    'description' => 'Stores details about batches (processes that run in multiple HTTP requests).',
566
    'fields' => array(
567
      'bid' => array(
568
        'description' => 'Primary Key: Unique batch ID.',
569 570 571
        // This is not a serial column, to allow both progressive and
        // non-progressive batches. See batch_process().
        'type' => 'int',
572
        'unsigned' => TRUE,
573 574
        'not null' => TRUE,
      ),
575
      'token' => array(
576
        '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.",
577 578
        'type' => 'varchar',
        'length' => 64,
579 580
        'not null' => TRUE,
      ),
581
      'timestamp' => array(
582
        'description' => 'A Unix timestamp indicating when this batch was submitted for processing. Stale batches are purged at cron time.',
583
        'type' => 'int',
584 585
        'not null' => TRUE,
      ),
586
      'batch' => array(
587
        'description' => 'A serialized array containing the processing data for the batch.',
588
        'type' => 'blob',
589
        'not null' => FALSE,
590
        'size' => 'big',
591
      ),
592
    ),
593
    'primary key' => array('bid'),
594 595 596 597
    'indexes' => array(
      'token' => array('token'),
    ),
  );
598

599
  $schema['blocked_ips'] = array(
600
    'description' => 'Stores blocked IP addresses.',
601 602
    'fields' => array(
       'iid' => array(
603
        'description' => 'Primary Key: unique ID for IP addresses.',
604 605 606 607 608
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
      'ip' => array(
609
        'description' => 'IP address',
610
        'type' => 'varchar',
611
        'length' => 40,
612 613 614 615 616 617 618 619 620 621
        'not null' => TRUE,
        'default' => '',
      ),
    ),
    'indexes' => array(
      'blocked_ip' => array('ip'),
    ),
    'primary key' => array('iid'),
  );

622
  $schema['cache'] = array(
623
    'description' => 'Generic cache table for caching things not separated out into their own tables. Contributed modules may also use this to store cached items.',
624
    'fields' => array(
625
      'cid' => array(
626
        'description' => 'Primary Key: Unique cache ID.',
627 628 629
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
630 631
        'default' => '',
      ),
632
      'data' => array(
633
        'description' => 'A collection of data to cache.',
634 635
        'type' => 'blob',
        'not null' => FALSE,
636 637
        'size' => 'big',
      ),
638
      'expire' => array(
639
        'description' => 'A Unix timestamp indicating when the cache entry should expire, or 0 for never.',
640 641
        'type' => 'int',
        'not null' => TRUE,
642 643
        'default' => 0,
      ),
644
      'created' => array(
645
        'description' => 'A Unix timestamp indicating when the cache entry was created.',
646 647
        'type' => 'int',
        'not null' => TRUE,
648 649
        'default' => 0,
      ),
650
      'serialized' => array(
651
        'description' => 'A flag to indicate whether content is serialized (1) or not (0).',
652 653 654
        'type' => 'int',
        'size' => 'small',
        'not null' => TRUE,
655
        'default' => 0,
656
      ),
657 658 659 660
    ),
    'indexes' => array(
      'expire' => array('expire'),
    ),
661
    'primary key' => array('cid'),
662
  );
663 664
  $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.';
665
  $schema['cache_form'] = $schema['cache'];
666
  $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.';
667
  $schema['cache_page'] = $schema['cache'];
668
  $schema['cache_page']['description'] = 'Cache table used to store compressed pages for anonymous users, if page caching is enabled.';
669
  $schema['cache_menu'] = $schema['cache'];
670
  $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.';
671 672
  $schema['cache_path'] = $schema['cache'];
  $schema['cache_path']['description'] = 'Cache table for path alias lookup.';
673

674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
  $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'),
698 699 700
    'indexes' => array(
      'title' => array('title'),
    ),
701 702
  );

703
  // This table's name is plural as some versions of MySQL can't create a
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 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
  // table named 'date_format'.
  $schema['date_formats'] = array(
    'description' => 'Stores configured date formats.',
    'fields' => array(
      'dfid' => array(
        'description' => 'The date format identifier.',
        'type' => 'serial',
        'not null' => TRUE,
        'unsigned' => TRUE,
      ),
      'format' => array(
        'description' => 'The date format string.',
        'type' => 'varchar',
        'length' => 100,
        'not null' => TRUE,
      ),
      'type' => array(
        'description' => 'The date format type, e.g. medium.',
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
      ),
      'locked' => array(
        'description' => 'Whether or not this format can be modified.',
        'type' => 'int',
        'size' => 'tiny',
        'default' => 0,
        'not null' => TRUE,
      ),
    ),
    'primary key' => array('dfid'),
    'unique keys' => array('formats' => array('format', 'type')),
  );

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

763
  $schema['file_managed'] = array(
764
    'description' => 'Stores information for uploaded files.',
765
    'fields' => array(
766
      'fid' => array(
767
        'description' => 'File ID.',
768 769
        'type' => 'serial',
        'unsigned' => TRUE,
770 771
        'not null' => TRUE,
      ),
772
      'uid' => array(
773
        'description' => 'The {users}.uid of the user who is associated with the file.',
774 775 776
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
777 778
        'default' => 0,
      ),
779
      'filename' => array(
780
        'description' => 'Name of the file with no path components. This may differ from the basename of the filepath if the file is renamed to avoid overwriting an existing file.',
781 782 783
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
784 785
        'default' => '',
      ),
786
      'uri' => array(
787
        'description' => 'Path of the file relative to Drupal root.',
788 789 790
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
791 792
        'default' => '',
      ),
793
      'filemime' => array(
794
        'description' => "The file's MIME type.",
795 796 797
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
798 799
        'default' => '',
      ),
800
      'filesize' => array(
801
        'description' => 'The size of the file in bytes.',
802 803 804
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
805 806
        'default' => 0,
      ),
807
      'status' => array(
808
        'description' => 'A bitmapped field indicating the status of the file. The least significant bit indicates temporary (0) or permanent (1). Temporary files older than DRUPAL_MAXIMUM_TEMP_FILE_AGE will be removed during a cron run.',
809 810
        'type' => 'int',
        'not null' => TRUE,
811 812
        'default' => 0,
      ),
813
      'timestamp' => array(
814
        'description' => 'UNIX timestamp for when the file was added.',
815 816 817
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
818
        'default' => 0,
819
      ),
820
    ),
821
    'indexes' => array(
822 823
      'uid' => array('uid'),
      'status' => array('status'),
824
      'timestamp' => array('timestamp'),
825
    ),
826 827 828
    'unique keys' => array(
      'uri' => array('uri'),
    ),
829
    'primary key' => array('fid'),
830 831 832
    'foreign keys' => array(
      'uid' => array('users' => 'uid'),
    ),
833
  );
834 835

  $schema['flood'] = array(
836
    'description' => 'Flood controls the threshold of events, such as the number of contact attempts.',
837
    'fields' => array(
838
      'fid' => array(
839
        'description' => 'Unique flood event ID.',
840
        'type' => 'serial',
841 842
        'not null' => TRUE,
      ),
843
      'event' => array(
844
        'description' => 'Name of event (e.g. contact).',
845 846 847
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
848 849
        'default' => '',
      ),
850 851
      'identifier' => array(
        'description' => 'Identifier of the visitor, such as an IP address or hostname.',
852 853 854
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
855 856
        'default' => '',
      ),
857
      'timestamp' => array(
858
        'description' => 'Timestamp of the event.',
859 860
        'type' => 'int',
        'not null' => TRUE,
861
        'default' => 0,
862
      ),
863 864 865 866 867 868
      'expiration' => array(
        'description' => 'Expiration timestamp. Expired events are purged on cron run.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
869
    ),
870
    'primary key' => array('fid'),
871
    'indexes' => array(
872
      'allow' => array('event', 'identifier', 'timestamp'),
873
      'purge' => array('expiration'),
874
    ),
875
  );
876 877

  $schema['history'] = array(
878
    'description' => 'A record of which {users} have read which {node}s.',
879
    'fields' => array(
880
      'uid' => array(
881
        'description' => 'The {users}.uid that read the {node} nid.',
882 883
        'type' => 'int',
        'not null' => TRUE,