system.install 81.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\Path\AliasStorage;
15
use Drupal\Core\Url;
16
use Drupal\Core\Database\Database;
17 18 19
use Drupal\Core\Entity\ContentEntityTypeInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Entity\FieldableEntityInterface;
20
use Drupal\Core\DrupalKernel;
21
use Drupal\Core\Field\BaseFieldDefinition;
22
use Drupal\Core\Site\Settings;
23
use Drupal\Core\StreamWrapper\PrivateStream;
24
use Drupal\Core\StreamWrapper\PublicStream;
25
use Drupal\system\SystemRequirements;
26
use Symfony\Component\HttpFoundation\Request;
27

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

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

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

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

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

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
  // 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;
      }
111
      elseif ($matches[1] == 2) {
112 113 114
        if (!isset($matches[2])) {
          $rewrite_warning = TRUE;
        }
115
        elseif ($matches[2] < 2) {
116 117
          $rewrite_error = TRUE;
        }
118
        elseif ($matches[2] == 2) {
119 120 121
          if (!isset($matches[3])) {
            $rewrite_warning = TRUE;
          }
122
          elseif ($matches[3] < 16) {
123 124 125 126 127 128 129 130 131 132
            $rewrite_error = TRUE;
          }
        }
      }
    }
    else {
      $rewrite_warning = TRUE;
    }

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

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

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

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

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

187 188 189
  // 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)) {
190
    $requirements['php'] = [
191
      'title' => t('PHP (multiple statement disabling)'),
192
      'value' => $phpversion_label,
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 197
  }

198
  // Test for PHP extensions.
199
  $requirements['php_extensions'] = [
200
    'title' => t('PHP extensions'),
201
  ];
202

203 204
  $missing_extensions = [];
  $required_extensions = [
205 206 207 208 209 210 211 212 213 214 215
    'date',
    'dom',
    'filter',
    'gd',
    'hash',
    'json',
    'pcre',
    'pdo',
    'session',
    'SimpleXML',
    'SPL',
216
    'tokenizer',
217
    'xml',
218
  ];
219 220 221 222 223 224 225
  foreach ($required_extensions as $extension) {
    if (!extension_loaded($extension)) {
      $missing_extensions[] = $extension;
    }
  }

  if (!empty($missing_extensions)) {
226
    $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):', [
227
      ':system_requirements' => 'https://www.drupal.org/requirements',
228
    ]);
229

230
    // We use twig inline_template to avoid twig's autoescape.
231
    $description = [
232 233
      '#type' => 'inline_template',
      '#template' => '{{ description }}{{ missing_extensions }}',
234
      '#context' => [
235
        'description' => $description,
236
        'missing_extensions' => [
237 238
          '#theme' => 'item_list',
          '#items' => $missing_extensions,
239 240 241
        ],
      ],
    ];
242

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

  if ($phase == 'install' || $phase == 'runtime') {
    // Check to see if OPcache is installed.
253
    if (!OpCodeCache::isEnabled()) {
254
      $requirements['php_opcache'] = [
255 256
        'value' => t('Not enabled'),
        'severity' => REQUIREMENT_WARNING,
257
        '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.'),
258
      ];
259 260 261 262 263
    }
    else {
      $requirements['php_opcache']['value'] = t('Enabled');
    }
    $requirements['php_opcache']['title'] = t('PHP OPcode caching');
264
  }
265

266 267
  if ($phase != 'update') {
    // Test whether we have a good source of random bytes.
268
    $requirements['php_random_bytes'] = [
269
      'title' => t('Random number generation'),
270
    ];
271 272 273
    try {
      $bytes = random_bytes(10);
      if (strlen($bytes) != 10) {
274
        throw new \Exception(t('Tried to generate 10 random bytes, generated @count', ['@count' => strlen($bytes)]));
275 276 277 278 279 280 281 282 283 284 285
      }
      $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);
286
          $open_basedir_blocks_urandom = !array_intersect(['/dev', '/dev/', '/dev/urandom'], $open_basedir_paths);
287 288
        }
      }
289
      $args = [
290 291
        ':drupal-php' => 'https://www.drupal.org/docs/7/system-requirements/php#csprng',
        '%exception_message' => $e->getMessage(),
292
      ];
293 294 295 296 297 298 299 300 301 302 303
      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;
    }
  }

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

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

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

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

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

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

386
      $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']);
387

388
      $description = [
389 390
        '#type' => 'inline_template',
        '#template' => '{{ description_phase }} {{ description_memory }} {{ handbook }}',
391
        '#context' => [
392 393 394
          'description_phase' => $description['phase'],
          'description_memory' => $description['memory'],
          'handbook' => $handbook_link,
395 396
        ],
      ];
397 398

      $requirements['php_memory_limit']['description'] = $description;
399
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
400
    }
401
  }
402

403
  // Test configuration files and directory for writability.
404
  if ($phase == 'runtime') {
405
    $conf_errors = [];
406 407 408 409 410 411 412 413
    // 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());
    }
414 415 416 417 418 419 420 421 422 423 424 425 426
    // 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')) {
427
        $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]);
428
      }
429
    }
430
    foreach (['settings.php', 'settings.local.php', 'services.yml'] as $conf_file) {
431
      $full_path = $site_path . '/' . $conf_file;
432
      if (file_exists($full_path) && (Settings::get('skip_permissions_hardening') || !drupal_verify_install_file($full_path, FILE_EXIST | FILE_READABLE | FILE_NOT_WRITABLE))) {
433
        $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]);
434 435 436 437 438 439 440
      }
    }
    if (!empty($conf_errors)) {
      if (count($conf_errors) == 1) {
        $description = $conf_errors[0];
      }
      else {
441
        // We use twig inline_template to avoid double escaping.
442
        $description = [
443 444
          '#type' => 'inline_template',
          '#template' => '{{ configuration_error_list }}',
445 446
          '#context' => [
            'configuration_error_list' => [
447 448
              '#theme' => 'item_list',
              '#items' => $conf_errors,
449 450 451
            ],
          ],
        ];
452
      }
453
      $requirements['configuration_files'] = [
454
        'value' => t('Not protected'),
455
        'severity' => $file_protection_severity,
456
        'description' => $description,
457
      ];
458 459
    }
    else {
460
      $requirements['configuration_files'] = [
461
        'value' => t('Protected'),
462
      ];
463
    }
464
    $requirements['configuration_files']['title'] = t('Configuration files');
465 466
  }

467 468 469 470 471
  // 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();
472
    $file_system = \Drupal::service('file_system');
473
    $htaccess_files['public://.htaccess'] = [
474
      'title' => t('Public files directory'),
475
      'directory' => $file_system->realpath('public://'),
476
    ];
477
    if (PrivateStream::basePath()) {
478
      $htaccess_files['private://.htaccess'] = [
479
        'title' => t('Private files directory'),
480
        'directory' => $file_system->realpath('private://'),
481
      ];
482
    }
483
    $htaccess_files['temporary://.htaccess'] = [
484
      'title' => t('Temporary files directory'),
485
      'directory' => $file_system->realpath('temporary://'),
486
    ];
487 488 489 490
    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) {
491
        $url = 'https://www.drupal.org/SA-CORE-2013-003';
492
        $requirements[$htaccess_file] = [
493 494 495
          'title' => $info['title'],
          'value' => t('Not fully protected'),
          'severity' => REQUIREMENT_ERROR,
496 497
          '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']]),
        ];
498 499 500 501
      }
    }
  }

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

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

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

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

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

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

600 601 602
  // 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.
603
  if (!empty($GLOBALS['config_directories'])) {
604 605
    foreach (array_keys(array_filter($GLOBALS['config_directories'])) as $type) {
      $directory = config_get_config_directory($type);
606 607 608 609
      // 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);
      }
610
      if (!is_dir($directory)) {
611
        if ($phase == 'install') {
612
          $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']);
613 614
        }
        else {
615
          $description = t('The directory %directory does not exist.', ['%directory' => $directory]);
616
        }
617
        $requirements['config directory ' . $type] = [
618
          'title' => t('Configuration directory: %type', ['%type' => $type]),
619
          'description' => $description,
620
          'severity' => REQUIREMENT_ERROR,
621
        ];
622
      }
623
    }
624
  }
625
  if ($phase != 'install' && (empty($GLOBALS['config_directories']) || empty($GLOBALS['config_directories'][CONFIG_SYNC_DIRECTORY]))) {
626
    $requirements['config directories'] = [
627 628
      'title' => t('Configuration directories'),
      'value' => t('Not present'),
629
      '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.', ['%file' => $site_path . '/settings.php', '%sync_key' => CONFIG_SYNC_DIRECTORY]),
630
      'severity' => REQUIREMENT_ERROR,
631
    ];
632 633
  }

634
  $requirements['file system'] = [
635
    'title' => t('File system'),
636
  ];
637

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