ILazyConfig

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

core/Command/Config/ListConfigs.php

@@ -25,6 +25,7 @@
 use OC\Core\Command\Base;
 use OC\SystemConfig;
 use OCP\IAppConfig;
+use OCP\ILazyConfig;
 use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -37,6 +38,7 @@ class ListConfigs extends Base {
 	public function __construct(
 		protected SystemConfig $systemConfig,
 		protected IAppConfig $appConfig,
+		protected ILazyConfig $lazyConfig,
 	) {
 		parent::__construct();
 	}
@@ -83,17 +85,20 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 				$configs = [
 					'system' => $this->getSystemConfigs($noSensitiveValues),
 					'apps' => [],
+					'lazy' => [],
 				];
 				foreach ($apps as $appName) {
 					$configs['apps'][$appName] = $this->getAppConfigs($appName, $noSensitiveValues);
 				}
+				foreach($this->lazyConfig->getApps() as $appId) {
+					$configs['lazy'][$appId] = $this->getLazyConfigs($appId, $noSensitiveValues);
+				}
 				break;
 
 			default:
 				$configs = [
-					'apps' => [
-						$app => $this->getAppConfigs($app, $noSensitiveValues),
-					],
+					'apps' => [$app => $this->getAppConfigs($app, $noSensitiveValues)],
+					'lazy' => [$app => $this->getLazyConfigs($app, $noSensitiveValues)]
 				];
 		}
 
@@ -107,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 = [];
@@ -133,14 +138,22 @@ protected function getSystemConfigs($noSensitiveValues) {
 	 * @param bool $noSensitiveValues
 	 * @return array
 	 */
-	protected function getAppConfigs($app, $noSensitiveValues) {
+	protected function getAppConfigs(string $app, bool $noSensitiveValues): array {
 		if ($noSensitiveValues) {
-			return $this->appConfig->getFilteredValues($app, false);
+			return $this->appConfig->getFilteredValues($app);
 		} else {
 			return $this->appConfig->getValues($app, false);
 		}
 	}
 
+	protected function getLazyConfigs(string $app, bool $noSensitiveValues): array {
+		if ($noSensitiveValues) {
+			return $this->lazyConfig->getFilteredValues($app);
+		} else {
+			return $this->lazyConfig->getValues($app);
+		}
+	}
+
 	/**
 	 * @param string $argumentName
 	 * @param CompletionContext $context

core/Migrations/Version29000Date20231126110901.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright 2023 Maxence Lange <[email protected]>
+ *
+ * @author Maxence Lange <[email protected]>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Core\Migrations;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+// Create new tables for the ILazyConfig API (lazyconfig).
+class Version29000Date20231126110901 extends SimpleMigrationStep {
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+		$updated = false;
+
+		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', 'extra'], 'lazy_app_id_i');
+			$table->addIndex(['app_id', 'extra', 'config_key'], 'lazy_app_id_key_i');
+			$updated = true;
+		}
+
+		if (!$updated) {
+			return null;
+		}
+
+		return $schema;
+	}
+}

core/register_command.php

@@ -99,7 +99,7 @@
 	$application->add(new OC\Core\Command\Config\App\GetConfig(\OC::$server->getConfig()));
 	$application->add(new OC\Core\Command\Config\App\SetConfig(\OC::$server->getConfig()));
 	$application->add(new OC\Core\Command\Config\Import(\OC::$server->getConfig()));
-	$application->add(new OC\Core\Command\Config\ListConfigs(\OC::$server->getSystemConfig(), \OC::$server->getAppConfig()));
+	$application->add(\OCP\Server::get(\OC\Core\Command\Config\ListConfigs::class));
 	$application->add(new OC\Core\Command\Config\System\DeleteConfig(\OC::$server->getSystemConfig()));
 	$application->add(new OC\Core\Command\Config\System\GetConfig(\OC::$server->getSystemConfig()));
 	$application->add(new OC\Core\Command\Config\System\SetConfig(\OC::$server->getSystemConfig()));

lib/private/AllConfig.php

@@ -36,14 +36,15 @@
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\IConfig;
 use OCP\IDBConnection;
+use OCP\ILazyConfig;
 use OCP\PreConditionNotMetException;
 
 /**
  * Class to combine all the configuration options ownCloud offers
  */
 class AllConfig implements IConfig {
-	private SystemConfig $systemConfig;
 	private ?IDBConnection $connection = null;
+	private ?ILazyConfig $lazyConfig = null;
 
 	/**
 	 * 3 dimensional array with the following structure:
@@ -67,9 +68,10 @@ class AllConfig implements IConfig {
 	 */
 	private CappedMemoryCache $userCache;
 
-	public function __construct(SystemConfig $systemConfig) {
+	public function __construct(
+		private SystemConfig $systemConfig
+	) {
 		$this->userCache = new CappedMemoryCache();
-		$this->systemConfig = $systemConfig;
 	}
 
 	/**
@@ -546,4 +548,38 @@ public function getUsersForUserValueCaseInsensitive($appName, $key, $value) {
 	public function getSystemConfig() {
 		return $this->systemConfig;
 	}
+
+	public function getLazyConfig(): ILazyConfig {
+		if ($this->lazyConfig === null) {
+			$this->lazyConfig = \OCP\Server::get(ILazyConfig::class);
+		}
+
+		return $this->lazyConfig;
+	}
+
+	/**
+	 * export AppConfig keys/values into LazyConfig
+	 *
+	 * $this->config->exportToLazy('my_app', [
+	 * 		'first-config' => 'default_value',
+	 *      'my-other-config' => 12,
+	 *      'boolean-flag' => '0'
+	 * ]);
+	 *
+	 * @param string $app
+	 * @param array $configKeys an array with keys to export as index, default as value
+	 * @since 29.0.0
+	 */
+	public function exportToLazy(string $app, array $configKeys): void {
+		foreach ($configKeys as $key => $default) {
+			$value = $this->getAppValue($app, $key, (string)$default);
+			if ($this->getLazyConfig()->hasKey($app, $key)
+				|| $default === $value) {
+				continue;
+			}
+
+			$this->getLazyConfig()->setValueString($app, $key, $value);
+			$this->deleteAppValue($app, $key);
+		}
+	}
 }