-
-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate opcache check to new SetupCheck API
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
- Loading branch information
Showing
8 changed files
with
138 additions
and
168 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright (c) 2023 Côme Chilliet <come.chilliet@nextcloud.com> | ||
| * | ||
| * @author Côme Chilliet <come.chilliet@nextcloud.com> | ||
| * | ||
| * @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 <http://www.gnu.org/licenses/>. | ||
| * | ||
| */ | ||
| namespace OCA\Settings\SetupChecks; | ||
|
|
||
| use bantu\IniGetWrapper\IniGetWrapper; | ||
| use OCP\IL10N; | ||
| use OCP\IURLGenerator; | ||
| use OCP\SetupCheck\ISetupCheck; | ||
| use OCP\SetupCheck\SetupResult; | ||
|
|
||
| class PhpOpcacheSetup implements ISetupCheck { | ||
| public function __construct( | ||
| private IL10N $l10n, | ||
| private IURLGenerator $urlGenerator, | ||
| private IniGetWrapper $iniGetWrapper, | ||
| ) { | ||
| } | ||
|
|
||
| public function getName(): string { | ||
| return $this->l10n->t('PHP opcache'); | ||
| } | ||
|
|
||
| public function getCategory(): string { | ||
| return 'php'; | ||
| } | ||
|
|
||
| /** | ||
| * Checks whether a PHP OPcache is properly set up | ||
| * @return string[] The list of OPcache setup recommendations | ||
| */ | ||
| protected function getOpcacheSetupRecommendations(): array { | ||
| // 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.')]; | ||
| } | ||
|
|
||
| $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, '/'))) { | ||
| $isPermitted = false; | ||
| } | ||
|
|
||
| if (!$this->iniGetWrapper->getBool('opcache.enable')) { | ||
| $recommendations[] = $this->l10n->t('OPcache is disabled. For better performance, it is recommended to apply <code>opcache.enable=1</code> 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, <code>opcache.save_comments=1</code> 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 <code>opcache.restrict_api</code> 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 <code>opcache.restrict_api</code> or unset this setting to disable OPcache API restrictions, to prevent errors during Nextcloud core or app upgrades.'); | ||
| } 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 <code>opcache.file_cache_only=0</code> 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 []; | ||
| } | ||
|
|
||
| $status = opcache_get_status(false); | ||
|
|
||
| // Recommend to raise value, if more than 90% of max value is reached | ||
| if ( | ||
| empty($status['opcache_statistics']['max_cached_keys']) || | ||
| ($status['opcache_statistics']['num_cached_keys'] / $status['opcache_statistics']['max_cached_keys'] > 0.9) | ||
| ) { | ||
| $recommendations[] = $this->l10n->t('The maximum number of OPcache keys is nearly exceeded. To assure that all scripts can be kept in the cache, it is recommended to apply <code>opcache.max_accelerated_files</code> to your PHP configuration with a value higher than <code>%s</code>.', [($this->iniGetWrapper->getNumeric('opcache.max_accelerated_files') ?: 'currently')]); | ||
| } | ||
|
|
||
| if ( | ||
| empty($status['memory_usage']['free_memory']) || | ||
| ($status['memory_usage']['used_memory'] / $status['memory_usage']['free_memory'] > 9) | ||
| ) { | ||
| $recommendations[] = $this->l10n->t('The OPcache buffer is nearly full. To assure that all scripts can be hold in cache, it is recommended to apply <code>opcache.memory_consumption</code> to your PHP configuration with a value higher than <code>%s</code>.', [($this->iniGetWrapper->getNumeric('opcache.memory_consumption') ?: 'currently')]); | ||
| } | ||
|
|
||
| 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') < $this->iniGetWrapper->getNumeric('opcache.memory_consumption') / 4) && | ||
| ( | ||
| empty($status['interned_strings_usage']['free_memory']) || | ||
| ($status['interned_strings_usage']['used_memory'] / $status['interned_strings_usage']['free_memory'] > 9) | ||
| ) | ||
| ) { | ||
| $recommendations[] = $this->l10n->t('The OPcache interned strings buffer is nearly full. To assure that repeating strings can be effectively cached, it is recommended to apply <code>opcache.interned_strings_buffer</code> to your PHP configuration with a value higher than <code>%s</code>.', [($this->iniGetWrapper->getNumeric('opcache.interned_strings_buffer') ?: 'currently')]); | ||
| } | ||
| } | ||
|
|
||
| return $recommendations; | ||
| } | ||
|
|
||
| public function run(): SetupResult { | ||
| $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') | ||
| ); | ||
| } else { | ||
| return SetupResult::success($this->l10n->t('Correctly configured')); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.