From f2348f418d481e2a57158eafc9db233e3949a0f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=B4me=20Chilliet?= Date: Thu, 12 Oct 2023 17:04:11 +0200 Subject: [PATCH] Migrate missing PHP modules check to new API and improve it MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Test all modules listed as required in our documentation Signed-off-by: Côme Chilliet --- .../composer/composer/autoload_classmap.php | 1 + .../composer/composer/autoload_static.php | 1 + apps/settings/lib/AppInfo/Application.php | 2 + .../lib/Controller/CheckSetupController.php | 35 ------- apps/settings/lib/SetupChecks/PhpModules.php | 95 +++++++++++++++++++ .../Controller/CheckSetupControllerTest.php | 1 - core/js/setupchecks.js | 10 -- core/js/tests/specs/setupchecksSpec.js | 25 ----- 8 files changed, 99 insertions(+), 71 deletions(-) create mode 100644 apps/settings/lib/SetupChecks/PhpModules.php diff --git a/apps/settings/composer/composer/autoload_classmap.php b/apps/settings/composer/composer/autoload_classmap.php index d07cbebfb8354..289b3c92f7221 100644 --- a/apps/settings/composer/composer/autoload_classmap.php +++ b/apps/settings/composer/composer/autoload_classmap.php @@ -79,6 +79,7 @@ 'OCA\\Settings\\SetupChecks\\LegacySSEKeyFormat' => $baseDir . '/../lib/SetupChecks/LegacySSEKeyFormat.php', 'OCA\\Settings\\SetupChecks\\NeedsSystemAddressBookSync' => $baseDir . '/../lib/SetupChecks/NeedsSystemAddressBookSync.php', 'OCA\\Settings\\SetupChecks\\PhpDefaultCharset' => $baseDir . '/../lib/SetupChecks/PhpDefaultCharset.php', + 'OCA\\Settings\\SetupChecks\\PhpModules' => $baseDir . '/../lib/SetupChecks/PhpModules.php', 'OCA\\Settings\\SetupChecks\\PhpOutdated' => $baseDir . '/../lib/SetupChecks/PhpOutdated.php', 'OCA\\Settings\\SetupChecks\\PhpOutputBuffering' => $baseDir . '/../lib/SetupChecks/PhpOutputBuffering.php', 'OCA\\Settings\\SetupChecks\\ReadOnlyConfig' => $baseDir . '/../lib/SetupChecks/ReadOnlyConfig.php', diff --git a/apps/settings/composer/composer/autoload_static.php b/apps/settings/composer/composer/autoload_static.php index debf3f2966a6f..d0a7e0e414222 100644 --- a/apps/settings/composer/composer/autoload_static.php +++ b/apps/settings/composer/composer/autoload_static.php @@ -94,6 +94,7 @@ class ComposerStaticInitSettings 'OCA\\Settings\\SetupChecks\\LegacySSEKeyFormat' => __DIR__ . '/..' . '/../lib/SetupChecks/LegacySSEKeyFormat.php', 'OCA\\Settings\\SetupChecks\\NeedsSystemAddressBookSync' => __DIR__ . '/..' . '/../lib/SetupChecks/NeedsSystemAddressBookSync.php', 'OCA\\Settings\\SetupChecks\\PhpDefaultCharset' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpDefaultCharset.php', + 'OCA\\Settings\\SetupChecks\\PhpModules' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpModules.php', 'OCA\\Settings\\SetupChecks\\PhpOutdated' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpOutdated.php', 'OCA\\Settings\\SetupChecks\\PhpOutputBuffering' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpOutputBuffering.php', 'OCA\\Settings\\SetupChecks\\ReadOnlyConfig' => __DIR__ . '/..' . '/../lib/SetupChecks/ReadOnlyConfig.php', diff --git a/apps/settings/lib/AppInfo/Application.php b/apps/settings/lib/AppInfo/Application.php index e6106cb9b1edd..a8660a033b803 100644 --- a/apps/settings/lib/AppInfo/Application.php +++ b/apps/settings/lib/AppInfo/Application.php @@ -53,6 +53,7 @@ use OCA\Settings\SetupChecks\InternetConnectivity; use OCA\Settings\SetupChecks\LegacySSEKeyFormat; use OCA\Settings\SetupChecks\PhpDefaultCharset; +use OCA\Settings\SetupChecks\PhpModules; use OCA\Settings\SetupChecks\PhpOutdated; use OCA\Settings\SetupChecks\PhpOutputBuffering; use OCA\Settings\SetupChecks\ReadOnlyConfig; @@ -151,6 +152,7 @@ public function register(IRegistrationContext $context): void { $context->registerSetupCheck(InternetConnectivity::class); $context->registerSetupCheck(LegacySSEKeyFormat::class); $context->registerSetupCheck(PhpDefaultCharset::class); + $context->registerSetupCheck(PhpModules::class); $context->registerSetupCheck(PhpOutdated::class); $context->registerSetupCheck(PhpOutputBuffering::class); $context->registerSetupCheck(ReadOnlyConfig::class); diff --git a/apps/settings/lib/Controller/CheckSetupController.php b/apps/settings/lib/Controller/CheckSetupController.php index b2da455bc1166..4748dd155ced6 100644 --- a/apps/settings/lib/Controller/CheckSetupController.php +++ b/apps/settings/lib/Controller/CheckSetupController.php @@ -691,40 +691,6 @@ private function getAppDirsWithDifferentOwnerForAppRoot(int $currentUser, array return $appDirsWithDifferentOwner; } - /** - * Checks for potential PHP modules that would improve the instance - * - * @return string[] A list of PHP modules that is recommended - */ - protected function hasRecommendedPHPModules(): array { - $recommendedPHPModules = []; - - if (!extension_loaded('intl')) { - $recommendedPHPModules[] = 'intl'; - } - - if (!extension_loaded('sysvsem')) { - // used to limit the usage of resources by preview generator - $recommendedPHPModules[] = 'sysvsem'; - } - - if (!extension_loaded('exif')) { - // used to extract metadata from images - // required for correct orientation of preview images - $recommendedPHPModules[] = 'exif'; - } - - if (!defined('PASSWORD_ARGON2I')) { - // Installing php-sodium on >=php7.4 will provide PASSWORD_ARGON2I - // on previous version argon2 wasn't part of the "standard" extension - // and RedHat disabled it so even installing php-sodium won't provide argon2i - // support in password_hash/password_verify. - $recommendedPHPModules[] = 'sodium'; - } - - return $recommendedPHPModules; - } - protected function isImagickEnabled(): bool { if ($this->config->getAppValue('theming', 'enabled', 'no') === 'yes') { if (!extension_loaded('imagick')) { @@ -882,7 +848,6 @@ public function check() { 'isImagickEnabled' => $this->isImagickEnabled(), 'areWebauthnExtensionsEnabled' => $this->areWebauthnExtensionsEnabled(), 'is64bit' => $this->is64bit(), - 'recommendedPHPModules' => $this->hasRecommendedPHPModules(), 'pendingBigIntConversionColumns' => $this->hasBigIntConversionPendingColumns(), 'isMysqlUsedWithoutUTF8MB4' => $this->isMysqlUsedWithoutUTF8MB4(), 'isEnoughTempSpaceAvailableIfS3PrimaryStorageIsUsed' => $this->isEnoughTempSpaceAvailableIfS3PrimaryStorageIsUsed(), diff --git a/apps/settings/lib/SetupChecks/PhpModules.php b/apps/settings/lib/SetupChecks/PhpModules.php new file mode 100644 index 0000000000000..d6f072432526d --- /dev/null +++ b/apps/settings/lib/SetupChecks/PhpModules.php @@ -0,0 +1,95 @@ + + * + * @author Côme Chilliet + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ +namespace OCA\Settings\SetupChecks; + +use OCP\IL10N; +use OCP\SetupCheck\ISetupCheck; +use OCP\SetupCheck\SetupResult; + +class PhpModules implements ISetupCheck { + protected const REQUIRED_MODULES = [ + 'ctype', + 'curl', + 'dom', + 'fileinfo', + 'gd', + 'json', + 'mbstring', + 'openssl', + 'posix', + 'session', + 'xml', + 'xmlreader', + 'xmlwriter', + 'zip', + 'zlib', + ]; + protected const RECOMMENDED_MODULES = [ + 'intl', + 'sysvsem', + 'exif', + 'sodium', + 'bz2', + ]; + + public function __construct( + private IL10N $l10n, + ) { + } + + public function getName(): string { + return $this->l10n->t('PHP modules'); + } + + public function getCategory(): string { + return 'system'; + } + + public function run(): SetupResult { + $missingRecommendedModules = $this->getMissingModules(self::RECOMMENDED_MODULES); + $missingRequiredModules = $this->getMissingModules(self::REQUIRED_MODULES); + if (!empty($missingRequiredModules)) { + return new SetupResult(SetupResult::ERROR, $this->l10n->t('This instance is missing some required PHP modules. It is required to install them: %s', implode(', ', $missingRequiredModules))); + } elseif (!empty($missingRecommendedModules)) { + return new SetupResult(SetupResult::INFO, $this->l10n->t('This instance is missing some recommended PHP modules. For improved performance and better compatibility it is highly recommended to install them: %s', implode(', ', $missingRecommendedModules))); + } else { + return new SetupResult(SetupResult::SUCCESS); + } + } + + /** + * Checks for potential PHP modules that would improve the instance + * + * @param string[] $modules modules to test + * @return string[] A list of PHP modules which are missing + */ + protected function getMissingModules(array $modules): array { + return array_values(array_filter( + $modules, + fn (string $module) => !extension_loaded($module), + )); + } +} diff --git a/apps/settings/tests/Controller/CheckSetupControllerTest.php b/apps/settings/tests/Controller/CheckSetupControllerTest.php index 449f181e8c18b..6117658c7b031 100644 --- a/apps/settings/tests/Controller/CheckSetupControllerTest.php +++ b/apps/settings/tests/Controller/CheckSetupControllerTest.php @@ -537,7 +537,6 @@ public function testCheck() { 'isImagickEnabled' => false, 'areWebauthnExtensionsEnabled' => false, 'is64bit' => false, - 'recommendedPHPModules' => [], 'pendingBigIntConversionColumns' => [], 'isMysqlUsedWithoutUTF8MB4' => false, 'isEnoughTempSpaceAvailableIfS3PrimaryStorageIsUsed' => true, diff --git a/core/js/setupchecks.js b/core/js/setupchecks.js index a2bddefbe698d..dd77c8603c435 100644 --- a/core/js/setupchecks.js +++ b/core/js/setupchecks.js @@ -383,16 +383,6 @@ type: OC.SetupChecks.MESSAGE_TYPE_INFO }) } - if (data.recommendedPHPModules.length > 0) { - var listOfRecommendedPHPModules = ""; - data.recommendedPHPModules.forEach(function(element){ - listOfRecommendedPHPModules += '
  • ' + element + '
    • '; - }); - messages.push({ - msg: t('core', 'This instance is missing some recommended PHP modules. For improved performance and better compatibility it is highly recommended to install them.') + '
      ' + listOfRecommendedPHPModules + '
    ', - type: OC.SetupChecks.MESSAGE_TYPE_INFO - }) - } if (!data.isImagickEnabled) { messages.push({ msg: t( diff --git a/core/js/tests/specs/setupchecksSpec.js b/core/js/tests/specs/setupchecksSpec.js index 163a21c46a786..79aa96b6d86be 100644 --- a/core/js/tests/specs/setupchecksSpec.js +++ b/core/js/tests/specs/setupchecksSpec.js @@ -253,7 +253,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -315,7 +314,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -378,7 +376,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -439,7 +436,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -498,7 +494,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -557,7 +552,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -616,7 +610,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -675,7 +668,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -736,7 +728,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -795,7 +786,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -856,7 +846,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -915,7 +904,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -974,7 +962,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -1054,7 +1041,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -1113,7 +1099,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -1172,7 +1157,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -1231,7 +1215,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: true, isDefaultPhoneRegionSet: true, @@ -1294,7 +1277,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -1354,7 +1336,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -1411,7 +1392,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -1471,7 +1451,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: false, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -1531,7 +1510,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: false, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -1590,7 +1568,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: false, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true, @@ -1649,7 +1626,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: false, @@ -1708,7 +1684,6 @@ describe('OC.SetupChecks tests', function() { isImagickEnabled: true, areWebauthnExtensionsEnabled: true, is64bit: true, - recommendedPHPModules: [], pendingBigIntConversionColumns: [], isMysqlUsedWithoutUTF8MB4: false, isDefaultPhoneRegionSet: true,