system.install 73.2 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

13 14
/**
 * Test and report Drupal installation requirements.
15 16 17 18 19
 *
 * @param $phase
 *   The current system installation phase.
 * @return
 *   An array of system requirements.
20 21
 */
function system_requirements($phase) {
22
  global $base_url;
23 24 25 26 27
  $requirements = array();

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

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

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

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

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

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

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

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

  if (!empty($missing_extensions)) {
130
    $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(
131 132 133
      '@system_requirements' => 'http://drupal.org/requirements',
    ));

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

136
    $requirements['php_extensions']['value'] = t('Disabled');
137 138
    $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
  if ($phase == 'install' || $phase == 'update') {
    // Test for PDO (database).
    $requirements['database_extensions'] = array(
147
      'title' => t('Database support'),
148
    );
149

150
    // Make sure PDO is available.
151
    $database_ok = extension_loaded('pdo');
152
    if (!$database_ok) {
153
      $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(
154 155 156 157 158
        '@link' => 'http://drupal.org/requirements/pdo',
      ));
    }
    else {
      // Make sure at least one supported database driver exists.
159
      $drivers = drupal_detect_database_types();
160 161
      if (empty($drivers)) {
        $database_ok = FALSE;
162
        $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(
163 164 165 166 167 168 169
          '@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;
170
        $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(
171 172 173
          '@link' => 'http://drupal.org/requirements/pdo#pecl',
        ));
      }
174
    }
175

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

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

206
  if (!drupal_check_memory_limit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
207 208
    $description = '';
    if ($phase == 'install') {
209
      $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));
210 211
    }
    elseif ($phase == 'update') {
212
      $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));
213
    }
214
    elseif ($phase == 'runtime') {
215
      $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));
216
    }
217

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

226
      $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'));
227
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
228
    }
229
  }
230

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

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

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

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

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

297 298
    $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))));
299

300
    $requirements['cron'] = array(
301
      'title' => t('Cron maintenance tasks'),
302 303
      'severity' => $severity,
      'value' => $summary,
304
      'description' => $description
305
    );
306
  }
307 308 309 310 311 312 313 314 315 316
  if ($phase != 'install') {
    $filesystem_config = config('system.file');
    $directories = array(
      variable_get('file_public_path', conf_path() . '/files'),
      // 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(),
    );
  }
317

318 319
  // During an install we need to make assumptions about the file system
  // unless overrides are provided in settings.php.
320
  if ($phase == 'install') {
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
    global $conf;
    $directories = array();
    if (!empty($conf['file_public_path'])) {
      $directories[] = $conf['file_public_path'];
    }
    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();
    }
343 344
  }

345 346 347
  // 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.
348 349 350
  if (!empty($GLOBALS['config_directories'])) {
    $directories[] = config_get_config_directory(CONFIG_ACTIVE_DIRECTORY);
    $directories[] = config_get_config_directory(CONFIG_STAGING_DIRECTORY);
351 352
  }
  elseif ($phase != 'install') {
353
    $requirements['config directories'] = array(
354 355 356
      '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')),
357 358 359 360
      'severity' => REQUIREMENT_ERROR,
    );
  }

361
  $requirements['file system'] = array(
362
    'title' => t('File system'),
363
  );
364

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

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

    // Check installed modules.
420
    foreach (Drupal::moduleHandler()->getModuleList() as $module => $filename) {
421 422 423 424 425
      $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;
426 427
          $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'));
428 429 430 431 432 433
          break;
        }
      }
    }
  }

434 435
  // Verify the update.php access setting
  if ($phase == 'runtime') {
436
    if (settings()->get('update_free_access')) {
437
      $requirements['update access'] = array(
438
        'value' => t('Not protected'),
439
        'severity' => REQUIREMENT_ERROR,
440
        '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\']')),
441 442 443 444
      );
    }
    else {
      $requirements['update access'] = array(
445
        'value' => t('Protected'),
446 447
      );
    }
448
    $requirements['update access']['title'] = t('Access to update.php');
449 450
  }

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

499
  // Test Unicode library
500
  include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
501 502
  $requirements = array_merge($requirements, unicode_requirements());

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

520 521 522
  return $requirements;
}

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

534
  // Populate the cron key state variable.
535
  $cron_key = Crypt::randomStringHashed(55);
536
  Drupal::state()->set('system.cron_key', $cron_key);
537 538
}

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

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

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

643
  $schema['key_value'] = array(
644
    'description' => 'Generic key-value storage table. See the state system for an example.',
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
    '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'),
  );

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 703 704 705 706
  $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'),
    ),
  );

707
  $schema['menu_router'] = array(
708
    'description' => 'Maps paths to various callbacks (access, page and title)',
709
    'fields' => array(
710
      'path' => array(
711
        'description' => 'Primary Key: the Drupal path this entry describes',
712 713 714
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
715 716
        'default' => '',
      ),
717
      'load_functions' => array(
718
        '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.',
719
        'type' => 'blob',
720
        'not null' => TRUE,
721
      ),
722
      'to_arg_functions' => array(
723
        '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.',
724
        'type' => 'blob',
725
        'not null' => TRUE,
726
      ),
727
      'access_callback' => array(
728
        'description' => 'The callback which determines the access to this router path. Defaults to user_access.',
729 730 731
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
732 733
        'default' => '',
      ),
734
      'access_arguments' => array(
735
        'description' => 'A serialized array of arguments for the access callback.',
736
        'type' => 'blob',
737 738
        'not null' => FALSE,
      ),
739
      'page_callback' => array(
740
        'description' => 'The name of the function that renders the page.',
741 742 743
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
744 745
        'default' => '',
      ),
746
      'page_arguments' => array(
747
        'description' => 'A serialized array of arguments for the page callback.',
748
        'type' => 'blob',
749 750
        'not null' => FALSE,
      ),
751
      'fit' => array(
752
        'description' => 'A numeric representation of how specific the path is.',
753 754
        'type' => 'int',
        'not null' => TRUE,
755 756
        'default' => 0,
      ),
757
      'number_parts' => array(
758
        'description' => 'Number of parts in this router path.',
759 760 761
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
762 763
        'size' => 'small',
      ),
764 765 766 767 768 769
      'context' => array(
        'description' => 'Only for local tasks (tabs) - the context of a local task to control its placement.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
770
      'tab_parent' => array(
771
        'description' => 'Only for local tasks (tabs) - the router path of the parent page (which may also be a local task).',<