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

3
use Drupal\Core\Database\Database;
4

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

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

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

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

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

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

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

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

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

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

  if (!empty($missing_extensions)) {
    $description = $t('Drupal requires you to enable the PHP extensions in the following list (see the <a href="@system_requirements">system requirements page</a> for more information):', array(
      '@system_requirements' => 'http://drupal.org/requirements',
    ));

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

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

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

149
    // Make sure PDO is available.
150
    $database_ok = extension_loaded('pdo');
151 152 153 154 155 156 157
    if (!$database_ok) {
      $pdo_message = $t('Your web server does not appear to support PDO (PHP Data Objects). Ask your hosting provider if they support the native PDO extension. See the <a href="@link">system requirements</a> page for more information.', array(
        '@link' => 'http://drupal.org/requirements/pdo',
      ));
    }
    else {
      // Make sure at least one supported database driver exists.
158
      $drivers = drupal_detect_database_types();
159 160 161 162 163 164 165 166 167 168
      if (empty($drivers)) {
        $database_ok = FALSE;
        $pdo_message = $t('Your web server does not appear to support any common PDO database extensions. Check with your hosting provider to see if they support PDO (PHP Data Objects) and offer any databases that <a href="@drupal-databases">Drupal supports</a>.', array(
          '@drupal-databases' => 'http://drupal.org/node/270#database',
        ));
      }
      // Make sure the native PDO extension is available, not the older PEAR
      // version. (See install_verify_pdo() for details.)
      if (!defined('PDO::ATTR_DEFAULT_FETCH_MODE')) {
        $database_ok = FALSE;
169
        $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(
170 171 172
          '@link' => 'http://drupal.org/requirements/pdo#pecl',
        ));
      }
173
    }
174

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

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

205
  if (!drupal_check_memory_limit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
206 207 208
    $description = '';
    if ($phase == 'install') {
      $description = $t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the installation process.', array('%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
209 210 211
    }
    elseif ($phase == 'update') {
      $description = $t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the update process.', array('%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
212
    }
213 214
    elseif ($phase == 'runtime') {
      $description = $t('Depending on your configuration, Drupal can run with a %memory_limit PHP memory limit. However, a %memory_minimum_limit PHP memory limit or above is recommended, especially if your site uses additional custom or contributed modules.', array('%memory_limit' => $memory_limit, '%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
215
    }
216

217 218
    if (!empty($description)) {
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
219
        $description .= ' ' . $t('Increase the memory limit by editing the memory_limit parameter in the file %configuration-file and then restart your web server (or contact your system administrator or hosting provider for assistance).', array('%configuration-file' => $php_ini_path));
220 221
      }
      else {
222
        $description .= ' ' . $t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
223
      }
224

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

230
  // Test configuration files and directory for writability.
231
  if ($phase == 'runtime') {
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
    $conf_errors = array();
    $conf_path = conf_path();
    if (!drupal_verify_install_file($conf_path, FILE_NOT_WRITABLE, 'dir')) {
      $conf_errors[] = $t("The directory %file is not protected from modifications and poses a security risk. You must change the directory's permissions to be non-writable.", array('%file' => $conf_path));
    }
    foreach (array('settings.php', 'settings.local.php') as $conf_file) {
      $full_path = $conf_path . '/' . $conf_file;
      if (file_exists($full_path) && !drupal_verify_install_file($full_path, FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE)) {
        $conf_errors[] = $t("The file %file is not protected from modifications and poses a security risk. You must change the file's permissions to be non-writable.", array('%file' => $full_path));
      }
    }
    if (!empty($conf_errors)) {
      if (count($conf_errors) == 1) {
        $description = $conf_errors[0];
      }
      else {
        $description = theme('item_list', array('items' => $conf_errors));
      }
250 251 252
      $requirements['settings.php'] = array(
        'value' => $t('Not protected'),
        'severity' => REQUIREMENT_ERROR,
253
        'description' => $description,
254 255 256 257 258 259 260
      );
    }
    else {
      $requirements['settings.php'] = array(
        'value' => $t('Protected'),
      );
    }
261
    $requirements['settings.php']['title'] = $t('Configuration files');
262 263
  }

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

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

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

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

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

299 300 301 302
    $requirements['cron'] = array(
      'title' => $t('Cron maintenance tasks'),
      'severity' => $severity,
      'value' => $summary,
303
      'description' => $description
304
    );
305
  }
306 307 308 309 310 311 312 313 314 315
  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(),
    );
  }
316

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

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

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

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

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

    // Check installed modules.
419
    foreach (drupal_container()->get('module_handler')->getModuleList() as $module => $filename) {
420 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;
          $requirements['update']['value'] = $t('Out of date');
426
          $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'));
427 428 429 430 431 432
          break;
        }
      }
    }
  }

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

450 451
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
452
    $profile = drupal_get_profile();
453 454
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
455
      // Ignore disabled modules and installation profiles.
456
      if (!$file->status || $module == $profile) {
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
        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;
        }
      }
    }
  }

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

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

519 520 521
  return $requirements;
}

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

533
  // Populate the cron key state variable.
534
  $cron_key = drupal_hash_base64(drupal_random_bytes(55));
535
  state()->set('system.cron_key', $cron_key);
536 537
}

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

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

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

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

706
  $schema['menu_router'] = array(
707
    'description' => 'Maps paths to various callbacks (access, page and title)',
708
    'fields' => array(
709
      'path' => array(
710
        'description' => 'Primary Key: the Drupal path this entry describes',
711 712 713
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
714 715
        'default' => '',
      ),
716
      'load_functions' => array(
717
        '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.',
718
        'type' => 'blob',
719
        'not null' => TRUE,
720
      ),
721
      'to_arg_functions' => array(
722
        '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.',
723
        'type' => 'blob',
724
        'not null' => TRUE,
725
      ),
726
      'access_callback' => array(
727
        'description' => 'The callback which determines the access to this router path. Defaults to user_access.',
728 729 730
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
731 732
        'default' => '',
      ),
733
      'access_arguments' => array(
734
        'description' => 'A serialized array of arguments for the access callback.',
735
        'type' => 'blob',
736 737
        'not null' => FALSE,
      ),
738
      'page_callback' => array(
739
        'description' => 'The name of the function that renders the page.',
740 741 742
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
743 744
        'default' => '',
      ),
745
      'page_arguments' => array(
746
        'description' => 'A serialized array of arguments for the page callback.',
747
        'type' => 'blob',
748 749
        'not null' => FALSE,
      ),
750
      'fit' => array(
751
        'description' => 'A numeric representation of how specific the path is.',
752 753
        'type' => 'int',
        'not null' => TRUE,
754 755
        'default' => 0,
      ),
756
      'number_parts' => array(
757
        'description' => 'Number of parts in this router path.',
758 759 760
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
761 762
        'size' => 'small',
      ),
763 764 765 766 767 768
      '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,
      ),
769
      'tab_parent' => array(
770
        'description' => 'Only for local tasks (tabs) - the router path of the parent page (which may also be a local task).',
771 772 773
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
774 775
        'default' => '',
      ),
776
      'tab_root' => array(
777
        'description' => 'Router path of the closest non-tab parent page. For pages that are not local tasks, this will be the same as the path.',
778 779 780
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
781 782
        'default' => '',
      ),
783
      'title' => array(
784
        'description' => 'The title for the current page, or the title for the tab if this is a local task.',
785 786 787
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
788 789
        'default' => '',
      ),
790
      'title_callback' => array(
791
        'description' => 'A function which will alter the title. Defaults to t()',
792 793 794
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
795 796
        'default' => '',
      ),
797
      'title_arguments' => array(
798
        'description' => 'A serialized array of arguments for the title callback. If empty, the title will be used as the sole argument for the title callback.',
799 800 801
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
802 803
        'default' => '',
      ),
804 805 806 807 808 809 810 811 812 813 814 815 816 817
      'theme_callback' => array(
        'description' => 'A function which returns the name of the theme that will be used to render this page. If left empty, the default theme will be used.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'theme_arguments' => array(
        'description' => 'A serialized array of arguments for the theme callback.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
818
      'type' => array(
819
        'description' => 'Numeric representation of the type of the menu item, like MENU_LOCAL_TASK.',
820 821
        'type' => 'int',
        'not null' => TRUE,
822 823
        'default' => 0,
      ),
824
      'description' => array(
825
        'description' => 'A description of this item.',
826
        'type' => 'text',
827 828
        'not null' => TRUE,
      ),
829 830 831 832 833 834 835 836 837 838 839 840 841 842
      'description_callback' => array(
        'description' => 'A function which will alter the description. Defaults to t().',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'description_arguments' => array(
        'description' => 'A serialized array of arguments for the description callback. If empty, the description will be used as the sole argument for the description callback.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
843
      'position' => array(
844
        'description' => 'The position of the block (left or right) on the system administration page for this item.',
845 846 847
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
848 849
        'default' => '',
      ),
850
      'weight' => array(
851
        'description' => 'Weight of the element. Lighter weights are higher up, heavier weights go down.',
852 853
        'type' => 'int',
        'not null' => TRUE,
854 855
        'default' => 0,
      ),
856
      'include_file' => array(
857 858
        'description' => 'The file to include for this element, usually the page callback function lives in this file.',
        'type' => 'text',
859
        'size' => 'medium',
860
      ),
861
    ),
862
    'indexes' => array(
863
      'fit' => array('fit'),
864
      'tab_parent' => array(array('tab_parent', 64), 'weight', 'title'),
865
      'tab_root_weight_title' => array(array('tab_root', 64), 'weight', 'title'),
866
    ),
867
    'primary key' => array('path'),