system.install 97.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\FileSystem\FileSystem;
11
use Drupal\Component\Utility\OpCodeCache;
12
use Drupal\Component\Utility\Unicode;
13
use Drupal\Core\Cache\Cache;
14
use Drupal\Core\File\FileSystemInterface;
15
use Drupal\Core\Path\AliasStorage;
16
use Drupal\Core\Url;
17
use Drupal\Core\Database\Database;
18 19 20
use Drupal\Core\Entity\ContentEntityTypeInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Entity\FieldableEntityInterface;
21
use Drupal\Core\DrupalKernel;
22
use Drupal\Core\Extension\Extension;
23
use Drupal\Core\Field\BaseFieldDefinition;
24
use Drupal\Core\Site\Settings;
25
use Drupal\Core\StreamWrapper\PrivateStream;
26
use Drupal\Core\StreamWrapper\PublicStream;
27
use Symfony\Component\HttpFoundation\Request;
28

29
/**
30
 * Implements hook_requirements().
31 32
 */
function system_requirements($phase) {
33
  global $install_state;
34
  $requirements = [];
35 36 37

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

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

    // Warn if any experimental modules are installed.
63
    $experimental = [];
64
    $enabled_modules = \Drupal::moduleHandler()->getModuleList();
65
    foreach ($enabled_modules as $module => $data) {
66
      $info = system_get_info('module', $module);
67
      if (isset($info['package']) && $info['package'] === 'Core (Experimental)') {
68
        $experimental[$module] = $info['name'];
69 70 71
      }
    }
    if (!empty($experimental)) {
72
      $requirements['experimental'] = [
73
        'title' => t('Experimental modules enabled'),
74
        '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), ':url' => 'https://www.drupal.org/core/experimental']),
75
        'severity' => REQUIREMENT_WARNING,
76
      ];
77
    }
78 79
  }

80
  // Web server information.
81 82
  $request_object = \Drupal::request();
  $software = $request_object->server->get('SERVER_SOFTWARE');
83
  $requirements['webserver'] = [
84
    'title' => t('Web server'),
Steven Wittens's avatar
Steven Wittens committed
85
    'value' => $software,
86
  ];
87

88
  // Tests clean URL support.
89
  if ($phase == 'install' && $install_state['interactive'] && !$request_object->query->has('rewrite') && strpos($software, 'Apache') !== FALSE) {
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
    // 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;
      }
113
      elseif ($matches[1] == 2) {
114 115 116
        if (!isset($matches[2])) {
          $rewrite_warning = TRUE;
        }
117
        elseif ($matches[2] < 2) {
118 119
          $rewrite_error = TRUE;
        }
120
        elseif ($matches[2] == 2) {
121 122 123
          if (!isset($matches[3])) {
            $rewrite_warning = TRUE;
          }
124
          elseif ($matches[3] < 16) {
125 126 127 128 129 130 131 132 133 134
            $rewrite_error = TRUE;
          }
        }
      }
    }
    else {
      $rewrite_warning = TRUE;
    }

    if ($rewrite_warning) {
135
      $requirements['apache_version'] = [
136 137 138
        'title' => t('Apache version'),
        'value' => $apache_version_string,
        'severity' => REQUIREMENT_WARNING,
139 140
        '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]),
      ];
141 142 143
    }

    if ($rewrite_error) {
144
      $requirements['Apache version'] = [
145 146 147
        'title' => t('Apache version'),
        'value' => $apache_version_string,
        'severity' => REQUIREMENT_ERROR,
148
        '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']),
149
      ];
150 151 152
    }

    if (!$rewrite_error && !$rewrite_warning) {
153
      $requirements['rewrite_module'] = [
154 155 156
        'title' => t('Clean URLs'),
        'value' => t('Disabled'),
        'severity' => REQUIREMENT_WARNING,
157
        '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']),
158
      ];
159 160 161
    }
  }

162 163 164 165 166
  // 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.
167
  $phpversion = $phpversion_label = phpversion();
168
  if (function_exists('phpinfo')) {
169
    if ($phase === 'runtime') {
170
      $phpversion_label = t('@phpversion (<a href=":url">more information</a>)', ['@phpversion' => $phpversion, ':url' => (new Url('system.php'))->toString()]);
171
    }
172
    $requirements['php'] = [
173
      'title' => t('PHP'),
174
      'value' => $phpversion_label,
175
    ];
176 177
  }
  else {
178 179
    // @todo Revisit whether this description makes sense in
    //   https://www.drupal.org/project/drupal/issues/2927318.
180
    $requirements['php'] = [
181
      'title' => t('PHP'),
182
      'value' => $phpversion_label,
183
      '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']),
184
      'severity' => REQUIREMENT_INFO,
185
    ];
186 187
  }

188 189 190 191 192 193 194 195 196
  // 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',
      ]
    );
197
    $requirements['php']['severity'] = REQUIREMENT_ERROR;
198 199 200 201 202 203 204 205 206 207

    // 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') {
208 209
      $requirements['php']['severity'] = REQUIREMENT_WARNING;
    }
210 211 212 213 214 215 216
    // 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;
217
    }
218
  }
219 220 221 222 223 224
  // 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;
225 226
  }

227
  // Test for PHP extensions.
228
  $requirements['php_extensions'] = [
229
    'title' => t('PHP extensions'),
230
  ];
231

232 233
  $missing_extensions = [];
  $required_extensions = [
234 235 236 237 238 239 240 241 242 243 244
    'date',
    'dom',
    'filter',
    'gd',
    'hash',
    'json',
    'pcre',
    'pdo',
    'session',
    'SimpleXML',
    'SPL',
245
    'tokenizer',
246
    'xml',
247
  ];
248 249 250 251 252 253 254
  foreach ($required_extensions as $extension) {
    if (!extension_loaded($extension)) {
      $missing_extensions[] = $extension;
    }
  }

  if (!empty($missing_extensions)) {
255
    $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):', [
256
      ':system_requirements' => 'https://www.drupal.org/requirements',
257
    ]);
258

259
    // We use twig inline_template to avoid twig's autoescape.
260
    $description = [
261 262
      '#type' => 'inline_template',
      '#template' => '{{ description }}{{ missing_extensions }}',
263
      '#context' => [
264
        'description' => $description,
265
        'missing_extensions' => [
266 267
          '#theme' => 'item_list',
          '#items' => $missing_extensions,
268 269 270
        ],
      ],
    ];
271

272
    $requirements['php_extensions']['value'] = t('Disabled');
273 274
    $requirements['php_extensions']['severity'] = REQUIREMENT_ERROR;
    $requirements['php_extensions']['description'] = $description;
275 276
  }
  else {
277
    $requirements['php_extensions']['value'] = t('Enabled');
278 279 280 281
  }

  if ($phase == 'install' || $phase == 'runtime') {
    // Check to see if OPcache is installed.
282
    if (!OpCodeCache::isEnabled()) {
283
      $requirements['php_opcache'] = [
284 285
        'value' => t('Not enabled'),
        'severity' => REQUIREMENT_WARNING,
286
        '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.'),
287
      ];
288 289 290 291 292
    }
    else {
      $requirements['php_opcache']['value'] = t('Enabled');
    }
    $requirements['php_opcache']['title'] = t('PHP OPcode caching');
293
  }
294

295 296
  if ($phase != 'update') {
    // Test whether we have a good source of random bytes.
297
    $requirements['php_random_bytes'] = [
298
      'title' => t('Random number generation'),
299
    ];
300 301 302
    try {
      $bytes = random_bytes(10);
      if (strlen($bytes) != 10) {
303
        throw new \Exception(t('Tried to generate 10 random bytes, generated @count', ['@count' => strlen($bytes)]));
304 305 306 307 308 309 310 311 312 313 314
      }
      $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);
315
          $open_basedir_blocks_urandom = !array_intersect(['/dev', '/dev/', '/dev/urandom'], $open_basedir_paths);
316 317
        }
      }
318
      $args = [
319
        ':drupal-php' => 'https://www.drupal.org/docs/8/system-requirements/php-requirements',
320
        '%exception_message' => $e->getMessage(),
321
      ];
322 323 324 325 326 327 328 329 330 331 332
      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;
    }
  }

333 334
  if ($phase == 'install' || $phase == 'update') {
    // Test for PDO (database).
335
    $requirements['database_extensions'] = [
336
      'title' => t('Database support'),
337
    ];
338

339
    // Make sure PDO is available.
340
    $database_ok = extension_loaded('pdo');
341
    if (!$database_ok) {
342
      $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.', [
343
        ':link' => 'https://www.drupal.org/requirements/pdo',
344
      ]);
345 346 347
    }
    else {
      // Make sure at least one supported database driver exists.
348
      $drivers = drupal_detect_database_types();
349 350
      if (empty($drivers)) {
        $database_ok = FALSE;
351
        $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>.', [
352
          ':drupal-databases' => 'https://www.drupal.org/requirements/database',
353
        ]);
354 355 356 357 358
      }
      // 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;
359
        $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.', [
360
          ':link' => 'https://www.drupal.org/requirements/pdo#pecl',
361
        ]);
362
      }
363
    }
364

365
    if (!$database_ok) {
366
      $requirements['database_extensions']['value'] = t('Disabled');
367
      $requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
368
      $requirements['database_extensions']['description'] = $pdo_message;
369 370
    }
    else {
371
      $requirements['database_extensions']['value'] = t('Enabled');
372
    }
373
  }
374 375
  else {
    // Database information.
376
    $class = Database::getConnection()->getDriverClass('Install\\Tasks');
377
    $tasks = new $class();
378
    $requirements['database_system'] = [
379
      'title' => t('Database system'),
380
      'value' => $tasks->name(),
381 382
    ];
    $requirements['database_system_version'] = [
383
      'title' => t('Database system version'),
384
      'value' => Database::getConnection()->version(),
385
    ];
386
  }
387

388
  // Test PHP memory_limit
389
  $memory_limit = ini_get('memory_limit');
390
  $requirements['php_memory_limit'] = [
391
    'title' => t('PHP memory limit'),
392
    'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
393
  ];
394

395
  if (!Environment::checkMemoryLimit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
396
    $description = [];
397
    if ($phase == 'install') {
398
      $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]);
399 400
    }
    elseif ($phase == 'update') {
401
      $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]);
402
    }
403
    elseif ($phase == 'runtime') {
404
      $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]);
405
    }
406

407
    if (!empty($description['phase'])) {
408
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
409
        $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]);
410 411
      }
      else {
412
        $description['memory'] = t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
413
      }
414

415
      $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']);
416

417
      $description = [
418 419
        '#type' => 'inline_template',
        '#template' => '{{ description_phase }} {{ description_memory }} {{ handbook }}',
420
        '#context' => [
421 422 423
          'description_phase' => $description['phase'],
          'description_memory' => $description['memory'],
          'handbook' => $handbook_link,
424 425
        ],
      ];
426 427

      $requirements['php_memory_limit']['description'] = $description;
428
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
429
    }
430
  }
431

432
  // Test configuration files and directory for writability.
433
  if ($phase == 'runtime') {
434
    $conf_errors = [];
435 436 437 438 439 440 441 442
    // 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());
    }
443 444 445 446
    // 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')) {
447
      $error_value = t('Protection disabled');
448 449 450 451 452
      // 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 {
453
      $error_value = t('Not protected');
454 455 456
      // 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')) {
457
        $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]);
458
      }
459
    }
460
    foreach (['settings.php', 'settings.local.php', 'services.yml'] as $conf_file) {
461
      $full_path = $site_path . '/' . $conf_file;
462
      if (file_exists($full_path) && !drupal_verify_install_file($full_path, FILE_EXIST | FILE_READABLE | FILE_NOT_WRITABLE, 'file', !Settings::get('skip_permissions_hardening'))) {
463
        $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]);
464 465 466 467 468 469 470
      }
    }
    if (!empty($conf_errors)) {
      if (count($conf_errors) == 1) {
        $description = $conf_errors[0];
      }
      else {
471
        // We use twig inline_template to avoid double escaping.
472
        $description = [
473 474
          '#type' => 'inline_template',
          '#template' => '{{ configuration_error_list }}',
475 476
          '#context' => [
            'configuration_error_list' => [
477 478
              '#theme' => 'item_list',
              '#items' => $conf_errors,
479 480 481
            ],
          ],
        ];
482
      }
483
      $requirements['configuration_files'] = [
484
        'value' => $error_value,
485
        'severity' => $file_protection_severity,
486
        'description' => $description,
487
      ];
488 489
    }
    else {
490
      $requirements['configuration_files'] = [
491
        'value' => t('Protected'),
492
      ];
493
    }
494
    $requirements['configuration_files']['title'] = t('Configuration files');
495 496
  }

497 498 499 500
  // 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.
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
    file_ensure_htaccess();
    $file_system = \Drupal::service('file_system');
    $htaccess_files['public://.htaccess'] = [
      'title' => t('Public files directory'),
      'directory' => $file_system->realpath('public://'),
    ];
    if (PrivateStream::basePath()) {
      $htaccess_files['private://.htaccess'] = [
        'title' => t('Private files directory'),
        'directory' => $file_system->realpath('private://'),
      ];
    }
    $htaccess_files['temporary://.htaccess'] = [
      'title' => t('Temporary files directory'),
      'directory' => $file_system->realpath('temporary://'),
    ];
    foreach ($htaccess_files as $htaccess_file => $info) {
518 519 520
      // 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) {
521
        $url = 'https://www.drupal.org/SA-CORE-2013-003';
522
        $requirements[$htaccess_file] = [
523 524 525
          'title' => $info['title'],
          'value' => t('Not fully protected'),
          'severity' => REQUIREMENT_ERROR,
526 527
          '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' => $info['directory']]),
        ];
528 529 530 531
      }
    }
  }

532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
  // Test that path.temporary config is not set.
  if ($phase == 'runtime') {
    if (!Settings::get('file_temp_path')) {
      $filesystem_config = \Drupal::config('system.file');
      if ($temp_path = $filesystem_config->get('path.temporary')) {
        $requirements['temp_directory'] = [
          'title' => t('Temporary Directory'),
          'severity' => REQUIREMENT_WARNING,
          'value' => 'Deprecated configuration',
          'description' => [
            [
              '#markup' => t('You are using deprecated configuration for the temporary files path.'),
              '#suffix' => ' ',
            ],
          ],
        ];
        if ($temp_path === FileSystem::getOsTemporaryDirectory()) {
          $requirements['temp_directory']['description'][] = [
            '#markup' => t('Your temporary directory configuration matches the OS default and can be safely removed.'),
            '#suffix' => ' ',
          ];
        }
        else {
          $requirements['temp_directory']['description'][] = [
            '#markup' => t('Remove the configuration and add the following to <code>settings.php</code>. <code>$settings["file_temp_path"] = "%temp_path"', ['%temp_path' => $temp_path]),
            '#suffix' => ' ',
          ];
        }
      }
    }
  }

564
  // Report cron status.
565
  if ($phase == 'runtime') {
566
    $cron_config = \Drupal::config('system.cron');
567
    // Cron warning threshold defaults to two days.
568
    $threshold_warning = $cron_config->get('threshold.requirements_warning');
569
    // Cron error threshold defaults to two weeks.
570
    $threshold_error = $cron_config->get('threshold.requirements_error');
571

572
    // Determine when cron last ran.
573
    $cron_last = \Drupal::state()->get('system.cron_last');
574
    if (!is_numeric($cron_last)) {
575
      $cron_last = \Drupal::state()->get('install_time', 0);
576
    }
577

578
    // Determine severity based on time since cron last ran.
579
    $severity = REQUIREMENT_INFO;
580
    if (REQUEST_TIME - $cron_last > $threshold_error) {
581
      $severity = REQUIREMENT_ERROR;
582
    }
583
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
584 585 586 587
      $severity = REQUIREMENT_WARNING;
    }

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

590
    $requirements['cron'] = [
591
      'title' => t('Cron maintenance tasks'),
592 593
      'severity' => $severity,
      'value' => $summary,
594
    ];
595 596 597 598 599 600 601
    if ($severity != REQUIREMENT_INFO) {
      $requirements['cron']['description'][] = [
        [
          '#markup' => t('Cron has not run recently.'),
          '#suffix' => ' ',
        ],
        [
602
          '#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']),
603 604 605 606 607 608
          '#suffix' => ' ',
        ],
      ];
    }
    $requirements['cron']['description'][] = [
      [
609 610 611 612 613
        '#type' => 'link',
        '#prefix' => '(',
        '#title' => t('more information'),
        '#suffix' => ')',
        '#url' => Url::fromRoute('system.cron_settings'),
614 615
      ],
      [
616 617 618 619 620
        '#prefix' => '<span class="cron-description__run-cron">',
        '#suffix' => '</span>',
        '#type' => 'link',
        '#title' => t('Run cron'),
        '#url' => Url::fromRoute('system.run_cron'),
621 622
      ],
    ];
623
  }
624
  if ($phase != 'install') {
625
    $filesystem_config = \Drupal::config('system.file');
626
    $directories = [
627
      PublicStream::basePath(),
628 629
      // By default no private files directory is configured. For private files
      // to be secure the admin needs to provide a path outside the webroot.
630
      PrivateStream::basePath(),
631
      \Drupal::service('file_system')->getTempDirectory(),
632
    ];
633
  }
634

635 636
  // During an install we need to make assumptions about the file system
  // unless overrides are provided in settings.php.
637
  if ($phase == 'install') {
638
    $directories = [];
639
    if ($file_public_path = Settings::get('file_public_path')) {
640
      $directories[] = $file_public_path;
641 642 643
    }
    else {
      // If we are installing Drupal, the settings.php file might not exist yet
644
      // in the intended site directory, so don't require it.
645 646 647
      $request = Request::createFromGlobals();
      $site_path = DrupalKernel::findSitePath($request);
      $directories[] = $site_path . '/files';
648
    }
649 650
    if ($file_private_path = Settings::get('file_private_path')) {
      $directories[] = $file_private_path;
651
    }
652 653
    if (Settings::get('file_temp_path')) {
      $directories[] = Settings::get('file_temp_path');
654 655 656 657
    }
    else {
      // If the temporary directory is not overridden use an appropriate
      // temporary path for the system.
658
      $directories[] = FileSystem::getOsTemporaryDirectory();
659
    }
660 661
  }

662 663 664
  // 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.
665 666 667 668 669 670 671 672 673
  $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']);
674
      }
675 676
      else {
        $description = t('The directory %directory does not exist.', ['%directory' => $config_sync_directory]);
677
      }
678 679 680 681 682
      $requirements['config sync directory'] = [
        'title' => t('Configuration sync directory'),
        'description' => $description,
        'severity' => REQUIREMENT_ERROR,
      ];
683
    }
684
  }
685 686 687
  if ($phase != 'install' && empty($config_sync_directory)) {
    $requirements['config sync directory'] = [
      'title' => t('Configuration sync directory'),
688
      'value' => t('Not present'),
689
      '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']"]),
690
      'severity' => REQUIREMENT_ERROR,
691
    ];
692 693
  }

694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
  // Handle other configuration directories. This will be removed in Drupal 9.
  // See https://www.drupal.org/node/3018145.
  $bc_config_directories = isset($GLOBALS['config_directories']) ? $GLOBALS['config_directories'] : [];
  unset($bc_config_directories['sync']);
  foreach (array_keys(array_filter($bc_config_directories)) as $type) {
    @trigger_error("Automatic creation of '$type' configuration directory will be removed from drupal:9.0.0. See https://www.drupal.org/node/3018145.", E_USER_DEPRECATED);
    $directory = config_get_config_directory($type);
    // If we're installing Drupal try and create the config sync directory.
    if (!is_dir($directory) && $phase == 'install') {
      \Drupal::service('file_system')->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
    }
    if (!is_dir($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' => $directory, ':handbook_url' => 'https://www.drupal.org/server-permissions']);
      }
      else {
        $description = t('The directory %directory does not exist.', ['%directory' => $directory]);
      }
      $requirements['config directory ' . $type] = [
        'title' => t('Configuration directory: %type', ['%type' => $type]),
        'description' => $description,
        'severity' => REQUIREMENT_ERROR,
      ];
    }
  }

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

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