feat(lexicon): preset()

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

Author: ArtificialOwl

lib/private/AppConfig.php

@@ -12,6 +12,7 @@
 use InvalidArgumentException;
 use JsonException;
 use NCU\Config\Lexicon\ConfigLexiconEntry;
+use NCU\Config\Lexicon\ConfigLexiconPreset;
 use NCU\Config\Lexicon\ConfigLexiconStrictness;
 use NCU\Config\Lexicon\IConfigLexicon;
 use OC\AppFramework\Bootstrap\Coordinator;
@@ -70,6 +71,7 @@ class AppConfig implements IAppConfig {
 
 	public function __construct(
 		protected IDBConnection $connection,
+		protected IConfig $config,
 		protected LoggerInterface $logger,
 		protected ICrypto $crypto,
 	) {
@@ -1682,6 +1684,9 @@ private function applyLexiconStrictness(
 	 */
 	public function getConfigDetailsFromLexicon(string $appId): array {
 		if (!array_key_exists($appId, $this->configLexiconDetails)) {
+			if (!defined(ConfigManager::PRESET_CONSTANT)) {
+				define(ConfigManager::PRESET_CONSTANT, ConfigLexiconPreset::tryFrom($this->config->getSystemValueInt(ConfigManager::PRESET_CONFIGKEY, 0)));
+			}
 			$entries = $aliases = [];
 			$bootstrapCoordinator = \OCP\Server::get(Coordinator::class);
 			$configLexicon = $bootstrapCoordinator->getRegistrationContext()?->getConfigLexicon($appId);

lib/private/Config/ConfigManager.php

@@ -25,6 +25,11 @@
  * @since 32.0.0
  */
 class ConfigManager {
+	/** @since 32.0.0 */
+	public const PRESET_CONFIGKEY = 'config.preset';
+	/** @since 32.0.0 */
+	public const PRESET_CONSTANT = '_LEXICON_PRESET_';
+
 	/** @var AppConfig|null $appConfig */
 	private ?IAppConfig $appConfig = null;
 	/** @var UserConfig|null $userConfig */

lib/private/Config/Lexicon/CoreConfigLexicon.php

@@ -9,6 +9,7 @@
 namespace OC\Config\Lexicon;
 
 use NCU\Config\Lexicon\ConfigLexiconEntry;
+use NCU\Config\Lexicon\ConfigLexiconPreset;
 use NCU\Config\Lexicon\ConfigLexiconStrictness;
 use NCU\Config\Lexicon\IConfigLexicon;
 use NCU\Config\ValueType;

lib/private/Config/UserConfig.php

@@ -16,6 +16,7 @@
 use NCU\Config\Exceptions\UnknownKeyException;
 use NCU\Config\IUserConfig;
 use NCU\Config\Lexicon\ConfigLexiconEntry;
+use NCU\Config\Lexicon\ConfigLexiconPreset;
 use NCU\Config\Lexicon\ConfigLexiconStrictness;
 use NCU\Config\ValueType;
 use OC\AppFramework\Bootstrap\Coordinator;
@@ -1993,6 +1994,9 @@ private function applyLexiconStrictness(?ConfigLexiconStrictness $strictness, st
 	 */
 	public function getConfigDetailsFromLexicon(string $appId): array {
 		if (!array_key_exists($appId, $this->configLexiconDetails)) {
+			if (!defined(ConfigManager::PRESET_CONSTANT)) {
+				define(ConfigManager::PRESET_CONSTANT, ConfigLexiconPreset::tryFrom($this->config->getSystemValueInt(ConfigManager::PRESET_CONFIGKEY, 0)));
+			}
 			$entries = $aliases = [];
 			$bootstrapCoordinator = \OCP\Server::get(Coordinator::class);
 			$configLexicon = $bootstrapCoordinator->getRegistrationContext()?->getConfigLexicon($appId);

lib/unstable/Config/Lexicon/ConfigLexiconEntry.php

@@ -9,6 +9,7 @@
 namespace NCU\Config\Lexicon;
 
 use NCU\Config\ValueType;
+use OC\Config\ConfigManager;
 
 /**
  * Model that represent config values within an app config lexicon.
@@ -24,7 +25,7 @@ class ConfigLexiconEntry {
 	private ?string $default = null;
 
 	/**
-	 * @param string $key config key
+	 * @param string $key config key, can only contain alphanumerical chars and -._
 	 * @param ValueType $type type of config value
 	 * @param string $definition optional description of config key available when using occ command
 	 * @param bool $lazy set config value as lazy
@@ -47,12 +48,34 @@ public function __construct(
 		private readonly ?string $rename = null,
 		private readonly int $options = 0,
 	) {
+		// key can only contain alphanumeric chars and _-.
+		if (preg_match("/[^[:alnum:]\-._]/", $key)) {
+			throw new \Exception();
+		}
 		/** @psalm-suppress UndefinedClass */
 		if (\OC::$CLI) { // only store definition if ran from CLI
 			$this->definition = $definition;
 		}
 	}
 
+	/**
+	 * @param ConfigLexiconPreset|ConfigLexiconPreset[] $preset
+	 */
+	public function preset(ConfigLexiconPreset|array $preset, string|int|float|bool|array $defaultRaw): self {
+		if (!is_array($preset)) {
+			$preset = [$preset];
+		}
+
+		foreach($preset as $entry) {
+			if ($entry === constant(ConfigManager::PRESET_CONSTANT)) {
+				$this->defaultRaw = $defaultRaw;
+				break;
+			}
+		}
+
+		return $this;
+	}
+
 	/**
 	 * returns the config key
 	 *

lib/unstable/Config/Lexicon/ConfigLexiconPreset.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+namespace NCU\Config\Lexicon;
+
+/**
+ * list of preset to handle the default behavior of the instance
+ *
+ * @see ConfigLexiconEntry::preset
+ *
+ * - **ConfigLexiconPreset::LARGE** - Large size organisation (> 50k accounts)
+ * - **ConfigLexiconPreset::MEDIUM** - Medium size organisation (> 100 accounts)
+ * - **ConfigLexiconPreset::SMALL** - Small size organisation (< 100 accounts)
+ * - **ConfigLexiconPreset::SHARED** - Shared hosting
+ * - **ConfigLexiconPreset::EDUCATION** - School/University
+ * - **ConfigLexiconPreset::CLUB** - Club/Association
+ * - **ConfigLexiconPreset::FAMILY** - Family
+ * - **ConfigLexiconPreset::PRIVATE** - Private
+ *
+ * @experimental 32.0.0
+ */
+enum ConfigLexiconPreset: int {
+	/** @experimental 32.0.0 */
+	case LARGE = 8;
+	/** @experimental 32.0.0 */
+	case MEDIUM = 7;
+	/** @experimental 32.0.0 */
+	case SMALL = 6;
+	/** @experimental 32.0.0 */
+	case SHARED = 5;
+	/** @experimental 32.0.0 */
+	case EDUCATION = 4;
+	/** @experimental 32.0.0 */
+	case CLUB = 3;
+	/** @experimental 32.0.0 */
+	case FAMILY = 2;
+	/** @experimental 32.0.0 */
+	case PRIVATE = 1;
+}