system.install 64.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

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

72
  // Web server information.
73
  $software = \Drupal::request()->server->get('SERVER_SOFTWARE');
74
  $requirements['webserver'] = array(
75
    'title' => t('Web server'),
Steven Wittens's avatar
Steven Wittens committed
76
    'value' => $software,
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
136
137
138
  // 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,
139
        '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')),
140
141
142
143
144
145
146
147
      );
    }

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

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

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

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

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

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

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

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

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

  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,
251
        'description' => t('PHP OPcode caching can improve your site\'s performance considerably. It is <strong>highly recommended</strong> to have <a href=":opcache_link" target="_blank">OPcache</a> installed on your server.', array(':opcache_link' => 'http://php.net/manual/en/opcache.installation.php')),
252
253
254
255
256
257
      );
    }
    else {
      $requirements['php_opcache']['value'] = t('Enabled');
    }
    $requirements['php_opcache']['title'] = t('PHP OPcode caching');
258
  }
259

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

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

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

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

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

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

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

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

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

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

410
411
412
413
414
415
416
417
418
  // 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://'),
    );
419
    if (PrivateStream::basePath()) {
420
421
422
423
424
425
426
427
428
429
430
431
432
      $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) {
433
        $url = 'https://www.drupal.org/SA-CORE-2013-003';
434
435
436
437
        $requirements[$htaccess_file] = array(
          'title' => $info['title'],
          'value' => t('Not fully protected'),
          'severity' => REQUIREMENT_ERROR,
438
          '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'])),
439
440
441
442
443
        );
      }
    }
  }

444
  // Report cron status.
445
  if ($phase == 'runtime') {
446
    $cron_config = \Drupal::config('system.cron');
447
    // Cron warning threshold defaults to two days.
448
    $threshold_warning = $cron_config->get('threshold.requirements_warning');
449
    // Cron error threshold defaults to two weeks.
450
    $threshold_error = $cron_config->get('threshold.requirements_error');
451

452
    // Determine when cron last ran.
453
    $cron_last = \Drupal::state()->get('system.cron_last');
454
    if (!is_numeric($cron_last)) {
455
      $cron_last = \Drupal::state()->get('install_time', 0);
456
    }
457

458
    // Determine severity based on time since cron last ran.
459
    $severity = REQUIREMENT_INFO;
460
    if (REQUEST_TIME - $cron_last > $threshold_error) {
461
      $severity = REQUIREMENT_ERROR;
462
    }
463
    elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
464
465
466
467
      $severity = REQUIREMENT_WARNING;
    }

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

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

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

536
537
538
  // 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.
539
  if (!empty($GLOBALS['config_directories'])) {
540
541
542
    foreach ($GLOBALS['config_directories'] as $type => $directory) {
      $directories[] = config_get_config_directory($type);
    }
543
544
  }
  elseif ($phase != 'install') {
545
    $requirements['config directories'] = array(
546
547
      'title' => t('Configuration directories'),
      'value' => t('Not present'),
548
      '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')),
549
550
551
552
      'severity' => REQUIREMENT_ERROR,
    );
  }

553
  $requirements['file system'] = array(
554
    'title' => t('File system'),
555
  );
556

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

612
613
614
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
615
616
      'title' => t('Database updates'),
      'value' => t('Up to date'),
617
618
619
    );

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

    // 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.'),
      );
655
    }
656
657
  }

658
659
  // Verify the update.php access setting
  if ($phase == 'runtime') {
660
    if (Settings::get('update_free_access')) {
661
      $requirements['update access'] = array(
662
        'value' => t('Not protected'),
663
        'severity' => REQUIREMENT_ERROR,
664
        '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\']')),
665
666
667
668
      );
    }
    else {
      $requirements['update access'] = array(
669
        'value' => t('Protected'),
670
671
      );
    }
672
    $requirements['update access']['title'] = t('Access to update.php');
673
674
  }

675
676
  // Display an error if a newly introduced dependency in a module is not resolved.
  if ($phase == 'update') {
677
    $profile = drupal_get_profile();
678
679
    $files = system_rebuild_module_data();
    foreach ($files as $module => $file) {
680
      // Ignore disabled modules and installation profiles.
681
      if (!$file->status || $module == $profile) {
682
683
684
685
686
687
        continue;
      }
      // Check the module's PHP version.
      $name = $file->info['name'];
      $php = $file->info['php'];
      if (version_compare($php, PHP_VERSION, '>')) {
688
        $requirements['php']['description'] .= t('@name requires at least PHP @version.', array('@name' => $name, '@version' => $php));
689
690
691
692
693
694
695
696
        $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(
697
698
            'title' => t('Unresolved dependency'),
            'description' => t('@name requires this module.', array('@name' => $name)),
699
700
701
702
703
704
705
706
            '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'];
707
        $version = str_replace(\Drupal::CORE_COMPATIBILITY . '-', '', $required_file->info['version']);
708
709
710
711
        $compatibility = drupal_check_incompatibility($requirement, $version);
        if ($compatibility) {
          $compatibility = rtrim(substr($compatibility, 2), ')');
          $requirements["$module-$required_module"] = array(
712
713
            '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)),
714
715
716
717
718
719
720
721
722
            'value' => t('@required_name (Version @compatibility required)', array('@required_name' => $required_name, '@compatibility' => $compatibility)),
            'severity' => REQUIREMENT_ERROR,
          );
          continue;
        }
      }
    }
  }

723
  // Test Unicode library
724
  include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
725
726
  $requirements = array_merge($requirements, unicode_requirements());

727
  if ($phase == 'runtime') {
728
    // Check for update status module.
729
    if (!\Drupal::moduleHandler()->moduleExists('update')) {
730
      $requirements['update status'] = array(
731
        'value' => t('Not enabled'),
732
        'severity' => REQUIREMENT_WARNING,
733
734
735
        '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'),
736
        )),
737
738
739
740
      );
    }
    else {
      $requirements['update status'] = array(
741
        'value' => t('Enabled'),
742
743
      );
    }
744
    $requirements['update status']['title'] = t('Update notifications');
745

746
    if (Settings::get('rebuild_access')) {
747
748
749
750
751
752
753
      $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.'),
      );
    }
754
755
  }

756
757
758
759
760
761
762
763
  // 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'),
764
        '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')),
765
766
767
768
769
770
771
772
773
774
775
        '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))),
      );
    }
  }
776
777
778
779
780
781
782
783
784
785

  // 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');
786
      $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]);
787
788
    }
    else {
789
      $requirements['twig_c_extension']['description'] = t('The <a href=":url">Twig C extension</a> is available', [':url' => $url]);
790
791
    }
  }
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809

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

811
812
813
  return $requirements;
}

814
/**
815
 * Implements hook_install().
816
 */
817
function system_install() {
818
  // Populate the cron key state variable.
819
  $cron_key = Crypt::randomBytesBase64(55);
820
  \Drupal::state()->set('system.cron_key', $cron_key);
821

822
823
824
825
826
827
  // 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');
  }
828
  $site->save(TRUE);
829
830
}

831
/**
832
 * Implements hook_schema().
833
834
835
 */
function system_schema() {
  $schema['batch'] = array(
836
    'description' => 'Stores details about batches (processes that run in multiple HTTP requests).',
837
    'fields' => array(
838
      'bid' => array(
839
        'description' => 'Primary Key: Unique batch ID.',
840
841
842
        // This is not a serial column, to allow both progressive and
        // non-progressive batches. See batch_process().
        'type' => 'int',
843
        'unsigned' => TRUE,
844
845
        'not null' => TRUE,
      ),
846
      'token' => array(
847
        '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.",
848
        'type' => 'varchar_ascii',
849
        'length' => 64,
850
851
        'not null' => TRUE,
      ),
852
      'timestamp' => array(
853
        'description' => 'A Unix timestamp indicating when this batch was submitted for processing. Stale batches are purged at cron time.',
854
        'type' => 'int',
855
856
        'not null' => TRUE,
      ),
857
      'batch' => array(
858
        'description' => 'A serialized array containing the processing data for the batch.',
859
        'type' => 'blob',
860
        'not null' => FALSE,
861
        'size' => 'big',
862
      ),
863
    ),
864
    'primary key' => array('bid'),
865
866
867
868
    'indexes' => array(
      'token' => array('token'),
    ),
  );
869
870

  $schema['flood'] = array(
871
    'description' => 'Flood controls the threshold of events, such as the number of contact attempts.',
872
    'fields' => array(
873
      'fid' => array(
874
        'description' => 'Unique flood event ID.',
875
        'type' => 'serial',
876
877
        'not null' => TRUE,
      ),
878
      'event' => array(
879
        'description' => 'Name of event (e.g. contact).',
880
        'type' => 'varchar_ascii',
881
882
        'length' => 64,
        'not null' => TRUE,
883
884
        'default' => '',
      ),
885
886
      'identifier' => array(
        'description' => 'Identifier of the visitor, such as an IP address or hostname.',
887
        'type' => 'varchar_ascii',
888
889
        'length' => 128,
        'not null' => TRUE,
890
891
        'default' => '',
      ),
892
      'timestamp' => array(
893
        'description' => 'Timestamp of the event.',
894
895
        'type' => 'int',
        'not null' => TRUE,
896
        'default' => 0,
897
      ),
898
899
900
901
902
903
      'expiration' => array(
        'description' => 'Expiration timestamp. Expired events are purged on cron run.',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
904
    ),
905
    'primary key' => array('fid'),
906
    'indexes' => array(
907
      'allow' => array('event', 'identifier', 'timestamp'),
908
      'purge' => array('expiration'),
909
    ),
910
  );
911

912
  $schema['key_value'] = array(
913
    'description' => 'Generic key-value storage table. See the state system for an example.',
914
915
916
    'fields' => array(
      'collection' => array(
        'description' => 'A named collection of key and value pairs.',
917
        'type' => 'varchar_ascii',
918
919
920
921
922
923
        '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.',
924
        'type' => 'varchar_ascii',
925
926
927
928
929
930
931
932
933
934
935
936
937
938
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
      ),
      'value' => array(
        'description' => 'The value.',
        'type' => 'blob',
        'not null' => TRUE,
        'size' => 'big',
      ),
    ),
    'primary key' => array('collection', 'name'),
  );

939
940
941
942
943
  $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.',
944
        'type' => 'varchar_ascii',
945
946
947
948
949
950
951
        '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.',
952
        'type' => 'varchar_ascii',
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
        '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'),