Newer
Older
Dries Buytaert
committed
Angie Byron
committed
/**
* @file
* Install, update and uninstall functions for the system module.
*/
Alex Pott
committed
use Drupal\Component\FileSystem\FileSystem as FileSystemComponent;
use Drupal\Component\Utility\Bytes;
Alex Pott
committed
use Drupal\Component\Utility\Crypt;
use Drupal\Component\Utility\Environment;
use Drupal\Component\Utility\OpCodeCache;
use Drupal\Component\Utility\Unicode;
use Drupal\Core\Cache\Cache;
Alex Pott
committed
use Drupal\Core\Database\Database;
use Drupal\Core\DrupalKernel;
use Drupal\Core\Entity\ContentEntityTypeInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Entity\FieldableEntityInterface;
use Drupal\Core\Entity\Sql\SqlContentEntityStorage;
use Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema;
use Drupal\Core\Extension\Extension;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\StringTranslation\PluralTranslatableMarkup;
use Drupal\path_alias\Entity\PathAlias;
use Drupal\path_alias\PathAliasStorage;
Alex Pott
committed
use Drupal\Core\Site\Settings;
use Drupal\Core\StreamWrapper\PrivateStream;
use Drupal\Core\StreamWrapper\PublicStream;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\Url;
use Symfony\Component\HttpFoundation\Request;
Angie Byron
committed
Steven Wittens
committed
/**
Jennifer Hodgdon
committed
* Implements hook_requirements().
Steven Wittens
committed
*/
function system_requirements($phase) {
Alex Pott
committed
global $install_state;
// Reset the extension lists.
\Drupal::service('extension.list.module')->reset();
\Drupal::service('extension.list.theme')->reset();
$requirements = [];
Steven Wittens
committed
// Report Drupal version
if ($phase == 'runtime') {
$requirements['drupal'] = [
'title' => t('Drupal'),
'value' => \Drupal::VERSION,
'severity' => REQUIREMENT_INFO,
'weight' => -10,
];
Angie Byron
committed
Jennifer Hodgdon
committed
// Display the currently active installation profile, if the site
// is not running the default installation profile.
catch
committed
$profile = \Drupal::installProfile();
Angie Byron
committed
if ($profile != 'standard') {
$info = \Drupal::service('extension.list.module')->getExtensionInfo($profile);
$requirements['install_profile'] = [
'title' => t('Installation profile'),
'value' => t('%profile_name (%profile-%version)', [
Angie Byron
committed
'%profile_name' => $info['name'],
'%profile' => $profile,
'%version' => $info['version'],
]),
Angie Byron
committed
'severity' => REQUIREMENT_INFO,
'weight' => -9,
];
}
// Warn if any experimental modules are installed.
Alex Bronstein
committed
$experimental_modules = [];
Alex Pott
committed
$enabled_modules = \Drupal::moduleHandler()->getModuleList();
foreach ($enabled_modules as $module => $data) {
$info = \Drupal::service('extension.list.module')->getExtensionInfo($module);
Alex Pott
committed
if (isset($info['package']) && $info['package'] === 'Core (Experimental)') {
Alex Bronstein
committed
$experimental_modules[$module] = $info['name'];
Alex Bronstein
committed
if (!empty($experimental_modules)) {
$requirements['experimental_modules'] = [
'title' => t('Experimental modules enabled'),
Alex Bronstein
committed
'value' => t('Experimental modules found: %module_list. <a href=":url">Experimental modules</a> are provided for testing purposes only. Use at your own risk.', ['%module_list' => implode(', ', $experimental_modules), ':url' => 'https://www.drupal.org/core/experimental']),
'severity' => REQUIREMENT_WARNING,
];
}
// Warn if any experimental themes are installed.
$experimental_themes = [];
$installed_themes = \Drupal::service('theme_handler')->listInfo();
foreach ($installed_themes as $theme => $data) {
if (isset($data->info['experimental']) && $data->info['experimental']) {
$experimental_themes[$theme] = $data->info['name'];
}
}
if (!empty($experimental_themes)) {
$requirements['experimental_themes'] = [
'title' => t('Experimental themes enabled'),
'value' => t('Experimental themes found: %theme_list. Experimental themes are provided for testing purposes only. Use at your own risk.', ['%theme_list' => implode(', ', $experimental_themes)]),
'severity' => REQUIREMENT_WARNING,
];
Steven Wittens
committed
}
Gábor Hojtsy
committed
// Web server information.
$request_object = \Drupal::request();
$software = $request_object->server->get('SERVER_SOFTWARE');
$requirements['webserver'] = [
'title' => t('Web server'),
];
Steven Wittens
committed
Alex Pott
committed
// Tests clean URL support.
if ($phase == 'install' && $install_state['interactive'] && !$request_object->query->has('rewrite') && strpos($software, 'Apache') !== FALSE) {
Alex Pott
committed
// 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;
}
elseif ($matches[1] == 2) {
Alex Pott
committed
if (!isset($matches[2])) {
$rewrite_warning = TRUE;
}
elseif ($matches[2] < 2) {
Alex Pott
committed
$rewrite_error = TRUE;
}
elseif ($matches[2] == 2) {
Alex Pott
committed
if (!isset($matches[3])) {
$rewrite_warning = TRUE;
}
elseif ($matches[3] < 16) {
Alex Pott
committed
$rewrite_error = TRUE;
}
}
}
}
else {
$rewrite_warning = TRUE;
}
if ($rewrite_warning) {
$requirements['apache_version'] = [
Alex Pott
committed
'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.', ['@reported' => $apache_version_string]),
];
Alex Pott
committed
}
if ($rewrite_error) {
$requirements['Apache version'] = [
Alex Pott
committed
'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.', [':link' => 'http://drupal.org/docs/8/clean-urls-in-drupal-8']),
];
Alex Pott
committed
}
if (!$rewrite_error && !$rewrite_warning) {
$requirements['rewrite_module'] = [
Alex Pott
committed
'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>', [':link' => 'http://drupal.org/docs/8/clean-urls-in-drupal-8']),
];
Alex Pott
committed
}
}
// Verify the user is running a supported PHP version.
// If the site is running a recommended version of PHP, just display it
// as an informational message on the status report. This will be overridden
// with an error or warning if the site is running older PHP versions for
// which Drupal has already or will soon drop support.
Alex Pott
committed
$phpversion = $phpversion_label = phpversion();
if (function_exists('phpinfo')) {
Alex Pott
committed
if ($phase === 'runtime') {
$phpversion_label = t('@phpversion (<a href=":url">more information</a>)', ['@phpversion' => $phpversion, ':url' => (new Url('system.php'))->toString()]);
Alex Pott
committed
}
$requirements['php'] = [
'title' => t('PHP'),
Alex Pott
committed
'value' => $phpversion_label,
];
}
else {
// @todo Revisit whether this description makes sense in
// https://www.drupal.org/project/drupal/issues/2927318.
$requirements['php'] = [
'title' => t('PHP'),
Alex Pott
committed
'value' => $phpversion_label,
'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.', [':phpinfo' => 'https://www.drupal.org/node/243993']),
'severity' => REQUIREMENT_INFO,
];
}
// Check if the PHP version is below what Drupal supports.
if (version_compare($phpversion, DRUPAL_MINIMUM_SUPPORTED_PHP) < 0) {
$requirements['php']['description'] = t('Your PHP installation is too old. Drupal requires at least PHP %version. It is recommended to upgrade to PHP version %recommended or higher for the best ongoing support. See <a href="http://php.net/supported-versions.php">PHP\'s version support documentation</a> and the <a href=":php_requirements">Drupal 8 PHP requirements handbook page</a> for more information.',
[
'%version' => DRUPAL_MINIMUM_SUPPORTED_PHP,
'%recommended' => DRUPAL_RECOMMENDED_PHP,
':php_requirements' => 'https://www.drupal.org/docs/8/system-requirements/php',
]
);
Steven Wittens
committed
$requirements['php']['severity'] = REQUIREMENT_ERROR;
// If the PHP version is also below the absolute minimum allowed, it's not
// safe to continue with the requirements check.
if (version_compare($phpversion, DRUPAL_MINIMUM_PHP) < 0) {
return $requirements;
}
// Otherwise downgrade the error to a warning during updates. Even if there
// are some problems with the site's PHP version, it's still better for the
// site to keep its Drupal codebase up to date.
elseif ($phase === 'update') {
Lee Rowlands
committed
$requirements['php']['severity'] = REQUIREMENT_WARNING;
}
// Since we allow sites with unsupported PHP versions to still run Drupal
// updates, we also need to be able to run tests with those PHP versions,
// which requires the ability to install test sites. Not all tests are
// required to pass on these PHP versions, but we want to monitor which
// ones do and don't.
elseif ($phase === 'install' && drupal_valid_test_ua()) {
$requirements['php']['severity'] = REQUIREMENT_INFO;
Lee Rowlands
committed
}
}
// For PHP versions that are still supported but no longer recommended,
// inform users of what's recommended, allowing them to take action before it
// becomes urgent.
elseif ($phase === 'runtime' && version_compare($phpversion, DRUPAL_RECOMMENDED_PHP) < 0) {
$requirements['php']['description'] = t('It is recommended to upgrade to PHP version %recommended or higher for the best ongoing support. See <a href="http://php.net/supported-versions.php">PHP\'s version support documentation</a> and the <a href=":php_requirements">Drupal 8 PHP requirements handbook page</a> for more information.', ['%recommended' => DRUPAL_RECOMMENDED_PHP, ':php_requirements' => 'https://www.drupal.org/docs/8/system-requirements/php']);
$requirements['php']['severity'] = REQUIREMENT_INFO;
Alex Pott
committed
}
// Test for PHP extensions.
$requirements['php_extensions'] = [
'title' => t('PHP extensions'),
];
$missing_extensions = [];
$required_extensions = [
'date',
'dom',
'filter',
'gd',
'hash',
'json',
'pcre',
'pdo',
'session',
'SimpleXML',
'SPL',
'tokenizer',
'xml',
];
foreach ($required_extensions as $extension) {
if (!extension_loaded($extension)) {
$missing_extensions[] = $extension;
}
}
if (!empty($missing_extensions)) {
$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):', [
':system_requirements' => 'https://www.drupal.org/requirements',
]);
// We use twig inline_template to avoid twig's autoescape.
$description = [
'#type' => 'inline_template',
'#template' => '{{ description }}{{ missing_extensions }}',
'#context' => [
'description' => $description,
'missing_extensions' => [
'#theme' => 'item_list',
'#items' => $missing_extensions,
],
],
];
$requirements['php_extensions']['value'] = t('Disabled');
$requirements['php_extensions']['severity'] = REQUIREMENT_ERROR;
$requirements['php_extensions']['description'] = $description;
Angie Byron
committed
}
else {
$requirements['php_extensions']['value'] = t('Enabled');
Alex Pott
committed
}
if ($phase == 'install' || $phase == 'runtime') {
// Check to see if OPcache is installed.
if (!OpCodeCache::isEnabled()) {
$requirements['php_opcache'] = [
Alex Pott
committed
'value' => t('Not enabled'),
'severity' => REQUIREMENT_WARNING,
'description' => t('PHP OPcode caching can improve your site\'s performance considerably. It is <strong>highly recommended</strong> to have <a href="http://php.net/manual/opcache.installation.php" target="_blank">OPcache</a> installed on your server.'),
];
Alex Pott
committed
}
else {
$requirements['php_opcache']['value'] = t('Enabled');
}
$requirements['php_opcache']['title'] = t('PHP OPcode caching');
Angie Byron
committed
}
Gábor Hojtsy
committed
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
// Check to see if APCu is installed and configured correctly.
if ($phase == 'runtime' && PHP_SAPI != 'cli') {
$requirements['php_apcu']['title'] = t('PHP APCu caching');
if (extension_loaded('apcu') && filter_var(ini_get('apc.enabled'), FILTER_VALIDATE_BOOLEAN)) {
$memory_info = apcu_sma_info(TRUE);
$apcu_actual_size = format_size($memory_info['seg_size']);
$apcu_recommended_size = '32 MB';
$requirements['php_apcu']['value'] = t('Enabled (@size)', ['@size' => $apcu_actual_size]);
if (Bytes::toInt($apcu_actual_size) < Bytes::toInt($apcu_recommended_size)) {
$requirements['php_apcu']['severity'] = REQUIREMENT_WARNING;
$requirements['php_apcu']['description'] = t('Depending on your configuration, Drupal can run with a @apcu_size APCu limit. However, a @apcu_default_size APCu limit (the default) or above is recommended, especially if your site uses additional custom or contributed modules.', [
'@apcu_size' => $apcu_actual_size,
'@apcu_default_size' => $apcu_recommended_size,
]);
}
else {
$memory_available = $memory_info['avail_mem'] / $memory_info['seg_size'];
if ($memory_available < 0.1) {
$requirements['php_apcu']['severity'] = REQUIREMENT_ERROR;
}
elseif ($memory_available < 0.25) {
$requirements['php_apcu']['severity'] = REQUIREMENT_WARNING;
}
else {
$requirements['php_apcu']['severity'] = REQUIREMENT_OK;
}
$requirements['php_apcu']['description'] = t('Memory available: @available.', [
'@available' => format_size($memory_info['avail_mem']),
]);
}
}
else {
$requirements['php_apcu'] += [
'value' => t('Not enabled'),
'severity' => REQUIREMENT_INFO,
'description' => t('PHP APCu caching can improve your site\'s performance considerably. It is <strong>highly recommended</strong> to have <a href="https://www.php.net/manual/apcu.installation.php" target="_blank">APCu</a> installed on your server.'),
];
}
}
if ($phase != 'update') {
// Test whether we have a good source of random bytes.
$requirements['php_random_bytes'] = [
'title' => t('Random number generation'),
];
try {
$bytes = random_bytes(10);
if (strlen($bytes) != 10) {
throw new \Exception("Tried to generate 10 random bytes, generated '" . strlen($bytes) . "'");
}
$requirements['php_random_bytes']['value'] = t('Successful');
}
catch (\Exception $e) {
// If /dev/urandom is not available on a UNIX-like system, check whether
// open_basedir restrictions are the cause.
$open_basedir_blocks_urandom = FALSE;
if (DIRECTORY_SEPARATOR === '/' && !@is_readable('/dev/urandom')) {
$open_basedir = ini_get('open_basedir');
if ($open_basedir) {
$open_basedir_paths = explode(PATH_SEPARATOR, $open_basedir);
$open_basedir_blocks_urandom = !array_intersect(['/dev', '/dev/', '/dev/urandom'], $open_basedir_paths);
}
}
$args = [
':drupal-php' => 'https://www.drupal.org/docs/8/system-requirements/php-requirements',
'%exception_message' => $e->getMessage(),
];
if ($open_basedir_blocks_urandom) {
$requirements['php_random_bytes']['description'] = t('Drupal is unable to generate highly randomized numbers, which means certain security features like password reset URLs are not as secure as they should be. Instead, only a slow, less-secure fallback generator is available. The most likely cause is that open_basedir restrictions are in effect and /dev/urandom is not on the whitelist. See the <a href=":drupal-php">system requirements</a> page for more information. %exception_message', $args);
}
else {
$requirements['php_random_bytes']['description'] = t('Drupal is unable to generate highly randomized numbers, which means certain security features like password reset URLs are not as secure as they should be. Instead, only a slow, less-secure fallback generator is available. See the <a href=":drupal-php">system requirements</a> page for more information. %exception_message', $args);
}
$requirements['php_random_bytes']['value'] = t('Less secure');
$requirements['php_random_bytes']['severity'] = REQUIREMENT_ERROR;
}
}
Angie Byron
committed
if ($phase == 'install' || $phase == 'update') {
// Test for PDO (database).
$requirements['database_extensions'] = [
'title' => t('Database support'),
];
Dries Buytaert
committed
// Make sure PDO is available.
Angie Byron
committed
$database_ok = extension_loaded('pdo');
Dries Buytaert
committed
if (!$database_ok) {
$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.', [
':link' => 'https://www.drupal.org/requirements/pdo',
]);
Dries Buytaert
committed
}
else {
// Make sure at least one supported database driver exists.
Angie Byron
committed
$drivers = drupal_detect_database_types();
Dries Buytaert
committed
if (empty($drivers)) {
$database_ok = FALSE;
$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>.', [
':drupal-databases' => 'https://www.drupal.org/requirements/database',
]);
Dries Buytaert
committed
}
// 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;
$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.', [
':link' => 'https://www.drupal.org/requirements/pdo#pecl',
]);
Dries Buytaert
committed
}
Angie Byron
committed
}
Angie Byron
committed
if (!$database_ok) {
$requirements['database_extensions']['value'] = t('Disabled');
Angie Byron
committed
$requirements['database_extensions']['severity'] = REQUIREMENT_ERROR;
Dries Buytaert
committed
$requirements['database_extensions']['description'] = $pdo_message;
Angie Byron
committed
}
else {
$requirements['database_extensions']['value'] = t('Enabled');
Angie Byron
committed
}
Dries Buytaert
committed
}
if ($phase === 'runtime' || $phase === 'update') {
// Database information.
Larry Garfield
committed
$class = Database::getConnection()->getDriverClass('Install\\Tasks');
/** @var \Drupal\Core\Database\Install\Tasks $tasks */
$tasks = new $class();
$requirements['database_system'] = [
'title' => t('Database system'),
'value' => $tasks->name(),
];
$requirements['database_system_version'] = [
'title' => t('Database system version'),
'value' => Database::getConnection()->version(),
];
$errors = $tasks->engineVersionRequirementsCheck();
$error_count = count($errors);
if ($error_count > 0) {
$error_message = [
'#theme' => 'item_list',
'#items' => $errors,
// Use the comma-list style to display a single error without bullets.
'#context' => ['list_style' => $error_count === 1 ? 'comma-list' : ''],
];
$requirements['database_system_version']['severity'] = REQUIREMENT_ERROR;
$requirements['database_system_version']['description'] = $error_message;
}
Dries Buytaert
committed
Gábor Hojtsy
committed
// Test PHP memory_limit
Gábor Hojtsy
committed
$memory_limit = ini_get('memory_limit');
$requirements['php_memory_limit'] = [
'title' => t('PHP memory limit'),
Dries Buytaert
committed
'value' => $memory_limit == -1 ? t('-1 (Unlimited)') : $memory_limit,
];
Gábor Hojtsy
committed
if (!Environment::checkMemoryLimit(DRUPAL_MINIMUM_PHP_MEMORY_LIMIT, $memory_limit)) {
$description = [];
Gábor Hojtsy
committed
if ($phase == 'install') {
$description['phase'] = t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the installation process.', ['%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT]);
Gábor Hojtsy
committed
}
elseif ($phase == 'update') {
$description['phase'] = t('Consider increasing your PHP memory limit to %memory_minimum_limit to help prevent errors in the update process.', ['%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT]);
Gábor Hojtsy
committed
}
Gábor Hojtsy
committed
elseif ($phase == 'runtime') {
$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.', ['%memory_limit' => $memory_limit, '%memory_minimum_limit' => DRUPAL_MINIMUM_PHP_MEMORY_LIMIT]);
Gábor Hojtsy
committed
}
Gábor Hojtsy
committed
if (!empty($description['phase'])) {
Gábor Hojtsy
committed
if ($php_ini_path = get_cfg_var('cfg_file_path')) {
$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).', ['%configuration-file' => $php_ini_path]);
Gábor Hojtsy
committed
}
else {
$description['memory'] = t('Contact your system administrator or hosting provider for assistance with increasing your PHP memory limit.');
Gábor Hojtsy
committed
}
Gábor Hojtsy
committed
$handbook_link = t('For more information, see the online handbook entry for <a href=":memory-limit">increasing the PHP memory limit</a>.', [':memory-limit' => 'https://www.drupal.org/node/207036']);
$description = [
'#type' => 'inline_template',
'#template' => '{{ description_phase }} {{ description_memory }} {{ handbook }}',
'#context' => [
'description_phase' => $description['phase'],
'description_memory' => $description['memory'],
'handbook' => $handbook_link,
],
];
$requirements['php_memory_limit']['description'] = $description;
Gábor Hojtsy
committed
$requirements['php_memory_limit']['severity'] = REQUIREMENT_WARNING;
Gábor Hojtsy
committed
}
Gábor Hojtsy
committed
}
Gábor Hojtsy
committed
// Test configuration files and directory for writability.
Steven Wittens
committed
if ($phase == 'runtime') {
$conf_errors = [];
// 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());
}
// Allow system administrators to disable permissions hardening for the site
// directory. This allows additional files in the site directory to be
// updated when they are managed in a version control system.
if (Settings::get('skip_permissions_hardening')) {
$error_value = t('Protection disabled');
// If permissions hardening is disabled, then only show a warning for a
// writable file, as a reminder, rather than an error.
$file_protection_severity = REQUIREMENT_WARNING;
}
else {
$error_value = t('Not protected');
// In normal operation, writable files or directories are an error.
$file_protection_severity = REQUIREMENT_ERROR;
if (!drupal_verify_install_file($site_path, FILE_NOT_WRITABLE, 'dir')) {
$conf_errors[] = t("The directory %file is not protected from modifications and poses a security risk. You must change the directory's permissions to be non-writable.", ['%file' => $site_path]);
}
}
foreach (['settings.php', 'settings.local.php', 'services.yml'] as $conf_file) {
$full_path = $site_path . '/' . $conf_file;
if (file_exists($full_path) && !drupal_verify_install_file($full_path, FILE_EXIST | FILE_READABLE | FILE_NOT_WRITABLE, 'file', !Settings::get('skip_permissions_hardening'))) {
$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.", ['%file' => $full_path]);
}
}
if (!empty($conf_errors)) {
if (count($conf_errors) == 1) {
$description = $conf_errors[0];
}
else {
// We use twig inline_template to avoid double escaping.
$description = [
'#type' => 'inline_template',
'#template' => '{{ configuration_error_list }}',
'#context' => [
'configuration_error_list' => [
'#theme' => 'item_list',
'#items' => $conf_errors,
],
],
];
}
$requirements['configuration_files'] = [
'value' => $error_value,
'severity' => $file_protection_severity,
'description' => $description,
];
Steven Wittens
committed
}
else {
$requirements['configuration_files'] = [
'value' => t('Protected'),
];
Steven Wittens
committed
}
Angie Byron
committed
$requirements['configuration_files']['title'] = t('Configuration files');
Steven Wittens
committed
}
Angie Byron
committed
// 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.
/** @var \Drupal\Core\File\HtaccessWriterInterface $htaccessWriter */
$htaccessWriter = \Drupal::service("file.htaccess_writer");
$htaccessWriter->ensure();
foreach ($htaccessWriter->defaultProtectedDirs() as $protected_dir) {
$htaccess_file = $protected_dir->getPath() . '/.htaccess';
Angie Byron
committed
// 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) {
$url = 'https://www.drupal.org/SA-CORE-2013-003';
$requirements[$htaccess_file] = [
'title' => new TranslatableMarkup($protected_dir->getTitle()),
Angie Byron
committed
'value' => t('Not fully protected'),
'severity' => REQUIREMENT_ERROR,
'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.', [':url' => $url, '@url' => $url, '%directory' => $protected_dir->getPath()]),
];
Angie Byron
committed
}
}
}
// Test that path.temporary config is not set.
if ($phase == 'runtime') {
if (!Settings::get('file_temp_path')) {
$filesystem_config = \Drupal::config('system.file');
if ($temp_path = $filesystem_config->get('path.temporary')) {
$requirements['temp_directory'] = [
'title' => t('Temporary Directory'),
'severity' => REQUIREMENT_WARNING,
'value' => 'Deprecated configuration',
'description' => [
[
'#markup' => t('You are using deprecated configuration for the temporary files path.'),
'#suffix' => ' ',
],
],
];
if ($temp_path === FileSystemComponent::getOsTemporaryDirectory()) {
$requirements['temp_directory']['description'][] = [
'#markup' => t('Your temporary directory configuration matches the OS default and can be safely removed.'),
'#suffix' => ' ',
];
}
else {
$requirements['temp_directory']['description'][] = [
catch
committed
'#markup' => t('Remove the configuration and add the following to <code>settings.php</code>. <code>$settings["file_temp_path"] = "%temp_path"</code>', ['%temp_path' => $temp_path]),
'#suffix' => ' ',
];
}
}
}
}
Gábor Hojtsy
committed
// Report cron status.
Steven Wittens
committed
if ($phase == 'runtime') {
$cron_config = \Drupal::config('system.cron');
Gábor Hojtsy
committed
// Cron warning threshold defaults to two days.
$threshold_warning = $cron_config->get('threshold.requirements_warning');
Gábor Hojtsy
committed
// Cron error threshold defaults to two weeks.
$threshold_error = $cron_config->get('threshold.requirements_error');
Gábor Hojtsy
committed
Dries Buytaert
committed
// Determine when cron last ran.
$cron_last = \Drupal::state()->get('system.cron_last');
Gábor Hojtsy
committed
if (!is_numeric($cron_last)) {
$cron_last = \Drupal::state()->get('install_time', 0);
Gábor Hojtsy
committed
}
Steven Wittens
committed
Gábor Hojtsy
committed
// Determine severity based on time since cron last ran.
$severity = REQUIREMENT_INFO;
Dries Buytaert
committed
if (REQUEST_TIME - $cron_last > $threshold_error) {
Gábor Hojtsy
committed
$severity = REQUIREMENT_ERROR;
Steven Wittens
committed
}
Dries Buytaert
committed
elseif (REQUEST_TIME - $cron_last > $threshold_warning) {
Gábor Hojtsy
committed
$severity = REQUIREMENT_WARNING;
}
// Set summary and description based on values determined above.
$summary = t('Last run @time ago', ['@time' => \Drupal::service('date.formatter')->formatTimeDiffSince($cron_last)]);
Dries Buytaert
committed
$requirements['cron'] = [
'title' => t('Cron maintenance tasks'),
Gábor Hojtsy
committed
'severity' => $severity,
'value' => $summary,
];
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'][] = [
[
'#type' => 'link',
'#prefix' => '(',
'#title' => t('more information'),
'#suffix' => ')',
'#url' => Url::fromRoute('system.cron_settings'),
],
[
'#prefix' => '<span class="cron-description__run-cron">',
'#suffix' => '</span>',
'#type' => 'link',
'#title' => t('Run cron'),
'#url' => Url::fromRoute('system.run_cron'),
],
];
Steven Wittens
committed
}
if ($phase != 'install') {
$filesystem_config = \Drupal::config('system.file');
$directories = [
PublicStream::basePath(),
// By default no private files directory is configured. For private files
// to be secure the admin needs to provide a path outside the webroot.
PrivateStream::basePath(),
\Drupal::service('file_system')->getTempDirectory(),
];
}
Steven Wittens
committed
// During an install we need to make assumptions about the file system
// unless overrides are provided in settings.php.
if ($phase == 'install') {
$directories = [];
if ($file_public_path = Settings::get('file_public_path')) {
$directories[] = $file_public_path;
}
else {
// If we are installing Drupal, the settings.php file might not exist yet
// in the intended site directory, so don't require it.
$request = Request::createFromGlobals();
$site_path = DrupalKernel::findSitePath($request);
$directories[] = $site_path . '/files';
}
if ($file_private_path = Settings::get('file_private_path')) {
$directories[] = $file_private_path;
}
if (Settings::get('file_temp_path')) {
$directories[] = Settings::get('file_temp_path');
}
else {
// If the temporary directory is not overridden use an appropriate
// temporary path for the system.
$directories[] = FileSystemComponent::getOsTemporaryDirectory();
}
// 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.
$config_sync_directory = Settings::get('config_sync_directory');
if (!empty($config_sync_directory)) {
// If we're installing Drupal try and create the config sync directory.
if (!is_dir($config_sync_directory) && $phase == 'install') {
\Drupal::service('file_system')->prepareDirectory($config_sync_directory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
}
if (!is_dir($config_sync_directory)) {
if ($phase == 'install') {
$description = t('An automated attempt to create the directory %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>.', ['%directory' => $config_sync_directory, ':handbook_url' => 'https://www.drupal.org/server-permissions']);
}
else {
$description = t('The directory %directory does not exist.', ['%directory' => $config_sync_directory]);
$requirements['config sync directory'] = [
'title' => t('Configuration sync directory'),
'description' => $description,
'severity' => REQUIREMENT_ERROR,
];
catch
committed
}
if ($phase != 'install' && empty($config_sync_directory)) {
$requirements['config sync directory'] = [
'title' => t('Configuration sync directory'),
'value' => t('Not present'),
'description' => t("Your %file file must define the %setting setting as a string containing the directory in which configuration files can be found.", ['%file' => $site_path . '/settings.php', '%setting' => "\$settings['config_sync_directory']"]),
'severity' => REQUIREMENT_ERROR,
];
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
// Handle other configuration directories. This will be removed in Drupal 9.
// See https://www.drupal.org/node/3018145.
$bc_config_directories = isset($GLOBALS['config_directories']) ? $GLOBALS['config_directories'] : [];
unset($bc_config_directories['sync']);
foreach (array_keys(array_filter($bc_config_directories)) as $type) {
@trigger_error("Automatic creation of '$type' configuration directory will be removed from drupal:9.0.0. See https://www.drupal.org/node/3018145.", E_USER_DEPRECATED);
$directory = config_get_config_directory($type);
// If we're installing Drupal try and create the config sync directory.
if (!is_dir($directory) && $phase == 'install') {
\Drupal::service('file_system')->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
}
if (!is_dir($directory)) {
if ($phase == 'install') {
$description = t('An automated attempt to create the directory %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>.', ['%directory' => $directory, ':handbook_url' => 'https://www.drupal.org/server-permissions']);
}
else {
$description = t('The directory %directory does not exist.', ['%directory' => $directory]);
}
$requirements['config directory ' . $type] = [
'title' => t('Configuration directory: %type', ['%type' => $type]),
'description' => $description,
'severity' => REQUIREMENT_ERROR,
];
}
}
$requirements['file system'] = [
'title' => t('File system'),
];
$error = '';
// For installer, create the directories if possible.
foreach ($directories as $directory) {
Angie Byron
committed
if (!$directory) {
continue;
}
if ($phase == 'install') {
\Drupal::service('file_system')->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
Gábor Hojtsy
committed
}
$is_writable = is_writable($directory);
$is_directory = is_dir($directory);
if (!$is_writable || !$is_directory) {
$description = '';
$requirements['file system']['value'] = t('Not writable');
if (!$is_directory) {
$error = t('The directory %directory does not exist.', ['%directory' => $directory]);
}
else {
$error = t('The directory %directory is not writable.', ['%directory' => $directory]);
}
// The files directory requirement check is done only during install and runtime.
if ($phase == 'runtime') {
$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.', [':admin-file-system' => Url::fromRoute('system.file_system_settings')->toString()]);
}
elseif ($phase == 'install') {
// For the installer UI, we need different wording. 'value' will
// be treated as version, so provide none there.
$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>.', [':handbook_url' => 'https://www.drupal.org/server-permissions']);
$requirements['file system']['value'] = '';
}
if (!empty($description)) {
$description = [
'#type' => 'inline_template',
'#template' => '{{ error }} {{ description }}',
'#context' => [
'error' => $error,
'description' => $description,
],
];
$requirements['file system']['description'] = $description;
$requirements['file system']['severity'] = REQUIREMENT_ERROR;
}
Gábor Hojtsy
committed
}
else {
Angie Byron
committed
// This function can be called before the config_cache table has been
// created.
Lee Rowlands
committed
if ($phase == 'install' || \Drupal::config('system.file')->get('default_scheme') == 'public') {
$requirements['file system']['value'] = t('Writable (<em>public</em> download method)');
}
else {
$requirements['file system']['value'] = t('Writable (<em>private</em> download method)');
}
// See if updates are available in update.php.
if ($phase == 'runtime') {
$requirements['update'] = [
'title' => t('Database updates'),
'value' => t('Up to date'),
];
// Check installed modules.
$has_pending_updates = FALSE;
foreach (\Drupal::moduleHandler()->getModuleList() as $module => $filename) {
$updates = drupal_get_schema_versions($module);
if ($updates !== FALSE) {
$default = drupal_get_installed_schema_version($module);
if (max($updates) > $default) {
$has_pending_updates = TRUE;
break;
}
}
}
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');
$requirements['update']['description'] = t('Some modules have database schema updates to install. You should run the <a href=":update">database update script</a> immediately.', [':update' => Url::fromRoute('system.db_update')->toString()]);
}
Alex Bronstein
committed
$requirements['entity_update'] = [
'title' => t('Entity/field definitions'),
'value' => t('Up to date'),
];
// Verify that no entity updates are pending.
if ($change_list = \Drupal::entityDefinitionUpdateManager()->getChangeSummary()) {
$build = [];
foreach ($change_list as $entity_type_id => $changes) {
$entity_type = \Drupal::entityTypeManager()->getDefinition($entity_type_id);
$build[] = [
'#theme' => 'item_list',
'#title' => $entity_type->getLabel(),
'#items' => $changes,
];
}
$entity_update_issues = \Drupal::service('renderer')->renderPlain($build);
$requirements['entity_update']['severity'] = REQUIREMENT_ERROR;
$requirements['entity_update']['value'] = t('Mismatched entity and/or field definitions');
$requirements['entity_update']['description'] = t('The following changes were detected in the entity type and field definitions. @updates', ['@updates' => $entity_update_issues]);
Alex Pott
committed
}
Gábor Hojtsy
committed
// Verify the update.php access setting
if ($phase == 'runtime') {
if (Settings::get('update_free_access')) {
$requirements['update access'] = [
'value' => t('Not protected'),
Gábor Hojtsy
committed
'severity' => REQUIREMENT_ERROR,
'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.', ['@settings_name' => '$settings[\'update_free_access\']']),
];
Gábor Hojtsy
committed
}
else {
$requirements['update access'] = [
'value' => t('Protected'),
];
Gábor Hojtsy
committed
}
$requirements['update access']['title'] = t('Access to update.php');
Gábor Hojtsy
committed
}
// Display an error if a newly introduced dependency in a module is not resolved.
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
if ($phase === 'update' || $phase === 'runtime') {
$create_extension_incompatibility_list = function ($extension_names, $description, $title) {
// Use an inline twig template to:
// - Concatenate two MarkupInterface objects and preserve safeness.
// - Use the item_list theme for the extension list.
$template = [
'#type' => 'inline_template',
'#template' => '{{ description }}{{ extensions }}',
'#context' => [
'extensions' => [
'#theme' => 'item_list',
],
],
];
$template['#context']['extensions']['#items'] = $extension_names;
$template['#context']['description'] = $description;
return [
'title' => $title,
'value' => [
'list' => $template,
'handbook_link' => [
'#markup' => t(
'Review the <a href=":url"> suggestions for resolving this incompatibility</a> to repair your installation, and then re-run update.php.',
[':url' => 'https://www.drupal.org/docs/8/update/troubleshooting-database-updates']
),
],
],
'severity' => REQUIREMENT_ERROR,
];
};
catch
committed
$profile = \Drupal::installProfile();
$files = \Drupal::service('extension.list.module')->getList();
$files += \Drupal::service('extension.list.theme')->getList();
$core_incompatible_extensions = [];
$php_incompatible_extensions = [];
foreach ($files as $extension_name => $file) {
// Ignore uninstalled extensions and installation profiles.
if (!$file->status || $extension_name == $profile) {
continue;
}
$name = $file->info['name'];
if (!empty($file->info['core_incompatible'])) {
$core_incompatible_extensions[$file->info['type']][] = $name;
}
// Check the extension's PHP version.
$php = $file->info['php'];
if (version_compare($php, PHP_VERSION, '>')) {
$php_incompatible_extensions[$file->info['type']][] = $name;
}
// Check the module's required modules.
Lee Rowlands
committed
/** @var \Drupal\Core\Extension\Dependency $requirement */
foreach ($file->requires as $requirement) {
Lee Rowlands
committed
$required_module = $requirement->getName();
// Check if the module exists.
if (!isset($files[$required_module])) {
$requirements["$extension_name-$required_module"] = [
'title' => t('Unresolved dependency'),
'description' => t('@name requires this module.', ['@name' => $name]),
'value' => t('@required_name (Missing)', ['@required_name' => $required_module]),
'severity' => REQUIREMENT_ERROR,
];
continue;
}
// Check for an incompatible version.
$required_file = $files[$required_module];
$required_name = $required_file->info['name'];
$version = str_replace(\Drupal::CORE_COMPATIBILITY . '-', '', $required_file->info['version']);
Lee Rowlands
committed
if (!$requirement->isCompatible($version)) {
$requirements["$extension_name-$required_module"] = [
'title' => t('Unresolved dependency'),
'description' => t('@name requires this module and version. Currently using @required_name version @version', ['@name' => $name, '@required_name' => $required_name, '@version' => $version]),
Lee Rowlands
committed
'value' => t('@required_name (Version @compatibility required)', ['@required_name' => $required_name, '@compatibility' => $requirement->getConstraintString()]),
'severity' => REQUIREMENT_ERROR,
];
continue;
}
}