feat(config): frame config keys/values

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

lib/private/AppConfig.php

@@ -38,6 +38,9 @@
 
 use InvalidArgumentException;
 use JsonException;
+use OC\AppFramework\Bootstrap\Coordinator;
+use OC\AppFramework\ConfigValues\AppConfigValue;
+use OCP\AppFramework\ConfigValues\IConfigValue;
 use OCP\DB\Exception as DBException;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\Exceptions\AppConfigIncorrectTypeException;
@@ -97,6 +100,7 @@ public function __construct(
 		protected IDBConnection $connection,
 		protected LoggerInterface $logger,
 		protected ICrypto $crypto,
+		private Coordinator $coordinator,
 	) {
 	}
 
@@ -455,8 +459,9 @@ private function getTypedValue(
 		int $type
 	): string {
 		$this->assertParams($app, $key, valueType: $type);
+		$this->compareRegisteredConfigValues($app, $key, $default, $lazy, $type);
 		$this->loadConfig($lazy);
-
+		
 		/**
 		 * We ignore check if mixed type is requested.
 		 * If type of stored value is set as mixed, we don't filter.
@@ -746,6 +751,7 @@ private function setTypedValue(
 		int $type
 	): bool {
 		$this->assertParams($app, $key);
+		$this->compareRegisteredConfigValues($app, $key, $default, $lazy, $type);
 		$this->loadConfig($lazy);
 
 		$sensitive = $this->isTyped(self::VALUE_SENSITIVE, $type);
@@ -1506,4 +1512,45 @@ private function getSensitiveKeys(string $app): array {
 	public function clearCachedConfig(): void {
 		$this->clearCache();
 	}
+
+
+
+	private function compareRegisteredConfigValues(
+		string $app,
+		string $key,
+		string &$default,
+		bool &$lazy,
+		int &$type
+	): void {
+		$context = $this->coordinator->getRegistrationContext();
+		$configValues = $context->getConfigValues($app, AppConfigValue::TYPE);
+
+		if (!array_key_exists($key, $configValues)) {
+			if ($context->strictConfigValues($app)) {
+				throw new AppConfigUnknownKeyException('This key is not defined in the list of available AppConfig keys for this app');
+			}
+			return;
+		}
+
+		$configValue = $configValues[$key];
+
+		if ($configValue->getValueType() !== match($type) {
+			self::VALUE_STRING => IConfigValue::TYPE_STRING,
+			self::VALUE_INT => IConfigValue::TYPE_INT,
+			self::VALUE_FLOAT => IConfigValue::TYPE_FLOAT,
+			self::VALUE_BOOL => IConfigValue::TYPE_BOOL,
+			self::VALUE_ARRAY => IConfigValue::TYPE_ARRAY,
+			}) {
+			throw new AppConfigTypeConflictException('This key is mistyped compare to the list of available AppConfig keys for this app');
+		}
+
+		$lazy = $configValue->isLazy();
+		$default = $configValue->getDefault();
+		if ($configValue->isSensitive()) {
+			$type |= self::VALUE_SENSITIVE;
+		}
+		if ($configValue->isDeprecated()) {
+			$this->logger->notice('config value ' . $key . ' from ' . $app . ' is set as deprecated');
+		}
+	}
 }

lib/private/AppFramework/Bootstrap/RegistrationContext.php

@@ -33,6 +33,7 @@
 use OC\Support\CrashReport\Registry;
 use OCP\AppFramework\App;
 use OCP\AppFramework\Bootstrap\IRegistrationContext;
+use OCP\AppFramework\ConfigValues\IConfigValue;
 use OCP\AppFramework\Middleware;
 use OCP\AppFramework\Services\InitialStateProvider;
 use OCP\Authentication\IAlternativeLogin;
@@ -160,6 +161,7 @@ class RegistrationContext {
 	/** @var ServiceRegistration<IDeclarativeSettingsForm>[] */
 	private array $declarativeSettings = [];
 
+	private array $configValues = [];
 	/** @var ServiceRegistration<ITeamResourceProvider>[] */
 	private array $teamResourceProviders = [];
 
@@ -411,6 +413,14 @@ public function registerDeclarativeSettings(string $declarativeSettingsClass): v
 					$declarativeSettingsClass
 				);
 			}
+
+			public function registerConfigValues(bool $strict, IConfigValue ...$configValues): void {
+				$this->context->registerConfigValues(
+					$this->appId,
+					$strict,
+					...$configValues
+				);
+			}
 		};
 	}
 
@@ -590,6 +600,16 @@ public function registerDeclarativeSettings(string $appId, string $declarativeSe
 		$this->declarativeSettings[] = new ServiceRegistration($appId, $declarativeSettingsClass);
 	}
 
+	public function registerConfigValues(string $appId, bool $strict, IConfigValue ...$configValues): void {
+		$values = ['_strict' => $strict];
+		foreach ($configValues as $configValue) {
+			$values[$configValue->getConfigType()][$configValue->getKey()] = $configValue;
+		}
+
+		$this->configValues[$appId] = $values;
+	}
+
+
 	/**
 	 * @param App[] $apps
 	 */
@@ -920,4 +940,18 @@ public function getTeamResourceProviders(): array {
 	public function getDeclarativeSettings(): array {
 		return $this->declarativeSettings;
 	}
+
+	/**
+	 * @param string $app
+	 * @param string $configType
+	 *
+	 * @return array<string, IConfigValue>
+	 */
+	public function getConfigValues(string $app, string $configType): array {
+		return $this->configValues[$app][$configType] ?? [];
+    }
+
+	public function strictConfigValues(string $app): bool {
+		return $this->configValues[$app]['_strict'] ?? false;
+	}
 }

lib/private/AppFramework/ConfigValues/AConfigValue.php

@@ -0,0 +1,106 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2024 Maxence Lange <[email protected]>
+ *
+ * @author Maxence Lange <[email protected]>
+ *
+ * @license AGPL-3.0 or later
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OC\AppFramework\ConfigValues;
+
+use OCP\AppFramework\ConfigValues\IConfigValue;
+
+abstract class AConfigValue implements IConfigValue {
+	private ?string $default = null;
+	private bool $lazy = false;
+	private bool $sensitive = false;
+	private bool $deprecated = false;
+
+	public function __construct(
+		private string $key,
+		private int $valueType
+	) {
+	}
+
+	abstract public function getConfigType(): string;
+
+	public function getKey(): string {
+		return $this->key;
+	}
+
+	public function getValueType(): int {
+		return $this->valueType;
+	}
+
+	public function withDefaultString(string $default): self {
+		$this->default = $default;
+		return $this;
+	}
+
+	public function withDefaultInt(int $default): self {
+		$this->default = (string) $default;
+		return $this;
+	}
+
+	public function withDefaultFloat(float $default): self {
+		$this->default = (string) $default;
+		return $this;
+	}
+
+	public function withDefaultBool(bool $default): self {
+		$this->default = ($default) ? '1' : '0';
+		return $this;
+	}
+
+	public function withDefaultArray(array $default): self {
+		$this->default = json_encode($default);
+		return $this;
+	}
+
+	public function getDefault(): string {
+		return $this->default;
+	}
+
+	public function asLazy(bool $lazy = true): self {
+		$this->lazy = $lazy;
+		return $this;
+	}
+
+	public function isLazy(): bool {
+		return $this->lazy;
+	}
+
+	public function asSensitive(bool $sensitive = true): self {
+		$this->sensitive = $sensitive;
+		return $this;
+	}
+
+	public function isSensitive(): bool {
+		return $this->sensitive;
+	}
+
+	public function asDeprecated(bool $deprecated = true): self {
+		$this->deprecated = $deprecated;
+		return $this;
+	}
+
+	public function isDeprecated(): bool {
+		return $this->deprecated;
+	}
+}

lib/private/AppFramework/ConfigValues/AppConfigValue.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2024 Maxence Lange <[email protected]>
+ *
+ * @author Maxence Lange <[email protected]>
+ *
+ * @license AGPL-3.0 or later
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OC\AppFramework\ConfigValues;
+
+class AppConfigValue extends AConfigValue {
+	public const TYPE = 'AppConfig';
+
+	public function getConfigType(): string {
+		return self::TYPE;
+	}
+}

lib/private/AppFramework/ConfigValues/UserPreferenceValue.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2024 Maxence Lange <[email protected]>
+ *
+ * @author Maxence Lange <[email protected]>
+ *
+ * @license AGPL-3.0 or later
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OC\AppFramework\ConfigValues;
+
+class UserPreferenceValue extends AConfigValue {
+	public const TYPE = 'UserPreference';
+
+	public function getConfigType(): string {
+		return self::TYPE;
+	}
+}

lib/public/AppFramework/Bootstrap/IRegistrationContext.php

@@ -29,6 +29,7 @@
 
 namespace OCP\AppFramework\Bootstrap;
 
+use OCP\AppFramework\ConfigValues\IConfigValue;
 use OCP\AppFramework\IAppContainer;
 use OCP\Authentication\TwoFactorAuth\IProvider;
 use OCP\Calendar\ICalendarProvider;
@@ -410,4 +411,6 @@ public function registerSetupCheck(string $setupCheckClass): void;
 	 * @since 29.0.0
 	 */
 	public function registerDeclarativeSettings(string $declarativeSettingsClass): void;
+
+	public function registerConfigValues(bool $strict, IConfigValue ...$configValues): void;
 }

lib/public/AppFramework/ConfigValues/IConfigValue.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2024 Maxence Lange <[email protected]>
+ *
+ * @author Maxence Lange <[email protected]>
+ *
+ * @license AGPL-3.0 or later
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCP\AppFramework\ConfigValues;
+
+interface IConfigValue {
+	public const TYPE_STRING = 1;
+	public const TYPE_INT = 2;
+	public const TYPE_FLOAT = 3;
+	public const TYPE_BOOL = 4;
+	public const TYPE_ARRAY = 5;
+
+	public function getConfigType(): string;
+
+	public function getKey(): string;
+	public function getValueType(): int;
+
+	public function withDefaultString(string $default): self;
+	public function withDefaultInt(int $default): self;
+	public function withDefaultFloat(float $default): self;
+	public function withDefaultBool(bool $default): self;
+	public function withDefaultArray(array $default): self;
+	public function getDefault(): ?string;
+
+	public function asLazy(bool $lazy = true): self;
+	public function isLazy(): bool;
+	public function asSensitive(bool $sensitive = true): self;
+	public function isSensitive(): bool;
+	public function asDeprecated(bool $deprecated = true): self;
+	public function isDeprecated(): bool;
+}