123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122 |
- <?php
- declare(strict_types=1);
- namespace OCA\Settings\SetupChecks;
- use OCP\IL10N;
- use OCP\IURLGenerator;
- 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 = [
- 'bcmath',
- 'exif',
- 'gmp',
- 'intl',
- 'sodium',
- 'sysvsem',
- ];
- public function __construct(
- private IL10N $l10n,
- private IURLGenerator $urlGenerator,
- ) {
- }
- public function getName(): string {
- return $this->l10n->t('PHP modules');
- }
- public function getCategory(): string {
- return 'php';
- }
- protected function getRecommendedModuleDescription(string $module): string {
- return match($module) {
- 'intl' => $this->l10n->t('increases language translation performance and fixes sorting of non-ASCII characters'),
- 'sodium' => $this->l10n->t('for Argon2 for password hashing'),
- 'bcmath' => $this->l10n->t('for WebAuthn passwordless login'),
- 'gmp' => $this->l10n->t('for WebAuthn passwordless login, and SFTP storage'),
- 'exif' => $this->l10n->t('for picture rotation in server and metadata extraction in the Photos app'),
- default => '',
- };
- }
- public function run(): SetupResult {
- $missingRecommendedModules = $this->getMissingModules(self::RECOMMENDED_MODULES);
- $missingRequiredModules = $this->getMissingModules(self::REQUIRED_MODULES);
- if (!empty($missingRequiredModules)) {
- return SetupResult::error(
- $this->l10n->t('This instance is missing some required PHP modules. It is required to install them: %s.', implode(', ', $missingRequiredModules)),
- $this->urlGenerator->linkToDocs('admin-php-modules')
- );
- } elseif (!empty($missingRecommendedModules)) {
- $moduleList = implode(
- "\n",
- array_map(
- fn (string $module) => '- '.$module.' '.$this->getRecommendedModuleDescription($module),
- $missingRecommendedModules
- )
- );
- return 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:\n%s", $moduleList),
- $this->urlGenerator->linkToDocs('admin-php-modules')
- );
- } else {
- return SetupResult::success();
- }
- }
-
- protected function getMissingModules(array $modules): array {
- return array_values(array_filter(
- $modules,
- fn (string $module) => !extension_loaded($module),
- ));
- }
- }
|