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

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

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

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

    // Warn if any experimental modules are installed.
    $experimental = array();
55
    $enabled_modules = \Drupal::moduleHandler()->getModuleList();
56
    foreach ($enabled_modules as $module => $data) {
57
58
59
      $info = system_get_info('module', $module);
      if ($info['package'] === 'Core (Experimental)') {
        $experimental[$module] = $info['name'];
60
61
62
63
64
      }
    }
    if (!empty($experimental)) {
      $requirements['experimental'] = array(
        'title' => t('Experimental modules enabled'),
65
        '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')),
66
67
68
        'severity' => REQUIREMENT_WARNING,
      );
    }
69
70
  }

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

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
  // 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;
      }
103
      elseif ($matches[1] == 2) {
104
105
106
        if (!isset($matches[2])) {
          $rewrite_warning = TRUE;
        }
107
        elseif ($matches[2] < 2) {
108
109
          $rewrite_error = TRUE;
        }
110
        elseif ($matches[2] == 2) {
111
112
113
          if (!isset($matches[3])) {
            $rewrite_warning = TRUE;
          }
114
          elseif ($matches[3] < 16) {
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
            $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,
138
        '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')),
139
140
141
142
143
144
145
146
      );
    }

    if (!$rewrite_error && !$rewrite_warning) {
      $requirements['rewrite_module'] = array (
        'title' => t('Clean URLs'),
        'value' => t('Disabled'),
        'severity' => REQUIREMENT_WARNING,
147
        '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')),
148
149
150
151
      );
    }
  }

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

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

179
180
181
182
183
  // 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)'),
184
      'value' => $phpversion_label,
185
186
187
188
189
      '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,
    );
  }

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

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

  if (!empty($missing_extensions)) {
218
219
    $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',
220
221
    ));

222
223
224
225
226
227
228
229
230
231
232
    // 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,
        ),
      ),
233
    );
234

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

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

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

265
    // Make sure PDO is available.
266
    $database_ok = extension_loaded('pdo');
267
    if (!$database_ok) {
268
269
      $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',
270
271
272
273
      ));
    }
    else {
      // Make sure at least one supported database driver exists.
274
      $drivers = drupal_detect_database_types();
275
276
      if (empty($drivers)) {
        $database_ok = FALSE;
277
278
        $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',
279
280
281
282
283
284
        ));
      }
      // 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;
285
286
        $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',
287
288
        ));
      }
289
    }
290

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

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

321
  if (!Environment::checkMemoryLimit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
322
    $description = array();
323
    if ($phase == 'install') {
324
      $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));
325
326
    }
    elseif ($phase == 'update') {
327
      $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));
328
    }
329
    elseif ($phase == 'runtime') {
330
      $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));
331
    }
332

333
    if (!empty($description['phase'])) {
334
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
335
        $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));
336
337
      }
      else {
338
        $description['memory'] = t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
339
      }
340

341
      $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'));
342
343
344
345
346
347
348
349
350
351
352
353

      $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;
354
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
355
    }
356
  }
357

358
  // Test configuration files and directory for writability.
359
  if ($phase == 'runtime') {
360
    $conf_errors = array();
361
362
363
364
365
366
367
368
    // 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());
    }
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
    // 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));
      }
384
    }
385
    foreach (array('settings.php', 'settings.local.php', 'services.yml') as $conf_file) {
386
      $full_path = $site_path . '/' . $conf_file;
387
      if (file_exists($full_path) && (Settings::get('skip_permissions_hardening') || !drupal_verify_install_file($full_path, FILE_EXIST | FILE_READABLE | FILE_NOT_WRITABLE))) {
388
        $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));
389
390
391
392
393
394
395
      }
    }
    if (!empty($conf_errors)) {
      if (count($conf_errors) == 1) {
        $description = $conf_errors[0];
      }
      else {
396
397
398
399
400
401
402
403
404
405
        // 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,
            ),
          ),
406
        );
407
      }
408
      $requirements['configuration_files'] = array(
409
        'value' => t('Not protected'),
410
        'severity' => $file_protection_severity,
411
        'description' => $description,
412
413
414
      );
    }
    else {
415
      $requirements['configuration_files'] = array(
416
        'value' => t('Protected'),
417
418
      );
    }
419
    $requirements['configuration_files']['title'] = t('Configuration files');
420
421
  }

422
423
424
425
426
427
428
429
430
  // 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://'),
    );
431
    if (PrivateStream::basePath()) {
432
433
434
435
436
437
438
439
440
441
442
443
444
      $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) {
445
        $url = 'https://www.drupal.org/SA-CORE-2013-003';
446
447
448
449
        $requirements[$htaccess_file] = array(
          'title' => $info['title'],
          'value' => t('Not fully protected'),
          'severity' => REQUIREMENT_ERROR,
450
          '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'])),
451
452
453
454
455
        );
      }
    }
  }

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

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

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

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

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

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

548
549
550
  // 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.
551
  if (!empty($GLOBALS['config_directories'])) {
552
553
554
    foreach ($GLOBALS['config_directories'] as $type => $directory) {
      $directories[] = config_get_config_directory($type);
    }
555
556
  }
  elseif ($phase != 'install') {
557
    $requirements['config directories'] = array(
558
559
      'title' => t('Configuration directories'),
      'value' => t('Not present'),
560
      'description' => t('Your %file file must define the $config_directories variable as an array containing the name of a directories in which configuration files can be written.', array('%file' => $site_path . '/settings.php')),
561
562
563
564
      'severity' => REQUIREMENT_ERROR,
    );
  }

565
  $requirements['file system'] = array(
566
    'title' => t('File system'),
567
  );
568

569
570
571
  $error = '';
  // For installer, create the directories if possible.
  foreach ($directories as $directory) {
572
573
574
    if (!$directory) {
      continue;
    }
575
    if ($phase == 'install') {
576
      file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
577
    }
578
579
580
581
    $is_writable = is_writable($directory);
    $is_directory = is_dir($directory);
    if (!$is_writable || !$is_directory) {
      $description = '';
582
      $requirements['file system']['value'] = t('Not writable');
583
      if (!$is_directory) {
584
        $error = t('The directory %directory does not exist.', array('%directory' => $directory));
585
586
      }
      else {
587
        $error = t('The directory %directory is not writable.', array('%directory' => $directory));
588
589
590
      }
      // The files directory requirement check is done only during install and runtime.
      if ($phase == 'runtime') {
591
        $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')));
592
593
594
595
      }
      elseif ($phase == 'install') {
        // For the installer UI, we need different wording. 'value' will
        // be treated as version, so provide none there.
596
        $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'));
597
598
599
        $requirements['file system']['value'] = '';
      }
      if (!empty($description)) {
600
601
602
603
604
605
606
607
        $description = array(
          '#type' => 'inline_template',
          '#template' => '{{ error }} {{ description }}',
          '#context' => array(
            'error' => $error,
            'description' => $description,
          ),
        );
608
609
610
        $requirements['file system']['description'] = $description;
        $requirements['file system']['severity'] = REQUIREMENT_ERROR;
      }
611
612
    }
    else {
613
614
615
      // This function can be called before the config_cache table has been
      // created.
      if ($phase == 'install' || file_default_scheme() == 'public') {
616
        $requirements['file system']['value'] = t('Writable (<em>public</em> download method)');
617
618
      }
      else {
619
        $requirements['file system']['value'] = t('Writable (<em>private</em> download method)');
620
      }
621
622
623
    }
  }

624
625
626
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
627
628
      'title' => t('Database updates'),
      'value' => t('Up to date'),
629
630
631
    );

    // Check installed modules.
632
    $has_pending_updates = FALSE;
633
    foreach (\Drupal::moduleHandler()->getModuleList() as $module => $filename) {
634
635
636
637
      $updates = drupal_get_schema_versions($module);
      if ($updates !== FALSE) {
        $default = drupal_get_installed_schema_version($module);
        if (max($updates) > $default) {
638
          $has_pending_updates = TRUE;
639
640
641
642
          break;
        }
      }
    }
643
644
645
646
647
648
649
650
651
652
653
654
    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');
655
      $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')));
656
    }
657

658
659
660
661
662
    $requirements['entity_update'] = [
      'title' => t('Entity/field definitions'),
      'value' => t('Up to date'),
    ];
    // Verify that no entity updates are pending.
663
664
665
666
667
668
669
670
671
672
673
674
    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,
        ];
      }

      $entity_update_issues = \Drupal::service('renderer')->render($build);
675
676
      $requirements['entity_update']['severity'] = REQUIREMENT_ERROR;
      $requirements['entity_update']['value'] = t('Mismatched entity and/or field definitions');
677
      $requirements['entity_update']['description'] = t('The following changes were detected in the entity type and field definitions. @updates', ['@updates' => $entity_update_issues]);
678
    }
679
680
  }

681
682
  // Verify the update.php access setting
  if ($phase == 'runtime') {
683
    if (Settings::get('update_free_access')) {
684
      $requirements['update access'] = array(
685
        'value' => t('Not protected'),
686
        'severity' => REQUIREMENT_ERROR,
687
        '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\']')),
688
689
690
691
      );
    }
    else {
      $requirements['update access'] = array(
692
        'value' => t('Protected'),
693
694
      );
    }
695
    $requirements['update access']['title'] = t('Access to update.php');
696
697
  }

698
699
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
700
    $profile = drupal_get_profile();
701
702
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
703
      // Ignore disabled modules and installation profiles.
704
      if (!$file->status || $module == $profile) {
705
706
707
708
709
710
        continue;
      }
      // Check the module's PHP version.
      $name = $file->info['name'];
      $php = $file->info['php'];
      if (version_compare($php, PHP_VERSION, '>')) {
711
        $requirements['php']['description'] .= t('@name requires at least PHP @version.', array('@name' => $name, '@version' => $php));
712
713
714
715
716
717
718
719
        $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(
720
721
            'title' => t('Unresolved dependency'),
            'description' => t('@name requires this module.', array('@name' => $name)),
722
723
724
725
726
727
728
729
            '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'];
730
        $version = str_replace(\Drupal::CORE_COMPATIBILITY . '-', '', $required_file->info['version']);
731
732
733
734
        $compatibility = drupal_check_incompatibility($requirement, $version);
        if ($compatibility) {
          $compatibility = rtrim(substr($compatibility, 2), ')');
          $requirements["$module-$required_module"] = array(
735
736
            '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)),
737
738
739
740
741
742
743
744
745
            'value' => t('@required_name (Version @compatibility required)', array('@required_name' => $required_name, '@compatibility' => $compatibility)),
            'severity' => REQUIREMENT_ERROR,
          );
          continue;
        }
      }
    }
  }

746
  // Test Unicode library
747
  include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
748
749
  $requirements = array_merge($requirements, unicode_requirements());

750
  if ($phase == 'runtime') {
751
    // Check for update status module.
752
    if (!\Drupal::moduleHandler()->moduleExists('update')) {
753
      $requirements['update status'] = array(
754
        'value' => t('Not enabled'),
755
        'severity' => REQUIREMENT_WARNING,
756
757
758
        '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'),
759
        )),
760
761
762
763
      );
    }
    else {
      $requirements['update status'] = array(
764
        'value' => t('Enabled'),
765
766
      );
    }
767
    $requirements['update status']['title'] = t('Update notifications');
768

769
    if (Settings::get('rebuild_access')) {
770
771
772
773
774
775
776
      $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.'),
      );
    }
777
778
  }

779
780
781
782
783
784
785
786
  // 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'),
787
        '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')),
788
789
790
791
792
793
794
795
796
797
798
        '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))),
      );
    }
  }
799
800
801
802
803
804
805
806
807
808

  // Check if the Twig C extension is available.
  if ($phase == 'runtime') {
    $url = 'http://twig.sensiolabs.org/doc/installation.html#installing-the-c-extension';
    $requirements['twig_c_extension'] = [
      'title' => t('Twig C extension'),
      'severity' => REQUIREMENT_INFO,
    ];
    if (!function_exists('twig_template_get_attributes')) {
      $requirements['twig_c_extension']['value'] = t('Not available');
809
      $requirements['twig_c_extension']['description'] = t('Enabling the Twig C extension can greatly increase rendering performance. See <a href=":url">the installation instructions</a> for more detail.', [':url' => $url]);
810
811
    }
    else {
812
      $requirements['twig_c_extension']['description'] = t('The <a href=":url">Twig C extension</a> is available', [':url' => $url]);
813
814
    }
  }
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832

  // 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,
      ];
    }
  }
833

834
835
836
  return $requirements;
}

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

845
846
847
848
849
850
  // 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');
  }
851
  $site->save(TRUE);
852
853
}

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

885
886
887
888
889
  $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.',
890
        'type' => 'varchar_ascii',
891
892
893
894
895
896
897
        '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.',
898
        'type' => 'varchar_ascii',
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
        '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'),
919
      'expire' => array('expire'),
920
921
922
    ),
  );

923
924
925
926
927
928
929
930
931
932
933
934
935
  $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'),
  );

936
  $schema['sessions'] = array(
937
    'description' => "Drupal's session handlers read and write into the sessions table. Each record represents a user session, either anonymous or authenticated.",
938
    'fields' => array(
939
      'uid' => array(
940
        'description' => 'The {users}.uid corresponding to a session, or 0 for anonymous user.',
941
942
        'type' => 'int',
        'unsigned' => TRUE,
943
944
        'not null' => TRUE,
      ),
945
      'sid' => array(
946
        'description' => "A session ID (hashed). The value is generated by Drupal's session handlers.",
947
        'type' => 'varchar_ascii',
948
        'length' => 128,
949
        'not null' => TRUE,
950
      ),
951
      'hostname' => array(
952
        'description' => 'The IP address that last used this session ID (sid).',
953
        'type' => 'varchar_ascii',
954
955
        'length' => 128,
        'not null' => TRUE,
956
957
        'default' => '',
      ),
958
      'timestamp' => array(
959
        'description' => 'The Unix timestamp when this session last requested a page. Old records are purged by PHP automatically.',
960
961
        'type' => 'int',
        'not null' => TRUE,
962
963
        'default' => 0,
      ),
964
      'session' => array(
965
        '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.',
966
        'type' => 'blob',
967
        'not null' => FALSE,
968
        'size' => 'big',
969
      ),
970
    ),
971
972
973
    'primary key' => array(
      'sid',
    ),
974
975
    'indexes' => array(
      'timestamp' => array('timestamp'),
976
977
      'uid' => array('uid'),
    ),
978
    'foreign keys' => array(
979
980
981
982
      'session_user' => array(
        'table' => 'users',
        'columns' => array('uid' => 'uid'),
      ),
983
    ),