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

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

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

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

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

70
  // Web server information.
71
  $software = \Drupal::request()->server->get('SERVER_SOFTWARE');
72
  $requirements['webserver'] = array(
73
    'title' => t('Web server'),
Steven Wittens's avatar
Steven Wittens committed
74
    'value' => $software,
75
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
  // 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;
      }
102
      elseif ($matches[1] == 2) {
103
104
105
        if (!isset($matches[2])) {
          $rewrite_warning = TRUE;
        }
106
        elseif ($matches[2] < 2) {
107
108
          $rewrite_error = TRUE;
        }
109
        elseif ($matches[2] == 2) {
110
111
112
          if (!isset($matches[3])) {
            $rewrite_warning = TRUE;
          }
113
          elseif ($matches[3] < 16) {
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
            $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,
137
        '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')),
138
139
140
141
142
143
144
145
      );
    }

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

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

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

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

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

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

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

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

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

  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,
249
        '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.'),
250
251
252
253
254
255
      );
    }
    else {
      $requirements['php_opcache']['value'] = t('Enabled');
    }
    $requirements['php_opcache']['title'] = t('PHP OPcode caching');
256
  }
257

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

547
548
549
  // 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.
550
  if (!empty($GLOBALS['config_directories'])) {
551
552
553
    foreach ($GLOBALS['config_directories'] as $type => $directory) {
      $directories[] = config_get_config_directory($type);
    }
554
555
  }
  elseif ($phase != 'install') {
556
    $requirements['config directories'] = array(
557
558
      'title' => t('Configuration directories'),
      'value' => t('Not present'),
559
      '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')),
560
561
562
563
      'severity' => REQUIREMENT_ERROR,
    );
  }

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

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

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

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

657
658
659
660
661
    $requirements['entity_update'] = [
      'title' => t('Entity/field definitions'),
      'value' => t('Up to date'),
    ];
    // Verify that no entity updates are pending.
662
663
664
665
666
667
668
669
670
671
672
673
    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);
674
675
      $requirements['entity_update']['severity'] = REQUIREMENT_ERROR;
      $requirements['entity_update']['value'] = t('Mismatched entity and/or field definitions');
676
      $requirements['entity_update']['description'] = t('The following changes were detected in the entity type and field definitions. @updates', ['@updates' => $entity_update_issues]);
677
    }
678
679
  }

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

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

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

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

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

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

  // 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');
808
      $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]);
809
810
    }
    else {
811
      $requirements['twig_c_extension']['description'] = t('The <a href=":url">Twig C extension</a> is available', [':url' => $url]);
812
813
    }
  }
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831

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

833
834
835
  return $requirements;
}

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

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

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

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

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

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