system.install 77.6 KB
Newer Older
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\FileSystem\FileSystem;
11
use Drupal\Component\Utility\OpCodeCache;
12
use Drupal\Core\Path\AliasStorage;
13
use Drupal\Core\Url;
14
use Drupal\Core\Database\Database;
15 16 17
use Drupal\Core\Entity\ContentEntityTypeInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Entity\FieldableEntityInterface;
18
use Drupal\Core\DrupalKernel;
19
use Drupal\Core\Site\Settings;
20
use Drupal\Core\StreamWrapper\PrivateStream;
21
use Drupal\Core\StreamWrapper\PublicStream;
22
use Drupal\system\SystemRequirements;
23
use Symfony\Component\HttpFoundation\Request;
24

25
/**
26
 * Implements hook_requirements().
27 28
 */
function system_requirements($phase) {
29
  global $install_state;
30 31 32 33 34
  $requirements = array();

  // Report Drupal version
  if ($phase == 'runtime') {
    $requirements['drupal'] = array(
35
      'title' => t('Drupal'),
36
      'value' => \Drupal::VERSION,
Steven Wittens's avatar
Steven Wittens committed
37 38
      'severity' => REQUIREMENT_INFO,
      'weight' => -10,
39
    );
40

41 42
    // Display the currently active installation profile, if the site
    // is not running the default installation profile.
43
    $profile = drupal_get_profile();
44
    if ($profile != 'standard') {
45
      $info = system_get_info('module', $profile);
46
      $requirements['install_profile'] = array(
47 48
        'title' => t('Installation profile'),
        'value' => t('%profile_name (%profile-%version)', array(
49 50 51 52 53 54 55
          '%profile_name' => $info['name'],
          '%profile' => $profile,
          '%version' => $info['version']
        )),
        'severity' => REQUIREMENT_INFO,
        'weight' => -9
      );
56
    }
57 58 59

    // Warn if any experimental modules are installed.
    $experimental = array();
60
    $enabled_modules = \Drupal::moduleHandler()->getModuleList();
61
    foreach ($enabled_modules as $module => $data) {
62 63 64
      $info = system_get_info('module', $module);
      if ($info['package'] === 'Core (Experimental)') {
        $experimental[$module] = $info['name'];
65 66 67 68 69
      }
    }
    if (!empty($experimental)) {
      $requirements['experimental'] = array(
        'title' => t('Experimental modules enabled'),
70
        'value' => t('Experimental modules found: %module_list. <a href=":url">Experimental modules</a> are provided for testing purposes only. Use at your own risk.', array('%module_list' => implode(', ', $experimental), ':url' => 'https://www.drupal.org/core/experimental')),
71 72 73
        'severity' => REQUIREMENT_WARNING,
      );
    }
74 75
  }

76
  // Web server information.
77
  $software = \Drupal::request()->server->get('SERVER_SOFTWARE');
78
  $requirements['webserver'] = array(
79
    'title' => t('Web server'),
Steven Wittens's avatar
Steven Wittens committed
80
    'value' => $software,
81 82
  );

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
  // Tests clean URL support.
  if ($phase == 'install' && $install_state['interactive'] && !isset($_GET['rewrite']) && strpos($software, 'Apache') !== FALSE) {
    // If the Apache rewrite module is not enabled, Apache version must be >=
    // 2.2.16 because of the FallbackResource directive in the root .htaccess
    // file. Since the Apache version reported by the server is dependent on the
    // ServerTokens setting in httpd.conf, we may not be able to determine if a
    // given config is valid. Thus we are unable to use version_compare() as we
    // need have three possible outcomes: the version of Apache is greater than
    // 2.2.16, is less than 2.2.16, or cannot be determined accurately. In the
    // first case, we encourage the use of mod_rewrite; in the second case, we
    // raise an error regarding the minimum Apache version; in the third case,
    // we raise a warning that the current version of Apache may not be
    // supported.
    $rewrite_warning = FALSE;
    $rewrite_error = FALSE;
    $apache_version_string = 'Apache';

    // Determine the Apache version number: major, minor and revision.
    if (preg_match('/Apache\/(\d+)\.?(\d+)?\.?(\d+)?/', $software, $matches)) {
      $apache_version_string = $matches[0];

      // Major version number
      if ($matches[1] < 2) {
        $rewrite_error = TRUE;
      }
108
      elseif ($matches[1] == 2) {
109 110 111
        if (!isset($matches[2])) {
          $rewrite_warning = TRUE;
        }
112
        elseif ($matches[2] < 2) {
113 114
          $rewrite_error = TRUE;
        }
115
        elseif ($matches[2] == 2) {
116 117 118
          if (!isset($matches[3])) {
            $rewrite_warning = TRUE;
          }
119
          elseif ($matches[3] < 16) {
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
            $rewrite_error = TRUE;
          }
        }
      }
    }
    else {
      $rewrite_warning = TRUE;
    }

    if ($rewrite_warning) {
      $requirements['apache_version'] = array (
        'title' => t('Apache version'),
        'value' => $apache_version_string,
        'severity' => REQUIREMENT_WARNING,
        'description' => t('Due to the settings for ServerTokens in httpd.conf, it is impossible to accurately determine the version of Apache running on this server. The reported value is @reported, to run Drupal without mod_rewrite, a minimum version of 2.2.16 is needed.', array('@reported' => $apache_version_string)),
      );
    }

    if ($rewrite_error) {
      $requirements['Apache version'] = array (
        'title' => t('Apache version'),
        'value' => $apache_version_string,
        'severity' => REQUIREMENT_ERROR,
143
        'description' => t('The minimum version of Apache needed to run Drupal without mod_rewrite enabled is 2.2.16. See the <a href=":link">enabling clean URLs</a> page for more information on mod_rewrite.', array(':link' => 'http://drupal.org/node/15365')),
144 145 146 147 148 149 150 151
      );
    }

    if (!$rewrite_error && !$rewrite_warning) {
      $requirements['rewrite_module'] = array (
        'title' => t('Clean URLs'),
        'value' => t('Disabled'),
        'severity' => REQUIREMENT_WARNING,
152
        'description' => t('Your server is capable of using clean URLs, but it is not enabled. Using clean URLs gives an improved user experience and is recommended. <a href=":link">Enable clean URLs</a>', array(':link' => 'http://drupal.org/node/15365')),
153 154 155 156
      );
    }
  }

157
  // Test PHP version and show link to phpinfo() if it's available
158
  $phpversion = $phpversion_label = phpversion();
159
  if (function_exists('phpinfo')) {
160
    if ($phase === 'runtime') {
161
      $phpversion_label = t('@phpversion (<a href=":url">more information</a>)', ['@phpversion' => $phpversion, ':url' => (new Url('system.php'))->toString()]);
162
    }
163
    $requirements['php'] = array(
164
      'title' => t('PHP'),
165
      'value' => $phpversion_label,
166 167 168 169
    );
  }
  else {
    $requirements['php'] = array(
170
      'title' => t('PHP'),
171
      'value' => $phpversion_label,
172
      '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' => 'https://www.drupal.org/node/243993')),
173 174 175 176
      'severity' => REQUIREMENT_INFO,
    );
  }

177
  if (version_compare($phpversion, DRUPAL_MINIMUM_PHP) < 0) {
178
    $requirements['php']['description'] = t('Your PHP installation is too old. Drupal requires at least PHP %version.', array('%version' => DRUPAL_MINIMUM_PHP));
179
    $requirements['php']['severity'] = REQUIREMENT_ERROR;
180 181
    // If PHP is old, it's not safe to continue with the requirements check.
    return $requirements;
182
  }
183

184 185 186
  // Suggest to update to at least 5.5.21 or 5.6.5 for disabling multiple
  // statements.
  if (($phase === 'install' || \Drupal::database()->driver() === 'mysql') && !SystemRequirements::phpVersionWithPdoDisallowMultipleStatements($phpversion)) {
187
    $requirements['php'] = array(
188
      'title' => t('PHP (multiple statement disabling)'),
189
      'value' => $phpversion_label,
190 191 192 193 194
      'description' => t('PHP versions higher than 5.6.5 or 5.5.21 provide built-in SQL injection protection for mysql databases. It is recommended to update.'),
      'severity' => REQUIREMENT_INFO,
    );
  }

195 196
  // Test for PHP extensions.
  $requirements['php_extensions'] = array(
197
    'title' => t('PHP extensions'),
198
  );
199 200 201 202 203 204 205 206 207 208 209 210 211 212

  $missing_extensions = array();
  $required_extensions = array(
    'date',
    'dom',
    'filter',
    'gd',
    'hash',
    'json',
    'pcre',
    'pdo',
    'session',
    'SimpleXML',
    'SPL',
213
    'tokenizer',
214 215 216 217 218 219 220 221 222
    'xml',
  );
  foreach ($required_extensions as $extension) {
    if (!extension_loaded($extension)) {
      $missing_extensions[] = $extension;
    }
  }

  if (!empty($missing_extensions)) {
223 224
    $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' => 'https://www.drupal.org/requirements',
225 226
    ));

227 228 229 230 231 232 233 234 235 236 237
    // We use twig inline_template to avoid twig's autoescape.
    $description = array(
      '#type' => 'inline_template',
      '#template' => '{{ description }}{{ missing_extensions }}',
      '#context' => array(
        'description' => $description,
        'missing_extensions' => array(
          '#theme' => 'item_list',
          '#items' => $missing_extensions,
        ),
      ),
238
    );
239

240
    $requirements['php_extensions']['value'] = t('Disabled');
241 242
    $requirements['php_extensions']['severity'] = REQUIREMENT_ERROR;
    $requirements['php_extensions']['description'] = $description;
243 244
  }
  else {
245
    $requirements['php_extensions']['value'] = t('Enabled');
246 247 248 249
  }

  if ($phase == 'install' || $phase == 'runtime') {
    // Check to see if OPcache is installed.
250
    if (!OpCodeCache::isEnabled()) {
251 252 253
      $requirements['php_opcache'] = array(
        'value' => t('Not enabled'),
        'severity' => REQUIREMENT_WARNING,
254
        'description' => t('PHP OPcode caching can improve your site\'s performance considerably. It is <strong>highly recommended</strong> to have <a href="http://php.net/manual/opcache.installation.php" target="_blank">OPcache</a> installed on your server.'),
255 256 257 258 259 260
      );
    }
    else {
      $requirements['php_opcache']['value'] = t('Enabled');
    }
    $requirements['php_opcache']['title'] = t('PHP OPcode caching');
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 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
  if ($phase != 'update') {
    // Test whether we have a good source of random bytes.
    $requirements['php_random_bytes'] = array(
      'title' => t('Random number generation'),
    );
    try {
      $bytes = random_bytes(10);
      if (strlen($bytes) != 10) {
        throw new \Exception(t('Tried to generate 10 random bytes, generated @count', array('@count' => strlen($bytes))));
      }
      $requirements['php_random_bytes']['value'] = t('Successful');
    }
    catch (\Exception $e) {
      // If /dev/urandom is not available on a UNIX-like system, check whether
      // open_basedir restrictions are the cause.
      $open_basedir_blocks_urandom = FALSE;
      if (DIRECTORY_SEPARATOR === '/' && !@is_readable('/dev/urandom')) {
        $open_basedir = ini_get('open_basedir');
        if ($open_basedir) {
          $open_basedir_paths = explode(PATH_SEPARATOR, $open_basedir);
          $open_basedir_blocks_urandom = !array_intersect(array('/dev', '/dev/', '/dev/urandom'), $open_basedir_paths);
        }
      }
      $args = array(
        ':drupal-php' => 'https://www.drupal.org/docs/7/system-requirements/php#csprng',
        '%exception_message' => $e->getMessage(),
      );
      if ($open_basedir_blocks_urandom) {
        $requirements['php_random_bytes']['description'] = t('Drupal is unable to generate highly randomized numbers, which means certain security features like password reset URLs are not as secure as they should be. Instead, only a slow, less-secure fallback generator is available. The most likely cause is that open_basedir restrictions are in effect and /dev/urandom is not on the whitelist. See the <a href=":drupal-php">system requirements</a> page for more information. %exception_message', $args);
      }
      else {
        $requirements['php_random_bytes']['description'] = t('Drupal is unable to generate highly randomized numbers, which means certain security features like password reset URLs are not as secure as they should be. Instead, only a slow, less-secure fallback generator is available. See the <a href=":drupal-php">system requirements</a> page for more information. %exception_message', $args);
      }
      $requirements['php_random_bytes']['value'] = t('Less secure');
      $requirements['php_random_bytes']['severity'] = REQUIREMENT_ERROR;
    }
  }

301 302 303
  if ($phase == 'install' || $phase == 'update') {
    // Test for PDO (database).
    $requirements['database_extensions'] = array(
304
      'title' => t('Database support'),
305
    );
306

307
    // Make sure PDO is available.
308
    $database_ok = extension_loaded('pdo');
309
    if (!$database_ok) {
310 311
      $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' => 'https://www.drupal.org/requirements/pdo',
312 313 314 315
      ));
    }
    else {
      // Make sure at least one supported database driver exists.
316
      $drivers = drupal_detect_database_types();
317 318
      if (empty($drivers)) {
        $database_ok = FALSE;
319
        $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(
320
          ':drupal-databases' => 'https://www.drupal.org/requirements/database',
321 322 323 324 325 326
        ));
      }
      // 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;
327 328
        $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(
          ':link' => 'https://www.drupal.org/requirements/pdo#pecl',
329 330
        ));
      }
331
    }
332

333
    if (!$database_ok) {
334
      $requirements['database_extensions']['value'] = t('Disabled');
335
      $requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
336
      $requirements['database_extensions']['description'] = $pdo_message;
337 338
    }
    else {
339
      $requirements['database_extensions']['value'] = t('Enabled');
340
    }
341
  }
342 343
  else {
    // Database information.
344
    $class = Database::getConnection()->getDriverClass('Install\\Tasks');
345 346
    $tasks = new $class();
    $requirements['database_system'] = array(
347
      'title' => t('Database system'),
348 349 350
      'value' => $tasks->name(),
    );
    $requirements['database_system_version'] = array(
351
      'title' => t('Database system version'),
352 353 354
      'value' => Database::getConnection()->version(),
    );
  }
355

356
  // Test PHP memory_limit
357
  $memory_limit = ini_get('memory_limit');
358
  $requirements['php_memory_limit'] = array(
359
    'title' => t('PHP memory limit'),
360
    'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
361
  );
362

363
  if (!Environment::checkMemoryLimit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
364
    $description = array();
365
    if ($phase == 'install') {
366
      $description['phase'] = 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));
367 368
    }
    elseif ($phase == 'update') {
369
      $description['phase'] = 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));
370
    }
371
    elseif ($phase == 'runtime') {
372
      $description['phase'] = 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));
373
    }
374

375
    if (!empty($description['phase'])) {
376
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
377
        $description['memory'] = 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));
378 379
      }
      else {
380
        $description['memory'] = t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
381
      }
382

383
      $handbook_link = t('For more information, see the online handbook entry for <a href=":memory-limit">increasing the PHP memory limit</a>.', array(':memory-limit' => 'https://www.drupal.org/node/207036'));
384 385 386 387 388 389 390 391 392 393 394 395

      $description = array(
        '#type' => 'inline_template',
        '#template' => '{{ description_phase }} {{ description_memory }} {{ handbook }}',
        '#context' => array(
          'description_phase' => $description['phase'],
          'description_memory' => $description['memory'],
          'handbook' => $handbook_link,
        ),
      );

      $requirements['php_memory_limit']['description'] = $description;
396
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
397
    }
398
  }
399

400
  // Test configuration files and directory for writability.
401
  if ($phase == 'runtime') {
402
    $conf_errors = array();
403 404 405 406 407 408 409 410
    // Find the site path. Kernel service is not always available at this point,
    // but is preferred, when available.
    if (\Drupal::hasService('kernel')) {
      $site_path = \Drupal::service('site.path');
    }
    else {
      $site_path = DrupalKernel::findSitePath(Request::createFromGlobals());
    }
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
    // Allow system administrators to disable permissions hardening for the site
    // directory. This allows additional files in the site directory to be
    // updated when they are managed in a version control system.
    if (Settings::get('skip_permissions_hardening')) {
      $conf_errors[] = t('Protection disabled');
      // If permissions hardening is disabled, then only show a warning for a
      // writable file, as a reminder, rather than an error.
      $file_protection_severity = REQUIREMENT_WARNING;
    }
    else {
      // In normal operation, writable files or directories are an error.
      $file_protection_severity = REQUIREMENT_ERROR;
      if (!drupal_verify_install_file($site_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' => $site_path));
      }
426
    }
427
    foreach (array('settings.php', 'settings.local.php', 'services.yml') as $conf_file) {
428
      $full_path = $site_path . '/' . $conf_file;
429
      if (file_exists($full_path) && (Settings::get('skip_permissions_hardening') || !drupal_verify_install_file($full_path, FILE_EXIST | FILE_READABLE | FILE_NOT_WRITABLE))) {
430
        $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));
431 432 433 434 435 436 437
      }
    }
    if (!empty($conf_errors)) {
      if (count($conf_errors) == 1) {
        $description = $conf_errors[0];
      }
      else {
438 439 440 441 442 443 444 445 446 447
        // We use twig inline_template to avoid double escaping.
        $description = array(
          '#type' => 'inline_template',
          '#template' => '{{ configuration_error_list }}',
          '#context' => array(
            'configuration_error_list' => array(
              '#theme' => 'item_list',
              '#items' => $conf_errors,
            ),
          ),
448
        );
449
      }
450
      $requirements['configuration_files'] = array(
451
        'value' => t('Not protected'),
452
        'severity' => $file_protection_severity,
453
        'description' => $description,
454 455 456
      );
    }
    else {
457
      $requirements['configuration_files'] = array(
458
        'value' => t('Protected'),
459 460
      );
    }
461
    $requirements['configuration_files']['title'] = t('Configuration files');
462 463
  }

464 465 466 467 468 469 470 471 472
  // 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://'),
    );
473
    if (PrivateStream::basePath()) {
474 475 476 477 478 479 480 481 482 483 484 485 486
      $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) {
487
        $url = 'https://www.drupal.org/SA-CORE-2013-003';
488 489 490 491
        $requirements[$htaccess_file] = array(
          'title' => $info['title'],
          'value' => t('Not fully protected'),
          'severity' => REQUIREMENT_ERROR,
492
          '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' => $url, '@url' => $url, '%directory' => $info['directory'])),
493 494 495 496 497
        );
      }
    }
  }

498
  // Report cron status.
499
  if ($phase == 'runtime') {
500
    $cron_config = \Drupal::config('system.cron');
501
    // Cron warning threshold defaults to two days.
502
    $threshold_warning = $cron_config->get('threshold.requirements_warning');
503
    // Cron error threshold defaults to two weeks.
504
    $threshold_error = $cron_config->get('threshold.requirements_error');
505

506
    // Determine when cron last ran.
507
    $cron_last = \Drupal::state()->get('system.cron_last');
508
    if (!is_numeric($cron_last)) {
509
      $cron_last = \Drupal::state()->get('install_time', 0);
510
    }
511

512
    // Determine severity based on time since cron last ran.
513
    $severity = REQUIREMENT_INFO;
514
    if (REQUEST_TIME - $cron_last > $threshold_error) {
515
      $severity = REQUIREMENT_ERROR;
516
    }
517
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
518 519 520 521
      $severity = REQUIREMENT_WARNING;
    }

    // Set summary and description based on values determined above.
522
    $summary = t('Last run @time ago', array('@time' => \Drupal::service('date.formatter')->formatTimeDiffSince($cron_last)));
523

524
    $requirements['cron'] = array(
525
      'title' => t('Cron maintenance tasks'),
526 527 528
      'severity' => $severity,
      'value' => $summary,
    );
529 530 531 532 533 534 535
    if ($severity != REQUIREMENT_INFO) {
      $requirements['cron']['description'][] = [
        [
          '#markup' => t('Cron has not run recently.'),
          '#suffix' => ' ',
        ],
        [
536
          '#markup' => t('For more information, see the online handbook entry for <a href=":cron-handbook">configuring cron jobs</a>.', [':cron-handbook' => 'https://www.drupal.org/cron']),
537 538 539 540 541 542
          '#suffix' => ' ',
        ],
      ];
    }
    $requirements['cron']['description'][] = [
      [
543 544 545 546 547
        '#type' => 'link',
        '#prefix' => '(',
        '#title' => t('more information'),
        '#suffix' => ')',
        '#url' => Url::fromRoute('system.cron_settings'),
548 549
      ],
      [
550 551 552 553 554
        '#prefix' => '<span class="cron-description__run-cron">',
        '#suffix' => '</span>',
        '#type' => 'link',
        '#title' => t('Run cron'),
        '#url' => Url::fromRoute('system.run_cron'),
555 556
      ],
    ];
557
  }
558
  if ($phase != 'install') {
559
    $filesystem_config = \Drupal::config('system.file');
560
    $directories = array(
561
      PublicStream::basePath(),
562 563
      // By default no private files directory is configured. For private files
      // to be secure the admin needs to provide a path outside the webroot.
564
      PrivateStream::basePath(),
565 566 567
      file_directory_temp(),
    );
  }
568

569 570
  // During an install we need to make assumptions about the file system
  // unless overrides are provided in settings.php.
571
  if ($phase == 'install') {
572
    $directories = array();
573
    if ($file_public_path = Settings::get('file_public_path')) {
574
      $directories[] = $file_public_path;
575 576 577
    }
    else {
      // If we are installing Drupal, the settings.php file might not exist yet
578
      // in the intended site directory, so don't require it.
579 580 581
      $request = Request::createFromGlobals();
      $site_path = DrupalKernel::findSitePath($request);
      $directories[] = $site_path . '/files';
582
    }
583 584
    if ($file_private_path = Settings::get('file_private_path')) {
      $directories[] = $file_private_path;
585
    }
586 587
    if (!empty($GLOBALS['config']['system.file']['path']['temporary'])) {
      $directories[] = $GLOBALS['config']['system.file']['path']['temporary'];
588 589 590 591
    }
    else {
      // If the temporary directory is not overridden use an appropriate
      // temporary path for the system.
592
      $directories[] = FileSystem::getOsTemporaryDirectory();
593
    }
594 595
  }

596 597 598
  // 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.
599
  if (!empty($GLOBALS['config_directories'])) {
600 601
    foreach (array_keys(array_filter($GLOBALS['config_directories'])) as $type) {
      $directory = config_get_config_directory($type);
602 603 604 605
      // If we're installing Drupal try and create the config sync directory.
      if (!is_dir($directory) && $phase == 'install') {
        file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
      }
606
      if (!is_dir($directory)) {
607 608 609 610 611 612
        if ($phase == 'install') {
          $description = t('An automated attempt to create the directory %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('%directory' => $directory, ':handbook_url' => 'https://www.drupal.org/server-permissions'));
        }
        else {
          $description = t('The directory %directory does not exist.', array('%directory' => $directory));
        }
613 614
        $requirements['config directory ' . $type] = array(
          'title' => t('Configuration directory: %type', ['%type' => $type]),
615
          'description' => $description,
616 617 618
          'severity' => REQUIREMENT_ERROR,
        );
      }
619
    }
620
  }
621
  if ($phase != 'install' && (empty($GLOBALS['config_directories']) || empty($GLOBALS['config_directories'][CONFIG_SYNC_DIRECTORY]) )) {
622
    $requirements['config directories'] = array(
623 624
      'title' => t('Configuration directories'),
      'value' => t('Not present'),
625
      'description' => t('Your %file file must define the $config_directories variable as an array containing the names of directories in which configuration files can be found. It must contain a %sync_key key.', array('%file' => $site_path . '/settings.php', '%sync_key' => CONFIG_SYNC_DIRECTORY)),
626 627 628 629
      'severity' => REQUIREMENT_ERROR,
    );
  }

630
  $requirements['file system'] = array(
631
    'title' => t('File system'),
632
  );
633

634 635 636
  $error = '';
  // For installer, create the directories if possible.
  foreach ($directories as $directory) {
637 638 639
    if (!$directory) {
      continue;
    }
640
    if ($phase == 'install') {
641
      file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
642
    }
643 644 645 646
    $is_writable = is_writable($directory);
    $is_directory = is_dir($directory);
    if (!$is_writable || !$is_directory) {
      $description = '';
647
      $requirements['file system']['value'] = t('Not writable');
648
      if (!$is_directory) {
649
        $error = t('The directory %directory does not exist.', array('%directory' => $directory));
650 651
      }
      else {
652
        $error = t('The directory %directory is not writable.', array('%directory' => $directory));
653 654 655
      }
      // The files directory requirement check is done only during install and runtime.
      if ($phase == 'runtime') {
656
        $description = 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' => \Drupal::url('system.file_system_settings')));
657 658 659 660
      }
      elseif ($phase == 'install') {
        // For the installer UI, we need different wording. 'value' will
        // be treated as version, so provide none there.
661
        $description = 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' => 'https://www.drupal.org/server-permissions'));
662 663 664
        $requirements['file system']['value'] = '';
      }
      if (!empty($description)) {
665 666 667 668 669 670 671 672
        $description = array(
          '#type' => 'inline_template',
          '#template' => '{{ error }} {{ description }}',
          '#context' => array(
            'error' => $error,
            'description' => $description,
          ),
        );
673 674 675
        $requirements['file system']['description'] = $description;
        $requirements['file system']['severity'] = REQUIREMENT_ERROR;
      }
676 677
    }
    else {
678 679 680
      // This function can be called before the config_cache table has been
      // created.
      if ($phase == 'install' || file_default_scheme() == 'public') {
681
        $requirements['file system']['value'] = t('Writable (<em>public</em> download method)');
682 683
      }
      else {
684
        $requirements['file system']['value'] = t('Writable (<em>private</em> download method)');
685
      }
686 687 688
    }
  }

689 690 691
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
692 693
      'title' => t('Database updates'),
      'value' => t('Up to date'),
694 695 696
    );

    // Check installed modules.
697
    $has_pending_updates = FALSE;
698
    foreach (\Drupal::moduleHandler()->getModuleList() as $module => $filename) {
699 700 701 702
      $updates = drupal_get_schema_versions($module);
      if ($updates !== FALSE) {
        $default = drupal_get_installed_schema_version($module);
        if (max($updates) > $default) {
703
          $has_pending_updates = TRUE;
704 705 706 707
          break;
        }
      }
    }
708 709 710 711 712 713 714 715 716 717 718 719
    if (!$has_pending_updates) {
      /** @var \Drupal\Core\Update\UpdateRegistry $post_update_registry */
      $post_update_registry = \Drupal::service('update.post_update_registry');
      $missing_post_update_functions = $post_update_registry->getPendingUpdateFunctions();
      if (!empty($missing_post_update_functions)) {
        $has_pending_updates = TRUE;
      }
    }

    if ($has_pending_updates) {
      $requirements['update']['severity'] = REQUIREMENT_ERROR;
      $requirements['update']['value'] = t('Out of date');
720
      $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' => \Drupal::url('system.db_update')));
721
    }
722

723 724 725 726 727
    $requirements['entity_update'] = [
      'title' => t('Entity/field definitions'),
      'value' => t('Up to date'),
    ];
    // Verify that no entity updates are pending.
728 729 730 731 732 733 734 735 736 737 738
    if ($change_list = \Drupal::entityDefinitionUpdateManager()->getChangeSummary()) {
      $build = [];
      foreach ($change_list as $entity_type_id => $changes) {
        $entity_type = \Drupal::entityManager()->getDefinition($entity_type_id);
        $build[] = [
          '#theme' => 'item_list',
          '#title' => $entity_type->getLabel(),
          '#items' => $changes,
        ];
      }

739
      $entity_update_issues = \Drupal::service('renderer')->renderPlain($build);
740 741
      $requirements['entity_update']['severity'] = REQUIREMENT_ERROR;
      $requirements['entity_update']['value'] = t('Mismatched entity and/or field definitions');
742
      $requirements['entity_update']['description'] = t('The following changes were detected in the entity type and field definitions. @updates', ['@updates' => $entity_update_issues]);
743
    }
744 745
  }

746 747
  // Verify the update.php access setting
  if ($phase == 'runtime') {
748
    if (Settings::get('update_free_access')) {
749
      $requirements['update access'] = array(
750
        'value' => t('Not protected'),
751
        'severity' => REQUIREMENT_ERROR,
752
        '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\']')),
753 754 755 756
      );
    }
    else {
      $requirements['update access'] = array(
757
        'value' => t('Protected'),
758 759
      );
    }
760
    $requirements['update access']['title'] = t('Access to update.php');
761 762
  }

763 764
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
765
    $profile = drupal_get_profile();
766 767
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
768
      // Ignore disabled modules and installation profiles.
769
      if (!$file->status || $module == $profile) {
770 771 772 773 774 775
        continue;
      }
      // Check the module's PHP version.
      $name = $file->info['name'];
      $php = $file->info['php'];
      if (version_compare($php, PHP_VERSION, '>')) {
776
        $requirements['php']['description'] .= t('@name requires at least PHP @version.', array('@name' => $name, '@version' => $php));
777 778 779 780 781 782 783 784
        $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(
785 786
            'title' => t('Unresolved dependency'),
            'description' => t('@name requires this module.', array('@name' => $name)),
787 788 789 790 791 792 793 794
            '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'];
795
        $version = str_replace(\Drupal::CORE_COMPATIBILITY . '-', '', $required_file->info['version']);
796 797 798 799
        $compatibility = drupal_check_incompatibility($requirement, $version);
        if ($compatibility) {
          $compatibility = rtrim(substr($compatibility, 2), ')');
          $requirements["$module-$required_module"] = array(
800 801
            '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)),
802 803 804 805 806 807 808 809 810
            'value' => t('@required_name (Version @compatibility required)', array('@required_name' => $required_name, '@compatibility' => $compatibility)),
            'severity' => REQUIREMENT_ERROR,
          );
          continue;
        }
      }
    }
  }

811
  // Test Unicode library
812
  include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
813 814
  $requirements = array_merge($requirements, unicode_requirements());

815
  if ($phase == 'runtime') {
816
    // Check for update status module.
817
    if (!\Drupal::moduleHandler()->moduleExists('update')) {
818
      $requirements['update status'] = array(
819
        'value' => t('Not enabled'),
820
        'severity' => REQUIREMENT_WARNING,
821 822 823
        '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' => 'https://www.drupal.org/documentation/modules/update',
          ':module' => \Drupal::url('system.modules_list'),
824
        )),
825 826 827 828
      );
    }
    else {
      $requirements['update status'] = array(
829
        'value' => t('Enabled'),
830 831
      );
    }
832
    $requirements['update status']['title'] = t('Update notifications');
833

834
    if (Settings::get('rebuild_access')) {
835 836 837 838 839 840 841
      $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.'),
      );
    }
842 843
  }

844 845 846 847 848 849 850 851
  // See if trusted hostnames have been configured, and warn the user if they
  // are not set.
  if ($phase == 'runtime') {
    $trusted_host_patterns = Settings::get('trusted_host_patterns');
    if (empty($trusted_host_patterns)) {
      $requirements['trusted_host_patterns'] = array(
        'title' => t('Trusted Host Settings'),
        'value' => t('Not enabled'),
852
        'description' => t('The trusted_host_patterns setting is not configured in settings.php. This can lead to security vulnerabilities. It is <strong>highly recommended</strong> that you configure this. See <a href=":url">Protecting against HTTP HOST Header attacks</a> for more information.', array(':url' => 'https://www.drupal.org/node/1992030')),
853 854 855 856 857 858 859 860 861 862 863
        'severity' => REQUIREMENT_ERROR,
      );
    }
    else {
      $requirements['trusted_host_patterns'] = array(
        'title' => t('Trusted Host Settings'),
        'value' => t('Enabled'),
        'description' => t('The trusted_host_patterns setting is set to allow %trusted_host_patterns', array('%trusted_host_patterns' => join(', ', $trusted_host_patterns))),
      );
    }
  }
864

865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
  // Check xdebug.max_nesting_level, as some pages will not work if it is too
  // low.
  if (extension_loaded('xdebug')) {
    // Setting this value to 256 was considered adequate on Xdebug 2.3
    // (see http://bugs.xdebug.org/bug_view_page.php?bug_id=00001100)
    $minimum_nesting_level = 256;
    $current_nesting_level = ini_get('xdebug.max_nesting_level');

    if ($current_nesting_level < $minimum_nesting_level) {
      $requirements['xdebug_max_nesting_level'] = [
        'title' => t('Xdebug settings'),
        'value' => t('xdebug.max_nesting_level is set to %value.', ['%value' => $current_nesting_level]),
        'description' => t('Set <code>xdebug.max_nesting_level=@level</code> in your PHP configuration as some pages in your Drupal site will not work when this setting is too low.', ['@level' => $minimum_nesting_level]),
        'severity' => REQUIREMENT_ERROR,
      ];
    }
  }
882

883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
  // Warning for httpoxy on IIS with affected PHP versions
  // @see https://www.drupal.org/node/2783079
  if (strpos($software, 'Microsoft-IIS') !== FALSE
    && (
    version_compare(PHP_VERSION, '5.5.38', '<')
    || (version_compare(PHP_VERSION, '5.6.0', '>=') && version_compare(PHP_VERSION, '5.6.24', '<'))
    || (version_compare(PHP_VERSION, '7.0.0', '>=') && version_compare(PHP_VERSION, '7.0.9', '<'))
    )) {
    $dom = new \DOMDocument('1.0', 'UTF-8');
    $webconfig = file_get_contents('web.config');
    // If you are here the web.config file must - of course - be well formed.
    // But the PHP DOM component will throw warnings on some XML compliant
    // stuff, so silently parse the configuration file.
    @$dom->loadHTML($webconfig);
    $httpoxy_rewrite = FALSE;
    foreach ($dom->getElementsByTagName('rule') as $rule) {
      foreach ($rule->attributes as $attr) {
        if (@$attr->name == 'name' && @$attr->nodeValue == 'Erase HTTP_PROXY') {
          $httpoxy_rewrite = TRUE;
          break 2;
        }
      }
    }
    if (!$httpoxy_rewrite) {
      $requirements['iis_httpoxy_protection'] = [
        'title' => t('IIS httpoxy protection'),
        'value' => t('Your PHP runtime version is affected by the httpoxy vulnerability.'),
        'description' => t('Either update your PHP runtime version or uncomment the "Erase HTTP_PROXY" rule in your web.config file and add HTTP_PROXY to the allowed headers list. See more details in the <a href=":link">security advisory</a>.', [':link' => 'https://www.drupal.org/SA-CORE-2016-003']),
        'severity' => REQUIREMENT_ERROR,
      ];
    }
  }

916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
  // Installations on Windows can run into limitations with MAX_PATH if the
  // Drupal root directory is too deep in the filesystem. Generally this shows
  // up in cached Twig templates and other public files with long directory or
  // file names. There is no definite root directory depth below which Drupal is
  // guaranteed to function correctly on Windows. Since problems are likely
  // with more than 100 characters in the Drupal root path, show an error.
  if (substr(PHP_OS, 0, 3) == 'WIN') {
    $depth = strlen(realpath(DRUPAL_ROOT . '/' . PublicStream::basePath()));
    if ($depth > 120) {
      $requirements['max_path_on_windows'] = [
        'title' => t('Windows installation depth'),
        'description' => t('The public files directory path is %depth characters. Paths longer than 120 characters will cause problems on Windows.', ['%depth' => $depth]),
        'severity' => REQUIREMENT_ERROR,
      ];
    }
  }

933 934 935
  return $requirements;
}

936
/**
937
 * Implements hook_install().
938
 */
939
function system_install() {
940
  // Populate the cron key state variable.
941
  $cron_key = Crypt::randomBytesBase64(55);
942
  \Drupal::state()->set('system.cron_key', $cron_key);
943

944 945 946 947 948 949
  // Populate the site UUID and default name (if not set).
  $site = \Drupal::configFactory()->getEditable('system.site');
  $site->set('uuid', \Drupal::service('uuid')->generate());
  if (!$site->get('name')) {
    $site->set('name', 'Drupal');
  }
950
  $site->save(TRUE);
951 952
}

953
/**
954
 * Implements hook_schema().
955 956
 */
function system_schema() {
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
  $schema['key_value'] = array(
    'description' => 'Generic key-value storage table. See the state system for an example.',
    'fields' => array(
      'collection' => array(
        'description' => 'A named collection of key and value pairs.',
        'type' => 'varchar_ascii',
        '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_ascii',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
      ),
      'value' => array(
        'description' => 'The value.',
        'type' => 'blob',
        'not null' => TRUE,
        'size' => 'big',
      ),
    ),
    'primary key' => array('collection', 'name'),
  );

  $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_ascii',
        '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_ascii',
        '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'),
      'expire' => array('expire'),
    ),
  );

1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
  $schema['sequences'] = array(
    'description' => 'Stores IDs.',
    'fields' => array(
      'value' => array(
        'description' => 'The value of the sequence.',
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
     ),
    'primary key' => array('value'),
  );

1035
  $schema['sessions'] = array(
1036
    'description' => "Drupal's session handlers read and write into the sessions table. Each record represents a user session, either anonymous or authenticated.",
1037
    'fields' => array(
1038
      'uid' => array(
1039
        'description' => 'The {users}.uid corresponding to a session, or 0 for anonymous user.',
1040 1041
        'type' => 'int',
        'unsigned' => TRUE,
1042 1043
        'not null' => TRUE,
      ),
1044
      'sid' => array(
1045
        'description' => "A session ID (hashed). The value is generated by Drupal's session handlers.",
1046
        'type' => 'varchar_ascii',
1047
        'length' => 128,
1048
        'not null' => TRUE,
1049
      ),
1050
      'hostname' => array(
1051
        'description' => 'The IP address that last used this session ID (sid).',
1052
        'type' => 'varchar_ascii',
1053 1054
        'length' => 128,
        'not null' => TRUE,
1055 1056
        'default' => '',
      ),