feat(lexicon): events onSet() and initialize()

Signed-off-by: Maxence Lange <[email protected]>

d

Signed-off-by: Maxence Lange <[email protected]>

Author: ArtificialOwl

apps/settings/composer/composer/autoload_classmap.php

@@ -19,6 +19,7 @@
     'OCA\\Settings\\Command\\AdminDelegation\\Add' => $baseDir . '/../lib/Command/AdminDelegation/Add.php',
     'OCA\\Settings\\Command\\AdminDelegation\\Remove' => $baseDir . '/../lib/Command/AdminDelegation/Remove.php',
     'OCA\\Settings\\Command\\AdminDelegation\\Show' => $baseDir . '/../lib/Command/AdminDelegation/Show.php',
+    'OCA\\Settings\\ConfigLexicon' => $baseDir . '/../lib/ConfigLexicon.php',
     'OCA\\Settings\\Controller\\AISettingsController' => $baseDir . '/../lib/Controller/AISettingsController.php',
     'OCA\\Settings\\Controller\\AdminSettingsController' => $baseDir . '/../lib/Controller/AdminSettingsController.php',
     'OCA\\Settings\\Controller\\AppSettingsController' => $baseDir . '/../lib/Controller/AppSettingsController.php',

apps/settings/composer/composer/autoload_static.php

@@ -34,6 +34,7 @@ class ComposerStaticInitSettings
         'OCA\\Settings\\Command\\AdminDelegation\\Add' => __DIR__ . '/..' . '/../lib/Command/AdminDelegation/Add.php',
         'OCA\\Settings\\Command\\AdminDelegation\\Remove' => __DIR__ . '/..' . '/../lib/Command/AdminDelegation/Remove.php',
         'OCA\\Settings\\Command\\AdminDelegation\\Show' => __DIR__ . '/..' . '/../lib/Command/AdminDelegation/Show.php',
+        'OCA\\Settings\\ConfigLexicon' => __DIR__ . '/..' . '/../lib/ConfigLexicon.php',
         'OCA\\Settings\\Controller\\AISettingsController' => __DIR__ . '/..' . '/../lib/Controller/AISettingsController.php',
         'OCA\\Settings\\Controller\\AdminSettingsController' => __DIR__ . '/..' . '/../lib/Controller/AdminSettingsController.php',
         'OCA\\Settings\\Controller\\AppSettingsController' => __DIR__ . '/..' . '/../lib/Controller/AppSettingsController.php',

apps/settings/lib/AppInfo/Application.php

@@ -12,6 +12,7 @@
 use OC\Authentication\Events\AppPasswordCreatedEvent;
 use OC\Authentication\Token\IProvider;
 use OC\Server;
+use OCA\Settings\ConfigLexicon;
 use OCA\Settings\Hooks;
 use OCA\Settings\Listener\AppPasswordCreatedActivityListener;
 use OCA\Settings\Listener\GroupRemovedListener;
@@ -129,6 +130,9 @@ public function register(IRegistrationContext $context): void {
 		// Register Settings Form(s)
 		$context->registerDeclarativeSettings(MailProvider::class);
 
+		// Register Config Lexicon
+		$context->registerConfigLexicon(ConfigLexicon::class);
+
 		/**
 		 * Core class wrappers
 		 */

apps/settings/lib/ConfigLexicon.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Settings;
+
+use NCU\Config\Lexicon\ConfigLexiconEntry;
+use NCU\Config\Lexicon\ConfigLexiconStrictness;
+use NCU\Config\Lexicon\IConfigLexicon;
+use NCU\Config\ValueType;
+
+/**
+ * ConfigLexicon for 'settings' app/user configs
+ */
+class ConfigLexicon implements IConfigLexicon {
+	public function getStrictness(): ConfigLexiconStrictness {
+		return ConfigLexiconStrictness::IGNORE;
+	}
+
+	/**
+	 * @inheritDoc
+	 * @return ConfigLexiconEntry[]
+	 */
+	public function getAppConfigs(): array {
+		return [
+			(new ConfigLexiconEntry('email', ValueType::STRING, '', 'email'))->onSet(function (string &$value): void { $value = strtolower($value); }),
+		];
+	}
+
+	/**
+	 * @inheritDoc
+	 * @return ConfigLexiconEntry[]
+	 */
+	public function getUserConfigs(): array {
+		return [
+		];
+	}
+}

lib/private/AppConfig.php

@@ -438,7 +438,8 @@ private function getTypedValue(
 	): string {
 		$this->assertParams($app, $key, valueType: $type);
 		$origKey = $key;
-		if (!$this->matchAndApplyLexiconDefinition($app, $key, $lazy, $type, $default)) {
+		/** @var ConfigLexiconEntry $lexiconEntry */
+		if (!$this->matchAndApplyLexiconDefinition($app, $key, $lazy, $type, $default, lexiconEntry: $lexiconEntry)) {
 			return $default; // returns default if strictness of lexicon is set to WARNING (block and report)
 		}
 		$this->loadConfig($app, $lazy);
@@ -469,6 +470,13 @@ private function getTypedValue(
 		} elseif (isset($this->fastCache[$app][$key])) {
 			$value = $this->fastCache[$app][$key];
 		} else {
+			// unknown value, might want to execute something instead of just returning default.
+			// default value will be stored in database, unless false is returned
+			if (($lexiconEntry?->executeOnInit() !== null)
+				&& $lexiconEntry->executeOnInit()($default) !== false) {
+				$this->setTypedValue($app, $key, $default, $lazy, $type);
+			}
+
 			return $default;
 		}
 
@@ -748,11 +756,18 @@ private function setTypedValue(
 		int $type,
 	): bool {
 		$this->assertParams($app, $key);
-		if (!$this->matchAndApplyLexiconDefinition($app, $key, $lazy, $type)) {
+		/** @var ConfigLexiconEntry $lexiconEntry */
+		if (!$this->matchAndApplyLexiconDefinition($app, $key, $lazy, $type, lexiconEntry: $lexiconEntry)) {
 			return false; // returns false as database is not updated
 		}
 		$this->loadConfig(null, $lazy);
 
+		// might want to execute something before storing new value
+		// will cancel storing of new value in database if false is returned
+		if ($lexiconEntry?->executeOnSet() !== null && $lexiconEntry?->executeOnSet()($value) === false) {
+			return false;
+		}
+
 		$sensitive = $this->isTyped(self::VALUE_SENSITIVE, $type);
 		$inserted = $refreshCache = false;
 
@@ -1593,6 +1608,7 @@ private function matchAndApplyLexiconDefinition(
 		?bool &$lazy = null,
 		int &$type = self::VALUE_MIXED,
 		string &$default = '',
+		?ConfigLexiconEntry &$lexiconEntry = null,
 	): bool {
 		if (in_array($key,
 			[
@@ -1617,23 +1633,23 @@ private function matchAndApplyLexiconDefinition(
 			return true;
 		}
 
-		/** @var ConfigLexiconEntry $configValue */
-		$configValue = $configDetails['entries'][$key];
+		/** @var ConfigLexiconEntry $lexiconEntry */
+		$lexiconEntry = $configDetails['entries'][$key];
 		$type &= ~self::VALUE_SENSITIVE;
 
-		$appConfigValueType = $configValue->getValueType()->toAppConfigFlag();
+		$appConfigValueType = $lexiconEntry->getValueType()->toAppConfigFlag();
 		if ($type === self::VALUE_MIXED) {
 			$type = $appConfigValueType; // we overwrite if value was requested as mixed
 		} elseif ($appConfigValueType !== $type) {
 			throw new AppConfigTypeConflictException('The app 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
-		if ($configValue->isFlagged(self::FLAG_SENSITIVE)) {
+		$lazy = $lexiconEntry->isLazy();
+		$default = $lexiconEntry->getDefault() ?? $default; // default from Lexicon got priority
+		if ($lexiconEntry->isFlagged(self::FLAG_SENSITIVE)) {
 			$type |= self::VALUE_SENSITIVE;
 		}
-		if ($configValue->isDeprecated()) {
+		if ($lexiconEntry->isDeprecated()) {
 			$this->logger->notice('App config key ' . $app . '/' . $key . ' is set as deprecated.');
 		}
 

lib/private/Config/UserConfig.php

@@ -721,7 +721,7 @@ private function getTypedValue(
 	): string {
 		$this->assertParams($userId, $app, $key);
 		$origKey = $key;
-		if (!$this->matchAndApplyLexiconDefinition($userId, $app, $key, $lazy, $type, default: $default)) {
+		if (!$this->matchAndApplyLexiconDefinition($userId, $app, $key, $lazy, $type, default: $default, lexiconEntry: $lexiconEntry)) {
 			// returns default if strictness of lexicon is set to WARNING (block and report)
 			return $default;
 		}
@@ -753,6 +753,13 @@ private function getTypedValue(
 		} elseif (isset($this->fastCache[$userId][$app][$key])) {
 			$value = $this->fastCache[$userId][$app][$key];
 		} else {
+			// unknown value, might want to execute something instead of just returning default.
+			// default value will be stored in database, unless false is returned
+			if (($lexiconEntry?->executeOnInit() !== null)
+				&& $lexiconEntry->executeOnInit()($default) !== false) {
+				$this->setTypedValue($userId, $app, $key, $default, $lazy, $type);
+			}
+
 			return $default;
 		}
 
@@ -1068,12 +1075,19 @@ private function setTypedValue(
 		ValueType $type,
 	): bool {
 		$this->assertParams($userId, $app, $key);
-		if (!$this->matchAndApplyLexiconDefinition($userId, $app, $key, $lazy, $type, $flags)) {
+		/** @var ConfigLexiconEntry $lexiconEntry */
+		if (!$this->matchAndApplyLexiconDefinition($userId, $app, $key, $lazy, $type, $flags, lexiconEntry: $lexiconEntry)) {
 			// returns false as database is not updated
 			return false;
 		}
 		$this->loadConfig($userId, $lazy);
 
+		// might want to execute something before storing new value
+		// will cancel storing of new value in database if false is returned
+		if ($lexiconEntry?->executeOnSet() !== null && $lexiconEntry?->executeOnSet()($value) === false) {
+			return false;
+		}
+
 		$inserted = $refreshCache = false;
 		$origValue = $value;
 		$sensitive = $this->isFlagged(self::FLAG_SENSITIVE, $flags);
@@ -1882,6 +1896,7 @@ private function matchAndApplyLexiconDefinition(
 		ValueType &$type = ValueType::MIXED,
 		int &$flags = 0,
 		string &$default = '',
+		?ConfigLexiconEntry &$lexiconEntry = null,
 	): bool {
 		$configDetails = $this->getConfigDetailsFromLexicon($app);
 		if (array_key_exists($key, $configDetails['aliases']) && !$this->ignoreLexiconAliases) {
@@ -1898,18 +1913,18 @@ private function matchAndApplyLexiconDefinition(
 			return true;
 		}
 
-		/** @var ConfigLexiconEntry $configValue */
-		$configValue = $configDetails['entries'][$key];
+		/** @var ConfigLexiconEntry $lexiconEntry */
+		$lexiconEntry = $configDetails['entries'][$key];
 		if ($type === ValueType::MIXED) {
 			// we overwrite if value was requested as mixed
-			$type = $configValue->getValueType();
-		} elseif ($configValue->getValueType() !== $type) {
+			$type = $lexiconEntry->getValueType();
+		} elseif ($lexiconEntry->getValueType() !== $type) {
 			throw new TypeConflictException('The user config key ' . $app . '/' . $key . ' is typed incorrectly in relation to the config lexicon');
 		}
 
-		$lazy = $configValue->isLazy();
-		$flags = $configValue->getFlags();
-		if ($configValue->isDeprecated()) {
+		$lazy = $lexiconEntry->isLazy();
+		$flags = $lexiconEntry->getFlags();
+		if ($lexiconEntry->isDeprecated()) {
 			$this->logger->notice('User config key ' . $app . '/' . $key . ' is set as deprecated.');
 		}
 
@@ -1920,7 +1935,7 @@ private function matchAndApplyLexiconDefinition(
 		}
 
 		// default from Lexicon got priority but it can still be overwritten by admin
-		$default = $this->getSystemDefault($app, $configValue) ?? $configValue->getDefault() ?? $default;
+		$default = $this->getSystemDefault($app, $lexiconEntry) ?? $lexiconEntry->getDefault() ?? $default;
 
 		// returning false will make get() returning $default and set() not changing value in database
 		return !$enforcedValue;

lib/unstable/Config/Lexicon/ConfigLexiconEntry.php

@@ -8,6 +8,7 @@
 
 namespace NCU\Config\Lexicon;
 
+use Closure;
 use NCU\Config\ValueType;
 
 /**
@@ -22,6 +23,8 @@ class ConfigLexiconEntry {
 
 	private string $definition = '';
 	private ?string $default = null;
+	private ?Closure $initialize = null;
+	private ?Closure $onSet = null;
 
 	/**
 	 * @param string $key config key
@@ -136,6 +139,48 @@ public function getDefault(): ?string {
 		return $this->default;
 	}
 
+	/**
+	 * set a closure to be executed when reading a non-set config value
+	 * first param of the closure is the default value of the config key.
+	 *
+	 * @experimental 32.0.0
+	 */
+	public function initialize(Closure $closure): self {
+		$this->initialize = $closure;
+		return $this;
+	}
+
+	/**
+	 * returns if something needs to be executed when reading a non-set config value
+	 *
+	 * @return Closure|null NULL if nothing is supposed to happens
+	 * @experimental 32.0.0
+	 */
+	public function executeOnInit(): ?Closure {
+		return $this->initialize;
+	}
+
+	/**
+	 * set a closure to be executed when setting a value to this config key
+	 * first param of the closure is future value.
+	 *
+	 * @experimental 32.0.0
+	 */
+	public function onSet(Closure $closure): self {
+		$this->onSet = $closure;
+		return $this;
+	}
+
+	/**
+	 * returns if something needs to be executed when writing a new value
+	 *
+	 * @return Closure|null NULL if nothing is supposed to happens
+	 * @experimental 32.0.0
+	 */
+	public function executeOnSet(): ?Closure {
+		return $this->onSet;
+	}
+
 	/**
 	 * convert $entry into string, based on the expected type for config value
 	 *