Skip to content

Migrate opcache check to new SetupCheck API #41547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
come-nc merged 5 commits into from
Jan 8, 2024
Merged

Migrate opcache check to new SetupCheck API #41547

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3f13a1a
Migrate opcache check to new SetupCheck API
come-nc Nov 16, 2023
989b5ff
Remove unused properties from CheckSetupControllerTest
come-nc Nov 16, 2023
f6df5da
Remove unsupported <code> tag and use quotes instead
come-nc Dec 12, 2023
c92fbca
Fix small psalm issue
come-nc Dec 12, 2023
94d0399
Improve PHP opcache setup check and reduce level in some cases
come-nc Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Improve PHP opcache setup check and reduce level in some cases 
Signed-off-by: Côme Chilliet <[email protected]>
  • Loading branch information
@come-nc
come-nc committed Jan 8, 2024
commit 94d039922956c28484d98669caeea97f89e77adb
60 changes: 37 additions & 23 deletions apps/settings/lib/SetupChecks/PhpOpcacheSetup.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,47 +49,44 @@ public function getCategory(): string {

/**
* Checks whether a PHP OPcache is properly set up
* @return string[] The list of OPcache setup recommendations
* @return array{'warning'|'error',list<string>} The level and the list of OPcache setup recommendations
*/
protected function getOpcacheSetupRecommendations(): array {
$level = 'warning';

// If the module is not loaded, return directly to skip inapplicable checks
if (!extension_loaded('Zend OPcache')) {
return [$this->l10n->t('The PHP OPcache module is not loaded. For better performance it is recommended to load it into your PHP installation.')];
return ['error',[$this->l10n->t('The PHP OPcache module is not loaded. For better performance it is recommended to load it into your PHP installation.')]];
}

$recommendations = [];

// Check whether Nextcloud is allowed to use the OPcache API
$isPermitted = true;
$permittedPath = $this->iniGetWrapper->getString('opcache.restrict_api');
if (isset($permittedPath) && $permittedPath !== '' && !str_starts_with(\OC::$SERVERROOT, rtrim($permittedPath, '/'))) {
$permittedPath = (string)$this->iniGetWrapper->getString('opcache.restrict_api');
if ($permittedPath !== '' && !str_starts_with(\OC::$SERVERROOT, rtrim($permittedPath, '/'))) {
$isPermitted = false;
}

if (!$this->iniGetWrapper->getBool('opcache.enable')) {
$recommendations[] = $this->l10n->t('OPcache is disabled. For better performance, it is recommended to apply "opcache.enable=1" to your PHP configuration.');

// Check for saved comments only when OPcache is currently disabled. If it was enabled, opcache.save_comments=0 would break Nextcloud in the first place.
if (!$this->iniGetWrapper->getBool('opcache.save_comments')) {
$recommendations[] = $this->l10n->t('OPcache is configured to remove code comments. With OPcache enabled, "opcache.save_comments=1" must be set for Nextcloud to function.');
}

if (!$isPermitted) {
$recommendations[] = $this->l10n->t('Nextcloud is not allowed to use the OPcache API. With OPcache enabled, it is highly recommended to include all Nextcloud directories with "opcache.restrict_api" or unset this setting to disable OPcache API restrictions, to prevent errors during Nextcloud core or app upgrades.');
}
} elseif (!$isPermitted) {
$recommendations[] = $this->l10n->t('Nextcloud is not allowed to use the OPcache API. It is highly recommended to include all Nextcloud directories with "opcache.restrict_api" or unset this setting to disable OPcache API restrictions, to prevent errors during Nextcloud core or app upgrades.');
$level = 'error';
} elseif ($this->iniGetWrapper->getBool('opcache.file_cache_only')) {
$recommendations[] = $this->l10n->t('The shared memory based OPcache is disabled. For better performance, it is recommended to apply "opcache.file_cache_only=0" to your PHP configuration and use the file cache as second level cache only.');
} else {
// Check whether opcache_get_status has been explicitly disabled an in case skip usage based checks
$disabledFunctions = $this->iniGetWrapper->getString('disable_functions');
if (isset($disabledFunctions) && str_contains($disabledFunctions, 'opcache_get_status')) {
return [];
return [$level, $recommendations];
}

$status = opcache_get_status(false);

if ($status === false) {
$recommendations[] = $this->l10n->t('OPcache is not working as it should, opcache_get_status() returns false, please check configuration.');
$level = 'error';
}

// Recommend to raise value, if more than 90% of max value is reached
if (
empty($status['opcache_statistics']['max_cached_keys']) ||
Expand All @@ -107,7 +104,7 @@ protected function getOpcacheSetupRecommendations(): array {

if (
// Do not recommend to raise the interned strings buffer size above a quarter of the total OPcache size
($this->iniGetWrapper->getNumeric('opcache.interned_strings_buffer') ?? 0 < $this->iniGetWrapper->getNumeric('opcache.memory_consumption') / 4) &&
($this->iniGetWrapper->getNumeric('opcache.interned_strings_buffer') ?? 0 < $this->iniGetWrapper->getNumeric('opcache.memory_consumption') ?? 0 / 4) &&
(
empty($status['interned_strings_usage']['free_memory']) ||
($status['interned_strings_usage']['used_memory'] / $status['interned_strings_usage']['free_memory'] > 9)
Expand All @@ -117,16 +114,33 @@ protected function getOpcacheSetupRecommendations(): array {
}
}

return $recommendations;
// Check for saved comments only when OPcache is currently disabled. If it was enabled, opcache.save_comments=0 would break Nextcloud in the first place.
if (!$this->iniGetWrapper->getBool('opcache.save_comments')) {
$recommendations[] = $this->l10n->t('OPcache is configured to remove code comments. With OPcache enabled, "opcache.save_comments=1" must be set for Nextcloud to function.');
$level = 'error';
}

if (!$isPermitted) {
$recommendations[] = $this->l10n->t('Nextcloud is not allowed to use the OPcache API. With OPcache enabled, it is highly recommended to include all Nextcloud directories with "opcache.restrict_api" or unset this setting to disable OPcache API restrictions, to prevent errors during Nextcloud core or app upgrades.');
$level = 'error';
}

return [$level, $recommendations];
}

public function run(): SetupResult {
$recommendations = $this->getOpcacheSetupRecommendations();
[$level,$recommendations] = $this->getOpcacheSetupRecommendations();
if (!empty($recommendations)) {
return SetupResult::error(
$this->l10n->t('The PHP OPcache module is not properly configured. %s.', implode("\n", $recommendations)),
$this->urlGenerator->linkToDocs('admin-php-opcache')
);
return match($level) {
'error' => SetupResult::error(
$this->l10n->t('The PHP OPcache module is not properly configured. %s.', implode("\n", $recommendations)),
$this->urlGenerator->linkToDocs('admin-php-opcache')
),
default => SetupResult::warning(
$this->l10n->t('The PHP OPcache module is not properly configured. %s.', implode("\n", $recommendations)),
$this->urlGenerator->linkToDocs('admin-php-opcache')
),
};
} else {
return SetupResult::success($this->l10n->t('Correctly configured'));
}
Expand Down