fix(appconfig): only convert single entry on searchValues()

Signed-off-by: Maxence Lange <maxence@artificial-owl.com>
nextcloud · Apr 4, 2024 · 40d7716 · 40d7716
1 parent 7ad2461
commit 40d7716
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 31 deletions.
diff --git a/lib/private/AppConfig.php b/lib/private/AppConfig.php
@@ -211,7 +211,7 @@ public function isLazy(string $app, string $key): bool {
 	 * @param string $prefix config keys prefix to search
 	 * @param bool $filtered TRUE to hide sensitive config values. Value are replaced by {@see IConfig::SENSITIVE_VALUE}
 	 *
-	 * @return array<string, string> [configKey => configValue]
+	 * @return array<string, string|int|float|bool|array> [configKey => configValue]
 	 * @since 29.0.0
 	 */
 	public function getAllValues(string $app, string $prefix = '', bool $filtered = false): array {
@@ -254,14 +254,14 @@ function (string $key) use ($prefix): bool {
 	 *
 	 * @param string $key config key
 	 * @param bool $lazy search within lazy loaded config
+	 * @param int|null $typedAs enforce type for the returned values ({@see self::VALUE_STRING} and others)
 	 *
-	 * @return array<string, string> [appId => configValue]
+	 * @return array<string, string|int|float|bool|array> [appId => configValue]
 	 * @since 29.0.0
 	 */
-	public function searchValues(string $key, bool $lazy = false): array {
+	public function searchValues(string $key, bool $lazy = false, ?int $typedAs = null): array {
 		$this->assertParams('', $key, true);
 		$this->loadConfig($lazy);
-		$values = [];
 
 		/** @var array<array-key, array<array-key, mixed>> $cache */
 		if ($lazy) {
@@ -270,10 +270,10 @@ public function searchValues(string $key, bool $lazy = false): array {
 			$cache = $this->fastCache;
 		}
 
+		$values = [];
 		foreach (array_keys($cache) as $app) {
 			if (isset($cache[$app][$key])) {
-				$appCache = $this->formatAppValues((string)$app, $cache[$app], $lazy);
-				$values[$app] = $appCache[$key];
+				$values[$app] = $this->convertTypedValue($cache[$app][$key], $typedAs ?? $this->getValueType((string)$app, $key, $lazy));
 			}
 		}
 
@@ -1371,7 +1371,7 @@ public function getValues($app, $key) {
 
 		$key = ($key === false) ? '' : $key;
 		if (!$app) {
-			return $this->searchValues($key);
+			return $this->searchValues($key, false, self::VALUE_MIXED);
 		} else {
 			return $this->getAllValues($app, $key);
 		}
@@ -1395,10 +1395,10 @@ public function getFilteredValues($app) {
 	 * load all lazy values from the database
 	 *
 	 * @param string $app
-	 * @param array $values
+	 * @param array<string, string> $values ['key' => 'value']
 	 * @param bool|null $lazy
 	 *
-	 * @return array
+	 * @return array<string, string|int|float|bool|array>
 	 */
 	private function formatAppValues(string $app, array $values, ?bool $lazy = null): array {
 		foreach($values as $key => $value) {
@@ -1408,29 +1408,39 @@ private function formatAppValues(string $app, array $values, ?bool $lazy = null)
 				continue;
 			}
 
-			switch ($type) {
-				case self::VALUE_INT:
-					$values[$key] = (int)$value;
-					break;
-				case self::VALUE_FLOAT:
-					$values[$key] = (float)$value;
-					break;
-				case self::VALUE_BOOL:
-					$values[$key] = in_array(strtolower($value), ['1', 'true', 'yes', 'on']);
-					break;
-				case self::VALUE_ARRAY:
-					try {
-						$values[$key] = json_decode($value, true, flags: JSON_THROW_ON_ERROR);
-					} catch (JsonException $e) {
-						// ignoreable
-					}
-					break;
-			}
+			$values[$key] = $this->convertTypedValue($value, $type);
 		}
 
 		return $values;
 	}
 
+	/**
+	 * convert string value to the expected type
+	 *
+	 * @param string $value
+	 * @param int $type
+	 *
+	 * @return string|int|float|bool|array
+	 */
+	private function convertTypedValue(string $value, int $type): string|int|float|bool|array {
+		switch ($type) {
+			case self::VALUE_INT:
+				return (int)$value;
+			case self::VALUE_FLOAT:
+				return (float)$value;
+			case self::VALUE_BOOL:
+				return in_array(strtolower($value), ['1', 'true', 'yes', 'on']);
+			case self::VALUE_ARRAY:
+				try {
+					return json_decode($value, true, flags: JSON_THROW_ON_ERROR);
+				} catch (JsonException $e) {
+					// ignoreable
+				}
+				break;
+		}
+		return $value;
+	}
+
 	/**
 	 * @param string $app
 	 *

diff --git a/lib/private/AppFramework/Services/AppConfig.php b/lib/private/AppFramework/Services/AppConfig.php
@@ -97,7 +97,7 @@ public function isLazy(string $key): bool {
 	 * @param string $key config keys prefix to search
 	 * @param bool $filtered TRUE to hide sensitive config values. Value are replaced by {@see IConfig::SENSITIVE_VALUE}
 	 *
-	 * @return array<string, string> [configKey => configValue]
+	 * @return array<string, string|int|float|bool|array> [configKey => configValue]
 	 * @since 29.0.0
 	 */
 	public function getAllAppValues(string $key = '', bool $filtered = false): array {

diff --git a/lib/public/AppFramework/Services/IAppConfig.php b/lib/public/AppFramework/Services/IAppConfig.php
@@ -88,7 +88,7 @@ public function isLazy(string $key): bool;
 	 * @param string $key config keys prefix to search, can be empty.
 	 * @param bool $filtered filter sensitive config values
 	 *
-	 * @return array<string, string> [configKey => configValue]
+	 * @return array<string, string|int|float|bool|array> [configKey => configValue]
 	 * @since 29.0.0
 	 */
 	public function getAllAppValues(string $key = '', bool $filtered = false): array;

diff --git a/lib/public/IAppConfig.php b/lib/public/IAppConfig.php
@@ -140,7 +140,7 @@ public function isLazy(string $app, string $key): bool;
 	 * @param string $prefix config keys prefix to search, can be empty.
 	 * @param bool $filtered filter sensitive config values
 	 *
-	 * @return array<string, string> [configKey => configValue]
+	 * @return array<string, string|int|float|bool|array> [configKey => configValue]
 	 * @since 29.0.0
 	 */
 	public function getAllValues(string $app, string $prefix = '', bool $filtered = false): array;
@@ -151,11 +151,12 @@ public function getAllValues(string $app, string $prefix = '', bool $filtered =
 	 *
 	 * @param string $key config key
 	 * @param bool $lazy search within lazy loaded config
+	 * @param int|null $typedAs enforce type for the returned values {@see self::VALUE_STRING} and others
 	 *
 	 * @return array<string, string|int|float|bool|array> [appId => configValue]
 	 * @since 29.0.0
 	 */
-	public function searchValues(string $key, bool $lazy = false): array;
+	public function searchValues(string $key, bool $lazy = false, ?int $typedAs = null): array;
 
 	/**
 	 * Get config value assigned to a config key.