system.install 67 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\FileSystem\FileSystem as FileSystemComponent;
9
use Drupal\Component\Utility\Bytes;
10
use Drupal\Component\Utility\Crypt;
11
use Drupal\Component\Utility\Environment;
12
use Drupal\Component\Utility\OpCodeCache;
13
use Drupal\Component\Utility\Unicode;
14
use Drupal\Core\Database\Database;
15
use Drupal\Core\DrupalKernel;
16 17
use Drupal\Core\Entity\Sql\SqlContentEntityStorage;
use Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema;
18
use Drupal\Core\File\FileSystemInterface;
19
use Drupal\Core\Site\Settings;
20
use Drupal\Core\StreamWrapper\PrivateStream;
21
use Drupal\Core\StreamWrapper\PublicStream;
22
use Drupal\Core\StringTranslation\PluralTranslatableMarkup;
23 24
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\Url;
25
use Symfony\Component\HttpFoundation\Request;
26

27
/**
28
 * Implements hook_requirements().
29 30
 */
function system_requirements($phase) {
31
  global $install_state;
32 33 34
  // Reset the extension lists.
  \Drupal::service('extension.list.module')->reset();
  \Drupal::service('extension.list.theme')->reset();
35
  $requirements = [];
36 37 38

  // Report Drupal version
  if ($phase == 'runtime') {
39
    $requirements['drupal'] = [
40
      'title' => t('Drupal'),
41
      'value' => \Drupal::VERSION,
Steven Wittens's avatar
Steven Wittens committed
42 43
      'severity' => REQUIREMENT_INFO,
      'weight' => -10,
44
    ];
45

46 47
    // Display the currently active installation profile, if the site
    // is not running the default installation profile.
48
    $profile = \Drupal::installProfile();
49
    if ($profile != 'standard') {
50
      $info = \Drupal::service('extension.list.module')->getExtensionInfo($profile);
51
      $requirements['install_profile'] = [
52
        'title' => t('Installation profile'),
53
        'value' => t('%profile_name (%profile-%version)', [
54 55
          '%profile_name' => $info['name'],
          '%profile' => $profile,
56
          '%version' => $info['version'],
57
        ]),
58
        'severity' => REQUIREMENT_INFO,
59
        'weight' => -9,
60
      ];
61
    }
62 63

    // Warn if any experimental modules are installed.
64
    $experimental_modules = [];
65
    $enabled_modules = \Drupal::moduleHandler()->getModuleList();
66
    foreach ($enabled_modules as $module => $data) {
67
      $info = \Drupal::service('extension.list.module')->getExtensionInfo($module);
68
      if (isset($info['package']) && $info['package'] === 'Core (Experimental)') {
69
        $experimental_modules[$module] = $info['name'];
70 71
      }
    }
72 73
    if (!empty($experimental_modules)) {
      $requirements['experimental_modules'] = [
74
        'title' => t('Experimental modules enabled'),
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
        'value' => t('Experimental modules found: %module_list. <a href=":url">Experimental modules</a> are provided for testing purposes only. Use at your own risk.', ['%module_list' => implode(', ', $experimental_modules), ':url' => 'https://www.drupal.org/core/experimental']),
        'severity' => REQUIREMENT_WARNING,
      ];
    }
    // Warn if any experimental themes are installed.
    $experimental_themes = [];
    $installed_themes = \Drupal::service('theme_handler')->listInfo();
    foreach ($installed_themes as $theme => $data) {
      if (isset($data->info['experimental']) && $data->info['experimental']) {
        $experimental_themes[$theme] = $data->info['name'];
      }
    }
    if (!empty($experimental_themes)) {
      $requirements['experimental_themes'] = [
        'title' => t('Experimental themes enabled'),
        'value' => t('Experimental themes found: %theme_list. Experimental themes are provided for testing purposes only. Use at your own risk.', ['%theme_list' => implode(', ', $experimental_themes)]),
91
        'severity' => REQUIREMENT_WARNING,
92
      ];
93
    }
94 95
  }

96
  // Web server information.
97 98
  $request_object = \Drupal::request();
  $software = $request_object->server->get('SERVER_SOFTWARE');
99
  $requirements['webserver'] = [
100
    'title' => t('Web server'),
Steven Wittens's avatar
Steven Wittens committed
101
    'value' => $software,
102
  ];
103

104
  // Tests clean URL support.
105
  if ($phase == 'install' && $install_state['interactive'] && !$request_object->query->has('rewrite') && strpos($software, 'Apache') !== FALSE) {
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
    // 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;
      }
129
      elseif ($matches[1] == 2) {
130 131 132
        if (!isset($matches[2])) {
          $rewrite_warning = TRUE;
        }
133
        elseif ($matches[2] < 2) {
134 135
          $rewrite_error = TRUE;
        }
136
        elseif ($matches[2] == 2) {
137 138 139
          if (!isset($matches[3])) {
            $rewrite_warning = TRUE;
          }
140
          elseif ($matches[3] < 16) {
141 142 143 144 145 146 147 148 149 150
            $rewrite_error = TRUE;
          }
        }
      }
    }
    else {
      $rewrite_warning = TRUE;
    }

    if ($rewrite_warning) {
151
      $requirements['apache_version'] = [
152 153 154
        'title' => t('Apache version'),
        'value' => $apache_version_string,
        'severity' => REQUIREMENT_WARNING,
155 156
        '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.', ['@reported' => $apache_version_string]),
      ];
157 158 159
    }

    if ($rewrite_error) {
160
      $requirements['Apache version'] = [
161 162 163
        'title' => t('Apache version'),
        'value' => $apache_version_string,
        'severity' => REQUIREMENT_ERROR,
164
        '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.', [':link' => 'http://drupal.org/docs/8/clean-urls-in-drupal-8']),
165
      ];
166 167 168
    }

    if (!$rewrite_error && !$rewrite_warning) {
169
      $requirements['rewrite_module'] = [
170 171 172
        'title' => t('Clean URLs'),
        'value' => t('Disabled'),
        'severity' => REQUIREMENT_WARNING,
173
        '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>', [':link' => 'http://drupal.org/docs/8/clean-urls-in-drupal-8']),
174
      ];
175 176 177
    }
  }

178 179 180 181 182
  // Verify the user is running a supported PHP version.
  // If the site is running a recommended version of PHP, just display it
  // as an informational message on the status report. This will be overridden
  // with an error or warning if the site is running older PHP versions for
  // which Drupal has already or will soon drop support.
183
  $phpversion = $phpversion_label = phpversion();
184
  if (function_exists('phpinfo')) {
185
    if ($phase === 'runtime') {
186
      $phpversion_label = t('@phpversion (<a href=":url">more information</a>)', ['@phpversion' => $phpversion, ':url' => (new Url('system.php'))->toString()]);
187
    }
188
    $requirements['php'] = [
189
      'title' => t('PHP'),
190
      'value' => $phpversion_label,
191
    ];
192 193
  }
  else {
194 195
    // @todo Revisit whether this description makes sense in
    //   https://www.drupal.org/project/drupal/issues/2927318.
196
    $requirements['php'] = [
197
      'title' => t('PHP'),
198
      'value' => $phpversion_label,
199
      '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.', [':phpinfo' => 'https://www.drupal.org/node/243993']),
200
      'severity' => REQUIREMENT_INFO,
201
    ];
202 203
  }

204 205 206 207 208 209 210 211 212
  // Check if the PHP version is below what Drupal supports.
  if (version_compare($phpversion, DRUPAL_MINIMUM_SUPPORTED_PHP) < 0) {
    $requirements['php']['description'] = t('Your PHP installation is too old. Drupal requires at least PHP %version. It is recommended to upgrade to PHP version %recommended or higher for the best ongoing support. See <a href="http://php.net/supported-versions.php">PHP\'s version support documentation</a> and the <a href=":php_requirements">Drupal 8 PHP requirements handbook page</a> for more information.',
      [
        '%version' => DRUPAL_MINIMUM_SUPPORTED_PHP,
        '%recommended' => DRUPAL_RECOMMENDED_PHP,
        ':php_requirements' => 'https://www.drupal.org/docs/8/system-requirements/php',
      ]
    );
213
    $requirements['php']['severity'] = REQUIREMENT_ERROR;
214 215 216 217 218 219 220 221 222 223

    // If the PHP version is also below the absolute minimum allowed, it's not
    // safe to continue with the requirements check.
    if (version_compare($phpversion, DRUPAL_MINIMUM_PHP) < 0) {
      return $requirements;
    }
    // Otherwise downgrade the error to a warning during updates. Even if there
    // are some problems with the site's PHP version, it's still better for the
    // site to keep its Drupal codebase up to date.
    elseif ($phase === 'update') {
224 225
      $requirements['php']['severity'] = REQUIREMENT_WARNING;
    }
226 227 228 229 230 231 232
    // Since we allow sites with unsupported PHP versions to still run Drupal
    // updates, we also need to be able to run tests with those PHP versions,
    // which requires the ability to install test sites. Not all tests are
    // required to pass on these PHP versions, but we want to monitor which
    // ones do and don't.
    elseif ($phase === 'install' && drupal_valid_test_ua()) {
      $requirements['php']['severity'] = REQUIREMENT_INFO;
233
    }
234
  }
235 236 237 238 239 240
  // For PHP versions that are still supported but no longer recommended,
  // inform users of what's recommended, allowing them to take action before it
  // becomes urgent.
  elseif ($phase === 'runtime' && version_compare($phpversion, DRUPAL_RECOMMENDED_PHP) < 0) {
    $requirements['php']['description'] = t('It is recommended to upgrade to PHP version %recommended or higher for the best ongoing support.  See <a href="http://php.net/supported-versions.php">PHP\'s version support documentation</a> and the <a href=":php_requirements">Drupal 8 PHP requirements handbook page</a> for more information.', ['%recommended' => DRUPAL_RECOMMENDED_PHP, ':php_requirements' => 'https://www.drupal.org/docs/8/system-requirements/php']);
    $requirements['php']['severity'] = REQUIREMENT_INFO;
241 242
  }

243
  // Test for PHP extensions.
244
  $requirements['php_extensions'] = [
245
    'title' => t('PHP extensions'),
246
  ];
247

248 249
  $missing_extensions = [];
  $required_extensions = [
250 251 252 253 254 255 256 257 258 259 260
    'date',
    'dom',
    'filter',
    'gd',
    'hash',
    'json',
    'pcre',
    'pdo',
    'session',
    'SimpleXML',
    'SPL',
261
    'tokenizer',
262
    'xml',
263
  ];
264 265 266 267 268 269 270
  foreach ($required_extensions as $extension) {
    if (!extension_loaded($extension)) {
      $missing_extensions[] = $extension;
    }
  }

  if (!empty($missing_extensions)) {
271
    $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):', [
272
      ':system_requirements' => 'https://www.drupal.org/requirements',
273
    ]);
274

275
    // We use twig inline_template to avoid twig's autoescape.
276
    $description = [
277 278
      '#type' => 'inline_template',
      '#template' => '{{ description }}{{ missing_extensions }}',
279
      '#context' => [
280
        'description' => $description,
281
        'missing_extensions' => [
282 283
          '#theme' => 'item_list',
          '#items' => $missing_extensions,
284 285 286
        ],
      ],
    ];
287

288
    $requirements['php_extensions']['value'] = t('Disabled');
289 290
    $requirements['php_extensions']['severity'] = REQUIREMENT_ERROR;
    $requirements['php_extensions']['description'] = $description;
291 292
  }
  else {
293
    $requirements['php_extensions']['value'] = t('Enabled');
294 295 296 297
  }

  if ($phase == 'install' || $phase == 'runtime') {
    // Check to see if OPcache is installed.
298
    if (!OpCodeCache::isEnabled()) {
299
      $requirements['php_opcache'] = [
300 301
        'value' => t('Not enabled'),
        'severity' => REQUIREMENT_WARNING,
302
        '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.'),
303
      ];
304 305 306 307 308
    }
    else {
      $requirements['php_opcache']['value'] = t('Enabled');
    }
    $requirements['php_opcache']['title'] = t('PHP OPcode caching');
309
  }
310

311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
  // Check to see if APCu is installed and configured correctly.
  if ($phase == 'runtime' && PHP_SAPI != 'cli') {
    $requirements['php_apcu']['title'] = t('PHP APCu caching');
    if (extension_loaded('apcu') && filter_var(ini_get('apc.enabled'), FILTER_VALIDATE_BOOLEAN)) {
      $memory_info = apcu_sma_info(TRUE);
      $apcu_actual_size = format_size($memory_info['seg_size']);
      $apcu_recommended_size = '32 MB';
      $requirements['php_apcu']['value'] = t('Enabled (@size)', ['@size' => $apcu_actual_size]);
      if (Bytes::toInt($apcu_actual_size) < Bytes::toInt($apcu_recommended_size)) {
        $requirements['php_apcu']['severity'] = REQUIREMENT_WARNING;
        $requirements['php_apcu']['description'] = t('Depending on your configuration, Drupal can run with a @apcu_size APCu limit. However, a @apcu_default_size APCu limit (the default) or above is recommended, especially if your site uses additional custom or contributed modules.', [
          '@apcu_size' => $apcu_actual_size,
          '@apcu_default_size' => $apcu_recommended_size,
        ]);
      }
      else {
        $memory_available = $memory_info['avail_mem'] / $memory_info['seg_size'];
        if ($memory_available < 0.1) {
          $requirements['php_apcu']['severity'] = REQUIREMENT_ERROR;
        }
        elseif ($memory_available < 0.25) {
          $requirements['php_apcu']['severity'] = REQUIREMENT_WARNING;
        }
        else {
          $requirements['php_apcu']['severity'] = REQUIREMENT_OK;
        }
        $requirements['php_apcu']['description'] = t('Memory available: @available.', [
          '@available' => format_size($memory_info['avail_mem']),
        ]);
      }
    }
    else {
      $requirements['php_apcu'] += [
        'value' => t('Not enabled'),
        'severity' => REQUIREMENT_INFO,
        'description' => t('PHP APCu caching can improve your site\'s performance considerably. It is <strong>highly recommended</strong> to have <a href="https://www.php.net/manual/apcu.installation.php" target="_blank">APCu</a> installed on your server.'),
      ];
    }
  }

351 352
  if ($phase != 'update') {
    // Test whether we have a good source of random bytes.
353
    $requirements['php_random_bytes'] = [
354
      'title' => t('Random number generation'),
355
    ];
356 357 358
    try {
      $bytes = random_bytes(10);
      if (strlen($bytes) != 10) {
359
        throw new \Exception(t('Tried to generate 10 random bytes, generated @count', ['@count' => strlen($bytes)]));
360 361 362 363 364 365 366 367 368 369 370
      }
      $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);
371
          $open_basedir_blocks_urandom = !array_intersect(['/dev', '/dev/', '/dev/urandom'], $open_basedir_paths);
372 373
        }
      }
374
      $args = [
375
        ':drupal-php' => 'https://www.drupal.org/docs/8/system-requirements/php-requirements',
376
        '%exception_message' => $e->getMessage(),
377
      ];
378 379 380 381 382 383 384 385 386 387 388
      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;
    }
  }

389 390
  if ($phase == 'install' || $phase == 'update') {
    // Test for PDO (database).
391
    $requirements['database_extensions'] = [
392
      'title' => t('Database support'),
393
    ];
394

395
    // Make sure PDO is available.
396
    $database_ok = extension_loaded('pdo');
397
    if (!$database_ok) {
398
      $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.', [
399
        ':link' => 'https://www.drupal.org/requirements/pdo',
400
      ]);
401 402 403
    }
    else {
      // Make sure at least one supported database driver exists.
404
      $drivers = drupal_detect_database_types();
405 406
      if (empty($drivers)) {
        $database_ok = FALSE;
407
        $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>.', [
408
          ':drupal-databases' => 'https://www.drupal.org/requirements/database',
409
        ]);
410 411 412 413 414
      }
      // 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;
415
        $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.', [
416
          ':link' => 'https://www.drupal.org/requirements/pdo#pecl',
417
        ]);
418
      }
419
    }
420

421
    if (!$database_ok) {
422
      $requirements['database_extensions']['value'] = t('Disabled');
423
      $requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
424
      $requirements['database_extensions']['description'] = $pdo_message;
425 426
    }
    else {
427
      $requirements['database_extensions']['value'] = t('Enabled');
428
    }
429
  }
430 431

  if ($phase === 'runtime' || $phase === 'update') {
432
    // Database information.
433
    $class = Database::getConnection()->getDriverClass('Install\\Tasks');
434
    /** @var \Drupal\Core\Database\Install\Tasks $tasks */
435
    $tasks = new $class();
436
    $requirements['database_system'] = [
437
      'title' => t('Database system'),
438
      'value' => $tasks->name(),
439 440
    ];
    $requirements['database_system_version'] = [
441
      'title' => t('Database system version'),
442
      'value' => Database::getConnection()->version(),
443
    ];
444 445 446 447 448 449 450 451 452 453 454 455 456

    $errors = $tasks->engineVersionRequirementsCheck();
    $error_count = count($errors);
    if ($error_count > 0) {
      $error_message = [
        '#theme' => 'item_list',
        '#items' => $errors,
        // Use the comma-list style to display a single error without bullets.
        '#context' => ['list_style' => $error_count === 1 ? 'comma-list' : ''],
      ];
      $requirements['database_system_version']['severity'] = REQUIREMENT_ERROR;
      $requirements['database_system_version']['description'] = $error_message;
    }
457
  }
458

459
  // Test PHP memory_limit
460
  $memory_limit = ini_get('memory_limit');
461
  $requirements['php_memory_limit'] = [
462
    'title' => t('PHP memory limit'),
463
    'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
464
  ];
465

466
  if (!Environment::checkMemoryLimit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
467
    $description = [];
468
    if ($phase == 'install') {
469
      $description['phase'] = t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the installation process.', ['%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT]);
470 471
    }
    elseif ($phase == 'update') {
472
      $description['phase'] = t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the update process.', ['%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT]);
473
    }
474
    elseif ($phase == 'runtime') {
475
      $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.', ['%memory_limit' => $memory_limit, '%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT]);
476
    }
477

478
    if (!empty($description['phase'])) {
479
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
480
        $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).', ['%configuration-file' => $php_ini_path]);
481 482
      }
      else {
483
        $description['memory'] = t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
484
      }
485

486
      $handbook_link = t('For more information, see the online handbook entry for <a href=":memory-limit">increasing the PHP memory limit</a>.', [':memory-limit' => 'https://www.drupal.org/node/207036']);
487

488
      $description = [
489 490
        '#type' => 'inline_template',
        '#template' => '{{ description_phase }} {{ description_memory }} {{ handbook }}',
491
        '#context' => [
492 493 494
          'description_phase' => $description['phase'],
          'description_memory' => $description['memory'],
          'handbook' => $handbook_link,
495 496
        ],
      ];
497 498

      $requirements['php_memory_limit']['description'] = $description;
499
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
500
    }
501
  }
502

503
  // Test configuration files and directory for writability.
504
  if ($phase == 'runtime') {
505
    $conf_errors = [];
506 507 508
    // Find the site path. Kernel service is not always available at this point,
    // but is preferred, when available.
    if (\Drupal::hasService('kernel')) {
509
      $site_path = \Drupal::getContainer()->getParameter('site.path');
510 511 512 513
    }
    else {
      $site_path = DrupalKernel::findSitePath(Request::createFromGlobals());
    }
514 515 516 517
    // 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')) {
518
      $error_value = t('Protection disabled');
519 520 521 522 523
      // 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 {
524
      $error_value = t('Not protected');
525 526 527
      // 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')) {
528
        $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.", ['%file' => $site_path]);
529
      }
530
    }
531
    foreach (['settings.php', 'settings.local.php', 'services.yml'] as $conf_file) {
532
      $full_path = $site_path . '/' . $conf_file;
533
      if (file_exists($full_path) && !drupal_verify_install_file($full_path, FILE_EXIST | FILE_READABLE | FILE_NOT_WRITABLE, 'file', !Settings::get('skip_permissions_hardening'))) {
534
        $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.", ['%file' => $full_path]);
535 536 537 538 539 540 541
      }
    }
    if (!empty($conf_errors)) {
      if (count($conf_errors) == 1) {
        $description = $conf_errors[0];
      }
      else {
542
        // We use twig inline_template to avoid double escaping.
543
        $description = [
544 545
          '#type' => 'inline_template',
          '#template' => '{{ configuration_error_list }}',
546 547
          '#context' => [
            'configuration_error_list' => [
548 549
              '#theme' => 'item_list',
              '#items' => $conf_errors,
550 551 552
            ],
          ],
        ];
553
      }
554
      $requirements['configuration_files'] = [
555
        'value' => $error_value,
556
        'severity' => $file_protection_severity,
557
        'description' => $description,
558
      ];
559 560
    }
    else {
561
      $requirements['configuration_files'] = [
562
        'value' => t('Protected'),
563
      ];
564
    }
565
    $requirements['configuration_files']['title'] = t('Configuration files');
566 567
  }

568 569 570 571
  // 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.
572 573 574 575 576
    /** @var \Drupal\Core\File\HtaccessWriterInterface $htaccessWriter */
    $htaccessWriter = \Drupal::service("file.htaccess_writer");
    $htaccessWriter->ensure();
    foreach ($htaccessWriter->defaultProtectedDirs() as $protected_dir) {
      $htaccess_file = $protected_dir->getPath() . '/.htaccess';
577 578 579
      // 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) {
580
        $url = 'https://www.drupal.org/SA-CORE-2013-003';
581
        $requirements[$htaccess_file] = [
582
          'title' => new TranslatableMarkup($protected_dir->getTitle()),
583 584
          'value' => t('Not fully protected'),
          'severity' => REQUIREMENT_ERROR,
585
          '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.', [':url' => $url, '@url' => $url, '%directory' => $protected_dir->getPath()]),
586
        ];
587 588 589 590
      }
    }
  }

591
  // Report cron status.
592
  if ($phase == 'runtime') {
593
    $cron_config = \Drupal::config('system.cron');
594
    // Cron warning threshold defaults to two days.
595
    $threshold_warning = $cron_config->get('threshold.requirements_warning');
596
    // Cron error threshold defaults to two weeks.
597
    $threshold_error = $cron_config->get('threshold.requirements_error');
598

599
    // Determine when cron last ran.
600
    $cron_last = \Drupal::state()->get('system.cron_last');
601
    if (!is_numeric($cron_last)) {
602
      $cron_last = \Drupal::state()->get('install_time', 0);
603
    }
604

605
    // Determine severity based on time since cron last ran.
606
    $severity = REQUIREMENT_INFO;
607
    if (REQUEST_TIME - $cron_last > $threshold_error) {
608
      $severity = REQUIREMENT_ERROR;
609
    }
610
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
611 612 613 614
      $severity = REQUIREMENT_WARNING;
    }

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

617
    $requirements['cron'] = [
618
      'title' => t('Cron maintenance tasks'),
619 620
      'severity' => $severity,
      'value' => $summary,
621
    ];
622 623 624 625 626 627 628
    if ($severity != REQUIREMENT_INFO) {
      $requirements['cron']['description'][] = [
        [
          '#markup' => t('Cron has not run recently.'),
          '#suffix' => ' ',
        ],
        [
629
          '#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']),
630 631 632 633 634 635
          '#suffix' => ' ',
        ],
      ];
    }
    $requirements['cron']['description'][] = [
      [
636 637 638 639 640
        '#type' => 'link',
        '#prefix' => '(',
        '#title' => t('more information'),
        '#suffix' => ')',
        '#url' => Url::fromRoute('system.cron_settings'),
641 642
      ],
      [
643 644 645 646 647
        '#prefix' => '<span class="cron-description__run-cron">',
        '#suffix' => '</span>',
        '#type' => 'link',
        '#title' => t('Run cron'),
        '#url' => Url::fromRoute('system.run_cron'),
648 649
      ],
    ];
650
  }
651
  if ($phase != 'install') {
652
    $filesystem_config = \Drupal::config('system.file');
653
    $directories = [
654
      PublicStream::basePath(),
655 656
      // By default no private files directory is configured. For private files
      // to be secure the admin needs to provide a path outside the webroot.
657
      PrivateStream::basePath(),
658
      \Drupal::service('file_system')->getTempDirectory(),
659
    ];
660
  }
661

662 663
  // During an install we need to make assumptions about the file system
  // unless overrides are provided in settings.php.
664
  if ($phase == 'install') {
665
    $directories = [];
666
    if ($file_public_path = Settings::get('file_public_path')) {
667
      $directories[] = $file_public_path;
668 669 670
    }
    else {
      // If we are installing Drupal, the settings.php file might not exist yet
671
      // in the intended site directory, so don't require it.
672 673 674
      $request = Request::createFromGlobals();
      $site_path = DrupalKernel::findSitePath($request);
      $directories[] = $site_path . '/files';
675
    }
676 677
    if ($file_private_path = Settings::get('file_private_path')) {
      $directories[] = $file_private_path;
678
    }
679 680
    if (Settings::get('file_temp_path')) {
      $directories[] = Settings::get('file_temp_path');
681 682 683 684
    }
    else {
      // If the temporary directory is not overridden use an appropriate
      // temporary path for the system.
685
      $directories[] = FileSystemComponent::getOsTemporaryDirectory();
686
    }
687 688
  }

689 690 691
  // 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.
692 693 694 695 696 697 698 699 700
  $config_sync_directory = Settings::get('config_sync_directory');
  if (!empty($config_sync_directory)) {
    // If we're installing Drupal try and create the config sync directory.
    if (!is_dir($config_sync_directory) && $phase == 'install') {
      \Drupal::service('file_system')->prepareDirectory($config_sync_directory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
    }
    if (!is_dir($config_sync_directory)) {
      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>.', ['%directory' => $config_sync_directory, ':handbook_url' => 'https://www.drupal.org/server-permissions']);
701
      }
702 703
      else {
        $description = t('The directory %directory does not exist.', ['%directory' => $config_sync_directory]);
704
      }
705 706 707 708 709
      $requirements['config sync directory'] = [
        'title' => t('Configuration sync directory'),
        'description' => $description,
        'severity' => REQUIREMENT_ERROR,
      ];
710
    }
711
  }
712 713 714
  if ($phase != 'install' && empty($config_sync_directory)) {
    $requirements['config sync directory'] = [
      'title' => t('Configuration sync directory'),
715
      'value' => t('Not present'),
716
      'description' => t("Your %file file must define the %setting setting as a string containing the directory in which configuration files can be found.", ['%file' => $site_path . '/settings.php', '%setting' => "\$settings['config_sync_directory']"]),
717
      'severity' => REQUIREMENT_ERROR,
718
    ];
719 720
  }

721
  $requirements['file system'] = [
722
    'title' => t('File system'),
723
  ];
724

725 726 727
  $error = '';
  // For installer, create the directories if possible.
  foreach ($directories as $directory) {
728 729 730
    if (!$directory) {
      continue;
    }
731
    if ($phase == 'install') {
732
      \Drupal::service('file_system')->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
733
    }
734 735 736 737
    $is_writable = is_writable($directory);
    $is_directory = is_dir($directory);
    if (!$is_writable || !$is_directory) {
      $description = '';
738
      $requirements['file system']['value'] = t('Not writable');
739
      if (!$is_directory) {
740
        $error = t('The directory %directory does not exist.', ['%directory' => $directory]);
741 742
      }
      else {
743
        $error = t('The directory %directory is not writable.', ['%directory' => $directory]);
744 745 746
      }
      // The files directory requirement check is done only during install and runtime.
      if ($phase == 'runtime') {
747
        $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.', [':admin-file-system' => Url::fromRoute('system.file_system_settings')->toString()]);
748 749 750 751
      }
      elseif ($phase == 'install') {
        // For the installer UI, we need different wording. 'value' will
        // be treated as version, so provide none there.
752
        $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>.', [':handbook_url' => 'https://www.drupal.org/server-permissions']);