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

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

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

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

55
  // Web server information.
56
  $software = \Drupal::request()->server->get('SERVER_SOFTWARE');
57
  $requirements['webserver'] = array(
58
    'title' => t('Web server'),
Steven Wittens's avatar
Steven Wittens committed
59
    'value' => $software,
60
61
  );

62
63
64
65
66
67
68
69
70
71
72
73
74
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
  // 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;
      }
      else if ($matches[1] == 2) {
        if (!isset($matches[2])) {
          $rewrite_warning = TRUE;
        }
        else if ($matches[2] < 2) {
          $rewrite_error = TRUE;
        }
        else if ($matches[2] == 2) {
          if (!isset($matches[3])) {
            $rewrite_warning = TRUE;
          }
          else if ($matches[3] < 16) {
            $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,
        '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')),
      );
    }

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

136
  // Test PHP version and show link to phpinfo() if it's available
137
  $phpversion = $phpversion_label = phpversion();
138
  if (function_exists('phpinfo')) {
139
    if ($phase === 'runtime') {
140
      $phpversion_label = t('@phpversion (<a href="@url">more information</a>)', ['@phpversion' => $phpversion, '@url' => (new Url('system.php'))->toString()]);
141
    }
142
    $requirements['php'] = array(
143
      'title' => t('PHP'),
144
      'value' => $phpversion_label,
145
146
147
148
    );
  }
  else {
    $requirements['php'] = array(
149
      'title' => t('PHP'),
150
      'value' => $phpversion_label,
151
      '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')),
152
153
154
155
      'severity' => REQUIREMENT_INFO,
    );
  }

156
  if (version_compare($phpversion, DRUPAL_MINIMUM_PHP) < 0) {
157
    $requirements['php']['description'] = t('Your PHP installation is too old. Drupal requires at least PHP %version.', array('%version' => DRUPAL_MINIMUM_PHP));
158
    $requirements['php']['severity'] = REQUIREMENT_ERROR;
159
160
    // If PHP is old, it's not safe to continue with the requirements check.
    return $requirements;
161
  }
162

163
164
165
166
167
  // 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)'),
168
      'value' => $phpversion_label,
169
170
171
172
173
      '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,
    );
  }

174
175
  // Test for PHP extensions.
  $requirements['php_extensions'] = array(
176
    'title' => t('PHP extensions'),
177
  );
178
179
180
181
182
183
184
185
186
187
188
189
190
191

  $missing_extensions = array();
  $required_extensions = array(
    'date',
    'dom',
    'filter',
    'gd',
    'hash',
    'json',
    'pcre',
    'pdo',
    'session',
    'SimpleXML',
    'SPL',
192
    'tokenizer',
193
194
195
196
197
198
199
200
201
    'xml',
  );
  foreach ($required_extensions as $extension) {
    if (!extension_loaded($extension)) {
      $missing_extensions[] = $extension;
    }
  }

  if (!empty($missing_extensions)) {
202
    $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(
203
      '@system_requirements' => 'https://www.drupal.org/requirements',
204
205
    ));

206
207
208
209
210
211
212
213
214
215
216
    // 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,
        ),
      ),
217
    );
218

219
    $requirements['php_extensions']['value'] = t('Disabled');
220
221
    $requirements['php_extensions']['severity'] = REQUIREMENT_ERROR;
    $requirements['php_extensions']['description'] = $description;
222
223
  }
  else {
224
    $requirements['php_extensions']['value'] = t('Enabled');
225
  }
226

227
228
229
  if ($phase == 'install' || $phase == 'update') {
    // Test for PDO (database).
    $requirements['database_extensions'] = array(
230
      'title' => t('Database support'),
231
    );
232

233
    // Make sure PDO is available.
234
    $database_ok = extension_loaded('pdo');
235
    if (!$database_ok) {
236
      $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(
237
        '@link' => 'https://www.drupal.org/requirements/pdo',
238
239
240
241
      ));
    }
    else {
      // Make sure at least one supported database driver exists.
242
      $drivers = drupal_detect_database_types();
243
244
      if (empty($drivers)) {
        $database_ok = FALSE;
245
        $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(
246
          '@drupal-databases' => 'https://www.drupal.org/node/270#database',
247
248
249
250
251
252
        ));
      }
      // 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;
253
        $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(
254
          '@link' => 'https://www.drupal.org/requirements/pdo#pecl',
255
256
        ));
      }
257
    }
258

259
    if (!$database_ok) {
260
      $requirements['database_extensions']['value'] = t('Disabled');
261
      $requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
262
      $requirements['database_extensions']['description'] = $pdo_message;
263
264
    }
    else {
265
      $requirements['database_extensions']['value'] = t('Enabled');
266
    }
267
  }
268
269
  else {
    // Database information.
270
    $class = Database::getConnection()->getDriverClass('Install\\Tasks');
271
272
    $tasks = new $class();
    $requirements['database_system'] = array(
273
      'title' => t('Database system'),
274
275
276
      'value' => $tasks->name(),
    );
    $requirements['database_system_version'] = array(
277
      'title' => t('Database system version'),
278
279
280
      'value' => Database::getConnection()->version(),
    );
  }
281

282
  // Test PHP memory_limit
283
  $memory_limit = ini_get('memory_limit');
284
  $requirements['php_memory_limit'] = array(
285
    'title' => t('PHP memory limit'),
286
    'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
287
  );
288

289
  if (!Environment::checkMemoryLimit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
290
    $description = array();
291
    if ($phase == 'install') {
292
      $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));
293
294
    }
    elseif ($phase == 'update') {
295
      $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));
296
    }
297
    elseif ($phase == 'runtime') {
298
      $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));
299
    }
300

301
    if (!empty($description['phase'])) {
302
      if ($php_ini_path = get_cfg_var('cfg_file_path')) {
303
        $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));
304
305
      }
      else {
306
        $description['memory'] = t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
307
      }
308

309
      $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'));
310
311
312
313
314
315
316
317
318
319
320
321

      $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;
322
      $requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
323
    }
324
  }
325

326
  // Test configuration files and directory for writability.
327
  if ($phase == 'runtime') {
328
    $conf_errors = array();
329
330
331
332
333
334
335
336
337
338
    // 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());
    }
    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));
339
    }
340
    foreach (array('settings.php', 'settings.local.php', 'services.yml') as $conf_file) {
341
      $full_path = $site_path . '/' . $conf_file;
342
      if (file_exists($full_path) && !drupal_verify_install_file($full_path, FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE)) {
343
        $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));
344
345
346
347
348
349
350
      }
    }
    if (!empty($conf_errors)) {
      if (count($conf_errors) == 1) {
        $description = $conf_errors[0];
      }
      else {
351
352
353
354
355
356
357
358
359
360
        // 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,
            ),
          ),
361
        );
362
      }
363
      $requirements['configuration_files'] = array(
364
        'value' => t('Not protected'),
365
        'severity' => REQUIREMENT_ERROR,
366
        'description' => $description,
367
368
369
      );
    }
    else {
370
      $requirements['configuration_files'] = array(
371
        'value' => t('Protected'),
372
373
      );
    }
374
    $requirements['configuration_files']['title'] = t('Configuration files');
375
376
  }

377
378
379
380
381
382
383
384
385
  // 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://'),
    );
386
    if (PrivateStream::basePath()) {
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
      $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) {
        $requirements[$htaccess_file] = array(
          'title' => $info['title'],
          'value' => t('Not fully protected'),
          'severity' => REQUIREMENT_ERROR,
404
          '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' => 'https://www.drupal.org/SA-CORE-2013-003', '%directory' => $info['directory'])),
405
406
407
408
409
        );
      }
    }
  }

410
  // Report cron status.
411
  if ($phase == 'runtime') {
412
    $cron_config = \Drupal::config('system.cron');
413
    // Cron warning threshold defaults to two days.
414
    $threshold_warning = $cron_config->get('threshold.requirements_warning');
415
    // Cron error threshold defaults to two weeks.
416
    $threshold_error = $cron_config->get('threshold.requirements_error');
417

418
    // Determine when cron last ran.
419
    $cron_last = \Drupal::state()->get('system.cron_last');
420
    if (!is_numeric($cron_last)) {
421
      $cron_last = \Drupal::state()->get('install_time', 0);
422
    }
423

424
    // Determine severity based on time since cron last ran.
425
    $severity = REQUIREMENT_INFO;
426
    if (REQUEST_TIME - $cron_last > $threshold_error) {
427
      $severity = REQUIREMENT_ERROR;
428
    }
429
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
430
431
432
433
      $severity = REQUIREMENT_WARNING;
    }

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

436
    $requirements['cron'] = array(
437
      'title' => t('Cron maintenance tasks'),
438
439
440
      'severity' => $severity,
      'value' => $summary,
    );
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
    if ($severity != REQUIREMENT_INFO) {
      $requirements['cron']['description'][] = [
        [
          '#markup' => t('Cron has not run recently.'),
          '#suffix' => ' ',
        ],
        [
          '#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']),
          '#suffix' => ' ',
        ],
      ];
    }
    $requirements['cron']['description'][] = [
      [
        '#markup' => t('You can <a href="@cron">run cron manually</a>.', ['@cron' => \Drupal::url('system.run_cron')]),
      ],
      [
        '#prefix' => '<br />',
        '#markup' => t('To run cron from outside the site, go to <a href="@cron">@cron</a>', ['@cron' => \Drupal::url('system.cron', ['key' => \Drupal::state()->get('system.cron_key'), ['absolute' => TRUE]])]),
      ],
    ];
462
  }
463
  if ($phase != 'install') {
464
    $filesystem_config = \Drupal::config('system.file');
465
    $directories = array(
466
      PublicStream::basePath(),
467
468
      // By default no private files directory is configured. For private files
      // to be secure the admin needs to provide a path outside the webroot.
469
      PrivateStream::basePath(),
470
471
472
      file_directory_temp(),
    );
  }
473

474
475
  // During an install we need to make assumptions about the file system
  // unless overrides are provided in settings.php.
476
  if ($phase == 'install') {
477
    $directories = array();
478
    if ($file_public_path = Settings::get('file_public_path')) {
479
      $directories[] = $file_public_path;
480
481
482
    }
    else {
      // If we are installing Drupal, the settings.php file might not exist yet
483
      // in the intended site directory, so don't require it.
484
485
486
      $request = Request::createFromGlobals();
      $site_path = DrupalKernel::findSitePath($request);
      $directories[] = $site_path . '/files';
487
    }
488
489
    if ($file_private_path = Settings::get('file_private_path')) {
      $directories[] = $file_private_path;
490
    }
491
492
    if (!empty($GLOBALS['config']['system.file']['path']['temporary'])) {
      $directories[] = $GLOBALS['config']['system.file']['path']['temporary'];
493
494
495
496
497
498
    }
    else {
      // If the temporary directory is not overridden use an appropriate
      // temporary path for the system.
      $directories[] = file_directory_os_temp();
    }
499
500
  }

501
502
503
  // 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.
504
  if (!empty($GLOBALS['config_directories'])) {
505
506
507
    foreach ($GLOBALS['config_directories'] as $type => $directory) {
      $directories[] = config_get_config_directory($type);
    }
508
509
  }
  elseif ($phase != 'install') {
510
    $requirements['config directories'] = array(
511
512
      'title' => t('Configuration directories'),
      'value' => t('Not present'),
513
      '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')),
514
515
516
517
      'severity' => REQUIREMENT_ERROR,
    );
  }

518
  $requirements['file system'] = array(
519
    'title' => t('File system'),
520
  );
521

522
523
524
  $error = '';
  // For installer, create the directories if possible.
  foreach ($directories as $directory) {
525
526
527
    if (!$directory) {
      continue;
    }
528
    if ($phase == 'install') {
529
      file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
530
    }
531
532
533
534
    $is_writable = is_writable($directory);
    $is_directory = is_dir($directory);
    if (!$is_writable || !$is_directory) {
      $description = '';
535
      $requirements['file system']['value'] = t('Not writable');
536
      if (!$is_directory) {
537
        $error = t('The directory %directory does not exist.', array('%directory' => $directory));
538
539
      }
      else {
540
        $error = t('The directory %directory is not writable.', array('%directory' => $directory));
541
542
543
      }
      // The files directory requirement check is done only during install and runtime.
      if ($phase == 'runtime') {
544
        $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')));
545
546
547
548
      }
      elseif ($phase == 'install') {
        // For the installer UI, we need different wording. 'value' will
        // be treated as version, so provide none there.
549
        $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'));
550
551
552
        $requirements['file system']['value'] = '';
      }
      if (!empty($description)) {
553
554
555
556
557
558
559
560
        $description = array(
          '#type' => 'inline_template',
          '#template' => '{{ error }} {{ description }}',
          '#context' => array(
            'error' => $error,
            'description' => $description,
          ),
        );
561
562
563
        $requirements['file system']['description'] = $description;
        $requirements['file system']['severity'] = REQUIREMENT_ERROR;
      }
564
565
    }
    else {
566
567
568
      // This function can be called before the config_cache table has been
      // created.
      if ($phase == 'install' || file_default_scheme() == 'public') {
569
        $requirements['file system']['value'] = t('Writable (<em>public</em> download method)');
570
571
      }
      else {
572
        $requirements['file system']['value'] = t('Writable (<em>private</em> download method)');
573
      }
574
575
576
    }
  }

577
578
579
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
580
581
      'title' => t('Database updates'),
      'value' => t('Up to date'),
582
583
584
    );

    // Check installed modules.
585
    foreach (\Drupal::moduleHandler()->getModuleList() as $module => $filename) {
586
587
588
589
590
      $updates = drupal_get_schema_versions($module);
      if ($updates !== FALSE) {
        $default = drupal_get_installed_schema_version($module);
        if (max($updates) > $default) {
          $requirements['update']['severity'] = REQUIREMENT_ERROR;
591
          $requirements['update']['value'] = t('Out of date');
592
          $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')));
593
594
595
596
          break;
        }
      }
    }
597
598
599
600
601
602
603
604
605
606

    // Verify that no entity updates are pending after running every DB update.
    if (!isset($requirements['update']['severity']) && \Drupal::entityDefinitionUpdateManager()->needsUpdates()) {
      $requirements['entity_update'] = array(
        'title' => t('Entity/field definitions'),
        'value' => t('Mismatch detected'),
        'severity' => REQUIREMENT_ERROR,
        // @todo Provide details: https://www.drupal.org/node/2554911
        'description' => t('Mismatched entity and/or field definitions.'),
      );
607
    }
608
609
  }

610
611
  // Verify the update.php access setting
  if ($phase == 'runtime') {
612
    if (Settings::get('update_free_access')) {
613
      $requirements['update access'] = array(
614
        'value' => t('Not protected'),
615
        'severity' => REQUIREMENT_ERROR,
616
        '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\']')),
617
618
619
620
      );
    }
    else {
      $requirements['update access'] = array(
621
        'value' => t('Protected'),
622
623
      );
    }
624
    $requirements['update access']['title'] = t('Access to update.php');
625
626
  }

627
628
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
629
    $profile = drupal_get_profile();
630
631
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
632
      // Ignore disabled modules and installation profiles.
633
      if (!$file->status || $module == $profile) {
634
635
636
637
638
639
        continue;
      }
      // Check the module's PHP version.
      $name = $file->info['name'];
      $php = $file->info['php'];
      if (version_compare($php, PHP_VERSION, '>')) {
640
        $requirements['php']['description'] .= t('@name requires at least PHP @version.', array('@name' => $name, '@version' => $php));
641
642
643
644
645
646
647
648
        $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(
649
650
            'title' => t('Unresolved dependency'),
            'description' => t('@name requires this module.', array('@name' => $name)),
651
652
653
654
655
656
657
658
            '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'];
659
        $version = str_replace(\Drupal::CORE_COMPATIBILITY . '-', '', $required_file->info['version']);
660
661
662
663
        $compatibility = drupal_check_incompatibility($requirement, $version);
        if ($compatibility) {
          $compatibility = rtrim(substr($compatibility, 2), ')');
          $requirements["$module-$required_module"] = array(
664
665
            '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)),
666
667
668
669
670
671
672
673
674
            'value' => t('@required_name (Version @compatibility required)', array('@required_name' => $required_name, '@compatibility' => $compatibility)),
            'severity' => REQUIREMENT_ERROR,
          );
          continue;
        }
      }
    }
  }

675
  // Test Unicode library
676
  include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
677
678
  $requirements = array_merge($requirements, unicode_requirements());

679
  if ($phase == 'runtime') {
680
    // Check for update status module.
681
    if (!\Drupal::moduleHandler()->moduleExists('update')) {
682
      $requirements['update status'] = array(
683
        'value' => t('Not enabled'),
684
        'severity' => REQUIREMENT_WARNING,
685
        '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(
686
          '@update' => 'https://www.drupal.org/documentation/modules/update',
687
688
          '@module' => \Drupal::url('system.modules_list'),
        )),
689
690
691
692
      );
    }
    else {
      $requirements['update status'] = array(
693
        'value' => t('Enabled'),
694
695
      );
    }
696
    $requirements['update status']['title'] = t('Update notifications');
697

698
    if (Settings::get('rebuild_access')) {
699
700
701
702
703
704
705
      $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.'),
      );
    }
706
707
  }

708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
  // 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'),
        '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')),
        '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))),
      );
    }
  }
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743

  // 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');
      $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]);
    }
    else {
      $requirements['twig_c_extension']['description'] = t('The <a href="@url">Twig C extension</a> is available', ['@url' => $url]);
    }
  }
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761

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

763
764
765
  return $requirements;
}

766
/**
767
 * Implements hook_install().
768
 */
769
function system_install() {
770
  // Populate the cron key state variable.
771
  $cron_key = Crypt::randomBytesBase64(55);
772
  \Drupal::state()->set('system.cron_key', $cron_key);
773

774
775
776
777
778
779
  // 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');
  }
780
  $site->save(TRUE);
781
782
}

783
/**
784
 * Implements hook_schema().
785
786
787
 */
function system_schema() {
  $schema['batch'] = array(
788
    'description' => 'Stores details about batches (processes that run in multiple HTTP requests).',
789
    'fields' => array(
790
      'bid' => array(
791
        'description' => 'Primary Key: Unique batch ID.',
792
793
794
        // This is not a serial column, to allow both progressive and
        // non-progressive batches. See batch_process().
        'type' => 'int',
795
        'unsigned' => TRUE,
796
797
        'not null' => TRUE,
      ),
798
      'token' => array(
799
        'description' => "A string token generated against the current user's session id and the batch id, used to ensure that only the user who submitted the batch can effectively access it.",
800
        'type' => 'varchar_ascii',
801
        'length' => 64,
802
803
        'not null' => TRUE,
      ),
804
      'timestamp' => array(
805
        'description' => 'A Unix timestamp indicating when this batch was submitted for processing. Stale batches are purged at cron time.',
806
        'type' => 'int',
807
808
        'not null' => TRUE,
      ),
809
      'batch' => array(
810
        'description' => 'A serialized array containing the processing data for the batch.',
811
        'type' => 'blob',
812
        'not null' => FALSE,
813
        'size' => 'big',
814
      ),
815
    ),
816
    'primary key' => array('bid'),
817
818
819
820
    'indexes' => array(
      'token' => array('token'),
    ),
  );
821
822

  $schema['flood'] = array(
823
    'description' => 'Flood controls the threshold of events, such as the number of contact attempts.',
824
    'fields' => array(
825
      'fid' => array(
826
        'description' => 'Unique flood event ID.',
827
        'type' => 'serial',
828
829
        'not null' => TRUE,
      ),
830
      'event' => array(
831
        'description' => 'Name of event (e.g. contact).',
832
        'type' => 'varchar_ascii',
833
834
        'length' => 64,
        'not null' => TRUE,
835
836
        'default' => '',
      ),
837
838
      'identifier' => array(
        'description' => 'Identifier of the visitor, such as an IP address or hostname.',
839
        'type' => 'varchar_ascii',
840
841
        'length' => 128,
        'not null' => TRUE,
842
843
        'default' => '',
      ),
844
      'timestamp' => array(
845
        'description' => 'Timestamp of the event.',
846
847
        'type' => 'int',
        'not null' => TRUE,
848
        'default' => 0,
849
      ),
850
851
852
853
854
855
      'expiration' => array(
        'description' => 'Expiration timestamp. Expired events are purged on cron run.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
856
    ),
857
    'primary key' => array('fid'),
858
    'indexes' => array(
859
      'allow' => array('event', 'identifier', 'timestamp'),
860
      'purge' => array('expiration'),
861
    ),
862
  );
863

864
  $schema['key_value'] = array(
865
    'description' => 'Generic key-value storage table. See the state system for an example.',
866
867
868
    'fields' => array(
      'collection' => array(
        'description' => 'A named collection of key and value pairs.',
869
        'type' => 'varchar_ascii',
870
871
872
873
874
875
        '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.',
876
        'type' => 'varchar_ascii',
877
878
879
880
881
882
883
884
885
886
887
888
889
890
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
      ),
      'value' => array(
        'description' => 'The value.',
        'type' => 'blob',
        'not null' => TRUE,
        'size' => 'big',
      ),
    ),
    'primary key' => array('collection', 'name'),
  );

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

929
930
931
932
933
934
935
936
937
938
  $schema['queue'] = array(
    'description' => 'Stores items in queues.',
    'fields' => array(
      'item_id' => array(
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'Primary Key: Unique item ID.',
      ),
      'name' => array(
939
        'type' => 'varchar_ascii',
940
941
942
943
944
945
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
        'description' => 'The queue name.',
      ),
      'data' => array(
946
        'type' => 'blob',
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
        'not null' => FALSE,
        'size' => 'big',
        'serialize' => TRUE,
        'description' => 'The arbitrary data for the item.',
      ),
      'expire' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'Timestamp when the claim lease expires on the item.',
      ),
      'created' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'Timestamp when the item was created.',
      ),
    ),
    'primary key' => array('item_id'),
    'indexes' => array(
967
968
      'name_created' => array('name', 'created'),
      'expire' => array('expire'),
969
970
971
    ),
  );

972
973
974
975
976
  $schema['router'] = array(
    'description' => 'Maps paths to various callbacks (access, page and title)',
    'fields' => array(
      'name' => array(
        'description' => 'Primary Key: Machine name of this route',
977
        'type' => 'varchar_ascii',
978
979
980
981
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
982
983
      'path' => array(
        'description' => 'The path for this URI',
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'pattern_outline' => array(
        'description' => 'The pattern',
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
      'fit' => array(
        'description' => 'A numeric representation of how specific the path is.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
      'route' => array(
        'description' => 'A serialized Route object',
1004
1005
        'type' => 'blob',
        'size' => 'big',
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
      ),
      'number_parts' => array(
        'description' => 'Number of parts in this router path.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'size' => 'small',
      ),
    ),
    'indexes' => array(
1016
      'pattern_outline_parts' => array('pattern_outline', 'number_parts'),
1017