system.install 36.9 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\Utility\Environment;
10
use Drupal\Component\Utility\SafeMarkup;
11 12
use Drupal\Core\Database\Database;
use Drupal\Core\Language\Language;
13
use Drupal\Core\Site\Settings;
14
use Drupal\Core\StreamWrapper\PublicStream;
15

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

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

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

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

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

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

81 82
  // Test for PHP extensions.
  $requirements['php_extensions'] = array(
83
    'title' => t('PHP extensions'),
84
  );
85 86 87 88 89

  $missing_extensions = array();
  $required_extensions = array(
    'date',
    'dom',
90
    'fileinfo',
91 92 93 94 95 96 97 98 99
    'filter',
    'gd',
    'hash',
    'json',
    'pcre',
    'pdo',
    'session',
    'SimpleXML',
    'SPL',
100
    'tokenizer',
101 102 103 104 105 106 107 108 109
    'xml',
  );
  foreach ($required_extensions as $extension) {
    if (!extension_loaded($extension)) {
      $missing_extensions[] = $extension;
    }
  }

  if (!empty($missing_extensions)) {
110
    $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(
111 112 113
      '@system_requirements' => 'http://drupal.org/requirements',
    ));

114 115 116 117 118
    $item_list = array(
      '#theme' => 'item_list',
      '#items' => $missing_extensions,
    );
    $description .= drupal_render($item_list);
119

120
    $requirements['php_extensions']['value'] = t('Disabled');
121 122
    $requirements['php_extensions']['severity'] = REQUIREMENT_ERROR;
    $requirements['php_extensions']['description'] = $description;
123 124
  }
  else {
125
    $requirements['php_extensions']['value'] = t('Enabled');
126
  }
127

128 129 130
  if ($phase == 'install' || $phase == 'update') {
    // Test for PDO (database).
    $requirements['database_extensions'] = array(
131
      'title' => t('Database support'),
132
    );
133

134
    // Make sure PDO is available.
135
    $database_ok = extension_loaded('pdo');
136
    if (!$database_ok) {
137
      $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(
138 139 140 141 142
        '@link' => 'http://drupal.org/requirements/pdo',
      ));
    }
    else {
      // Make sure at least one supported database driver exists.
143
      $drivers = drupal_detect_database_types();
144 145
      if (empty($drivers)) {
        $database_ok = FALSE;
146
        $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(
147 148 149 150 151 152 153
          '@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;
154
        $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(
155 156 157
          '@link' => 'http://drupal.org/requirements/pdo#pecl',
        ));
      }
158
    }
159

160
    if (!$database_ok) {
161
      $requirements['database_extensions']['value'] = t('Disabled');
162
      $requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
163
      $requirements['database_extensions']['description'] = $pdo_message;
164 165
    }
    else {
166
      $requirements['database_extensions']['value'] = t('Enabled');
167
    }
168
  }
169 170
  else {
    // Database information.
171
    $class = Database::getConnection()->getDriverClass('Install\\Tasks');
172 173
    $tasks = new $class();
    $requirements['database_system'] = array(
174
      'title' => t('Database system'),
175 176 177
      'value' => $tasks->name(),
    );
    $requirements['database_system_version'] = array(
178
      'title' => t('Database system version'),
179 180 181
      'value' => Database::getConnection()->version(),
    );
  }
182

183
  // Test PHP memory_limit
184
  $memory_limit = ini_get('memory_limit');
185
  $requirements['php_memory_limit'] = array(
186
    'title' => t('PHP memory limit'),
187
    'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
188
  );
189

190
  if (!Environment::checkMemoryLimit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
191 192
    $description = '';
    if ($phase == 'install') {
193
      $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));
194 195
    }
    elseif ($phase == 'update') {
196
      $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));
197
    }
198
    elseif ($phase == 'runtime') {
199
      $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));
200
    }
201

202 203
    if (!empty($description)) {
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
204
        $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));
205 206
      }
      else {
207
        $description .= ' ' . t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
208
      }
209

210
      $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'));
211
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
212
    }
213
  }
214

215
  // Test configuration files and directory for writability.
216
  if ($phase == 'runtime') {
217 218 219
    $conf_errors = array();
    $conf_path = conf_path();
    if (!drupal_verify_install_file($conf_path, FILE_NOT_WRITABLE, 'dir')) {
220
      $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));
221
    }
222
    foreach (array('settings.php', 'settings.local.php', 'services.yml') as $conf_file) {
223 224
      $full_path = $conf_path . '/' . $conf_file;
      if (file_exists($full_path) && !drupal_verify_install_file($full_path, FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE)) {
225
        $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));
226 227 228 229 230 231 232
      }
    }
    if (!empty($conf_errors)) {
      if (count($conf_errors) == 1) {
        $description = $conf_errors[0];
      }
      else {
233 234 235 236 237
        $item_list = array(
          '#theme' => 'item_list',
          '#items' => $conf_errors,
        );
        $description = drupal_render($item_list);
238
      }
239
      $requirements['configuration_files'] = array(
240
        'value' => t('Not protected'),
241
        'severity' => REQUIREMENT_ERROR,
242
        'description' => $description,
243 244 245
      );
    }
    else {
246
      $requirements['configuration_files'] = array(
247
        'value' => t('Protected'),
248 249
      );
    }
250
    $requirements['configuration_files']['title'] = t('Configuration files');
251 252
  }

253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
  // Test the contents of the .htaccess files.
  if ($phase == 'runtime') {
    // Try to write the .htaccess files first, to prevent false alarms in case
    // (for example) the /tmp directory was wiped.
    file_ensure_htaccess();
    $htaccess_files['public://.htaccess'] = array(
      'title' => t('Public files directory'),
      'directory' => drupal_realpath('public://'),
    );
    if (\Drupal::config('system.file')->get('path.private')) {
      $htaccess_files['private://.htaccess'] = array(
        'title' => t('Private files directory'),
        'directory' => drupal_realpath('private://'),
      );
    }
    $htaccess_files['temporary://.htaccess'] = array(
      'title' => t('Temporary files directory'),
      'directory' => drupal_realpath('temporary://'),
    );
    foreach ($htaccess_files as $htaccess_file => $info) {
      // Check for the string which was added to the recommended .htaccess file
      // in the latest security update.
      if (!file_exists($htaccess_file) || !($contents = @file_get_contents($htaccess_file)) || strpos($contents, 'Drupal_Security_Do_Not_Remove_See_SA_2013_003') === FALSE) {
        $requirements[$htaccess_file] = array(
          'title' => $info['title'],
          'value' => t('Not fully protected'),
          'severity' => REQUIREMENT_ERROR,
          'description' => t('See <a href="@url">@url</a> for information about the recommended .htaccess file which should be added to the %directory directory to help protect against arbitrary code execution.', array('@url' => 'http://drupal.org/SA-CORE-2013-003', '%directory' => $info['directory'])),
        );
      }
    }
  }

286
  // Report cron status.
287
  if ($phase == 'runtime') {
288
    $cron_config = \Drupal::config('system.cron');
289
    // Cron warning threshold defaults to two days.
290
    $threshold_warning = $cron_config->get('threshold.requirements_warning');
291
    // Cron error threshold defaults to two weeks.
292
    $threshold_error = $cron_config->get('threshold.requirements_error');
293
    // Cron configuration help text.
294
    $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'));
295

296
    // Determine when cron last ran.
297
    $cron_last = \Drupal::state()->get('system.cron_last');
298
    if (!is_numeric($cron_last)) {
299
      $cron_last = \Drupal::state()->get('install_time', 0);
300
    }
301

302
    // Determine severity based on time since cron last ran.
303
    $severity = REQUIREMENT_INFO;
304
    if (REQUEST_TIME - $cron_last > $threshold_error) {
305
      $severity = REQUIREMENT_ERROR;
306
    }
307
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
308 309 310 311
      $severity = REQUIREMENT_WARNING;
    }

    // Set summary and description based on values determined above.
312
    $summary = t('Last run !time ago', array('!time' => \Drupal::service('date.formatter')->formatInterval(REQUEST_TIME - $cron_last)));
313
    $description = '';
314
    if ($severity != REQUIREMENT_INFO) {
315
      $description = t('Cron has not run recently.') . ' ' . $help;
316
    }
317

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

321
    $requirements['cron'] = array(
322
      'title' => t('Cron maintenance tasks'),
323 324
      'severity' => $severity,
      'value' => $summary,
325 326 327 328 329
      // @todo This string is concatenated from t() calls, safe drupal_render()
      //   output, whitespace, and <br /> tags, so is safe. However, as a best
      //   practice, we should not use SafeMarkup::set() around a variable. Fix
      //   in: https://www.drupal.org/node/2296929
      'description' => SafeMarkup::set($description),
330
    );
331
  }
332
  if ($phase != 'install') {
333
    $filesystem_config = \Drupal::config('system.file');
334
    $directories = array(
335
      PublicStream::basePath(),
336 337 338 339 340 341
      // 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(),
    );
  }
342

343 344
  // During an install we need to make assumptions about the file system
  // unless overrides are provided in settings.php.
345
  if ($phase == 'install') {
346
    $directories = array();
347
    if ($file_public_path = Settings::get('file_public_path')) {
348
      $directories[] = $file_public_path;
349 350 351
    }
    else {
      // If we are installing Drupal, the settings.php file might not exist yet
352 353
      // in the intended site directory, so don't require it.
      $directories[] = conf_path(FALSE) . '/files';
354
    }
355 356
    if (!empty($GLOBALS['config']['system.file']['path']['private'])) {
      $directories[] = $GLOBALS['config']['system.file']['path']['private'];
357
    }
358 359
    if (!empty($GLOBALS['config']['system.file']['path']['temporary'])) {
      $directories[] = $GLOBALS['config']['system.file']['path']['temporary'];
360 361 362 363 364 365
    }
    else {
      // If the temporary directory is not overridden use an appropriate
      // temporary path for the system.
      $directories[] = file_directory_os_temp();
    }
366 367
  }

368 369 370
  // 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.
371 372 373
  if (!empty($GLOBALS['config_directories'])) {
    $directories[] = config_get_config_directory(CONFIG_ACTIVE_DIRECTORY);
    $directories[] = config_get_config_directory(CONFIG_STAGING_DIRECTORY);
374 375
  }
  elseif ($phase != 'install') {
376
    $requirements['config directories'] = array(
377 378 379
      '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')),
380 381 382 383
      'severity' => REQUIREMENT_ERROR,
    );
  }

384
  $requirements['file system'] = array(
385
    'title' => t('File system'),
386
  );
387

388 389 390
  $error = '';
  // For installer, create the directories if possible.
  foreach ($directories as $directory) {
391 392 393
    if (!$directory) {
      continue;
    }
394
    if ($phase == 'install') {
395
      file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
396
    }
397 398 399 400
    $is_writable = is_writable($directory);
    $is_directory = is_dir($directory);
    if (!$is_writable || !$is_directory) {
      $description = '';
401
      $requirements['file system']['value'] = t('Not writable');
402
      if (!$is_directory) {
403
        $error .= t('The directory %directory does not exist.', array('%directory' => $directory)) . ' ';
404 405
      }
      else {
406
        $error .= t('The directory %directory is not writable.', array('%directory' => $directory)) . ' ';
407 408 409
      }
      // The files directory requirement check is done only during install and runtime.
      if ($phase == 'runtime') {
410
        $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')));
411 412 413 414
      }
      elseif ($phase == 'install') {
        // For the installer UI, we need different wording. 'value' will
        // be treated as version, so provide none there.
415
        $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'));
416 417 418 419 420 421
        $requirements['file system']['value'] = '';
      }
      if (!empty($description)) {
        $requirements['file system']['description'] = $description;
        $requirements['file system']['severity'] = REQUIREMENT_ERROR;
      }
422 423
    }
    else {
424 425 426
      // This function can be called before the config_cache table has been
      // created.
      if ($phase == 'install' || file_default_scheme() == 'public') {
427
        $requirements['file system']['value'] = t('Writable (<em>public</em> download method)');
428 429
      }
      else {
430
        $requirements['file system']['value'] = t('Writable (<em>private</em> download method)');
431
      }
432 433 434
    }
  }

435 436 437
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
438 439
      'title' => t('Database updates'),
      'value' => t('Up to date'),
440 441 442
    );

    // Check installed modules.
443
    foreach (\Drupal::moduleHandler()->getModuleList() as $module => $filename) {
444 445 446 447 448
      $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;
449 450
          $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'));
451 452 453 454 455 456
          break;
        }
      }
    }
  }

457 458
  // Verify the update.php access setting
  if ($phase == 'runtime') {
459
    if (Settings::get('update_free_access')) {
460
      $requirements['update access'] = array(
461
        'value' => t('Not protected'),
462
        'severity' => REQUIREMENT_ERROR,
463
        '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\']')),
464 465 466 467
      );
    }
    else {
      $requirements['update access'] = array(
468
        'value' => t('Protected'),
469 470
      );
    }
471
    $requirements['update access']['title'] = t('Access to update.php');
472 473
  }

474 475
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
476
    $profile = drupal_get_profile();
477 478
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
479
      // Ignore disabled modules and installation profiles.
480
      if (!$file->status || $module == $profile) {
481 482 483 484 485 486
        continue;
      }
      // Check the module's PHP version.
      $name = $file->info['name'];
      $php = $file->info['php'];
      if (version_compare($php, PHP_VERSION, '>')) {
487
        $requirements['php']['description'] .= t('@name requires at least PHP @version.', array('@name' => $name, '@version' => $php));
488 489 490 491 492 493 494 495
        $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(
496 497
            'title' => t('Unresolved dependency'),
            'description' => t('@name requires this module.', array('@name' => $name)),
498 499 500 501 502 503 504 505
            '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'];
506
        $version = str_replace(\Drupal::CORE_COMPATIBILITY . '-', '', $required_file->info['version']);
507 508 509 510
        $compatibility = drupal_check_incompatibility($requirement, $version);
        if ($compatibility) {
          $compatibility = rtrim(substr($compatibility, 2), ')');
          $requirements["$module-$required_module"] = array(
511 512
            '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)),
513 514 515 516 517 518 519 520 521
            'value' => t('@required_name (Version @compatibility required)', array('@required_name' => $required_name, '@compatibility' => $compatibility)),
            'severity' => REQUIREMENT_ERROR,
          );
          continue;
        }
      }
    }
  }

522
  // Test Unicode library
523
  include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
524 525
  $requirements = array_merge($requirements, unicode_requirements());

526
  if ($phase == 'runtime') {
527
    // Check for update status module.
528
    if (!\Drupal::moduleHandler()->moduleExists('update')) {
529
      $requirements['update status'] = array(
530
        'value' => t('Not enabled'),
531
        'severity' => REQUIREMENT_WARNING,
532
        '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'))),
533 534 535 536
      );
    }
    else {
      $requirements['update status'] = array(
537
        'value' => t('Enabled'),
538 539
      );
    }
540
    $requirements['update status']['title'] = t('Update notifications');
541

542
    if (Settings::get('rebuild_access')) {
543 544 545 546 547 548 549
      $requirements['rebuild access'] = array(
        'title' => t('Rebuild access'),
        'value' => t('Enabled'),
        'severity' => REQUIREMENT_ERROR,
        'description' => t('The rebuild_access setting is enabled in settings.php. It is recommended to have this setting disabled unless you are performing a rebuild.'),
      );
    }
550 551
  }

552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
  // Ensure that if upgrading from 7 to 8 we have no disabled modules.
  if ($phase == 'update' && db_table_exists('system')) {
    $modules = db_query('SELECT name, info FROM {system} WHERE type = :module AND status = 0 AND schema_version <> :schema_uninstalled', array(
      ':module' => 'module',
      ':schema_uninstalled' => SCHEMA_UNINSTALLED,
    ))->fetchAllKeyed(0, 1);
    array_walk($modules, function (&$value, $key) {
      $info = unserialize($value);
      $value = $info['name'];
    });
    if (!empty($modules)) {
      $requirements['disabled_modules'] = array(
        'severity' => REQUIREMENT_ERROR,
        'title' => t('Disabled modules'),
        'value' => format_plural(count($modules), 'The %modules module is disabled.', 'The following modules are disabled: %modules', array('%modules' => implode(', ', $modules))),
        'description' => t('Drupal 8 no longer supports disabled modules. Please either enable or uninstall them before upgrading.'),
      );
    }
  }
571 572 573
  return $requirements;
}

574
/**
575
 * Implements hook_install().
576
 */
577
function system_install() {
578
  // Populate the cron key state variable.
579
  $cron_key = Crypt::randomBytesBase64(55);
580
  \Drupal::state()->set('system.cron_key', $cron_key);
581 582 583 584 585

  // Populate the site UUID.
  \Drupal::config('system.site')
    ->set('uuid', \Drupal::service('uuid')->generate())
    ->save();
586 587
}

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

  $schema['flood'] = array(
628
    'description' => 'Flood controls the threshold of events, such as the number of contact attempts.',
629
    'fields' => array(
630
      'fid' => array(
631
        'description' => 'Unique flood event ID.',
632
        'type' => 'serial',
633 634
        'not null' => TRUE,
      ),
635
      'event' => array(
636
        'description' => 'Name of event (e.g. contact).',
637 638 639
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
640 641
        'default' => '',
      ),
642 643
      'identifier' => array(
        'description' => 'Identifier of the visitor, such as an IP address or hostname.',
644 645 646
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
647 648
        'default' => '',
      ),
649
      'timestamp' => array(
650
        'description' => 'Timestamp of the event.',
651 652
        'type' => 'int',
        'not null' => TRUE,
653
        'default' => 0,
654
      ),
655 656 657 658 659 660
      'expiration' => array(
        'description' => 'Expiration timestamp. Expired events are purged on cron run.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
661
    ),
662
    'primary key' => array('fid'),
663
    'indexes' => array(
664
      'allow' => array('event', 'identifier', 'timestamp'),
665
      'purge' => array('expiration'),
666
    ),
667
  );
668

669
  $schema['key_value'] = array(
670
    'description' => 'Generic key-value storage table. See the state system for an example.',
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
    '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'),
  );

696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
  $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'),
730
      'expire' => array('expire'),
731 732 733
    ),
  );

734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
  $schema['queue'] = array(
    'description' => 'Stores items in queues.',
    'fields' => array(
      'item_id' => array(
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'Primary Key: Unique item ID.',
      ),
      'name' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
        'description' => 'The queue name.',
      ),
      'data' => array(
751
        'type' => 'blob',
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
        'not null' => FALSE,
        'size' => 'big',
        'serialize' => TRUE,
        'description' => 'The arbitrary data for the item.',
      ),
      'expire' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'Timestamp when the claim lease expires on the item.',
      ),
      'created' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'Timestamp when the item was created.',
      ),
    ),
    'primary key' => array('item_id'),
    'indexes' => array(
772 773
      'name_created' => array('name', 'created'),
      'expire' => array('expire'),
774 775 776
    ),
  );

777 778 779 780 781 782 783 784 785 786
  $schema['router'] = array(
    'description' => 'Maps paths to various callbacks (access, page and title)',
    'fields' => array(
      'name' => array(
        'description' => 'Primary Key: Machine name of this route',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
787 788
      'path' => array(
        'description' => 'The path for this URI',
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'pattern_outline' => array(
        'description' => 'The pattern',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'fit' => array(
        'description' => 'A numeric representation of how specific the path is.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
      'route' => array(
        'description' => 'A serialized Route object',
809 810
        'type' => 'blob',
        'size' => 'big',
811 812 813 814 815 816 817 818 819 820
      ),
      'number_parts' => array(
        'description' => 'Number of parts in this router path.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'size' => 'small',
      ),
    ),
    'indexes' => array(
821
      'pattern_outline_fit' => array('pattern_outline', 'fit'),
822 823 824 825
    ),
    'primary key' => array('name'),
  );

826
  $schema['semaphore'] = array(
827
    'description' => 'Table for holding semaphores, locks, flags, etc. that cannot be stored as state since they must not be cached.',
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
    'fields' => array(
      'name' => array(
        'description' => 'Primary Key: Unique name.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''
      ),
      'value' => array(
        'description' => 'A value for the semaphore.',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''
      ),
      'expire' => array(
        'description' => 'A Unix timestamp with microseconds indicating when the semaphore should expire.',
        'type' => 'float',
        'size' => 'big',
        'not null' => TRUE
      ),
    ),
850