From 824f954a034d995971cdb00cf83fc7a6f06f3f90 Mon Sep 17 00:00:00 2001 From: Maxence Lange Date: Thu, 9 Jan 2025 09:42:53 -0100 Subject: [PATCH] feat(lexicon): configurable default value Signed-off-by: Maxence Lange --- lib/composer/composer/autoload_classmap.php | 1 + lib/composer/composer/autoload_static.php | 1 + .../Bootstrap/RegistrationContext.php | 3 +- .../Config/Lexicon/CoreConfigLexicon.php | 50 +++++++++++++++ lib/private/Config/UserConfig.php | 48 ++++++++++++-- .../Config/Lexicon/ConfigLexiconEntry.php | 63 ++++++++++++------- .../Core/Command/Config/App/GetConfigTest.php | 5 ++ tests/lib/Config/UserConfigTest.php | 4 ++ 8 files changed, 147 insertions(+), 28 deletions(-) create mode 100644 lib/private/Config/Lexicon/CoreConfigLexicon.php diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index 200e2e75612c6..ebd685934665d 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -1155,6 +1155,7 @@ 'OC\\Comments\\Manager' => $baseDir . '/lib/private/Comments/Manager.php', 'OC\\Comments\\ManagerFactory' => $baseDir . '/lib/private/Comments/ManagerFactory.php', 'OC\\Config' => $baseDir . '/lib/private/Config.php', + 'OC\\Config\\Lexicon\\CoreConfigLexicon' => $baseDir . '/lib/private/Config/Lexicon/CoreConfigLexicon.php', 'OC\\Config\\UserConfig' => $baseDir . '/lib/private/Config/UserConfig.php', 'OC\\Console\\Application' => $baseDir . '/lib/private/Console/Application.php', 'OC\\Console\\TimestampFormatter' => $baseDir . '/lib/private/Console/TimestampFormatter.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index bf9385c1741ca..8e2b421906656 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -1196,6 +1196,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2 'OC\\Comments\\Manager' => __DIR__ . '/../../..' . '/lib/private/Comments/Manager.php', 'OC\\Comments\\ManagerFactory' => __DIR__ . '/../../..' . '/lib/private/Comments/ManagerFactory.php', 'OC\\Config' => __DIR__ . '/../../..' . '/lib/private/Config.php', + 'OC\\Config\\Lexicon\\CoreConfigLexicon' => __DIR__ . '/../../..' . '/lib/private/Config/Lexicon/CoreConfigLexicon.php', 'OC\\Config\\UserConfig' => __DIR__ . '/../../..' . '/lib/private/Config/UserConfig.php', 'OC\\Console\\Application' => __DIR__ . '/../../..' . '/lib/private/Console/Application.php', 'OC\\Console\\TimestampFormatter' => __DIR__ . '/../../..' . '/lib/private/Console/TimestampFormatter.php', diff --git a/lib/private/AppFramework/Bootstrap/RegistrationContext.php b/lib/private/AppFramework/Bootstrap/RegistrationContext.php index f3b612edc38bb..77cc58c6468a7 100644 --- a/lib/private/AppFramework/Bootstrap/RegistrationContext.php +++ b/lib/private/AppFramework/Bootstrap/RegistrationContext.php @@ -11,6 +11,7 @@ use Closure; use NCU\Config\Lexicon\IConfigLexicon; +use OC\Config\Lexicon\CoreConfigLexicon; use OC\Support\CrashReport\Registry; use OCP\AppFramework\App; use OCP\AppFramework\Bootstrap\IRegistrationContext; @@ -143,7 +144,7 @@ class RegistrationContext { private array $declarativeSettings = []; /** @var array */ - private array $configLexiconClasses = []; + private array $configLexiconClasses = ['core' => CoreConfigLexicon::class]; /** @var ServiceRegistration[] */ private array $teamResourceProviders = []; diff --git a/lib/private/Config/Lexicon/CoreConfigLexicon.php b/lib/private/Config/Lexicon/CoreConfigLexicon.php new file mode 100644 index 0000000000000..f6bc586677be0 --- /dev/null +++ b/lib/private/Config/Lexicon/CoreConfigLexicon.php @@ -0,0 +1,50 @@ +assertParams($userId, $app, $key); - if (!$this->matchAndApplyLexiconDefinition($app, $key, $lazy, $type, default: $default)) { + if (!$this->matchAndApplyLexiconDefinition($userId, $app, $key, $lazy, $type, default: $default)) { return $default; // returns default if strictness of lexicon is set to WARNING (block and report) } $this->loadConfig($userId, $lazy); @@ -1046,7 +1047,7 @@ private function setTypedValue( ValueType $type, ): bool { $this->assertParams($userId, $app, $key); - if (!$this->matchAndApplyLexiconDefinition($app, $key, $lazy, $type, $flags)) { + if (!$this->matchAndApplyLexiconDefinition($userId, $app, $key, $lazy, $type, $flags)) { return false; // returns false as database is not updated } $this->loadConfig($userId, $lazy); @@ -1822,6 +1823,7 @@ private function decryptSensitiveValue(string $userId, string $app, string $key, * @throws TypeConflictException */ private function matchAndApplyLexiconDefinition( + string $userId, string $app, string $key, bool &$lazy, @@ -1837,20 +1839,54 @@ private function matchAndApplyLexiconDefinition( /** @var ConfigLexiconEntry $configValue */ $configValue = $configDetails['entries'][$key]; if ($type === ValueType::MIXED) { - $type = $configValue->getValueType(); // we overwrite if value was requested as mixed + // we overwrite if value was requested as mixed + $type = $configValue->getValueType(); } elseif ($configValue->getValueType() !== $type) { throw new TypeConflictException('The user config key ' . $app . '/' . $key . ' is typed incorrectly in relation to the config lexicon'); } $lazy = $configValue->isLazy(); - $default = $configValue->getDefault() ?? $default; // default from Lexicon got priority $flags = $configValue->getFlags(); - if ($configValue->isDeprecated()) { $this->logger->notice('User config key ' . $app . '/' . $key . ' is set as deprecated.'); } - return true; + $enforcedValue = $this->config->getSystemValue('lexicon.default.userconfig.enforced', [])[$app][$key] ?? false; + if (!$enforcedValue && $this->hasKey($userId, $app, $key, $lazy)) { + // if key exists there should be no need to extract default + return true; + } + + // default from Lexicon got priority but it can still be overwritten by admin + $default = $this->getSystemDefault($app, $configValue) ?? $configValue->getDefault() ?? $default; + + // returning false will make get() returning $default and set() not changing value in database + return !$enforcedValue; + } + + /** + * get default value set in config/config.php if stored in key: + * + * 'lexicon.default.userconfig' => [ + * => [ + * => 'my value', + * ] + * ], + * + * The entry is converted to string to fit the expected type when managing default value + * + * @param string $appId + * @param ConfigLexiconEntry $configValue + * + * @return string|null + */ + private function getSystemDefault(string $appId, ConfigLexiconEntry $configValue): ?string { + $default = $this->config->getSystemValue('lexicon.default.userconfig', [])[$appId][$configValue->getKey()] ?? null; + if ($default === null) { + return null; // no system default, using default default. + } + + return $configValue->convertToString($default); } /** diff --git a/lib/unstable/Config/Lexicon/ConfigLexiconEntry.php b/lib/unstable/Config/Lexicon/ConfigLexiconEntry.php index e6c6579881dba..2cf196113f7aa 100644 --- a/lib/unstable/Config/Lexicon/ConfigLexiconEntry.php +++ b/lib/unstable/Config/Lexicon/ConfigLexiconEntry.php @@ -35,25 +35,12 @@ class ConfigLexiconEntry { public function __construct( private readonly string $key, private readonly ValueType $type, - null|string|int|float|bool|array $default = null, + private null|string|int|float|bool|array $defaultRaw = null, string $definition = '', private readonly bool $lazy = false, private readonly int $flags = 0, private readonly bool $deprecated = false, ) { - if ($default !== null) { - // in case $default is array but is not expected to be an array... - $default = ($type !== ValueType::ARRAY && is_array($default)) ? json_encode($default) : $default; - $this->default = match ($type) { - ValueType::MIXED => (string)$default, - ValueType::STRING => $this->convertFromString((string)$default), - ValueType::INT => $this->convertFromInt((int)$default), - ValueType::FLOAT => $this->convertFromFloat((float)$default), - ValueType::BOOL => $this->convertFromBool((bool)$default), - ValueType::ARRAY => $this->convertFromArray((array)$default) - }; - } - /** @psalm-suppress UndefinedClass */ if (\OC::$CLI) { // only store definition if ran from CLI $this->definition = $definition; @@ -61,7 +48,7 @@ public function __construct( } /** - * @inheritDoc + * returns the config key * * @return string config key * @experimental 31.0.0 @@ -71,7 +58,7 @@ public function getKey(): string { } /** - * @inheritDoc + * get expected type for config value * * @return ValueType * @experimental 31.0.0 @@ -126,17 +113,51 @@ private function convertFromArray(array $default): string { } /** - * @inheritDoc + * returns default value * * @return string|null NULL if no default is set * @experimental 31.0.0 */ public function getDefault(): ?string { + if ($this->defaultRaw === null) { + return null; + } + + if ($this->default === null) { + $this->default = $this->convertToString($this->defaultRaw); + } + return $this->default; } /** - * @inheritDoc + * convert $entry into string, based on the expected type for config value + * + * @param string|int|float|bool|array $entry + * + * @return string + * @experimental 31.0.0 + * @psalm-suppress PossiblyInvalidCast arrays are managed pre-cast + * @psalm-suppress RiskyCast + */ + public function convertToString(string|int|float|bool|array $entry): string { + // in case $default is array but is not expected to be an array... + if ($this->getValueType() !== ValueType::ARRAY && is_array($entry)) { + $entry = json_encode($entry, JSON_THROW_ON_ERROR); + } + + return match ($this->getValueType()) { + ValueType::MIXED => (string)$entry, + ValueType::STRING => $this->convertFromString((string)$entry), + ValueType::INT => $this->convertFromInt((int)$entry), + ValueType::FLOAT => $this->convertFromFloat((float)$entry), + ValueType::BOOL => $this->convertFromBool((bool)$entry), + ValueType::ARRAY => $this->convertFromArray((array)$entry) + }; + } + + /** + * returns definition * * @return string * @experimental 31.0.0 @@ -146,7 +167,7 @@ public function getDefinition(): string { } /** - * @inheritDoc + * returns if config key is set as lazy * * @see IAppConfig for details on lazy config values * @return bool TRUE if config value is lazy @@ -157,7 +178,7 @@ public function isLazy(): bool { } /** - * @inheritDoc + * returns flags * * @see IAppConfig for details on sensitive config values * @return int bitflag about the config value @@ -178,7 +199,7 @@ public function isFlagged(int $flag): bool { } /** - * @inheritDoc + * returns if config key is set as deprecated * * @return bool TRUE if config si deprecated * @experimental 31.0.0 diff --git a/tests/Core/Command/Config/App/GetConfigTest.php b/tests/Core/Command/Config/App/GetConfigTest.php index c1a6265db4089..33e50699bbec8 100644 --- a/tests/Core/Command/Config/App/GetConfigTest.php +++ b/tests/Core/Command/Config/App/GetConfigTest.php @@ -101,6 +101,11 @@ public function testGet($configName, $value, $configExists, $defaultValue, $hasD ->method('getDetails') ->with('app-name', $configName) ->willReturn(['value' => $value]); + } else { + $this->config->expects($this->once()) + ->method('getValueMixed') + ->with('app-name', $configName, $defaultValue) + ->willReturn($defaultValue); } } diff --git a/tests/lib/Config/UserConfigTest.php b/tests/lib/Config/UserConfigTest.php index 0f2aed4a28860..f9a9b5c52720f 100644 --- a/tests/lib/Config/UserConfigTest.php +++ b/tests/lib/Config/UserConfigTest.php @@ -12,6 +12,7 @@ use NCU\Config\IUserConfig; use NCU\Config\ValueType; use OC\Config\UserConfig; +use OCP\IConfig; use OCP\IDBConnection; use OCP\Security\ICrypto; use Psr\Log\LoggerInterface; @@ -26,6 +27,7 @@ */ class UserConfigTest extends TestCase { protected IDBConnection $connection; + private IConfig $config; private LoggerInterface $logger; private ICrypto $crypto; private array $originalPreferences; @@ -169,6 +171,7 @@ protected function setUp(): void { parent::setUp(); $this->connection = \OCP\Server::get(IDBConnection::class); + $this->config = \OCP\Server::get(IConfig::class); $this->logger = \OCP\Server::get(LoggerInterface::class); $this->crypto = \OCP\Server::get(ICrypto::class); @@ -277,6 +280,7 @@ protected function tearDown(): void { private function generateUserConfig(array $preLoading = []): IUserConfig { $userConfig = new \OC\Config\UserConfig( $this->connection, + $this->config, $this->logger, $this->crypto, );