system.install 47.1 KB
Newer Older
Dries's avatar
   
Dries committed
1
<?php
2

3
4
5
6
/**
 * @file
 * Install, update and uninstall functions for the system module.
 */
7

8
use Drupal\Component\Utility\Crypt;
9
use Drupal\Component\Utility\Environment;
10
use Drupal\Component\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
140
141
142
    // $phpversion is safe and output of l() is safe, so this value is safe.
    if ($phase === 'runtime') {
      $phpversion_label = SafeMarkup::set($phpversion . ' (' . \Drupal::l(t('more information'), new Url('system.php')) . ')');
    }
143
    $requirements['php'] = array(
144
      'title' => t('PHP'),
145
      'value' => $phpversion_label,
146
147
148
149
    );
  }
  else {
    $requirements['php'] = array(
150
      'title' => t('PHP'),
151
      'value' => $phpversion_label,
152
      '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')),
153
154
155
156
      'severity' => REQUIREMENT_INFO,
    );
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

378
379
380
381
382
383
384
385
386
  // 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://'),
    );
387
    if (PrivateStream::basePath()) {
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
      $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,
405
          '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'])),
406
407
408
409
410
        );
      }
    }
  }

411
  // Report cron status.
412
  if ($phase == 'runtime') {
413
    $cron_config = \Drupal::config('system.cron');
414
    // Cron warning threshold defaults to two days.
415
    $threshold_warning = $cron_config->get('threshold.requirements_warning');
416
    // Cron error threshold defaults to two weeks.
417
    $threshold_error = $cron_config->get('threshold.requirements_error');
418
    // Cron configuration help text.
419
    $help = t('For more information, see the online handbook entry for <a href="@cron-handbook">configuring cron jobs</a>.', array('@cron-handbook' => 'https://www.drupal.org/cron'));
420

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

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

    // Set summary and description based on values determined above.
437
    $summary = t('Last run !time ago', array('!time' => \Drupal::service('date.formatter')->formatTimeDiffSince($cron_last)));
438
    $description = '';
439
    if ($severity != REQUIREMENT_INFO) {
440
      $description = t('Cron has not run recently.') . ' ' . $help;
441
    }
442

443
444
    $description .= ' ' . t('You can <a href="@cron">run cron manually</a>.', array('@cron' => \Drupal::url('system.run_cron')));
    $description .= '<br />' . t('To run cron from outside the site, go to <a href="!cron">!cron</a>', array('!cron' => \Drupal::url('system.cron', array('key' => \Drupal::state()->get('system.cron_key'), array('absolute' => TRUE)))));
445

446
    $requirements['cron'] = array(
447
      'title' => t('Cron maintenance tasks'),
448
449
      'severity' => $severity,
      'value' => $summary,
450
451
452
      // @todo This string is concatenated from t() calls, safe drupal_render()
      //   output, whitespace, and <br /> tags, so is safe. However, as a best
      //   practice, we should not use SafeMarkup::set() around a variable. Fix
453
      //   in: https://www.drupal.org/node/2296929.
454
      'description' => SafeMarkup::set($description),
455
    );
456
  }
457
  if ($phase != 'install') {
458
    $filesystem_config = \Drupal::config('system.file');
459
    $directories = array(
460
      PublicStream::basePath(),
461
462
      // By default no private files directory is configured. For private files
      // to be secure the admin needs to provide a path outside the webroot.
463
      PrivateStream::basePath(),
464
465
466
      file_directory_temp(),
    );
  }
467

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

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

512
  $requirements['file system'] = array(
513
    'title' => t('File system'),
514
  );
515

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

571
572
573
  // See if updates are available in update.php.
  if ($phase == 'runtime') {
    $requirements['update'] = array(
574
575
      'title' => t('Database updates'),
      'value' => t('Up to date'),
576
577
578
    );

    // Check installed modules.
579
    foreach (\Drupal::moduleHandler()->getModuleList() as $module => $filename) {
580
581
582
583
584
      $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;
585
          $requirements['update']['value'] = t('Out of date');
586
          $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')));
587
588
589
590
          break;
        }
      }
    }
591
592
593
    if (!isset($requirements['update']['severity']) && \Drupal::service('entity.definition_update_manager')->needsUpdates()) {
      $requirements['update']['severity'] = REQUIREMENT_ERROR;
      $requirements['update']['value'] = t('Out of date');
594
      $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')));
595
    }
596
597
  }

598
599
  // Verify the update.php access setting
  if ($phase == 'runtime') {
600
    if (Settings::get('update_free_access')) {
601
      $requirements['update access'] = array(
602
        'value' => t('Not protected'),
603
        'severity' => REQUIREMENT_ERROR,
604
        '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\']')),
605
606
607
608
      );
    }
    else {
      $requirements['update access'] = array(
609
        'value' => t('Protected'),
610
611
      );
    }
612
    $requirements['update access']['title'] = t('Access to update.php');
613
614
  }

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

663
  // Test Unicode library
664
  include_once DRUPAL_ROOT . '/core/includes/unicode.inc';
665
666
  $requirements = array_merge($requirements, unicode_requirements());

667
  if ($phase == 'runtime') {
668
    // Check for update status module.
669
    if (!\Drupal::moduleHandler()->moduleExists('update')) {
670
      $requirements['update status'] = array(
671
        'value' => t('Not enabled'),
672
        'severity' => REQUIREMENT_WARNING,
673
        '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(
674
          '@update' => 'https://www.drupal.org/documentation/modules/update',
675
676
          '@module' => \Drupal::url('system.modules_list'),
        )),
677
678
679
680
      );
    }
    else {
      $requirements['update status'] = array(
681
        'value' => t('Enabled'),
682
683
      );
    }
684
    $requirements['update status']['title'] = t('Update notifications');
685

686
    if (Settings::get('rebuild_access')) {
687
688
689
690
691
692
693
      $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.'),
      );
    }
694
695
  }

696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
  // 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))),
      );
    }
  }
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731

  // 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]);
    }
  }
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749

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

751
752
753
  return $requirements;
}

754
/**
755
 * Implements hook_install().
756
 */
757
function system_install() {
758
  // Populate the cron key state variable.
759
  $cron_key = Crypt::randomBytesBase64(55);
760
  \Drupal::state()->set('system.cron_key', $cron_key);
761

762
763
764
765
766
767
  // 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');
  }
768
  $site->save(TRUE);
769
770
}

771
/**
772
 * Implements hook_schema().
773
774
775
 */
function system_schema() {
  $schema['batch'] = array(
776
    'description' => 'Stores details about batches (processes that run in multiple HTTP requests).',
777
    'fields' => array(
778
      'bid' => array(
779
        'description' => 'Primary Key: Unique batch ID.',
780
781
782
        // This is not a serial column, to allow both progressive and
        // non-progressive batches. See batch_process().
        'type' => 'int',
783
        'unsigned' => TRUE,
784
785
        'not null' => TRUE,
      ),
786
      'token' => array(
787
        '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.",
788
        'type' => 'varchar_ascii',
789
        'length' => 64,
790
791
        'not null' => TRUE,
      ),
792
      'timestamp' => array(
793
        'description' => 'A Unix timestamp indicating when this batch was submitted for processing. Stale batches are purged at cron time.',
794
        'type' => 'int',
795
796
        'not null' => TRUE,
      ),
797
      'batch' => array(
798
        'description' => 'A serialized array containing the processing data for the batch.',
799
        'type' => 'blob',
800
        'not null' => FALSE,
801
        'size' => 'big',
802
      ),
803
    ),
804
    'primary key' => array('bid'),
805
806
807
808
    'indexes' => array(
      'token' => array('token'),
    ),
  );
809
810

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

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

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

917
918
919
920
921
922
923
924
925
926
  $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(
927
        'type' => 'varchar_ascii',
928
929
930
931
932
933
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
        'description' => 'The queue name.',
      ),
      'data' => array(
934
        'type' => 'blob',
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
        '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(
955
956
      'name_created' => array('name', 'created'),
      'expire' => array('expire'),
957
958
959
    ),
  );

960
961
962
963
964
  $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',
965
        'type' => 'varchar_ascii',
966
967
968
969
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ),
970
971
      'path' => array(
        'description' => 'The path for this URI',
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => ''<