aboutsummaryrefslogtreecommitdiffstats
path: root/lib/unstable/Config/Lexicon
diff options
context:
space:
mode:
Diffstat (limited to 'lib/unstable/Config/Lexicon')
-rw-r--r--lib/unstable/Config/Lexicon/ConfigLexiconEntry.php97
-rw-r--r--lib/unstable/Config/Lexicon/ConfigLexiconStrictness.php26
-rw-r--r--lib/unstable/Config/Lexicon/IConfigLexicon.php13
-rw-r--r--lib/unstable/Config/Lexicon/Preset.php75
4 files changed, 201 insertions, 10 deletions
diff --git a/lib/unstable/Config/Lexicon/ConfigLexiconEntry.php b/lib/unstable/Config/Lexicon/ConfigLexiconEntry.php
index d7d781d8e26..2587cd52c01 100644
--- a/lib/unstable/Config/Lexicon/ConfigLexiconEntry.php
+++ b/lib/unstable/Config/Lexicon/ConfigLexiconEntry.php
@@ -8,6 +8,7 @@ declare(strict_types=1);
namespace NCU\Config\Lexicon;
+use Closure;
use NCU\Config\ValueType;
/**
@@ -15,32 +16,52 @@ use NCU\Config\ValueType;
*
* @see IConfigLexicon
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
+ * @psalm-suppress DeprecatedClass
*/
class ConfigLexiconEntry {
+ /**
+ * @experimental 32.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
+ */
+ public const RENAME_INVERT_BOOLEAN = 1;
+
private string $definition = '';
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
* @param int $flags set flags
+ * @param string|null $rename previous config key to migrate config value from
* @param bool $deprecated set config key as deprecated
*
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
* @psalm-suppress PossiblyInvalidCast
* @psalm-suppress RiskyCast
*/
public function __construct(
private readonly string $key,
private readonly ValueType $type,
- private null|string|int|float|bool|array $defaultRaw = null,
+ private null|string|int|float|bool|array|Closure $defaultRaw = null,
string $definition = '',
private readonly bool $lazy = false,
private readonly int $flags = 0,
private readonly bool $deprecated = false,
+ private readonly ?string $rename = null,
+ private readonly int $options = 0,
) {
+ // key can only contain alphanumeric chars and underscore "_"
+ if (preg_match('/[^[:alnum:]_]/', $key)) {
+ throw new \Exception('invalid config key');
+ }
+
/** @psalm-suppress UndefinedClass */
if (\OC::$CLI) { // only store definition if ran from CLI
$this->definition = $definition;
@@ -52,6 +73,8 @@ class ConfigLexiconEntry {
*
* @return string config key
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
*/
public function getKey(): string {
return $this->key;
@@ -62,6 +85,9 @@ class ConfigLexiconEntry {
*
* @return ValueType
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
+ * @psalm-suppress DeprecatedClass
*/
public function getValueType(): ValueType {
return $this->type;
@@ -71,6 +97,8 @@ class ConfigLexiconEntry {
* @param string $default
* @return string
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
*/
private function convertFromString(string $default): string {
return $default;
@@ -80,6 +108,8 @@ class ConfigLexiconEntry {
* @param int $default
* @return string
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
*/
private function convertFromInt(int $default): string {
return (string)$default;
@@ -89,6 +119,8 @@ class ConfigLexiconEntry {
* @param float $default
* @return string
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
*/
private function convertFromFloat(float $default): string {
return (string)$default;
@@ -98,6 +130,8 @@ class ConfigLexiconEntry {
* @param bool $default
* @return string
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
*/
private function convertFromBool(bool $default): string {
return ($default) ? '1' : '0';
@@ -107,6 +141,8 @@ class ConfigLexiconEntry {
* @param array $default
* @return string
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
*/
private function convertFromArray(array $default): string {
return json_encode($default);
@@ -117,16 +153,28 @@ class ConfigLexiconEntry {
*
* @return string|null NULL if no default is set
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
+ * @psalm-suppress DeprecatedClass
+ * @psalm-suppress DeprecatedMethod
*/
- public function getDefault(): ?string {
+ public function getDefault(Preset $preset): ?string {
+ if ($this->default !== null) {
+ return $this->default;
+ }
+
if ($this->defaultRaw === null) {
return null;
}
- if ($this->default === null) {
- $this->default = $this->convertToString($this->defaultRaw);
+ if ($this->defaultRaw instanceof Closure) {
+ /** @psalm-suppress MixedAssignment we expect closure to returns string|int|float|bool|array */
+ $this->defaultRaw = ($this->defaultRaw)($preset);
}
+ /** @psalm-suppress MixedArgument closure should be managed previously */
+ $this->default = $this->convertToString($this->defaultRaw);
+
return $this->default;
}
@@ -137,8 +185,13 @@ class ConfigLexiconEntry {
*
* @return string
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
* @psalm-suppress PossiblyInvalidCast arrays are managed pre-cast
* @psalm-suppress RiskyCast
+ * @psalm-suppress DeprecatedClass
+ * @psalm-suppress DeprecatedMethod
+ * @psalm-suppress DeprecatedConstant
*/
public function convertToString(string|int|float|bool|array $entry): string {
// in case $default is array but is not expected to be an array...
@@ -161,6 +214,8 @@ class ConfigLexiconEntry {
*
* @return string
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
*/
public function getDefinition(): string {
return $this->definition;
@@ -172,6 +227,8 @@ class ConfigLexiconEntry {
* @see IAppConfig for details on lazy config values
* @return bool TRUE if config value is lazy
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
*/
public function isLazy(): bool {
return $this->lazy;
@@ -183,6 +240,8 @@ class ConfigLexiconEntry {
* @see IAppConfig for details on sensitive config values
* @return int bitflag about the config value
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
*/
public function getFlags(): int {
return $this->flags;
@@ -193,16 +252,44 @@ class ConfigLexiconEntry {
*
* @return bool TRUE is config value bitflag contains $flag
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
+ * @psalm-suppress DeprecatedMethod
*/
public function isFlagged(int $flag): bool {
return (($flag & $this->getFlags()) === $flag);
}
/**
+ * should be called/used only during migration/upgrade.
+ * link to an old config key.
+ *
+ * @return string|null not NULL if value can be imported from a previous key
+ * @experimental 32.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
+ */
+ public function getRename(): ?string {
+ return $this->rename;
+ }
+
+ /**
+ * @experimental 32.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
+ * @return bool TRUE if $option was set during the creation of the entry.
+ */
+ public function hasOption(int $option): bool {
+ return (($option & $this->options) !== 0);
+ }
+
+ /**
* returns if config key is set as deprecated
*
* @return bool TRUE if config si deprecated
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
+ * @see \OCP\Config\Lexicon\Entry
*/
public function isDeprecated(): bool {
return $this->deprecated;
diff --git a/lib/unstable/Config/Lexicon/ConfigLexiconStrictness.php b/lib/unstable/Config/Lexicon/ConfigLexiconStrictness.php
index a6490675c8a..2ccd7bd265c 100644
--- a/lib/unstable/Config/Lexicon/ConfigLexiconStrictness.php
+++ b/lib/unstable/Config/Lexicon/ConfigLexiconStrictness.php
@@ -17,14 +17,32 @@ namespace NCU\Config\Lexicon;
* - **ConfigLexiconStrictness::EXCEPTION** - block (throws exception) and report
*
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Strictness
+ * @see \OCP\Config\Lexicon\Strictness
*/
enum ConfigLexiconStrictness {
- /** @experimental 31.0.0 */
+ /**
+ * @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Strictness
+ * @see \OCP\Config\Lexicon\Strictness
+ */
case IGNORE; // fully ignore
- /** @experimental 31.0.0 */
+ /**
+ * @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Strictness
+ * @see \OCP\Config\Lexicon\Strictness
+ */
case NOTICE; // ignore and report
- /** @experimental 31.0.0 */
+ /**
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Strictness
+ * @see \OCP\Config\Lexicon\Strictness
+ * @experimental 31.0.0
+ */
case WARNING; // silently block (returns $default) and report
- /** @experimental 31.0.0 */
+ /**
+ * @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Strictness
+ * @see \OCP\Config\Lexicon\Strictness
+ */
case EXCEPTION; // block (throws exception) and report
}
diff --git a/lib/unstable/Config/Lexicon/IConfigLexicon.php b/lib/unstable/Config/Lexicon/IConfigLexicon.php
index 3fedb5f1f08..74dc19e7728 100644
--- a/lib/unstable/Config/Lexicon/IConfigLexicon.php
+++ b/lib/unstable/Config/Lexicon/IConfigLexicon.php
@@ -13,6 +13,8 @@ namespace NCU\Config\Lexicon;
* The config lexicon is used to avoid conflicts and problems when storing/retrieving config values
*
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
+ * @see \OCP\Config\Lexicon\ILexicon
*/
interface IConfigLexicon {
@@ -20,9 +22,12 @@ interface IConfigLexicon {
* Define the expected behavior when using config
* keys not set within your application config lexicon.
*
- * @see ConfigLexiconStrictness
* @return ConfigLexiconStrictness
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
+ * @see \OCP\Config\Lexicon\ILexicon
+ * @psalm-suppress DeprecatedClass
+ *
*/
public function getStrictness(): ConfigLexiconStrictness;
@@ -31,6 +36,9 @@ interface IConfigLexicon {
*
* @return ConfigLexiconEntry[]
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
+ * @see \OCP\Config\Lexicon\ILexicon
+ * @psalm-suppress DeprecatedClass
*/
public function getAppConfigs(): array;
@@ -39,6 +47,9 @@ interface IConfigLexicon {
*
* @return ConfigLexiconEntry[]
* @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
+ * @see \OCP\Config\Lexicon\ILexicon
+ * @psalm-suppress DeprecatedClass
*/
public function getUserConfigs(): array;
}
diff --git a/lib/unstable/Config/Lexicon/Preset.php b/lib/unstable/Config/Lexicon/Preset.php
new file mode 100644
index 00000000000..b2a98ed5647
--- /dev/null
+++ b/lib/unstable/Config/Lexicon/Preset.php
@@ -0,0 +1,75 @@
+<?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
+ *
+ * - **Preset::LARGE** - Large size organisation (> 50k accounts)
+ * - **Preset::MEDIUM** - Medium size organisation (> 100 accounts)
+ * - **Preset::SMALL** - Small size organisation (< 100 accounts)
+ * - **Preset::SHARED** - Shared hosting
+ * - **Preset::EDUCATION** - School/University
+ * - **Preset::CLUB** - Club/Association
+ * - **Preset::FAMILY** - Family
+ * - **Preset::PRIVATE** - Private
+ *
+ * @experimental 32.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\Preset
+ * @see \OCP\Config\Lexicon\Preset
+ */
+enum Preset: int {
+ /**
+ * @experimental 32.0.0
+ * @deprecated 32.0.0
+ */
+ case LARGE = 8;
+ /**
+ * @experimental 32.0.0
+ * @deprecated 32.0.0
+ */
+ case MEDIUM = 7;
+ /**
+ * @experimental 32.0.0
+ * @deprecated 32.0.0
+ */
+ case SMALL = 6;
+ /**
+ * @experimental 32.0.0
+ * @deprecated 32.0.0
+ */
+ case SHARED = 5;
+ /**
+ * @experimental 32.0.0
+ * @deprecated 32.0.0
+ */
+ case EDUCATION = 4;
+ /**
+ * @experimental 32.0.0
+ * @deprecated 32.0.0
+ */
+ case CLUB = 3;
+ /**
+ * @experimental 32.0.0
+ * @deprecated 32.0.0
+ */
+ case FAMILY = 2;
+ /**
+ * @experimental 32.0.0
+ * @deprecated 32.0.0
+ */
+ case PRIVATE = 1;
+ /**
+ * @experimental 32.0.0
+ * @deprecated 32.0.0
+ */
+ case NONE = 0;
+}