d

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

Author: ArtificialOwl

core/Command/Config/ListConfigs.php

@@ -112,7 +112,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 	 * @param bool $noSensitiveValues
 	 * @return array
 	 */
-	protected function getSystemConfigs($noSensitiveValues) {
+	protected function getSystemConfigs(bool $noSensitiveValues): array {
 		$keys = $this->systemConfig->getKeys();
 
 		$configs = [];

core/Migrations/Version29000Date20231126110901.php

@@ -41,11 +41,13 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt
 		if (!$schema->hasTable('appconfig_lazy')) {
 			$table = $schema->createTable('appconfig_lazy');
 			$table->addColumn('app_id', Types::STRING, ['length' => 32]);
+			$table->addColumn('extra', Types::STRING, ['length' => 32]);
 			$table->addColumn('config_key', Types::STRING, ['length' => 64]);
 			$table->addColumn('config_value', Types::TEXT);
 
 			$table->setPrimaryKey(['app_id', 'config_key'], 'lazy_app_prim');
-			$table->addIndex(['app_id'], 'lazy_app_id_i');
+			$table->addIndex(['app_id', 'extra'], 'lazy_app_id_i');
+			$table->addIndex(['app_id', 'extra', 'config_key'], 'lazy_app_id_key_i');
 			$updated = true;
 		}
 

lib/private/LazyConfig.php

@@ -32,8 +32,34 @@
 use OCP\ILazyConfig;
 use Psr\Log\LoggerInterface;
 
+/**
+ * Lazy load of your app config values.
+ *
+ * store a value:
+ *  $this->lazyConfig->setValueString('my_app', 'my_param', 'configuration_value');
+ *
+ * retrieve a value:
+ *  $this->lazyConfig->getValueString('my_app', 'my_param', 'default_value');
+ *
+ * The caching is made in a way that all configured value of my_app
+ * are retrieved when getValue*() is called for the first time
+ *
+ * There is a way to get values only when needed, without filling the cache with rarely needed values
+ * when getValue*() is called with 'my_app'. A group of values can be set by using 'my_app.my_group':
+ *
+ *   $this->lazyConfig->setValueString('my_app.my_group', 'my_param', 'configuration_value');
+ *   $this->lazyConfig->getValueString('my_app.my_group', 'my_param', 'default_value');
+ *
+ * Values set in group 'my_group' are not cached when calling getValue*() on 'my_app', but
+ * only when using 'my_app.my_group'.
+ *
+ * @since 29.0.0
+ */
 class LazyConfig implements ILazyConfig {
-	private array $cache = [];
+	public const APP_EXTRA_SEPARATOR = '.';
+
+	private array $cache = [];   // cached config
+	private array $extra = [];   // list of loaded extra config
 	protected array $sensitiveValues = [
 		'circles' => [
 			'/^key_pairs$/',
@@ -178,8 +204,8 @@ public function getApps(bool $loadValues = true): array {
 	 * @since 29.0.0
 	 */
 	public function getKeys(string $app): array {
-		$this->loadConfig($app);
-		return array_keys($this->cache[$app]);
+		$appId = $this->loadConfig($app);
+		return array_keys($this->cache[$appId]);
 	}
 
 	/**
@@ -188,12 +214,11 @@ public function getKeys(string $app): array {
 	 *
 	 * @inheritDoc
 	 * @return bool
-	 * @throws DBException
 	 * @since 29.0.0
 	 */
 	public function hasKey(string $app, string $key): bool {
-		$this->loadConfig($app);
-		return isset($this->cache[$app][$key]);
+		$appId = $this->loadConfig($app);
+		return isset($this->cache[$appId][$key]);
 	}
 
 	/**
@@ -202,20 +227,19 @@ public function hasKey(string $app, string $key): bool {
 	 *
 	 * @inheritDoc
 	 * @return array
-	 * @throws DBException
 	 * @since 29.0.0
 	 */
 	public function getValues(string $app, string $key = ''): array {
-		$this->loadConfig($app);
+		$appId = $this->loadConfig($app, true);
 
 		if ($key === '') {
-			return $this->cache[$app] ?? [];
+			return $this->cache[$appId] ?? [];
 		}
 
 		$values = [];
-		foreach (($this->cache[$app] ?? []) as $configkey => $configvalue) {
-			if (str_starts_with($configkey, $key)) {
-				$values[$configkey] = $configvalue;
+		foreach (($this->cache[$appId] ?? []) as $configKey => $configValue) {
+			if (str_starts_with($configKey, $key)) {
+				$values[$configKey] = $configValue;
 			}
 		}
 
@@ -251,12 +275,12 @@ public function getFilteredValues(string $app): array {
 	 * @since 29.0.0
 	 */
 	public function getValueString(string $app, string $key, string $default = ''): string {
-		$this->loadConfig($app);
+		$appId = $this->loadConfig($app);
 		if (!$this->hasKey($app, $key)) {
 			return $default;
 		}
 
-		return $this->cache[$app][$key];
+		return $this->cache[$appId][$key];
 	}
 
 	/**
@@ -315,15 +339,17 @@ public function getValueArray(string $app, string $key, array $default = []): ar
 	 * @since 29.0.0
 	 */
 	public function setValueString(string $app, string $key, string $value): bool {
-		$this->loadConfig($app);
+		$appId = $this->loadConfig($app);
 		$updated = !$this->hasKey($app, $key) || $value !== $this->getValueString($app, $key);
 		if (!$updated) {
 			return false;
 		}
 
+		[, $extra] = $this->parseExtra($app);
 		$insert = $this->connection->getQueryBuilder();
 		$insert->insert('appconfig_lazy')
-			->setValue('app_id', $insert->createNamedParameter($app))
+			->setValue('app_id', $insert->createNamedParameter($appId))
+			->setValue('extra', $insert->createNamedParameter($extra))
 			->setValue('config_key', $insert->createNamedParameter($key))
 			->setValue('config_value', $insert->createNamedParameter($value));
 		try {
@@ -336,6 +362,7 @@ public function setValueString(string $app, string $key, string $value): bool {
 			$update = $this->connection->getQueryBuilder();
 			$update->update('appconfig_lazy')
 				->set('config_value', $update->createNamedParameter($value))
+				->set('extra', $update->createNamedParameter($extra))
 				->where($update->expr()->eq('app_id', $update->createNamedParameter($app)))
 				->andWhere($update->expr()->eq('config_key', $update->createNamedParameter($key)));
 			$update->executeStatement();
@@ -422,56 +449,109 @@ public function unsetKey(string $app, string $key): void {
 	 * @since 29.0.0
 	 */
 	public function deleteApp(string $app): void {
-		$this->loadConfig($app);
+		$appId = $this->loadConfig($app);
+		//[$appId,] = $this->parseExtra($app);
 
 		$sql = $this->connection->getQueryBuilder();
 		$sql->delete('appconfig_lazy')
-			->where($sql->expr()->eq('app_id', $sql->createNamedParameter($app)));
+			->where($sql->expr()->eq('app_id', $sql->createNamedParameter($appId)));
 		$sql->executeStatement();
 
-		$this->clearCache($app);
+		$this->clearCache($appId);
 	}
 
 	/**
 	 * @param string $app
 	 *
-	 * @throws DBException
+	 * @return array<string, string>
 	 */
-	private function loadConfig(string $app): void {
-		if (array_key_exists($app, $this->cache)) {
-			return;
+	private function parseExtra(string $app): array {
+		if (!strpos($app, self::APP_EXTRA_SEPARATOR)) {
+			return [$app, ''];
 		}
 
-		$this->cache[$app] = [];
+		return explode(self::APP_EXTRA_SEPARATOR, $app, 2);
+	}
 
-		$sql = $this->connection->getQueryBuilder();
-		$sql->select('config_key', 'config_value')
+	/**
+	 * @param string $app
+	 * @param bool $includeExtras
+	 *
+	 * @return string
+	 */
+	private function loadConfig(string $app, bool $includeExtras = false): string {
+		[$appId, $extra] = $this->parseExtra($app);
+		if ($this->isLoaded($appId, $extra)) {
+			return $appId;
+		}
+
+		if (!array_key_exists($appId, $this->cache)) {
+			$this->cache[$appId] = [];
+			$this->extra[$appId] = [];
+		}
+
+		$qb = $this->connection->getQueryBuilder();
+		$qb->select('config_key', 'config_value')
 			->from('appconfig_lazy')
-			->where($sql->expr()->eq('app_id', $sql->createNamedParameter($app)));
-		$result = $sql->execute();
+			->where($qb->expr()->eq('app_id', $qb->createNamedParameter($appId)));
+
+		if (!$includeExtras) {
+			$qb->andWhere($qb->expr()->eq('extra', $qb->createNamedParameter($extra)));
+		}
+		$result = $qb->execute();
 
 		$rows = $result->fetchAll();
 		foreach ($rows as $row) {
-			$this->cache[$app][$row['config_key']] = $row['config_value'];
+			$this->cache[$appId][$row['config_key']] = $row['config_value'];
+			$this->setLoadedStatus($appId, $extra);
 		}
 		$result->closeCursor();
+
+		return $appId;
 	}
 
 	/**
 	 * @throws DBException
 	 */
 	private function loadConfigAll(): void {
 		$sql = $this->connection->getQueryBuilder();
-		$sql->select('app_id', 'config_key', 'config_value')
+		$sql->select('app_id', 'extra', 'config_key', 'config_value')
 			->from('appconfig_lazy');
 		$result = $sql->execute();
 
 		$rows = $result->fetchAll();
 		foreach ($rows as $row) {
 			$this->cache[$row['app_id']][$row['config_key']] = $row['config_value'];
+			$this->setLoadedStatus($row['app_id'], $row['extra']);
+		}
+	}
+
+
+	private function isLoaded(string $appId, string $extra): bool {
+		if (!array_key_exists($appId, $this->cache)) {
+			return false;
+		}
+
+		if (!in_array($extra, $this->extra[$appId])) {
+			return false;
+		}
+
+		return true;
+	}
+
+	public function currentCache(): void {
+		 echo 'current cache: ' . json_encode($this->cache, JSON_PRETTY_PRINT) . "\n";
+	}
+
+	private function setLoadedStatus(string $appId, string $extra): void {
+		if (in_array($extra, $this->extra[$appId] ?? [])) {
+			return;
 		}
+
+		$this->extra[$appId][] = $extra;
 	}
 
+
 	/**
 	 * @inheritDoc
 	 * @param string $app
@@ -481,6 +561,7 @@ private function loadConfigAll(): void {
 	public function clearCache(string $app = ''): void {
 		if ($app !== '') {
 			unset($this->cache[$app]);
+			unset($this->extra[$app]);
 			return;
 		}
 

tests/Core/Command/Config/ListConfigsTest.php

@@ -25,6 +25,7 @@
 use OC\SystemConfig;
 use OCP\IAppConfig;
 use OCP\IConfig;
+use OCP\ILazyConfig;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Test\TestCase;
@@ -52,12 +53,16 @@ protected function setUp(): void {
 		$appConfig = $this->appConfig = $this->getMockBuilder(IAppConfig::class)
 			->disableOriginalConstructor()
 			->getMock();
+		$lazyConfig = $this->lazyConfig = $this->getMockBuilder(ILazyConfig::class)
+			->disableOriginalConstructor()
+			->getMock();
 		$this->consoleInput = $this->getMockBuilder(InputInterface::class)->getMock();
 		$this->consoleOutput = $this->getMockBuilder(OutputInterface::class)->getMock();
 
 		/** @var \OC\SystemConfig $systemConfig */
 		/** @var \OCP\IAppConfig $appConfig */
-		$this->command = new ListConfigs($systemConfig, $appConfig);
+		/** @var \OCP\ILazyConfig $lazyConfig */
+		$this->command = new ListConfigs($systemConfig, $appConfig, $lazyConfig);
 	}
 
 	public function listData() {