system.install 65.1 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\Core\Path\AliasStorage;
13
use Drupal\Core\Url;
14
use Drupal\Core\Database\Database;
15
use Drupal\Core\DrupalKernel;
16
use Drupal\Core\Site\Settings;
17
use Drupal\Core\StreamWrapper\PrivateStream;
18
use Drupal\Core\StreamWrapper\PublicStream;
19
use Drupal\system\SystemRequirements;
20
use Symfony\Component\HttpFoundation\Request;
21

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

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

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

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

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

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

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

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

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

154
  // Test PHP version and show link to phpinfo() if it's available
155
  $phpversion = $phpversion_label = phpversion();
156
  if (function_exists('phpinfo')) {
157
    if ($phase === 'runtime') {
158
      $phpversion_label = t('@phpversion (<a href=":url">more information</a>)', ['@phpversion' => $phpversion, ':url' => (new Url('system.php'))->toString()]);
159
    }
160
    $requirements['php'] = array(
161
      'title' => t('PHP'),
162
      'value' => $phpversion_label,
163
164
165
166
    );
  }
  else {
    $requirements['php'] = array(
167
      'title' => t('PHP'),
168
      'value' => $phpversion_label,
169
      'description' => t('The phpinfo() function has been disabled for security reasons. To see your server\'s phpinfo() information, change your PHP settings or contact your server administrator. For more information, <a href=":phpinfo">Enabling and disabling phpinfo()</a> handbook page.', array(':phpinfo' => 'https://www.drupal.org/node/243993')),
170
171
172
173
      'severity' => REQUIREMENT_INFO,
    );
  }

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

181
182
183
184
185
  // 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)) {
    $requirements['php'] = array(
      'title' => t('PHP (multiple statement disabling)'),
186
      'value' => $phpversion_label,
187
188
189
190
191
      '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,
    );
  }

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

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

  if (!empty($missing_extensions)) {
220
221
    $description = t('Drupal requires you to enable the PHP extensions in the following list (see the <a href=":system_requirements">system requirements page</a> for more information):', array(
      ':system_requirements' => 'https://www.drupal.org/requirements',
222
223
    ));

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

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

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

260
261
262
  if ($phase == 'install' || $phase == 'update') {
    // Test for PDO (database).
    $requirements['database_extensions'] = array(
263
      'title' => t('Database support'),
264
    );
265

266
    // Make sure PDO is available.
267
    $database_ok = extension_loaded('pdo');
268
    if (!$database_ok) {
269
270
      $pdo_message = t('Your web server does not appear to support PDO (PHP Data Objects). Ask your hosting provider if they support the native PDO extension. See the <a href=":link">system requirements</a> page for more information.', array(
        ':link' => 'https://www.drupal.org/requirements/pdo',
271
272
273
274
      ));
    }
    else {
      // Make sure at least one supported database driver exists.
275
      $drivers = drupal_detect_database_types();
276
277
      if (empty($drivers)) {
        $database_ok = FALSE;
278
279
        $pdo_message = t('Your web server does not appear to support any common PDO database extensions. Check with your hosting provider to see if they support PDO (PHP Data Objects) and offer any databases that <a href=":drupal-databases">Drupal supports</a>.', array(
          ':drupal-databases' => 'https://www.drupal.org/node/270#database',
280
281
282
283
284
285
        ));
      }
      // 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;
286
287
        $pdo_message = t('Your web server seems to have the wrong version of PDO installed. Drupal requires the PDO extension from PHP core. This system has the older PECL version. See the <a href=":link">system requirements</a> page for more information.', array(
          ':link' => 'https://www.drupal.org/requirements/pdo#pecl',
288
289
        ));
      }
290
    }
291

292
    if (!$database_ok) {
293
      $requirements['database_extensions']['value'] = t('Disabled');
294
      $requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
295
      $requirements['database_extensions']['description'] = $pdo_message;
296
297
    }
    else {
298
      $requirements['database_extensions']['value'] = t('Enabled');
299
    }
300
  }
301
302
  else {
    // Database information.
303
    $class = Database::getConnection()->getDriverClass('Install\\Tasks');
304
305
    $tasks = new $class();
    $requirements['database_system'] = array(
306
      'title' => t('Database system'),
307
308
309
      'value' => $tasks->name(),
    );
    $requirements['database_system_version'] = array(
310
      'title' => t('Database system version'),
311
312
313
      'value' => Database::getConnection()->version(),
    );
  }
314

315
  // Test PHP memory_limit
316
  $memory_limit = ini_get('memory_limit');
317
  $requirements['php_memory_limit'] = array(
318
    'title' => t('PHP memory limit'),
319
    'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
320
  );
321

322
  if (!Environment::checkMemoryLimit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
323
    $description = array();
324
    if ($phase == 'install') {
325
      $description['phase'] = t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the installation process.', array('%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
326
327
    }
    elseif ($phase == 'update') {
328
      $description['phase'] = t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the update process.', array('%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
329
    }
330
    elseif ($phase == 'runtime') {
331
      $description['phase'] = t('Depending on your configuration, Drupal can run with a %memory_limit PHP memory limit. However, a %memory_minimum_limit PHP memory limit or above is recommended, especially if your site uses additional custom or contributed modules.', array('%memory_limit' => $memory_limit, '%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT));
332
    }
333

334
    if (!empty($description['phase'])) {
335
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
336
        $description['memory'] = t('Increase the memory limit by editing the memory_limit parameter in the file %configuration-file and then restart your web server (or contact your system administrator or hosting provider for assistance).', array('%configuration-file' => $php_ini_path));
337
338
      }
      else {
339
        $description['memory'] = t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
340
      }
341

342
      $handbook_link = t('For more information, see the online handbook entry for <a href=":memory-limit">increasing the PHP memory limit</a>.', array(':memory-limit' => 'https://www.drupal.org/node/207036'));
343
344
345
346
347
348
349
350
351
352
353
354

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

      $requirements['php_memory_limit']['description'] = $description;
355
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
356
    }
357
  }
358

359
  // Test configuration files and directory for writability.
360
  if ($phase == 'runtime') {
361
    $conf_errors = array();
362
363
364
365
366
367
368
369
    // 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());
    }
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
    // Allow system administrators to disable permissions hardening for the site
    // directory. This allows additional files in the site directory to be
    // updated when they are managed in a version control system.
    if (Settings::get('skip_permissions_hardening')) {
      $conf_errors[] = t('Protection disabled');
      // If permissions hardening is disabled, then only show a warning for a
      // writable file, as a reminder, rather than an error.
      $file_protection_severity = REQUIREMENT_WARNING;
    }
    else {
      // In normal operation, writable files or directories are an error.
      $file_protection_severity = REQUIREMENT_ERROR;
      if (!drupal_verify_install_file($site_path, FILE_NOT_WRITABLE, 'dir')) {
        $conf_errors[] = t("The directory %file is not protected from modifications and poses a security risk. You must change the directory's permissions to be non-writable.", array('%file' => $site_path));
      }
385
    }
386
    foreach (array('settings.php', 'settings.local.php', 'services.yml') as $conf_file) {
387
      $full_path = $site_path . '/' . $conf_file;
388
      if (file_exists($full_path) && (Settings::get('skip_permissions_hardening') || !drupal_verify_install_file($full_path, FILE_EXIST | FILE_READABLE | FILE_NOT_WRITABLE))) {
389
        $conf_errors[] = t("The file %file is not protected from modifications and poses a security risk. You must change the file's permissions to be non-writable.", array('%file' => $full_path));
390
391
392
393
394
395
396
      }
    }
    if (!empty($conf_errors)) {
      if (count($conf_errors) == 1) {
        $description = $conf_errors[0];
      }
      else {
397
398
399
400
401
402
403
404
405
406
        // We use twig inline_template to avoid double escaping.
        $description = array(
          '#type' => 'inline_template',
          '#template' => '{{ configuration_error_list }}',
          '#context' => array(
            'configuration_error_list' => array(
              '#theme' => 'item_list',
              '#items' => $conf_errors,
            ),
          ),
407
        );
408
      }
409
      $requirements['configuration_files'] = array(
410
        'value' => t('Not protected'),
411
        'severity' => $file_protection_severity,
412
        'description' => $description,
413
414
415
      );
    }
    else {
416
      $requirements['configuration_files'] = array(
417
        'value' => t('Protected'),
418
419
      );
    }
420
    $requirements['configuration_files']['title'] = t('Configuration files');
421
422
  }

423
424
425
426
427
428
429
430
431
  // Test the contents of the .htaccess files.
  if ($phase == 'runtime') {
    // Try to write the .htaccess files first, to prevent false alarms in case
    // (for example) the /tmp directory was wiped.
    file_ensure_htaccess();
    $htaccess_files['public://.htaccess'] = array(
      'title' => t('Public files directory'),
      'directory' => drupal_realpath('public://'),
    );
432
    if (PrivateStream::basePath()) {
433
434
435
436
437
438
439
440
441
442
443
444
445
      $htaccess_files['private://.htaccess'] = array(
        'title' => t('Private files directory'),
        'directory' => drupal_realpath('private://'),
      );
    }
    $htaccess_files['temporary://.htaccess'] = array(
      'title' => t('Temporary files directory'),
      'directory' => drupal_realpath('temporary://'),
    );
    foreach ($htaccess_files as $htaccess_file => $info) {
      // Check for the string which was added to the recommended .htaccess file
      // in the latest security update.
      if (!file_exists($htaccess_file) || !($contents = @file_get_contents($htaccess_file)) || strpos($contents, 'Drupal_Security_Do_Not_Remove_See_SA_2013_003') === FALSE) {
446
        $url = 'https://www.drupal.org/SA-CORE-2013-003';
447
448
449
450
        $requirements[$htaccess_file] = array(
          'title' => $info['title'],
          'value' => t('Not fully protected'),
          'severity' => REQUIREMENT_ERROR,
451
          'description' => t('See <a href=":url">@url</a> for information about the recommended .htaccess file which should be added to the %directory directory to help protect against arbitrary code execution.', array(':url' => $url, '@url' => $url, '%directory' => $info['directory'])),
452
453
454
455
456
        );
      }
    }
  }

457
  // Report cron status.
458
  if ($phase == 'runtime') {
459
    $cron_config = \Drupal::config('system.cron');
460
    // Cron warning threshold defaults to two days.
461
    $threshold_warning = $cron_config->get('threshold.requirements_warning');
462
    // Cron error threshold defaults to two weeks.
463
    $threshold_error = $cron_config->get('threshold.requirements_error');
464

465
    // Determine when cron last ran.
466
    $cron_last = \Drupal::state()->get('system.cron_last');
467
    if (!is_numeric($cron_last)) {
468
      $cron_last = \Drupal::state()->get('install_time', 0);
469
    }
470

471
    // Determine severity based on time since cron last ran.
472
    $severity = REQUIREMENT_INFO;
473
    if (REQUEST_TIME - $cron_last > $threshold_error) {
474
      $severity = REQUIREMENT_ERROR;
475
    }
476
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
477
478
479
480
      $severity = REQUIREMENT_WARNING;
    }

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

483
    $requirements['cron'] = array(
484
      'title' => t('Cron maintenance tasks'),
485
486
487
      'severity' => $severity,
      'value' => $summary,
    );
488
489
490
491
492
493
494
    if ($severity != REQUIREMENT_INFO) {
      $requirements['cron']['description'][] = [
        [
          '#markup' => t('Cron has not run recently.'),
          '#suffix' => ' ',
        ],
        [
495
          '#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']),
496
497
498
499
          '#suffix' => ' ',
        ],
      ];
    }
500
    $cron_url = \Drupal::url('system.cron', ['key' => \Drupal::state()->get('system.cron_key'), ['absolute' => TRUE]]);
501
502
    $requirements['cron']['description'][] = [
      [
503
        '#markup' => t('You can <a href=":cron">run cron manually</a>.', [':cron' => \Drupal::url('system.run_cron')]),
504
505
506
      ],
      [
        '#prefix' => '<br />',
507
        '#markup' => t('To run cron from outside the site, go to <a href=":url">@cron</a>', [':url' => $cron_url, '@cron' => $cron_url]),
508
509
      ],
    ];
510
  }
511
  if ($phase != 'install') {
512
    $filesystem_config = \Drupal::config('system.file');
513
    $directories = array(
514
      PublicStream::basePath(),
515
516
      // By default no private files directory is configured. For private files
      // to be secure the admin needs to provide a path outside the webroot.
517
      PrivateStream::basePath(),
518
519
520
      file_directory_temp(),
    );
  }
521

522
523
  // During an install we need to make assumptions about the file system
  // unless overrides are provided in settings.php.
524
  if ($phase == 'install') {
525
    $directories = array();
526
    if ($file_public_path = Settings::get('file_public_path')) {
527
      $directories[] = $file_public_path;
528
529
530
    }
    else {
      // If we are installing Drupal, the settings.php file might not exist yet
531
      // in the intended site directory, so don't require it.
532
533
534
      $request = Request::createFromGlobals();
      $site_path = DrupalKernel::findSitePath($request);
      $directories[] = $site_path . '/files';
535
    }
536
537
    if ($file_private_path = Settings::get('file_private_path')) {
      $directories[] = $file_private_path;
538
    }
539
540
    if (!empty($GLOBALS['config']['system.file']['path']['temporary'])) {
      $directories[] = $GLOBALS['config']['system.file']['path']['temporary'];
541
542
543
544
    }
    else {
      // If the temporary directory is not overridden use an appropriate
      // temporary path for the system.
545
      $directories[] = FileSystem::getOsTemporaryDirectory();
546
    }
547
548
  }

549
550
551
  // 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.
552
  if (!empty($GLOBALS['config_directories'])) {
553
554
    foreach (array_keys(array_filter($GLOBALS['config_directories'])) as $type) {
      $directory = config_get_config_directory($type);
555
556
557
558
      // 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);
      }
559
      if (!is_dir($directory)) {
560
561
562
563
564
565
        if ($phase == 'install') {
          $description = t('An automated attempt to create the directory %directory failed, possibly due to a permissions problem. To proceed with the installation, either create the directory and modify its permissions manually or ensure that the installer has the permissions to create it automatically. For more information, see INSTALL.txt or the <a href=":handbook_url">online handbook</a>.', array('%directory' => $directory, ':handbook_url' => 'https://www.drupal.org/server-permissions'));
        }
        else {
          $description = t('The directory %directory does not exist.', array('%directory' => $directory));
        }
566
567
        $requirements['config directory ' . $type] = array(
          'title' => t('Configuration directory: %type', ['%type' => $type]),
568
          'description' => $description,
569
570
571
          'severity' => REQUIREMENT_ERROR,
        );
      }
572
    }
573
  }
574
  if ($phase != 'install' && (empty($GLOBALS['config_directories']) || empty($GLOBALS['config_directories'][CONFIG_SYNC_DIRECTORY]) )) {
575
    $requirements['config directories'] = array(
576
577
      'title' => t('Configuration directories'),
      'value' => t('Not present'),
578
      'description' => t('Your %file file must define the $config_directories variable as an array containing the names of directories in which configuration files can be found. It must contain a %sync_key key.', array('%file' => $site_path . '/settings.php', '%sync_key' => CONFIG_SYNC_DIRECTORY)),
579
580
581
582
      'severity' => REQUIREMENT_ERROR,
    );
  }

583
  $requirements['file system'] = array(
584
    'title' => t('File system'),
585
  );
586

587
588
589
  $error = '';
  // For installer, create the directories if possible.
  foreach ($directories as $directory) {
590
591
592
    if (!$directory) {
      continue;
    }
593
    if ($phase == 'install') {
594
      file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
595
    }
596
597
598
599
    $is_writable = is_writable($directory);
    $is_directory = is_dir($directory);
    if (!$is_writable || !$is_directory) {
      $description = '';
600
      $requirements['file system']['value'] = t('Not writable');
601
      if (!$is_directory) {
602
        $error = t('The directory %directory does not exist.', array('%directory' => $directory));
603
604
      }
      else {
605
        $error = t('The directory %directory is not writable.', array('%directory' => $directory));
606
607
608
      }
      // The files directory requirement check is done only during install and runtime.
      if ($phase == 'runtime') {
609
        $description = t('You may need to set the correct directory at the <a href=":admin-file-system">file system settings page</a> or change the current directory\'s permissions so that it is writable.', array(':admin-file-system' => \Drupal::url('system.file_system_settings')));
610
611
612
613
      }
      elseif ($phase == 'install') {
        // For the installer UI, we need different wording. 'value' will
        // be treated as version, so provide none there.
614
        $description = t('An automated attempt to create this directory failed, possibly due to a permissions problem. To proceed with the installation, either create the directory and modify its permissions manually or ensure that the installer has the permissions to create it automatically. For more information, see INSTALL.txt or the <a href=":handbook_url">online handbook</a>.', array(':handbook_url' => 'https://www.drupal.org/server-permissions'));
615
616
617
        $requirements['file system']['value'] = '';
      }
      if (!empty($description)) {
618
619
620
621
622
623
624
625
        $description = array(
          '#type' => 'inline_template',
          '#template' => '{{ error }} {{ description }}',
          '#context' => array(
            'error' => $error,
            'description' => $description,
          ),
        );
626
627
628
        $requirements['file system']['description'] = $description;
        $requirements['file system']['severity'] = REQUIREMENT_ERROR;
      }
629
630
    }
    else {
631
632
633
      // This function can be called before the config_cache table has been
      // created.
      if ($phase == 'install' || file_default_scheme() == 'public') {
634
        $requirements['file system']['value'] = t('Writable (<em>public</em> download method)');
635
636
      }
      else {
637
        $requirements['file system']['value'] = t('Writable (<em>private</em> download method)');
638
      }
639
640
641
    }
  }

642
643
644
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
645
646
      'title' => t('Database updates'),
      'value' => t('Up to date'),
647
648
649
    );

    // Check installed modules.
650
    $has_pending_updates = FALSE;
651
    foreach (\Drupal::moduleHandler()->getModuleList() as $module => $filename) {
652
653
654
655
      $updates = drupal_get_schema_versions($module);
      if ($updates !== FALSE) {
        $default = drupal_get_installed_schema_version($module);
        if (max($updates) > $default) {
656
          $has_pending_updates = TRUE;
657
658
659
660
          break;
        }
      }
    }
661
662
663
664
665
666
667
668
669
670
671
672
    if (!$has_pending_updates) {
      /** @var \Drupal\Core\Update\UpdateRegistry $post_update_registry */
      $post_update_registry = \Drupal::service('update.post_update_registry');
      $missing_post_update_functions = $post_update_registry->getPendingUpdateFunctions();
      if (!empty($missing_post_update_functions)) {
        $has_pending_updates = TRUE;
      }
    }

    if ($has_pending_updates) {
      $requirements['update']['severity'] = REQUIREMENT_ERROR;
      $requirements['update']['value'] = t('Out of date');
673
      $requirements['update']['description'] = t('Some modules have database schema updates to install. You should run the <a href=":update">database update script</a> immediately.', array(':update' => \Drupal::url('system.db_update')));
674
    }
675

676
677
678
679
680
    $requirements['entity_update'] = [
      'title' => t('Entity/field definitions'),
      'value' => t('Up to date'),
    ];
    // Verify that no entity updates are pending.
681
682
683
684
685
686
687
688
689
690
691
    if ($change_list = \Drupal::entityDefinitionUpdateManager()->getChangeSummary()) {
      $build = [];
      foreach ($change_list as $entity_type_id => $changes) {
        $entity_type = \Drupal::entityManager()->getDefinition($entity_type_id);
        $build[] = [
          '#theme' => 'item_list',
          '#title' => $entity_type->getLabel(),
          '#items' => $changes,
        ];
      }

692
      $entity_update_issues = \Drupal::service('renderer')->renderPlain($build);
693
694
      $requirements['entity_update']['severity'] = REQUIREMENT_ERROR;
      $requirements['entity_update']['value'] = t('Mismatched entity and/or field definitions');
695
      $requirements['entity_update']['description'] = t('The following changes were detected in the entity type and field definitions. @updates', ['@updates' => $entity_update_issues]);
696
    }
697
698
  }

699
700
  // Verify the update.php access setting
  if ($phase == 'runtime') {
701
    if (Settings::get('update_free_access')) {
702
      $requirements['update access'] = array(
703
        'value' => t('Not protected'),
704
        'severity' => REQUIREMENT_ERROR,
705
        'description' => t('The update.php script is accessible to everyone without authentication check, which is a security risk. You must change the @settings_name value in your settings.php back to FALSE.', array('@settings_name' => '$settings[\'update_free_access\']')),
706
707
708
709
      );
    }
    else {
      $requirements['update access'] = array(
710
        'value' => t('Protected'),
711
712
      );
    }
713
    $requirements['update access']['title'] = t('Access to update.php');
714
715
  }

716
717
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
718
    $profile = drupal_get_profile();
719
720
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
721
      // Ignore disabled modules and installation profiles.
722
      if (!$file->status || $module == $profile) {
723
724
725
726
727
728
        continue;
      }
      // Check the module's PHP version.
      $name = $file->info['name'];
      $php = $file->info['php'];
      if (version_compare($php, PHP_VERSION, '>')) {
729
        $requirements['php']['description'] .= t('@name requires at least PHP @version.', array('@name' => $name, '@version' => $php));
730
731
732
733
734
735
736
737
        $requirements['php']['severity'] = REQUIREMENT_ERROR;
      }
      // Check the module's required modules.
      foreach ($file->requires as $requirement) {
        $required_module = $requirement['name'];
        // Check if the module exists.
        if (!isset($files[$required_module])) {
          $requirements["$module-$required_module"] = array(
738
739
            'title' => t('Unresolved dependency'),
            'description' => t('@name requires this module.', array('@name' => $name)),
740
741
742
743
744
745
746
747
            'value' => t('@required_name (Missing)', array('@required_name' => $required_module)),
            'severity' => REQUIREMENT_ERROR,
          );
          continue;
        }
        // Check for an incompatible version.
        $required_file = $files[$required_module];
        $required_name = $required_file->info['name'];
748
        $version = str_replace(\Drupal::CORE_COMPATIBILITY . '-', '', $required_file->info['version']);
749
750
751
752
        $compatibility = drupal_check_incompatibility($requirement, $version);
        if ($compatibility) {
          $compatibility = rtrim(substr($compatibility, 2), ')');
          $requirements["$module-$required_module"] = array(
753
754
            'title' => t('Unresolved dependency'),
            'description' => t('@name requires this module and version. Currently using @required_name version @version', array('@name' => $name, '@required_name' => $required_name, '@version' => $version)),
755
756
757
758
759
760
761
762
763
            'value' => t('@required_name (Version @compatibility required)', array('@required_name' => $required_name, '@compatibility' => $compatibility)),
            'severity' => REQUIREMENT_ERROR,
          );
          continue;
        }
      }
    }
  }

764
  // Test Unicode library
765
  include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
766
767
  $requirements = array_merge($requirements, unicode_requirements());

768
  if ($phase == 'runtime') {
769
    // Check for update status module.
770
    if (!\Drupal::moduleHandler()->moduleExists('update')) {
771
      $requirements['update status'] = array(
772
        'value' => t('Not enabled'),
773
        'severity' => REQUIREMENT_WARNING,
774
775
776
        'description' => t('Update notifications are not enabled. It is <strong>highly recommended</strong> that you enable the Update Manager module from the <a href=":module">module administration page</a> in order to stay up-to-date on new releases. For more information, <a href=":update">Update status handbook page</a>.', array(
          ':update' => 'https://www.drupal.org/documentation/modules/update',
          ':module' => \Drupal::url('system.modules_list'),
777
        )),
778
779
780
781
      );
    }
    else {
      $requirements['update status'] = array(
782
        'value' => t('Enabled'),
783
784
      );
    }
785
    $requirements['update status']['title'] = t('Update notifications');
786

787
    if (Settings::get('rebuild_access')) {
788
789
790
791
792
793
794
      $requirements['rebuild access'] = array(
        'title' => t('Rebuild access'),
        'value' => t('Enabled'),
        'severity' => REQUIREMENT_ERROR,
        'description' => t('The rebuild_access setting is enabled in settings.php. It is recommended to have this setting disabled unless you are performing a rebuild.'),
      );
    }
795
796
  }

797
798
799
800
801
802
803
804
  // See if trusted hostnames have been configured, and warn the user if they
  // are not set.
  if ($phase == 'runtime') {
    $trusted_host_patterns = Settings::get('trusted_host_patterns');
    if (empty($trusted_host_patterns)) {
      $requirements['trusted_host_patterns'] = array(
        'title' => t('Trusted Host Settings'),
        'value' => t('Not enabled'),
805
        'description' => t('The trusted_host_patterns setting is not configured in settings.php. This can lead to security vulnerabilities. It is <strong>highly recommended</strong> that you configure this. See <a href=":url">Protecting against HTTP HOST Header attacks</a> for more information.', array(':url' => 'https://www.drupal.org/node/1992030')),
806
807
808
809
810
811
812
813
814
815
816
        'severity' => REQUIREMENT_ERROR,
      );
    }
    else {
      $requirements['trusted_host_patterns'] = array(
        'title' => t('Trusted Host Settings'),
        'value' => t('Enabled'),
        'description' => t('The trusted_host_patterns setting is set to allow %trusted_host_patterns', array('%trusted_host_patterns' => join(', ', $trusted_host_patterns))),
      );
    }
  }
817

818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
  // Check xdebug.max_nesting_level, as some pages will not work if it is too
  // low.
  if (extension_loaded('xdebug')) {
    // Setting this value to 256 was considered adequate on Xdebug 2.3
    // (see http://bugs.xdebug.org/bug_view_page.php?bug_id=00001100)
    $minimum_nesting_level = 256;
    $current_nesting_level = ini_get('xdebug.max_nesting_level');

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

836
837
838
  return $requirements;
}

839
/**
840
 * Implements hook_install().
841
 */
842
function system_install() {
843
  // Populate the cron key state variable.
844
  $cron_key = Crypt::randomBytesBase64(55);
845
  \Drupal::state()->set('system.cron_key', $cron_key);
846

847
848
849
850
851
852
  // Populate the site UUID and default name (if not set).
  $site = \Drupal::configFactory()->getEditable('system.site');
  $site->set('uuid', \Drupal::service('uuid')->generate());
  if (!$site->get('name')) {
    $site->set('name', 'Drupal');
  }
853
  $site->save(TRUE);
854
855
}

856
/**
857
 * Implements hook_schema().
858
859
 */
function system_schema() {
860
  $schema['key_value'] = array(
861
    'description' => 'Generic key-value storage table. See the state system for an example.',
862
863
864
    'fields' => array(
      'collection' => array(
        'description' => 'A named collection of key and value pairs.',
865
        'type' => 'varchar_ascii',
866
867
868
869
870
871
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
      ),
      'name' => array(
        'description' => 'The key of the key-value pair. As KEY is a SQL reserved keyword, name was chosen instead.',
872
        'type' => 'varchar_ascii',
873
874
875
876
877
878
879
880
881
882
883
884
885
886
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
      ),
      'value' => array(
        'description' => 'The value.',
        'type' => 'blob',
        'not null' => TRUE,
        'size' => 'big',
      ),
    ),
    'primary key' => array('collection', 'name'),
  );

887
888
889
890
891
  $schema['key_value_expire'] = array(
    'description' => 'Generic key/value storage table with an expiration.',
    'fields' => array(
      'collection' => array(
        'description' => 'A named collection of key and value pairs.',
892
        'type' => 'varchar_ascii',
893
894
895
896
897
898
899
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
      ),
      'name' => array(
        // KEY is an SQL reserved word, so use 'name' as the key's field name.
        'description' => 'The key of the key/value pair.',
900
        'type' => 'varchar_ascii',
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
      ),
      'value' => array(
        'description' => 'The value of the key/value pair.',
        'type' => 'blob',
        'not null' => TRUE,
        'size' => 'big',
      ),
      'expire' => array(
        'description' => 'The time since Unix epoch in seconds when this item expires. Defaults to the maximum possible time.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 2147483647,
      ),
    ),
    'primary key' => array('collection', 'name'),
    'indexes' => array(
      'all' => array('name', 'collection', 'expire'),
921
      'expire' => array('expire'),
922
923
924
    ),
  );

925
926
927
928
929
930
931
932
933
934
935
936
937
  $schema['sequences'] = array(
    'description' => 'Stores IDs.',
    'fields' => array(
      'value' => array(
        'description' => 'The value of the sequence.',
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ),
     ),
    'primary key' => array('value'),
  );

938
  $schema['sessions'] = array(
939
    'description' => "Drupal's session handlers read and write into the sessions table. Each record represents a user session, either anonymous or authenticated.",
940
    'fields' => array(
941
      'uid' => array(
942
        'description' => 'The {users}.uid corresponding to a session, or 0 for anonymous user.',
943
944
        'type' => 'int',
        'unsigned' => TRUE,
945
946
        'not null' => TRUE,
      ),
947
      'sid' => array(
948
        'description' => "A session ID (hashed). The value is generated by Drupal's session handlers.",
949
        'type' => 'varchar_ascii',
950
        'length' => 128,
951
        'not null' => TRUE,
952
      ),
953
      'hostname' => array(
954
        'description' => 'The IP address that last used this session ID (sid).',
955
        'type' => 'varchar_ascii',
956
957
        'length' => 128,
        'not null' => TRUE,
958
959
        'default' => '',
      ),
960
      'timestamp' => array(
961
        'description' => 'The Unix timestamp when this session last requested a page. Old records are purged by PHP automatically.',
962
963
        'type' => 'int',
        'not null' => TRUE,
964
965
        'default' => 0,
      ),
966
      'session' => array(
967
        'description' => 'The serialized contents of $_SESSION, an array of name/value pairs that persists across page requests by this session ID. Drupal loads $_SESSION from here at the start of each request and saves it at the end.',
968
        'type' => 'blob',
969
        'not null' => FALSE,