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

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

8
use Drupal\Component\Utility\Crypt;
9
use Drupal\Component\Uuid\Uuid;
10 11
use Drupal\Core\Database\Database;
use Drupal\Core\Language\Language;
12
use Drupal\Core\StreamWrapper\PublicStream;
13

14
/**
15
 * Implements hook_requirements().
16 17
 */
function system_requirements($phase) {
18
  global $base_url;
19 20 21 22 23
  $requirements = array();

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

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

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

55 56 57 58
  // Test PHP version and show link to phpinfo() if it's available
  $phpversion = phpversion();
  if (function_exists('phpinfo')) {
    $requirements['php'] = array(
59 60
      'title' => t('PHP'),
      'value' => ($phase == 'runtime') ? $phpversion .' ('. l(t('more information'), 'admin/reports/status/php') .')' : $phpversion,
61 62 63 64
    );
  }
  else {
    $requirements['php'] = array(
65
      'title' => t('PHP'),
66
      'value' => $phpversion,
67
      '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')),
68 69 70 71 72
      'severity' => REQUIREMENT_INFO,
    );
  }

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

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

98 99
  // Test for PHP extensions.
  $requirements['php_extensions'] = array(
100
    'title' => t('PHP extensions'),
101
  );
102 103 104 105 106 107 108 109 110 111 112 113 114 115

  $missing_extensions = array();
  $required_extensions = array(
    'date',
    'dom',
    'filter',
    'gd',
    'hash',
    'json',
    'pcre',
    'pdo',
    'session',
    'SimpleXML',
    'SPL',
116
    'tokenizer',
117 118 119 120 121 122 123 124 125
    'xml',
  );
  foreach ($required_extensions as $extension) {
    if (!extension_loaded($extension)) {
      $missing_extensions[] = $extension;
    }
  }

  if (!empty($missing_extensions)) {
126
    $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(
127 128 129
      '@system_requirements' => 'http://drupal.org/requirements',
    ));

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

132
    $requirements['php_extensions']['value'] = t('Disabled');
133 134
    $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
  if ($phase == 'install' || $phase == 'update') {
    // Test for PDO (database).
    $requirements['database_extensions'] = array(
143
      'title' => t('Database support'),
144
    );
145

146
    // Make sure PDO is available.
147
    $database_ok = extension_loaded('pdo');
148
    if (!$database_ok) {
149
      $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(
150 151 152 153 154
        '@link' => 'http://drupal.org/requirements/pdo',
      ));
    }
    else {
      // Make sure at least one supported database driver exists.
155
      $drivers = drupal_detect_database_types();
156 157
      if (empty($drivers)) {
        $database_ok = FALSE;
158
        $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(
159 160 161 162 163 164 165
          '@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;
166
        $pdo_message = t('Your web server seems to have the wrong version of PDO installed. Drupal 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(
167 168 169
          '@link' => 'http://drupal.org/requirements/pdo#pecl',
        ));
      }
170
    }
171

172
    if (!$database_ok) {
173
      $requirements['database_extensions']['value'] = t('Disabled');
174
      $requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
175
      $requirements['database_extensions']['description'] = $pdo_message;
176 177
    }
    else {
178
      $requirements['database_extensions']['value'] = t('Enabled');
179
    }
180
  }
181 182
  else {
    // Database information.
183
    $class = Database::getConnection()->getDriverClass('Install\\Tasks');
184 185
    $tasks = new $class();
    $requirements['database_system'] = array(
186
      'title' => t('Database system'),
187 188 189
      'value' => $tasks->name(),
    );
    $requirements['database_system_version'] = array(
190
      'title' => t('Database system version'),
191 192 193
      'value' => Database::getConnection()->version(),
    );
  }
194

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

202
  if (!drupal_check_memory_limit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
203 204
    $description = '';
    if ($phase == 'install') {
205
      $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
    }
    elseif ($phase == 'update') {
208
      $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
    elseif ($phase == 'runtime') {
211
      $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('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'));
223
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
224
    }
225
  }
226

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

261
  // Report cron status.
262
  if ($phase == 'runtime') {
263
    $cron_config = Drupal::config('system.cron');
264
    // Cron warning threshold defaults to two days.
265
    $threshold_warning = $cron_config->get('threshold.requirements_warning');
266
    // Cron error threshold defaults to two weeks.
267
    $threshold_error = $cron_config->get('threshold.requirements_error');
268
    // Cron configuration help text.
269
    $help = t('For more information, see the online handbook entry for <a href="@cron-handbook">configuring cron jobs</a>.', array('@cron-handbook' => 'http://drupal.org/cron'));
270

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

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

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

293 294
    $description .= ' ' . t('You can <a href="@cron">run cron manually</a>.', array('@cron' => url('admin/reports/status/run-cron')));
    $description .= '<br />' . t('To run cron from outside the site, go to <a href="!cron">!cron</a>', array('!cron' => url('cron/' . Drupal::state()->get('system.cron_key'), array('absolute' => TRUE))));
295

296
    $requirements['cron'] = array(
297
      'title' => t('Cron maintenance tasks'),
298 299
      'severity' => $severity,
      'value' => $summary,
300
      'description' => $description
301
    );
302
  }
303
  if ($phase != 'install') {
304
    $filesystem_config = Drupal::config('system.file');
305
    $directories = array(
306
      PublicStream::basePath(),
307 308 309 310 311 312
      // By default no private files directory is configured. For private files
      // to be secure the admin needs to provide a path outside the webroot.
      $filesystem_config->get('path.private'),
      file_directory_temp(),
    );
  }
313

314 315
  // During an install we need to make assumptions about the file system
  // unless overrides are provided in settings.php.
316
  if ($phase == 'install') {
317 318
    global $conf;
    $directories = array();
319 320
    if ($file_public_path = settings()->get('file_public_path')) {
      $directories[] = $file_public_path;
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
    }
    else {
      // 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.
      $directories[] = conf_path(FALSE, TRUE) . '/files';
    }
    if (!empty($conf['system.file']['path.private'])) {
      $directories[] = $conf['system.file']['path.private'];
    }
    if (!empty($conf['system.file']['path.temporary'])) {
      $directories[] = $conf['system.file']['path.temporary'];
    }
    else {
      // If the temporary directory is not overridden use an appropriate
      // temporary path for the system.
      $directories[] = file_directory_os_temp();
    }
339 340
  }

341 342 343
  // 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.
344 345 346
  if (!empty($GLOBALS['config_directories'])) {
    $directories[] = config_get_config_directory(CONFIG_ACTIVE_DIRECTORY);
    $directories[] = config_get_config_directory(CONFIG_STAGING_DIRECTORY);
347 348
  }
  elseif ($phase != 'install') {
349
    $requirements['config directories'] = array(
350 351 352
      'title' => t('Configuration directories'),
      'value' => t('Not present'),
      'description' => t('Your %file file must define the $config_directories variable as an array containing the name of a directories in which configuration files can be written.', array('%file' => conf_path() . '/settings.php')),
353 354 355 356
      'severity' => REQUIREMENT_ERROR,
    );
  }

357
  $requirements['file system'] = array(
358
    'title' => t('File system'),
359
  );
360

361 362 363
  $error = '';
  // For installer, create the directories if possible.
  foreach ($directories as $directory) {
364 365 366
    if (!$directory) {
      continue;
    }
367
    if ($phase == 'install') {
368
      file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
369
    }
370 371 372 373
    $is_writable = is_writable($directory);
    $is_directory = is_dir($directory);
    if (!$is_writable || !$is_directory) {
      $description = '';
374
      $requirements['file system']['value'] = t('Not writable');
375
      if (!$is_directory) {
376
        $error .= t('The directory %directory does not exist.', array('%directory' => $directory)) . ' ';
377 378
      }
      else {
379
        $error .= t('The directory %directory is not writable.', array('%directory' => $directory)) . ' ';
380 381 382
      }
      // The files directory requirement check is done only during install and runtime.
      if ($phase == 'runtime') {
383
        $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')));
384 385 386 387
      }
      elseif ($phase == 'install') {
        // For the installer UI, we need different wording. 'value' will
        // be treated as version, so provide none there.
388
        $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'));
389 390 391 392 393 394
        $requirements['file system']['value'] = '';
      }
      if (!empty($description)) {
        $requirements['file system']['description'] = $description;
        $requirements['file system']['severity'] = REQUIREMENT_ERROR;
      }
395 396
    }
    else {
397 398 399
      // This function can be called before the config_cache table has been
      // created.
      if ($phase == 'install' || file_default_scheme() == 'public') {
400
        $requirements['file system']['value'] = t('Writable (<em>public</em> download method)');
401 402
      }
      else {
403
        $requirements['file system']['value'] = t('Writable (<em>private</em> download method)');
404
      }
405 406 407
    }
  }

408 409 410
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
411 412
      'title' => t('Database updates'),
      'value' => t('Up to date'),
413 414 415
    );

    // Check installed modules.
416
    foreach (Drupal::moduleHandler()->getModuleList() as $module => $filename) {
417 418 419 420 421
      $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;
422 423
          $requirements['update']['value'] = t('Out of date');
          $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'));
424 425 426 427 428 429
          break;
        }
      }
    }
  }

430 431
  // Verify the update.php access setting
  if ($phase == 'runtime') {
432
    if (settings()->get('update_free_access')) {
433
      $requirements['update access'] = array(
434
        'value' => t('Not protected'),
435
        'severity' => REQUIREMENT_ERROR,
436
        'description' => t('The update.php script is accessible to everyone without authentication check, which is a security risk. You must change the @settings_name value in your settings.php back to FALSE.', array('@settings_name' => '$settings[\'update_free_access\']')),
437 438 439 440
      );
    }
    else {
      $requirements['update access'] = array(
441
        'value' => t('Protected'),
442 443
      );
    }
444
    $requirements['update access']['title'] = t('Access to update.php');
445 446
  }

447 448
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
449
    $profile = drupal_get_profile();
450 451
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
452
      // Ignore disabled modules and installation profiles.
453
      if (!$file->status || $module == $profile) {
454 455 456 457 458 459
        continue;
      }
      // Check the module's PHP version.
      $name = $file->info['name'];
      $php = $file->info['php'];
      if (version_compare($php, PHP_VERSION, '>')) {
460
        $requirements['php']['description'] .= t('@name requires at least PHP @version.', array('@name' => $name, '@version' => $php));
461 462 463 464 465 466 467 468
        $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(
469 470
            'title' => t('Unresolved dependency'),
            'description' => t('@name requires this module.', array('@name' => $name)),
471 472 473 474 475 476 477 478 479 480 481 482 483
            '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(
484 485
            '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)),
486 487 488 489 490 491 492 493 494
            'value' => t('@required_name (Version @compatibility required)', array('@required_name' => $required_name, '@compatibility' => $compatibility)),
            'severity' => REQUIREMENT_ERROR,
          );
          continue;
        }
      }
    }
  }

495
  // Test Unicode library
496
  include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
497 498
  $requirements = array_merge($requirements, unicode_requirements());

499
  if ($phase == 'runtime') {
500
    // Check for update status module.
501 502
    if (!module_exists('update')) {
      $requirements['update status'] = array(
503
        'value' => t('Not enabled'),
504
        'severity' => REQUIREMENT_WARNING,
505
        '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'))),
506 507 508 509
      );
    }
    else {
      $requirements['update status'] = array(
510
        'value' => t('Enabled'),
511 512
      );
    }
513
    $requirements['update status']['title'] = t('Update notifications');
514 515
  }

516 517 518
  return $requirements;
}

519
/**
520
 * Implements hook_install().
521
 */
522
function system_install() {
523
  // Enable and set the default theme. Can't use theme_enable() this early in
524 525
  // installation.
  config_install_default_config('theme', 'stark');
526
  Drupal::config('system.theme')
527 528
    ->set('default', 'stark')
    ->save();
529

530
  // Populate the cron key state variable.
531
  $cron_key = Crypt::randomStringHashed(55);
532
  Drupal::state()->set('system.cron_key', $cron_key);
533 534
}

535
/**
536
 * Implements hook_schema().
537 538 539 540 541 542
 */
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(
543
    '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.',
544
    'fields' => array(
545
      'name' => array(
546
        'description' => 'The name of the variable.',
547 548 549
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
550 551
        'default' => '',
      ),
552
      'value' => array(
553
        'description' => 'The value of the variable.',
554
        'type' => 'blob',
555
        'not null' => TRUE,
556
        'size' => 'big',
557
      ),
558
    ),
559
    'primary key' => array('name'),
560
  );
561 562

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

  $schema['flood'] = array(
598
    'description' => 'Flood controls the threshold of events, such as the number of contact attempts.',
599
    'fields' => array(
600
      'fid' => array(
601
        'description' => 'Unique flood event ID.',
602
        'type' => 'serial',
603 604
        'not null' => TRUE,
      ),
605
      'event' => array(
606
        'description' => 'Name of event (e.g. contact).',
607 608 609
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
610 611
        'default' => '',
      ),
612 613
      'identifier' => array(
        'description' => 'Identifier of the visitor, such as an IP address or hostname.',
614 615 616
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
617 618
        'default' => '',
      ),
619
      'timestamp' => array(
620
        'description' => 'Timestamp of the event.',
621 622
        'type' => 'int',
        'not null' => TRUE,
623
        'default' => 0,
624
      ),
625 626 627 628 629 630
      'expiration' => array(
        'description' => 'Expiration timestamp. Expired events are purged on cron run.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
631
    ),
632
    'primary key' => array('fid'),
633
    'indexes' => array(
634
      'allow' => array('event', 'identifier', 'timestamp'),
635
      'purge' => array('expiration'),
636
    ),
637
  );
638

639
  $schema['key_value'] = array(
640
    'description' => 'Generic key-value storage table. See the state system for an example.',
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
    'fields' => array(
      'collection' => array(
        'description' => 'A named collection of key and value pairs.',
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
      ),
      'name' => array(
        'description' => 'The key of the key-value pair. As KEY is a SQL reserved keyword, name was chosen instead.',
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
      ),
      'value' => array(
        'description' => 'The value.',
        'type' => 'blob',
        'not null' => TRUE,
        'size' => 'big',
      ),
    ),
    'primary key' => array('collection', 'name'),
  );

666 667 668 669 670 671 672 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 698 699 700 701 702
  $schema['key_value_expire'] = array(
    'description' => 'Generic key/value storage table with an expiration.',
    'fields' => array(
      'collection' => array(
        'description' => 'A named collection of key and value pairs.',
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
      ),
      'name' => array(
        // KEY is an SQL reserved word, so use 'name' as the key's field name.
        'description' => 'The key of the key/value pair.',
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
      ),
      'value' => array(
        'description' => 'The value of the key/value pair.',
        'type' => 'blob',
        'not null' => TRUE,
        'size' => 'big',
      ),
      'expire' => array(
        'description' => 'The time since Unix epoch in seconds when this item expires. Defaults to the maximum possible time.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 2147483647,
      ),
    ),
    'primary key' => array('collection', 'name'),
    'indexes' => array(
      'all' => array('name', 'collection', 'expire'),
    ),
  );

703
  $schema['menu_router'] = array(
704
    'description' => 'Maps paths to various callbacks (access, page and title)',
705
    'fields' => array(
706
      'path' => array(
707
        'description' => 'Primary Key: the Drupal path this entry describes',
708 709 710
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
711 712
        'default' => '',
      ),
713
      'load_functions' => array(
714
        'description' => 'A serialized array of function names (like node_load) to be called to load an object corresponding to a part of the current path.',
715
        'type' => 'blob',
716
        'not null' => TRUE,
717
      ),
718
      'to_arg_functions' => array(
719
        'description' => 'A serialized array of function names (like user_uid_optional_to_arg) to be called to replace a part of the router path with another string.',
720
        'type' => 'blob',
721
        'not null' => TRUE,
722
      ),
723
      'access_callback' => array(
724
        'description' => 'The callback which determines the access to this router path. Defaults to user_access.',
725 726 727
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
728 729
        'default' => '',
      ),
730
      'access_arguments' => array(
731
        'description' => 'A serialized array of arguments for the access callback.',
732
        'type' => 'blob',
733 734
        'not null' => FALSE,
      ),
735
      'page_callback' => array(
736
        'description' => 'The name of the function that renders the page.',
737 738 739
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
740 741
        'default' => '',
      ),
742
      'page_arguments' => array(
743
        'description' => 'A serialized array of arguments for the page callback.',
744
        'type' => 'blob',
745 746
        'not null' => FALSE,
      ),
747
      'fit' => array(
748
        'description' => 'A numeric representation of how specific the path is.',
749 750
        'type' => 'int',
        'not null' => TRUE,
751 752
        'default' => 0,
      ),
753
      'number_parts' => array(
754
        'description' => 'Number of parts in this router path.',
755