*/
namespace OCA\Provisioning_API\Controller;
+use OC\AppConfig;
use OC\AppFramework\Middleware\Security\Exceptions\NotAdminException;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCSController;
use OCP\IAppConfig;
-use OCP\IConfig;
use OCP\IGroupManager;
use OCP\IL10N;
use OCP\IRequest;
use OCP\Settings\IManager;
class AppConfigController extends OCSController {
-
- /** @var IConfig */
- protected $config;
-
- /** @var IAppConfig */
- protected $appConfig;
-
- /** @var IUserSession */
- private $userSession;
-
- /** @var IL10N */
- private $l10n;
-
- /** @var IGroupManager */
- private $groupManager;
-
- /** @var IManager */
- private $settingManager;
-
- /**
- * @param string $appName
- * @param IRequest $request
- * @param IConfig $config
- * @param IAppConfig $appConfig
- */
- public function __construct(string $appName,
+ public function __construct(
+ string $appName,
IRequest $request,
- IConfig $config,
- IAppConfig $appConfig,
- IUserSession $userSession,
- IL10N $l10n,
- IGroupManager $groupManager,
- IManager $settingManager) {
+ /** @var AppConfig */
+ private IAppConfig $appConfig,
+ private IUserSession $userSession,
+ private IL10N $l10n,
+ private IGroupManager $groupManager,
+ private IManager $settingManager,
+ ) {
parent::__construct($appName, $request);
- $this->config = $config;
- $this->appConfig = $appConfig;
- $this->userSession = $userSession;
- $this->l10n = $l10n;
- $this->groupManager = $groupManager;
- $this->settingManager = $settingManager;
}
/**
return new DataResponse(['data' => ['message' => $e->getMessage()]], Http::STATUS_FORBIDDEN);
}
return new DataResponse([
- 'data' => $this->config->getAppKeys($app),
+ 'data' => $this->appConfig->getKeys($app),
]);
}
} catch (\InvalidArgumentException $e) {
return new DataResponse(['data' => ['message' => $e->getMessage()]], Http::STATUS_FORBIDDEN);
}
- return new DataResponse([
- 'data' => $this->config->getAppValue($app, $key, $defaultValue),
- ]);
+
+ /** @psalm-suppress InternalMethod */
+ $value = $this->appConfig->getValueMixed($app, $key, $defaultValue, null);
+ return new DataResponse(['data' => $value]);
}
/**
return new DataResponse(['data' => ['message' => $e->getMessage()]], Http::STATUS_FORBIDDEN);
}
- $this->config->setAppValue($app, $key, $value);
+ /** @psalm-suppress InternalMethod */
+ $this->appConfig->setValueMixed($app, $key, $value);
return new DataResponse();
}
return new DataResponse(['data' => ['message' => $e->getMessage()]], Http::STATUS_FORBIDDEN);
}
- $this->config->deleteAppValue($app, $key);
+ $this->appConfig->deleteKey($app, $key);
return new DataResponse();
}
if ($app === 'files'
&& $key === 'default_quota'
&& $value === 'none'
- && $this->config->getAppValue('files', 'allow_unlimited_quota', '1') === '0') {
+ && $this->appConfig->getValueInt('files', 'allow_unlimited_quota', 1) === 0) {
throw new \InvalidArgumentException('The given key can not be set, unlimited quota is forbidden on this instance');
}
}
->with($app)
->willThrowException($throws);
- $this->config->expects($this->never())
- ->method('getAppKeys');
+ $this->appConfig->expects($this->never())
+ ->method('getKeys');
} else {
$api->expects($this->once())
->method('verifyAppId')
->with($app);
- $this->config->expects($this->once())
- ->method('getAppKeys')
+ $this->appConfig->expects($this->once())
+ ->method('getKeys')
->with($app)
->willReturn($keys);
}
<?php
+
+declare(strict_types=1);
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Joas Schilling <coding@schilljs.com>
+ * @author Maxence Lange <maxence@artificial-owl.com>
*
* @license AGPL-3.0
*
*/
namespace OC\Core\Command\Config\App;
-use OCP\IConfig;
+use OCP\Exceptions\AppConfigUnknownKeyException;
+use OCP\IAppConfig;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
class GetConfig extends Base {
public function __construct(
- protected IConfig $config,
+ protected IAppConfig $appConfig,
) {
parent::__construct();
}
InputArgument::REQUIRED,
'Name of the config to get'
)
+ ->addOption(
+ 'details',
+ null,
+ InputOption::VALUE_NONE,
+ 'returns complete details about the app config value'
+ )
->addOption(
'default-value',
null,
$configName = $input->getArgument('name');
$defaultValue = $input->getOption('default-value');
- if (!in_array($configName, $this->config->getAppKeys($appName)) && !$input->hasParameterOption('--default-value')) {
- return 1;
+ if ($input->getOption('details')) {
+ $details = $this->appConfig->getDetails($appName, $configName);
+ $format = $input->getOption('output') ?? 'plain';
+ if ($format === 'json') {
+ $output->writeln(json_encode($details));
+ } elseif ($format === 'json_pretty') {
+ $output->writeln(json_encode($details, JSON_PRETTY_PRINT));
+ } else {
+ $output->writeln('App: ' . $details['app'] ?? '');
+ $output->writeln('Config Key: ' . $details['key'] ?? '');
+ $output->writeln('Config Value: ' . $details['value'] ?? '');
+ $output->writeln('Value type: ' . $details['typeString'] ?? '');
+ $output->writeln('Lazy loaded: ' . (($details['lazy'] ?? false) ? 'Yes' : 'No'));
+ $output->writeln('Sensitive: ' . (($details['sensitive'] ?? false) ? 'Yes' : 'No'));
+ }
+
+ return 0;
}
- if (!in_array($configName, $this->config->getAppKeys($appName))) {
+ try {
+ $configValue = $this->appConfig->getDetails($appName, $configName)['value'];
+ } catch (AppConfigUnknownKeyException $e) {
+ if (!$input->hasParameterOption('--default-value')) {
+ return 1;
+ }
$configValue = $defaultValue;
- } else {
- $configValue = $this->config->getAppValue($appName, $configName);
}
$this->writeMixedInOutputFormat($input, $output, $configValue);
<?php
+
+declare(strict_types=1);
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Joas Schilling <coding@schilljs.com>
+ * @author Maxence Lange <maxence@artificial-owl.com>
*
* @license AGPL-3.0
*
*/
namespace OC\Core\Command\Config\App;
-use OCP\IConfig;
+use OC\AppConfig;
+use OCP\Exceptions\AppConfigIncorrectTypeException;
+use OCP\Exceptions\AppConfigUnknownKeyException;
+use OCP\IAppConfig;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\Question;
class SetConfig extends Base {
+ private InputInterface $input;
+ private OutputInterface $output;
+
public function __construct(
- protected IConfig $config,
+ protected IAppConfig $appConfig,
) {
parent::__construct();
}
InputOption::VALUE_REQUIRED,
'The new value of the config'
)
+ ->addOption(
+ 'type',
+ null,
+ InputOption::VALUE_REQUIRED,
+ 'Value type [string, integer, float, boolean, array]',
+ 'string'
+ )
+ ->addOption(
+ 'lazy',
+ null,
+ InputOption::VALUE_NEGATABLE,
+ 'Set value as lazy loaded',
+ )
+ ->addOption(
+ 'sensitive',
+ null,
+ InputOption::VALUE_NEGATABLE,
+ 'Set value as sensitive',
+ )
->addOption(
'update-only',
null,
protected function execute(InputInterface $input, OutputInterface $output): int {
$appName = $input->getArgument('app');
$configName = $input->getArgument('name');
+ $this->input = $input;
+ $this->output = $output;
+
+ if (!($this->appConfig instanceof AppConfig)) {
+ throw new \Exception('Only compatible with OC\AppConfig as it uses internal methods');
+ }
+
+ if ($input->hasParameterOption('--update-only') && !$this->appConfig->hasKey($appName, $configName)) {
+ $output->writeln(
+ '<comment>Config value ' . $configName . ' for app ' . $appName
+ . ' not updated, as it has not been set before.</comment>'
+ );
- if (!in_array($configName, $this->config->getAppKeys($appName)) && $input->hasParameterOption('--update-only')) {
- $output->writeln('<comment>Config value ' . $configName . ' for app ' . $appName . ' not updated, as it has not been set before.</comment>');
return 1;
}
- $configValue = $input->getOption('value');
- $this->config->setAppValue($appName, $configName, $configValue);
+ $type = $typeString = null;
+ if ($input->hasParameterOption('--type')) {
+ $typeString = $input->getOption('type');
+ $type = $this->appConfig->convertTypeToInt($typeString);
+ }
+
+ /**
+ * If --Value is not specified, returns an exception if no value exists in database
+ * compare with current status in database and displays a reminder that this can break things.
+ * confirmation is required by admin, unless --no-interaction
+ */
+ $updated = false;
+ if (!$input->hasParameterOption('--value')) {
+ if (!$input->getOption('lazy') && $this->appConfig->isLazy($appName, $configName) && $this->ask('NOT LAZY')) {
+ $updated = $this->appConfig->updateLazy($appName, $configName, false);
+ }
+ if ($input->getOption('lazy') && !$this->appConfig->isLazy($appName, $configName) && $this->ask('LAZY')) {
+ $updated = $this->appConfig->updateLazy($appName, $configName, true) || $updated;
+ }
+ if (!$input->getOption('sensitive') && $this->appConfig->isSensitive($appName, $configName) && $this->ask('NOT SENSITIVE')) {
+ $updated = $this->appConfig->updateSensitive($appName, $configName, false) || $updated;
+ }
+ if ($input->getOption('sensitive') && !$this->appConfig->isSensitive($appName, $configName) && $this->ask('SENSITIVE')) {
+ $updated = $this->appConfig->updateSensitive($appName, $configName, true) || $updated;
+ }
+ if ($typeString !== null && $type !== $this->appConfig->getValueType($appName, $configName) && $this->ask($typeString)) {
+ $updated = $this->appConfig->updateType($appName, $configName, $type) || $updated;
+ }
+ } else {
+ /**
+ * If --type is specified in the command line, we upgrade the type in database
+ * after a confirmation from admin.
+ * If not we get the type from current stored value or VALUE_MIXED as default.
+ */
+ try {
+ $currType = $this->appConfig->getValueType($appName, $configName);
+ if ($type === null || $type === $currType || !$this->ask($typeString)) {
+ $type = $currType;
+ } else {
+ $updated = $this->appConfig->updateType($appName, $configName, $type);
+ }
+ } catch (AppConfigUnknownKeyException) {
+ $type = $type ?? IAppConfig::VALUE_MIXED;
+ }
+
+ /**
+ * if --lazy/--no-lazy option are set, compare with data stored in database.
+ * If no data in database, or identical, continue.
+ * If different, ask admin for confirmation.
+ */
+ $lazy = $input->getOption('lazy');
+ try {
+ $currLazy = $this->appConfig->isLazy($appName, $configName);
+ if ($lazy === null || $lazy === $currLazy || !$this->ask(($lazy) ? 'LAZY' : 'NOT LAZY')) {
+ $lazy = $currLazy;
+ }
+ } catch (AppConfigUnknownKeyException) {
+ $lazy = $lazy ?? false;
+ }
+
+ /**
+ * same with sensitive status
+ */
+ $sensitive = $input->getOption('sensitive');
+ try {
+ $currSensitive = $this->appConfig->isLazy($appName, $configName);
+ if ($sensitive === null || $sensitive === $currSensitive || !$this->ask(($sensitive) ? 'LAZY' : 'NOT LAZY')) {
+ $sensitive = $currSensitive;
+ }
+ } catch (AppConfigUnknownKeyException) {
+ $sensitive = $sensitive ?? false;
+ }
+
+ $value = (string)$input->getOption('value');
+
+ switch ($type) {
+ case IAppConfig::VALUE_MIXED:
+ $updated = $this->appConfig->setValueMixed($appName, $configName, $value, $lazy, $sensitive);
+ break;
+
+ case IAppConfig::VALUE_STRING:
+ $updated = $this->appConfig->setValueString($appName, $configName, $value, $lazy, $sensitive);
+ break;
+
+ case IAppConfig::VALUE_INT:
+ if ($value !== ((string) ((int) $value))) {
+ throw new AppConfigIncorrectTypeException('Value is not an integer');
+ }
+ $updated = $this->appConfig->setValueInt($appName, $configName, (int)$value, $lazy, $sensitive);
+ break;
+
+ case IAppConfig::VALUE_FLOAT:
+ if ($value !== ((string) ((float) $value))) {
+ throw new AppConfigIncorrectTypeException('Value is not a float');
+ }
+ $updated = $this->appConfig->setValueFloat($appName, $configName, (float)$value, $lazy, $sensitive);
+ break;
+
+ case IAppConfig::VALUE_BOOL:
+ if (strtolower($value) === 'true') {
+ $valueBool = true;
+ } elseif (strtolower($value) === 'false') {
+ $valueBool = false;
+ } else {
+ throw new AppConfigIncorrectTypeException('Value is not a boolean, please use \'true\' or \'false\'');
+ }
+ $updated = $this->appConfig->setValueBool($appName, $configName, $valueBool, $lazy);
+ break;
+
+ case IAppConfig::VALUE_ARRAY:
+ $valueArray = json_decode($value, true, flags: JSON_THROW_ON_ERROR);
+ $valueArray = (is_array($valueArray)) ? $valueArray : throw new AppConfigIncorrectTypeException('Value is not an array');
+ $updated = $this->appConfig->setValueArray($appName, $configName, $valueArray, $lazy, $sensitive);
+ break;
+ }
+ }
+
+ if ($updated) {
+ $current = $this->appConfig->getDetails($appName, $configName);
+ $output->writeln(
+ sprintf(
+ "<info>Config value '%s' for app '%s' is now set to '%s', stored as %s in %s</info>",
+ $configName,
+ $appName,
+ $current['value'],
+ $current['typeString'],
+ $current['lazy'] ? 'lazy cache' : 'fast cache'
+ )
+ );
+ } else {
+ $output->writeln('<info>Config value were not updated</info>');
+ }
- $output->writeln('<info>Config value ' . $configName . ' for app ' . $appName . ' set to ' . $configValue . '</info>');
return 0;
}
+
+ private function ask(string $request): bool {
+ $helper = $this->getHelper('question');
+ if ($this->input->getOption('no-interaction')) {
+ return true;
+ }
+
+ $this->output->writeln(sprintf('You are about to set config value %s as <info>%s</info>',
+ '<info>' . $this->input->getArgument('app') . '</info>/<info>' . $this->input->getArgument('name') . '</info>',
+ strtoupper($request)
+ ));
+ $this->output->writeln('');
+ $this->output->writeln('<comment>This might break thing, affect performance on your instance or its security!</comment>');
+
+ $result = (strtolower((string)$helper->ask(
+ $this->input,
+ $this->output,
+ new Question('<comment>Confirm this action by typing \'yes\'</comment>: '))) === 'yes');
+
+ $this->output->writeln(($result) ? 'done' : 'cancelled');
+ $this->output->writeln('');
+
+ return $result;
+ }
}
default:
$configs = [
- 'apps' => [
- $app => $this->getAppConfigs($app, $noSensitiveValues),
- ],
+ 'apps' => [$app => $this->getAppConfigs($app, $noSensitiveValues)],
];
}
* @param bool $noSensitiveValues
* @return array
*/
- protected function getSystemConfigs($noSensitiveValues) {
+ protected function getSystemConfigs(bool $noSensitiveValues): array {
$keys = $this->systemConfig->getKeys();
$configs = [];
* @param bool $noSensitiveValues
* @return array
*/
- protected function getAppConfigs($app, $noSensitiveValues) {
+ protected function getAppConfigs(string $app, bool $noSensitiveValues) {
if ($noSensitiveValues) {
return $this->appConfig->getFilteredValues($app, false);
} else {
use OC\Console\TimestampFormatter;
use OC\DB\MigratorExecuteSqlEvent;
-use OC\Installer;
use OC\Repair\Events\RepairAdvanceEvent;
use OC\Repair\Events\RepairErrorEvent;
use OC\Repair\Events\RepairFinishEvent;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IConfig;
use OCP\Util;
-use Psr\Log\LoggerInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputInterface;
public const ERROR_FAILURE = 5;
public function __construct(
- private IConfig $config,
- private LoggerInterface $logger,
- private Installer $installer,
+ private IConfig $config
) {
parent::__construct();
}
}
$self = $this;
- $updater = new Updater(
- $this->config,
- \OC::$server->getIntegrityCodeChecker(),
- $this->logger,
- $this->installer
- );
+ $updater = \OCP\Server::get(Updater::class);
/** @var IEventDispatcher $dispatcher */
$dispatcher = \OC::$server->get(IEventDispatcher::class);
--- /dev/null
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright 2023 Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @author Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @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 field in appconfig for the new IAppConfig API, including lazy grouping.
+class Version29000Date20231126110901 extends SimpleMigrationStep {
+ public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+ /** @var ISchemaWrapper $schema */
+ $schema = $schemaClosure();
+
+ if (!$schema->hasTable('appconfig')) {
+ return null;
+ }
+
+ $table = $schema->getTable('appconfig');
+ if ($table->hasColumn('lazy')) {
+ return null;
+ }
+
+ // type=2 means value is typed as MIXED
+ $table->addColumn('type', Types::INTEGER, ['notnull' => true, 'default' => 2]);
+ $table->addColumn('lazy', Types::BOOLEAN, ['notnull' => false, 'default' => false]);
+
+ if ($table->hasIndex('appconfig_config_key_index')) {
+ $table->dropIndex('appconfig_config_key_index');
+ }
+
+ $table->addIndex(['lazy'], 'ac_lazy_i');
+ $table->addIndex(['appid', 'lazy'], 'ac_app_lazy_i');
+ $table->addIndex(['appid', 'lazy', 'configkey'], 'ac_app_lazy_key_i');
+
+ return $schema;
+ }
+}
$application->add(\OC::$server->query(\OC\Core\Command\Broadcast\Test::class));
$application->add(new OC\Core\Command\Config\App\DeleteConfig(\OC::$server->getConfig()));
- $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(\OCP\Server::get(\OC\Core\Command\Config\App\GetConfig::class));
+ $application->add(\OCP\Server::get(\OC\Core\Command\Config\App\SetConfig::class));
$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()));
$application->add(new OC\Core\Command\Maintenance\UpdateHtaccess());
$application->add(new OC\Core\Command\Maintenance\UpdateTheme(\OC::$server->getMimeTypeDetector(), \OC::$server->getMemCacheFactory()));
- $application->add(new OC\Core\Command\Upgrade(\OC::$server->getConfig(), \OC::$server->get(LoggerInterface::class), \OC::$server->query(\OC\Installer::class)));
+ $application->add(new OC\Core\Command\Upgrade(\OC::$server->getConfig()));
$application->add(new OC\Core\Command\Maintenance\Repair(
new \OC\Repair([], \OC::$server->get(\OCP\EventDispatcher\IEventDispatcher::class), \OC::$server->get(LoggerInterface::class)),
\OC::$server->getConfig(),
'OCP\\EventDispatcher\\GenericEvent' => $baseDir . '/lib/public/EventDispatcher/GenericEvent.php',
'OCP\\EventDispatcher\\IEventDispatcher' => $baseDir . '/lib/public/EventDispatcher/IEventDispatcher.php',
'OCP\\EventDispatcher\\IEventListener' => $baseDir . '/lib/public/EventDispatcher/IEventListener.php',
+ 'OCP\\Exceptions\\AppConfigException' => $baseDir . '/lib/public/Exceptions/AppConfigException.php',
+ 'OCP\\Exceptions\\AppConfigIncorrectTypeException' => $baseDir . '/lib/public/Exceptions/AppConfigIncorrectTypeException.php',
+ 'OCP\\Exceptions\\AppConfigTypeConflictException' => $baseDir . '/lib/public/Exceptions/AppConfigTypeConflictException.php',
+ 'OCP\\Exceptions\\AppConfigUnknownKeyException' => $baseDir . '/lib/public/Exceptions/AppConfigUnknownKeyException.php',
'OCP\\Federation\\Events\\TrustedServerRemovedEvent' => $baseDir . '/lib/public/Federation/Events/TrustedServerRemovedEvent.php',
'OCP\\Federation\\Exceptions\\ActionNotSupportedException' => $baseDir . '/lib/public/Federation/Exceptions/ActionNotSupportedException.php',
'OCP\\Federation\\Exceptions\\AuthenticationFailedException' => $baseDir . '/lib/public/Federation/Exceptions/AuthenticationFailedException.php',
'OC\\Core\\Migrations\\Version28000Date20230906104802' => $baseDir . '/core/Migrations/Version28000Date20230906104802.php',
'OC\\Core\\Migrations\\Version28000Date20231004103301' => $baseDir . '/core/Migrations/Version28000Date20231004103301.php',
'OC\\Core\\Migrations\\Version28000Date20231103104802' => $baseDir . '/core/Migrations/Version28000Date20231103104802.php',
+ 'OC\\Core\\Migrations\\Version29000Date20231126110901' => $baseDir . '/core/Migrations/Version29000Date20231126110901.php',
'OC\\Core\\Migrations\\Version29000Date20231213104850' => $baseDir . '/core/Migrations/Version29000Date20231213104850.php',
'OC\\Core\\Notification\\CoreNotifier' => $baseDir . '/core/Notification/CoreNotifier.php',
'OC\\Core\\Service\\LoginFlowV2Service' => $baseDir . '/core/Service/LoginFlowV2Service.php',
'OCP\\EventDispatcher\\GenericEvent' => __DIR__ . '/../../..' . '/lib/public/EventDispatcher/GenericEvent.php',
'OCP\\EventDispatcher\\IEventDispatcher' => __DIR__ . '/../../..' . '/lib/public/EventDispatcher/IEventDispatcher.php',
'OCP\\EventDispatcher\\IEventListener' => __DIR__ . '/../../..' . '/lib/public/EventDispatcher/IEventListener.php',
+ 'OCP\\Exceptions\\AppConfigException' => __DIR__ . '/../../..' . '/lib/public/Exceptions/AppConfigException.php',
+ 'OCP\\Exceptions\\AppConfigIncorrectTypeException' => __DIR__ . '/../../..' . '/lib/public/Exceptions/AppConfigIncorrectTypeException.php',
+ 'OCP\\Exceptions\\AppConfigTypeConflictException' => __DIR__ . '/../../..' . '/lib/public/Exceptions/AppConfigTypeConflictException.php',
+ 'OCP\\Exceptions\\AppConfigUnknownKeyException' => __DIR__ . '/../../..' . '/lib/public/Exceptions/AppConfigUnknownKeyException.php',
'OCP\\Federation\\Events\\TrustedServerRemovedEvent' => __DIR__ . '/../../..' . '/lib/public/Federation/Events/TrustedServerRemovedEvent.php',
'OCP\\Federation\\Exceptions\\ActionNotSupportedException' => __DIR__ . '/../../..' . '/lib/public/Federation/Exceptions/ActionNotSupportedException.php',
'OCP\\Federation\\Exceptions\\AuthenticationFailedException' => __DIR__ . '/../../..' . '/lib/public/Federation/Exceptions/AuthenticationFailedException.php',
'OC\\Core\\Migrations\\Version28000Date20230906104802' => __DIR__ . '/../../..' . '/core/Migrations/Version28000Date20230906104802.php',
'OC\\Core\\Migrations\\Version28000Date20231004103301' => __DIR__ . '/../../..' . '/core/Migrations/Version28000Date20231004103301.php',
'OC\\Core\\Migrations\\Version28000Date20231103104802' => __DIR__ . '/../../..' . '/core/Migrations/Version28000Date20231103104802.php',
+ 'OC\\Core\\Migrations\\Version29000Date20231126110901' => __DIR__ . '/../../..' . '/core/Migrations/Version29000Date20231126110901.php',
'OC\\Core\\Migrations\\Version29000Date20231213104850' => __DIR__ . '/../../..' . '/core/Migrations/Version29000Date20231213104850.php',
'OC\\Core\\Notification\\CoreNotifier' => __DIR__ . '/../../..' . '/core/Notification/CoreNotifier.php',
'OC\\Core\\Service\\LoginFlowV2Service' => __DIR__ . '/../../..' . '/core/Service/LoginFlowV2Service.php',
* Class to combine all the configuration options ownCloud offers
*/
class AllConfig implements IConfig {
- private SystemConfig $systemConfig;
private ?IDBConnection $connection = null;
/**
*/
private CappedMemoryCache $userCache;
- public function __construct(SystemConfig $systemConfig) {
+ public function __construct(
+ private SystemConfig $systemConfig
+ ) {
$this->userCache = new CappedMemoryCache();
- $this->systemConfig = $systemConfig;
}
/**
*
* @param string $appName the appName that we stored the value under
* @return string[] the keys stored for the app
+ * @deprecated 29.0.0 Use {@see IAppConfig} directly
*/
public function getAppKeys($appName) {
return \OC::$server->get(AppConfig::class)->getKeys($appName);
* @param string $appName the appName that we want to store the value under
* @param string $key the key of the value, under which will be saved
* @param string|float|int $value the value that should be stored
+ * @deprecated 29.0.0 Use {@see IAppConfig} directly
*/
public function setAppValue($appName, $key, $value) {
\OC::$server->get(AppConfig::class)->setValue($appName, $key, $value);
* @param string $key the key of the value, under which it was saved
* @param string $default the default value to be returned if the value isn't set
* @return string the saved value
+ * @deprecated 29.0.0 Use {@see IAppConfig} directly
*/
public function getAppValue($appName, $key, $default = '') {
return \OC::$server->get(AppConfig::class)->getValue($appName, $key, $default);
*
* @param string $appName the appName that we stored the value under
* @param string $key the key of the value, under which it was saved
+ * @deprecated 29.0.0 Use {@see IAppConfig} directly
*/
public function deleteAppValue($appName, $key) {
\OC::$server->get(AppConfig::class)->deleteKey($appName, $key);
* Removes all keys in appconfig belonging to the app
*
* @param string $appName the appName the configs are stored under
+ * @deprecated 29.0.0 Use {@see IAppConfig} directly
*/
public function deleteAppValues($appName) {
\OC::$server->get(AppConfig::class)->deleteApp($appName);
<?php
+
+declare(strict_types=1);
/**
* @copyright Copyright (c) 2017, Joas Schilling <coding@schilljs.com>
* @copyright Copyright (c) 2016, ownCloud, Inc.
* @author Jakob Sack <mail@jakobsack.de>
* @author Joas Schilling <coding@schilljs.com>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
+ * @author Maxence Lange <maxence@artificial-owl.com>
* @author michaelletzgus <michaelletzgus@users.noreply.github.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <robin@icewind.nl>
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
+
namespace OC;
-use OC\DB\Connection;
-use OC\DB\OracleConnection;
+use InvalidArgumentException;
+use JsonException;
+use OCP\DB\Exception as DBException;
use OCP\DB\QueryBuilder\IQueryBuilder;
+use OCP\Exceptions\AppConfigIncorrectTypeException;
+use OCP\Exceptions\AppConfigTypeConflictException;
+use OCP\Exceptions\AppConfigUnknownKeyException;
use OCP\IAppConfig;
use OCP\IConfig;
+use OCP\IDBConnection;
+use OCP\Util;
+use Psr\Log\LoggerInterface;
/**
* This class provides an easy way for apps to store config values in the
* database.
+ *
+ * **Note:** since 29.0.0, it supports **lazy grouping**
+ *
+ * ### What is lazy grouping ?
+ * In order to avoid loading useless config values in memory for each request on
+ * the cloud, it has been made possible to group your config keys.
+ * Each group, called _lazy group_, is only loaded in memory when one its config
+ * keys is retrieved.
+ *
+ * It is advised to only use the default lazy group, named '' (empty string), for
+ * config keys used in the registered part of your code that is called even when
+ * your app is not boot (as in event listeners, ...)
+ *
+ * **WARNING:** some methods from this class are marked with a warning about ignoring
+ * lazy grouping, use them wisely and only on part of code called during
+ * specific request/action
+ *
+ * @since 7.0.0
*/
class AppConfig implements IAppConfig {
- /** @var array[] */
- protected $sensitiveValues = [
- 'circles' => [
- '/^key_pairs$/',
- '/^local_gskey$/',
- ],
- 'external' => [
- '/^sites$/',
- ],
- 'integration_discourse' => [
- '/^private_key$/',
- '/^public_key$/',
- ],
- 'integration_dropbox' => [
- '/^client_id$/',
- '/^client_secret$/',
- ],
- 'integration_github' => [
- '/^client_id$/',
- '/^client_secret$/',
- ],
- 'integration_gitlab' => [
- '/^client_id$/',
- '/^client_secret$/',
- '/^oauth_instance_url$/',
- ],
- 'integration_google' => [
- '/^client_id$/',
- '/^client_secret$/',
- ],
- 'integration_jira' => [
- '/^client_id$/',
- '/^client_secret$/',
- '/^forced_instance_url$/',
- ],
- 'integration_onedrive' => [
- '/^client_id$/',
- '/^client_secret$/',
- ],
- 'integration_openproject' => [
- '/^client_id$/',
- '/^client_secret$/',
- '/^oauth_instance_url$/',
- ],
- 'integration_reddit' => [
- '/^client_id$/',
- '/^client_secret$/',
- ],
- 'integration_suitecrm' => [
- '/^client_id$/',
- '/^client_secret$/',
- '/^oauth_instance_url$/',
- ],
- 'integration_twitter' => [
- '/^consumer_key$/',
- '/^consumer_secret$/',
- '/^followed_user$/',
- ],
- 'integration_zammad' => [
- '/^client_id$/',
- '/^client_secret$/',
- '/^oauth_instance_url$/',
- ],
- 'notify_push' => [
- '/^cookie$/',
- ],
- 'serverinfo' => [
- '/^token$/',
- ],
- 'spreed' => [
- '/^bridge_bot_password$/',
- '/^hosted-signaling-server-(.*)$/',
- '/^recording_servers$/',
- '/^signaling_servers$/',
- '/^signaling_ticket_secret$/',
- '/^signaling_token_privkey_(.*)$/',
- '/^signaling_token_pubkey_(.*)$/',
- '/^sip_bridge_dialin_info$/',
- '/^sip_bridge_shared_secret$/',
- '/^stun_servers$/',
- '/^turn_servers$/',
- '/^turn_server_secret$/',
- ],
- 'support' => [
- '/^last_response$/',
- '/^potential_subscription_key$/',
- '/^subscription_key$/',
- ],
- 'theming' => [
- '/^imprintUrl$/',
- '/^privacyUrl$/',
- '/^slogan$/',
- '/^url$/',
- ],
- 'user_ldap' => [
- '/^(s..)?ldap_agent_password$/',
- ],
- 'user_saml' => [
- '/^idp-x509cert$/',
- ],
- ];
-
- /** @var Connection */
- protected $conn;
-
- /** @var array[] */
- private $cache = [];
-
- /** @var bool */
- private $configLoaded = false;
-
- /**
- * @param Connection $conn
- */
- public function __construct(Connection $conn) {
- $this->conn = $conn;
+ private const APP_MAX_LENGTH = 32;
+ private const KEY_MAX_LENGTH = 64;
+
+ /** @var array<string, array<string, mixed>> ['app_id' => ['config_key' => 'config_value']] */
+ private array $fastCache = []; // cache for normal config keys
+ /** @var array<string, array<string, mixed>> ['app_id' => ['config_key' => 'config_value']] */
+ private array $lazyCache = []; // cache for lazy config keys
+ /** @var array<string, array<string, int>> ['app_id' => ['config_key' => bitflag]] */
+ private array $valueTypes = []; // type for all config values
+ private bool $fastLoaded = false;
+ private bool $lazyLoaded = false;
+
+ /**
+ * $migrationCompleted is only needed to manage the previous structure
+ * of the database during the upgrading process to nc29.
+ * @TODO: remove this value in Nextcloud 30+
+ */
+ private bool $migrationCompleted = true;
+
+ public function __construct(
+ protected IDBConnection $connection,
+ private LoggerInterface $logger,
+ ) {
}
/**
- * @param string $app
- * @return array
+ * @inheritDoc
+ *
+ * @return string[] list of app ids
+ * @since 7.0.0
+ */
+ public function getApps(): array {
+ $this->loadConfigAll();
+ $apps = array_merge(array_keys($this->fastCache), array_keys($this->lazyCache));
+ sort($apps);
+
+ return array_values(array_unique($apps));
+ }
+
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ *
+ * @return string[] list of stored config keys
+ * @since 29.0.0
*/
- private function getAppValues($app) {
- $this->loadConfigValues();
+ public function getKeys(string $app): array {
+ $this->assertParams($app);
+ $this->loadConfigAll();
+ $keys = array_merge(array_keys($this->fastCache[$app] ?? []), array_keys($this->lazyCache[$app] ?? []));
+ sort($keys);
+
+ return array_values(array_unique($keys));
+ }
- if (isset($this->cache[$app])) {
- return $this->cache[$app];
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param bool|null $lazy TRUE to search within lazy loaded config, NULL to search within all config
+ *
+ * @return bool TRUE if key exists
+ * @since 7.0.0
+ * @since 29.0.0 Added the $lazy argument
+ */
+ public function hasKey(string $app, string $key, ?bool $lazy = false): bool {
+ $this->assertParams($app, $key);
+ $this->loadConfig($lazy);
+
+ if ($lazy === null) {
+ $appCache = $this->getAllValues($app);
+ return isset($appCache[$key]);
+ }
+
+ if ($lazy) {
+ $cache = &$this->lazyCache;
+ } else {
+ $cache = &$this->fastCache;
}
- return [];
+ return isset($cache[$app][$key]);
+ }
+
+ /**
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param bool|null $lazy TRUE to search within lazy loaded config, NULL to search within all config
+ *
+ * @return bool
+ * @throws AppConfigUnknownKeyException if config key is not known
+ * @since 29.0.0
+ */
+ public function isSensitive(string $app, string $key, ?bool $lazy = false): bool {
+ $this->assertParams($app, $key);
+ $this->loadConfig($lazy);
+
+ return $this->isTyped(self::VALUE_SENSITIVE, $this->valueTypes[$app][$key] ?? throw new AppConfigUnknownKeyException('unknown config key'));
}
/**
- * Get all apps using the config
+ * @inheritDoc
*
- * @return string[] an array of app ids
+ * @param string $app if of the app
+ * @param string $key config key
*
- * This function returns a list of all apps that have at least one
- * entry in the appconfig table.
+ * @return bool TRUE if config is lazy loaded
+ * @throws AppConfigUnknownKeyException if config key is not known
+ * @see IAppConfig for details about lazy loading
+ * @since 29.0.0
*/
- public function getApps() {
- $this->loadConfigValues();
+ public function isLazy(string $app, string $key): bool {
+ // there is a huge probability the non-lazy config are already loaded
+ if ($this->hasKey($app, $key, false)) {
+ return false;
+ }
+
+ // key not found, we search in the lazy config
+ if ($this->hasKey($app, $key, true)) {
+ return true;
+ }
- return $this->getSortedKeys($this->cache);
+ throw new AppConfigUnknownKeyException('unknown config key');
}
+
/**
- * Get the available keys for an app
+ * @inheritDoc
*
- * @param string $app the app we are looking for
- * @return array an array of key names
+ * @param string $app id of the app
+ * @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}
*
- * This function gets all keys of an app. Please note that the values are
- * not returned.
+ * @return array<string, string> [configKey => configValue]
+ * @since 29.0.0
*/
- public function getKeys($app) {
- $this->loadConfigValues();
+ public function getAllValues(string $app, string $key = '', bool $filtered = false): array {
+ $this->assertParams($app, $key);
+ // if we want to filter values, we need to get sensitivity
+ $this->loadConfigAll();
+ // array_merge() will remove numeric keys (here config keys), so addition arrays instead
+ $values = ($this->fastCache[$app] ?? []) + ($this->lazyCache[$app] ?? []);
+
+ if (!$filtered) {
+ return $values;
+ }
+
+ /**
+ * Using the old (deprecated) list of sensitive values.
+ */
+ foreach ($this->getSensitiveKeys($app) as $sensitiveKeyExp) {
+ $sensitiveKeys = preg_grep($sensitiveKeyExp, array_keys($values));
+ foreach ($sensitiveKeys as $sensitiveKey) {
+ $this->valueTypes[$app][$sensitiveKey] = ($this->valueTypes[$app][$sensitiveKey] ?? 0) | self::VALUE_SENSITIVE;
+ }
+ }
- if (isset($this->cache[$app])) {
- return $this->getSortedKeys($this->cache[$app]);
+ $result = [];
+ foreach ($values as $key => $value) {
+ $result[$key] = $this->isTyped(self::VALUE_SENSITIVE, $this->valueTypes[$app][$key] ?? 0) ? IConfig::SENSITIVE_VALUE : $value;
}
- return [];
+ return $result;
}
- public function getSortedKeys($data) {
- $keys = array_keys($data);
- sort($keys);
- return $keys;
+ /**
+ * @inheritDoc
+ *
+ * @param string $key config key
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return array<string, string> [appId => configValue]
+ * @since 29.0.0
+ */
+ public function searchValues(string $key, bool $lazy = false): array {
+ $this->assertParams('', $key, true);
+ $this->loadConfig($lazy);
+ $values = [];
+
+ /** @var array<array-key, array<array-key, mixed>> $cache */
+ if ($lazy) {
+ $cache = &$this->lazyCache;
+ } else {
+ $cache = &$this->fastCache;
+ }
+
+ foreach (array_keys($cache) as $app) {
+ if (isset($cache[$app][$key])) {
+ $values[$app] = $cache[$app][$key];
+ }
+ }
+
+ return $values;
}
+
/**
- * Gets the config value
+ * Get any config value, will be returned as string.
+ * If value does not exist, will return $default
+ *
+ * $lazy can be NULL to ignore lazy loading
+ *
+ * **WARNING:** Method is internal and **MUST** not be used as it is best to set a real value type
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param string $default config value
+ * @param null|bool $lazy get config as lazy loaded or not. can be NULL
*
- * @param string $app app
- * @param string $key key
- * @param string $default = null, default value if the key does not exist
* @return string the value or $default
+ * @internal
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy grouping
+ * @see getValueString()
+ * @see getValueInt()
+ * @see getValueBigInt()
+ * @see getValueFloat()
+ * @see getValueBool()
+ * @see setValueArray()
+ */
+ public function getValueMixed(
+ string $app,
+ string $key,
+ string $default = '',
+ ?bool $lazy = false
+ ): string {
+ return $this->getTypedValue(
+ $app,
+ $key,
+ $default,
+ ($lazy === null) ? $this->isLazy($app, $key) : $lazy,
+ self::VALUE_MIXED
+ );
+ }
+
+ /**
+ * @inheritDoc
*
- * This function gets a value from the appconfig table. If the key does
- * not exist the default value will be returned
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param string $default default value
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return string stored config value or $default if not set in database
+ * @throws InvalidArgumentException if one of the argument format is invalid
+ * @throws AppConfigTypeConflictException in case of conflict with the value type set in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see getValueInt()
+ * @see getValueBigInt()
+ * @see getValueFloat()
+ * @see getValueBool()
+ * @see getValueArray()
*/
- public function getValue($app, $key, $default = null) {
- $this->loadConfigValues();
+ public function getValueString(
+ string $app,
+ string $key,
+ string $default = '',
+ bool $lazy = false
+ ): string {
+ return $this->getTypedValue($app, $key, $default, $lazy, self::VALUE_STRING);
+ }
+
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param int $default default value
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return int stored config value or $default if not set in database
+ * @throws InvalidArgumentException if one of the argument format is invalid
+ * @throws AppConfigTypeConflictException in case of conflict with the value type set in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see getValueString()
+ * @see getValueBigInt()
+ * @see getValueFloat()
+ * @see getValueBool()
+ * @see getValueArray()
+ */
+ public function getValueInt(
+ string $app,
+ string $key,
+ int $default = 0,
+ bool $lazy = false
+ ): int {
+ return (int)$this->getTypedValue($app, $key, (string)$default, $lazy, self::VALUE_INT);
+ }
+
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param int|float $default default value
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return int|float stored config value or $default if not set in database
+ * @throws InvalidArgumentException if one of the argument format is invalid
+ * @throws AppConfigTypeConflictException in case of conflict with the value type set in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see getValueString()
+ * @see getValueInt()
+ * @see getValueFloat()
+ * @see getValueBool()
+ * @see getValueArray()
+ */
+ public function getValueBigInt(
+ string $app,
+ string $key,
+ int|float $default = 0,
+ bool $lazy = false
+ ): int|float {
+ return Util::numericToNumber($this->getTypedValue($app, $key, (string)$default, $lazy, self::VALUE_INT));
+ }
+
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param float $default default value
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return float stored config value or $default if not set in database
+ * @throws InvalidArgumentException if one of the argument format is invalid
+ * @throws AppConfigTypeConflictException in case of conflict with the value type set in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see getValueString()
+ * @see getValueInt()
+ * @see getValueBigInt()
+ * @see getValueBool()
+ * @see getValueArray()
+ */
+ public function getValueFloat(string $app, string $key, float $default = 0, bool $lazy = false): float {
+ return (float)$this->getTypedValue($app, $key, (string)$default, $lazy, self::VALUE_FLOAT);
+ }
+
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param bool $default default value
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return bool stored config value or $default if not set in database
+ * @throws InvalidArgumentException if one of the argument format is invalid
+ * @throws AppConfigTypeConflictException in case of conflict with the value type set in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see getValueString()
+ * @see getValueInt()
+ * @see getValueBigInt()
+ * @see getValueFloat()
+ * @see getValueArray()
+ */
+ public function getValueBool(string $app, string $key, bool $default = false, bool $lazy = false): bool {
+ $b = strtolower($this->getTypedValue($app, $key, $default ? 'true' : 'false', $lazy, self::VALUE_BOOL));
+ return in_array($b, ['1', 'true', 'yes', 'on']);
+ }
- if ($this->hasKey($app, $key)) {
- return $this->cache[$app][$key];
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param array $default default value
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return array stored config value or $default if not set in database
+ * @throws InvalidArgumentException if one of the argument format is invalid
+ * @throws AppConfigTypeConflictException in case of conflict with the value type set in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see getValueString()
+ * @see getValueInt()
+ * @see getValueBigInt()
+ * @see getValueFloat()
+ * @see getValueBool()
+ */
+ public function getValueArray(
+ string $app,
+ string $key,
+ array $default = [],
+ bool $lazy = false
+ ): array {
+ try {
+ $defaultJson = json_encode($default, JSON_THROW_ON_ERROR);
+ $value = json_decode($this->getTypedValue($app, $key, $defaultJson, $lazy, self::VALUE_ARRAY), true, flags: JSON_THROW_ON_ERROR);
+
+ return is_array($value) ? $value : [];
+ } catch (JsonException) {
+ return [];
}
+ }
- return $default;
+ /**
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param string $default default value
+ * @param bool $lazy search within lazy loaded config
+ * @param int $type value type {@see VALUE_STRING} {@see VALUE_INT}{@see VALUE_FLOAT} {@see VALUE_BOOL} {@see VALUE_ARRAY}
+ *
+ * @return string
+ * @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
+ * @throws InvalidArgumentException
+ */
+ private function getTypedValue(
+ string $app,
+ string $key,
+ string $default,
+ bool $lazy,
+ int $type
+ ): string {
+ $this->assertParams($app, $key, valueType: $type);
+ $this->loadConfig($lazy);
+
+ /**
+ * We ignore check if mixed type is requested.
+ * If type of stored value is set as mixed, we don't filter.
+ * If type of stored value is defined, we compare with the one requested.
+ */
+ $knownType = $this->valueTypes[$app][$key] ?? 0;
+ if (!$this->isTyped(self::VALUE_MIXED, $type)
+ && $knownType > 0
+ && !$this->isTyped(self::VALUE_MIXED, $knownType)
+ && !$this->isTyped($type, $knownType)) {
+ $this->logger->warning('conflict with value type from database', ['app' => $app, 'key' => $key, 'type' => $type, 'knownType' => $knownType]);
+ throw new AppConfigTypeConflictException('conflict with value type from database');
+ }
+
+ if ($lazy) {
+ $cache = &$this->lazyCache;
+ } else {
+ $cache = &$this->fastCache;
+ }
+
+ return $cache[$app][$key] ?? $default;
}
/**
- * check if a key is set in the appconfig
+ * @inheritDoc
*
- * @param string $app
- * @param string $key
- * @return bool
+ * @param string $app id of the app
+ * @param string $key config key
+ *
+ * @return int type of the value
+ * @throws AppConfigUnknownKeyException if config key is not known
+ * @since 29.0.0
+ * @see VALUE_STRING
+ * @see VALUE_INT
+ * @see VALUE_FLOAT
+ * @see VALUE_BOOL
+ * @see VALUE_ARRAY
*/
- public function hasKey($app, $key) {
- $this->loadConfigValues();
+ public function getValueType(string $app, string $key): int {
+ $this->assertParams($app, $key);
+ $this->loadConfigAll();
- return isset($this->cache[$app][$key]);
+ $type = $this->valueTypes[$app][$key] ?? throw new AppConfigUnknownKeyException('unknown config key');
+ $type &= ~self::VALUE_SENSITIVE;
+ return $type;
}
+
/**
- * Sets a value. If the key did not exist before it will be created.
+ * Store a config key and its value in database as VALUE_MIXED
*
- * @param string $app app
- * @param string $key key
- * @param string|float|int $value value
- * @return bool True if the value was inserted or updated, false if the value was the same
+ * **WARNING:** Method is internal and **MUST** not be used as it is best to set a real value type
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param string $value config value
+ * @param bool $lazy set config as lazy loaded
+ * @param bool $sensitive if TRUE value will be hidden when listing config values.
+ *
+ * @return bool TRUE if value was different, therefor updated in database
+ * @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED
+ * @internal
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy grouping
+ * @see setValueString()
+ * @see setValueInt()
+ * @see setValueBigInt()
+ * @see setValueFloat()
+ * @see setValueBool()
+ * @see setValueArray()
*/
- public function setValue($app, $key, $value) {
- if (!$this->hasKey($app, $key)) {
- $inserted = (bool) $this->conn->insertIfNotExist('*PREFIX*appconfig', [
- 'appid' => $app,
- 'configkey' => $key,
- 'configvalue' => $value,
- ], [
- 'appid',
- 'configkey',
- ]);
-
- if ($inserted) {
- if (!isset($this->cache[$app])) {
- $this->cache[$app] = [];
- }
+ public function setValueMixed(
+ string $app,
+ string $key,
+ string $value,
+ bool $lazy = false,
+ bool $sensitive = false
+ ): bool {
+ return $this->setTypedValue(
+ $app,
+ $key,
+ $value,
+ $lazy,
+ self::VALUE_MIXED | ($sensitive ? self::VALUE_SENSITIVE : 0)
+ );
+ }
- $this->cache[$app][$key] = $value;
- return true;
- }
+
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param string $value config value
+ * @param bool $lazy set config as lazy loaded
+ * @param bool $sensitive if TRUE value will be hidden when listing config values.
+ *
+ * @return bool TRUE if value was different, therefor updated in database
+ * @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see setValueInt()
+ * @see setValueBigInt()
+ * @see setValueFloat()
+ * @see setValueBool()
+ * @see setValueArray()
+ */
+ public function setValueString(
+ string $app,
+ string $key,
+ string $value,
+ bool $lazy = false,
+ bool $sensitive = false
+ ): bool {
+ return $this->setTypedValue(
+ $app,
+ $key,
+ $value,
+ $lazy,
+ self::VALUE_STRING | ($sensitive ? self::VALUE_SENSITIVE : 0)
+ );
+ }
+
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param int $value config value
+ * @param bool $lazy set config as lazy loaded
+ * @param bool $sensitive if TRUE value will be hidden when listing config values.
+ *
+ * @return bool TRUE if value was different, therefor updated in database
+ * @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see setValueString()
+ * @see setValueBigInt()
+ * @see setValueFloat()
+ * @see setValueBool()
+ * @see setValueArray()
+ */
+ public function setValueInt(
+ string $app,
+ string $key,
+ int $value,
+ bool $lazy = false,
+ bool $sensitive = false
+ ): bool {
+ return $this->setTypedValue(
+ $app,
+ $key,
+ (string)$value,
+ $lazy,
+ self::VALUE_INT | ($sensitive ? self::VALUE_SENSITIVE : 0)
+ );
+ }
+
+
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param int|float $value config value
+ * @param bool $lazy set config as lazy loaded
+ * @param bool $sensitive if TRUE value will be hidden when listing config values.
+ *
+ * @return bool TRUE if value was different, therefor updated in database
+ * @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see setValueString()
+ * @see setValueInt()
+ * @see setValueFloat()
+ * @see setValueBool()
+ * @see setValueArray()
+ */
+ public function setValueBigInt(
+ string $app,
+ string $key,
+ int|float $value,
+ bool $lazy = false,
+ bool $sensitive = false
+ ): bool {
+ return $this->setTypedValue(
+ $app,
+ $key,
+ (string)$value,
+ $lazy,
+ self::VALUE_INT | ($sensitive ? self::VALUE_SENSITIVE : 0)
+ );
+ }
+
+
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param float $value config value
+ * @param bool $lazy set config as lazy loaded
+ * @param bool $sensitive if TRUE value will be hidden when listing config values.
+ *
+ * @return bool TRUE if value was different, therefor updated in database
+ * @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see setValueString()
+ * @see setValueInt()
+ * @see setValueBigInt()
+ * @see setValueBool()
+ * @see setValueArray()
+ */
+ public function setValueFloat(
+ string $app,
+ string $key,
+ float $value,
+ bool $lazy = false,
+ bool $sensitive = false
+ ): bool {
+ return $this->setTypedValue(
+ $app,
+ $key,
+ (string)$value,
+ $lazy,
+ self::VALUE_FLOAT | ($sensitive ? self::VALUE_SENSITIVE : 0)
+ );
+ }
+
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param bool $value config value
+ * @param bool $lazy set config as lazy loaded
+ *
+ * @return bool TRUE if value was different, therefor updated in database
+ * @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see setValueString()
+ * @see setValueInt()
+ * @see setValueBigInt()
+ * @see setValueFloat()
+ * @see setValueArray()
+ */
+ public function setValueBool(
+ string $app,
+ string $key,
+ bool $value,
+ bool $lazy = false
+ ): bool {
+ return $this->setTypedValue(
+ $app,
+ $key,
+ ($value) ? '1' : '0',
+ $lazy,
+ self::VALUE_BOOL
+ );
+ }
+
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param array $value config value
+ * @param bool $lazy set config as lazy loaded
+ * @param bool $sensitive if TRUE value will be hidden when listing config values.
+ *
+ * @return bool TRUE if value was different, therefor updated in database
+ * @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
+ * @throws JsonException
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see setValueString()
+ * @see setValueInt()
+ * @see setValueBigInt()
+ * @see setValueFloat()
+ * @see setValueBool()
+ */
+ public function setValueArray(
+ string $app,
+ string $key,
+ array $value,
+ bool $lazy = false,
+ bool $sensitive = false
+ ): bool {
+ try {
+ return $this->setTypedValue(
+ $app,
+ $key,
+ json_encode($value, JSON_THROW_ON_ERROR),
+ $lazy,
+ self::VALUE_ARRAY | ($sensitive ? self::VALUE_SENSITIVE : 0)
+ );
+ } catch (JsonException $e) {
+ $this->logger->warning('could not setValueArray', ['app' => $app, 'key' => $key, 'exception' => $e]);
+ throw $e;
}
+ }
+
+ /**
+ * Store a config key and its value in database
+ *
+ * If config key is already known with the exact same config value and same sensitive/lazy status, the
+ * database is not updated. If config value was previously stored as sensitive, status will not be
+ * altered.
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param string $value config value
+ * @param bool $lazy config set as lazy loaded
+ * @param int $type value type {@see VALUE_STRING} {@see VALUE_INT} {@see VALUE_FLOAT} {@see VALUE_BOOL} {@see VALUE_ARRAY}
+ *
+ * @return bool TRUE if value was updated in database
+ * @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
+ * @see IAppConfig for explanation about lazy loading
+ */
+ private function setTypedValue(
+ string $app,
+ string $key,
+ string $value,
+ bool $lazy,
+ int $type
+ ): bool {
+ $this->assertParams($app, $key);
+ $this->loadConfig($lazy);
- $sql = $this->conn->getQueryBuilder();
- $sql->update('appconfig')
- ->set('configvalue', $sql->createNamedParameter($value))
- ->where($sql->expr()->eq('appid', $sql->createNamedParameter($app)))
- ->andWhere($sql->expr()->eq('configkey', $sql->createNamedParameter($key)));
+ $sensitive = $this->isTyped(self::VALUE_SENSITIVE, $type);
/*
- * Only limit to the existing value for non-Oracle DBs:
- * http://docs.oracle.com/cd/E11882_01/server.112/e26088/conditions002.htm#i1033286
- * > Large objects (LOBs) are not supported in comparison conditions.
+ * no update if key is already known with set lazy status, or value is
+ * different, or sensitivity switched from false to true.
*/
- if (!($this->conn instanceof OracleConnection)) {
- /*
- * Only update the value when it is not the same
- * Note that NULL requires some special handling. Since comparing
- * against null can have special results.
+ if ($this->hasKey($app, $key, $lazy)
+ && $value === $this->getTypedValue($app, $key, $value, $lazy, $type)
+ && (!$sensitive || $this->isSensitive($app, $key, $lazy))) {
+ return false;
+ }
+
+ $refreshCache = false;
+ $insert = $this->connection->getQueryBuilder();
+ $insert->insert('appconfig')
+ ->setValue('appid', $insert->createNamedParameter($app))
+ ->setValue('lazy', $insert->createNamedParameter($lazy, IQueryBuilder::PARAM_BOOL))
+ ->setValue('type', $insert->createNamedParameter($type, IQueryBuilder::PARAM_INT))
+ ->setValue('configkey', $insert->createNamedParameter($key))
+ ->setValue('configvalue', $insert->createNamedParameter($value));
+ try {
+ $insert->executeStatement();
+ } catch (DBException $e) {
+ if ($e->getReason() !== DBException::REASON_UNIQUE_CONSTRAINT_VIOLATION) {
+ throw $e; // TODO: throw exception or just log and returns false !?
+ }
+
+ $currType = $this->valueTypes[$app][$key] ?? 0;
+ if ($currType === 0) { // this might happen when switching lazy loading status
+ $this->loadConfigAll();
+ $currType = $this->valueTypes[$app][$key] ?? 0;
+ }
+
+ /**
+ * we only accept a different type from the one stored in database
+ * if the one stored in database is not-defined (VALUE_MIXED)
*/
+ if (!$this->isTyped(self::VALUE_MIXED, $currType) &&
+ ($type | self::VALUE_SENSITIVE) !== ($currType | self::VALUE_SENSITIVE)) {
+ try {
+ $currType = $this->convertTypeToString($currType);
+ $type = $this->convertTypeToString($type);
+ } catch (AppConfigIncorrectTypeException) {
+ }
+ throw new AppConfigTypeConflictException('conflict between new type (' . $type . ') and old type (' . $currType . ')');
+ }
- if ($value === null) {
- $sql->andWhere(
- $sql->expr()->isNotNull('configvalue')
- );
- } else {
- $sql->andWhere(
- $sql->expr()->orX(
- $sql->expr()->isNull('configvalue'),
- $sql->expr()->neq('configvalue', $sql->createNamedParameter($value), IQueryBuilder::PARAM_STR)
- )
- );
+ // we fix $type if the stored value, or the new value as it might be changed, is set as sensitive
+ if ($sensitive || $this->isTyped(self::VALUE_SENSITIVE, $currType)) {
+ $type = $type | self::VALUE_SENSITIVE;
}
+
+ if ($lazy !== $this->isLazy($app, $key)) {
+ $refreshCache = true;
+ }
+
+ $update = $this->connection->getQueryBuilder();
+ $update->update('appconfig')
+ ->set('configvalue', $update->createNamedParameter($value))
+ ->set('lazy', $update->createNamedParameter($lazy, IQueryBuilder::PARAM_BOOL))
+ ->set('type', $update->createNamedParameter($type, IQueryBuilder::PARAM_INT))
+ ->where($update->expr()->eq('appid', $update->createNamedParameter($app)))
+ ->andWhere($update->expr()->eq('configkey', $update->createNamedParameter($key)));
+
+ $update->executeStatement();
}
- $changedRow = (bool) $sql->execute();
+ if ($refreshCache) {
+ $this->clearCache();
+ return true;
+ }
- $this->cache[$app][$key] = $value;
+ // update local cache
+ if ($lazy) {
+ $cache = &$this->lazyCache;
+ } else {
+ $cache = &$this->fastCache;
+ }
+ $cache[$app][$key] = $value;
+ $this->valueTypes[$app][$key] = $type;
- return $changedRow;
+ return true;
}
/**
- * Deletes a key
+ * Change the type of config value.
*
- * @param string $app app
- * @param string $key key
- * @return boolean
+ * **WARNING:** Method is internal and **MUST** not be used as it may break things.
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param int $type value type {@see VALUE_STRING} {@see VALUE_INT} {@see VALUE_FLOAT} {@see VALUE_BOOL} {@see VALUE_ARRAY}
+ *
+ * @return bool TRUE if database update were necessary
+ * @throws AppConfigUnknownKeyException if $key is now known in database
+ * @throws AppConfigIncorrectTypeException if $type is not valid
+ * @internal
+ * @since 29.0.0
*/
- public function deleteKey($app, $key) {
- $this->loadConfigValues();
+ public function updateType(string $app, string $key, int $type = self::VALUE_MIXED): bool {
+ $this->assertParams($app, $key);
+ $this->loadConfigAll();
+ $lazy = $this->isLazy($app, $key);
+
+ if (!$this->hasKey($app, $key, $lazy)) {
+ throw new AppConfigUnknownKeyException('Unknown config key');
+ }
- $sql = $this->conn->getQueryBuilder();
- $sql->delete('appconfig')
- ->where($sql->expr()->eq('appid', $sql->createParameter('app')))
- ->andWhere($sql->expr()->eq('configkey', $sql->createParameter('configkey')))
- ->setParameter('app', $app)
- ->setParameter('configkey', $key);
- $sql->execute();
+ // type can only be one type
+ if (!in_array($type, [self::VALUE_MIXED, self::VALUE_STRING, self::VALUE_INT, self::VALUE_FLOAT, self::VALUE_BOOL, self::VALUE_ARRAY])) {
+ throw new AppConfigIncorrectTypeException('Unknown value type');
+ }
+
+ $currType = $this->valueTypes[$app][$key];
+ if (($type | self::VALUE_SENSITIVE) === ($currType | self::VALUE_SENSITIVE)) {
+ return false;
+ }
+
+ // we complete with sensitive flag if the stored value is set as sensitive
+ if ($this->isTyped(self::VALUE_SENSITIVE, $currType)) {
+ $type = $type | self::VALUE_SENSITIVE;
+ }
- unset($this->cache[$app][$key]);
- return false;
+ $update = $this->connection->getQueryBuilder();
+ $update->update('appconfig')
+ ->set('type', $update->createNamedParameter($type, IQueryBuilder::PARAM_INT))
+ ->where($update->expr()->eq('appid', $update->createNamedParameter($app)))
+ ->andWhere($update->expr()->eq('configkey', $update->createNamedParameter($key)));
+ $update->executeStatement();
+ $this->valueTypes[$app][$key] = $type;
+
+ return true;
}
+
/**
- * Remove app from appconfig
+ * @inheritDoc
*
- * @param string $app app
- * @return boolean
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param bool $sensitive TRUE to set as sensitive, FALSE to unset
*
- * Removes all keys in appconfig belonging to the app.
+ * @return bool TRUE if database update were necessary
+ * @throws AppConfigUnknownKeyException if config key is not known
+ * @since 29.0.0
*/
- public function deleteApp($app) {
- $this->loadConfigValues();
+ public function updateSensitive(string $app, string $key, bool $sensitive): bool {
+ $this->assertParams($app, $key);
+ $this->loadConfigAll();
+
+ if ($sensitive === $this->isSensitive($app, $key, null)) {
+ return false;
+ }
- $sql = $this->conn->getQueryBuilder();
- $sql->delete('appconfig')
- ->where($sql->expr()->eq('appid', $sql->createParameter('app')))
- ->setParameter('app', $app);
- $sql->execute();
+ /**
+ * type returned by getValueType() is already cleaned from sensitive flag
+ * we just need to update it based on $sensitive and store it in database
+ */
+ $type = $this->getValueType($app, $key);
+ if ($sensitive) {
+ $type = $type | self::VALUE_SENSITIVE;
+ }
+
+ $update = $this->connection->getQueryBuilder();
+ $update->update('appconfig')
+ ->set('type', $update->createNamedParameter($type, IQueryBuilder::PARAM_INT))
+ ->where($update->expr()->eq('appid', $update->createNamedParameter($app)))
+ ->andWhere($update->expr()->eq('configkey', $update->createNamedParameter($key)));
+ $update->executeStatement();
- unset($this->cache[$app]);
- return false;
+ $this->valueTypes[$app][$key] = $type;
+
+ return true;
}
/**
- * get multiple values, either the app or key can be used as wildcard by setting it to false
+ * @inheritDoc
*
- * @param string|false $app
- * @param string|false $key
- * @return array|false
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param bool $lazy TRUE to set as lazy loaded, FALSE to unset
+ *
+ * @return bool TRUE if database update was necessary
+ * @throws AppConfigUnknownKeyException if config key is not known
+ * @since 29.0.0
*/
- public function getValues($app, $key) {
- if (($app !== false) === ($key !== false)) {
+ public function updateLazy(string $app, string $key, bool $lazy): bool {
+ $this->assertParams($app, $key);
+ $this->loadConfigAll();
+
+ if ($lazy === $this->isLazy($app, $key)) {
return false;
}
- if ($key === false) {
- return $this->getAppValues($app);
+ $update = $this->connection->getQueryBuilder();
+ $update->update('appconfig')
+ ->set('lazy', $update->createNamedParameter($lazy, IQueryBuilder::PARAM_BOOL))
+ ->where($update->expr()->eq('appid', $update->createNamedParameter($app)))
+ ->andWhere($update->expr()->eq('configkey', $update->createNamedParameter($key)));
+ $update->executeStatement();
+
+ // At this point, it is a lot safer to clean cache
+ $this->clearCache();
+
+ return true;
+ }
+
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ *
+ * @return array
+ * @throws AppConfigUnknownKeyException if config key is not known in database
+ * @since 29.0.0
+ */
+ public function getDetails(string $app, string $key): array {
+ $this->assertParams($app, $key);
+ $this->loadConfigAll();
+ $lazy = $this->isLazy($app, $key);
+
+ if ($lazy) {
+ $cache = &$this->lazyCache;
} else {
- $appIds = $this->getApps();
- $values = array_map(function ($appId) use ($key) {
- return $this->cache[$appId][$key] ?? null;
- }, $appIds);
- $result = array_combine($appIds, $values);
+ $cache = &$this->fastCache;
+ }
- return array_filter($result);
+ $type = $this->getValueType($app, $key);
+ try {
+ $typeString = $this->convertTypeToString($type);
+ } catch (AppConfigIncorrectTypeException $e) {
+ $this->logger->warning('type stored in database is not correct', ['exception' => $e, 'type' => $type]);
+ $typeString = (string)$type;
}
+
+ return [
+ 'app' => $app,
+ 'key' => $key,
+ 'value' => $cache[$app][$key] ?? throw new AppConfigUnknownKeyException('unknown config key'),
+ 'lazy' => $lazy,
+ 'type' => $type,
+ 'typeString' => $typeString,
+ 'sensitive' => $this->isSensitive($app, $key, null)
+ ];
}
/**
- * get all values of the app or and filters out sensitive data
+ * @param string $type
+ *
+ * @return int
+ * @throws AppConfigIncorrectTypeException
+ * @since 29.0.0
+ */
+ public function convertTypeToInt(string $type): int {
+ return match (strtolower($type)) {
+ 'mixed' => IAppConfig::VALUE_MIXED,
+ 'string' => IAppConfig::VALUE_STRING,
+ 'integer' => IAppConfig::VALUE_INT,
+ 'float' => IAppConfig::VALUE_FLOAT,
+ 'boolean' => IAppConfig::VALUE_BOOL,
+ 'array' => IAppConfig::VALUE_ARRAY,
+ default => throw new AppConfigIncorrectTypeException('Unknown type ' . $type)
+ };
+ }
+
+ /**
+ * @param int $type
+ *
+ * @return string
+ * @throws AppConfigIncorrectTypeException
+ * @since 29.0.0
+ */
+ public function convertTypeToString(int $type): string {
+ $type &= ~self::VALUE_SENSITIVE;
+
+ return match ($type) {
+ IAppConfig::VALUE_MIXED => 'mixed',
+ IAppConfig::VALUE_STRING => 'string',
+ IAppConfig::VALUE_INT => 'integer',
+ IAppConfig::VALUE_FLOAT => 'float',
+ IAppConfig::VALUE_BOOL => 'boolean',
+ IAppConfig::VALUE_ARRAY => 'array',
+ default => throw new AppConfigIncorrectTypeException('Unknown numeric type ' . $type)
+ };
+ }
+
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ *
+ * @since 29.0.0
+ */
+ public function deleteKey(string $app, string $key): void {
+ $this->assertParams($app, $key);
+ $qb = $this->connection->getQueryBuilder();
+ $qb->delete('appconfig')
+ ->where($qb->expr()->eq('appid', $qb->createNamedParameter($app)))
+ ->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key)));
+ $qb->executeStatement();
+
+ unset($this->lazyCache[$app][$key]);
+ unset($this->fastCache[$app][$key]);
+ }
+
+ /**
+ * @inheritDoc
+ *
+ * @param string $app id of the app
+ *
+ * @since 29.0.0
+ */
+ public function deleteApp(string $app): void {
+ $this->assertParams($app);
+ $qb = $this->connection->getQueryBuilder();
+ $qb->delete('appconfig')
+ ->where($qb->expr()->eq('appid', $qb->createNamedParameter($app)));
+ $qb->executeStatement();
+
+ $this->clearCache();
+ }
+
+ /**
+ * @inheritDoc
+ *
+ * @param bool $reload set to TRUE to refill cache instantly after clearing it
+ *
+ * @since 29.0.0
+ */
+ public function clearCache(bool $reload = false): void {
+ $this->lazyLoaded = $this->fastLoaded = false;
+ $this->lazyCache = $this->fastCache = $this->valueTypes = [];
+
+ if (!$reload) {
+ return;
+ }
+
+ $this->loadConfigAll();
+ }
+
+
+ /**
+ * For debug purpose.
+ * Returns the cached data.
*
- * @param string $app
* @return array
+ * @since 29.0.0
+ * @internal
*/
- public function getFilteredValues($app) {
- $values = $this->getValues($app, false);
+ public function statusCache(): array {
+ return [
+ 'fastLoaded' => $this->fastLoaded,
+ 'fastCache' => $this->fastCache,
+ 'lazyLoaded' => $this->lazyLoaded,
+ 'lazyCache' => $this->lazyCache,
+ ];
+ }
- if (isset($this->sensitiveValues[$app])) {
- foreach ($this->sensitiveValues[$app] as $sensitiveKeyExp) {
- $sensitiveKeys = preg_grep($sensitiveKeyExp, array_keys($values));
- foreach ($sensitiveKeys as $sensitiveKey) {
- $values[$sensitiveKey] = IConfig::SENSITIVE_VALUE;
- }
+ /**
+ * @param int $needle bitflag to search
+ * @param int $type known value
+ *
+ * @return bool TRUE if bitflag $needle is set in $type
+ */
+ private function isTyped(int $needle, int $type): bool {
+ return (($needle & $type) !== 0);
+ }
+
+ /**
+ * Confirm the string set for app, key and lazyGroup fit the database description
+ *
+ * @param string $app assert $app fit in database
+ * @param string $configKey assert config key fit in database
+ * @param bool $allowEmptyApp $app can be empty string
+ * @param int $valueType assert value type is only one type
+ *
+ * @throws InvalidArgumentException
+ */
+ private function assertParams(string $app = '', string $configKey = '', bool $allowEmptyApp = false, int $valueType = -1): void {
+ if (!$allowEmptyApp && $app === '') {
+ throw new InvalidArgumentException('app cannot be an empty string');
+ }
+ if (strlen($app) > self::APP_MAX_LENGTH) {
+ throw new InvalidArgumentException(
+ 'Value (' . $app . ') for app is too long (' . self::APP_MAX_LENGTH . ')'
+ );
+ }
+ if (strlen($configKey) > self::KEY_MAX_LENGTH) {
+ throw new InvalidArgumentException('Value (' . $configKey . ') for key is too long (' . self::KEY_MAX_LENGTH . ')');
+ }
+ if ($valueType > -1) {
+ $valueType &= ~self::VALUE_SENSITIVE;
+ if (!in_array($valueType, [self::VALUE_MIXED, self::VALUE_STRING, self::VALUE_INT, self::VALUE_FLOAT, self::VALUE_BOOL, self::VALUE_ARRAY])) {
+ throw new InvalidArgumentException('Unknown value type');
}
}
+ }
- return $values;
+ private function loadConfigAll(): void {
+ $this->loadConfig(null);
}
/**
- * Load all the app config values
+ * Load normal config or config set as lazy loaded
+ *
+ * @param bool|null $lazy set to TRUE to load config set as lazy loaded, set to NULL to load all config
*/
- protected function loadConfigValues() {
- if ($this->configLoaded) {
+ private function loadConfig(?bool $lazy = false): void {
+ if ($this->isLoaded($lazy)) {
return;
}
- $this->cache = [];
+ $qb = $this->connection->getQueryBuilder();
+ $qb->from('appconfig');
+
+ /**
+ * The use of $this->>migrationCompleted is only needed to manage the
+ * database during the upgrading process to nc29.
+ */
+ if (!$this->migrationCompleted) {
+ $qb->select('appid', 'configkey', 'configvalue');
+ } else {
+ $qb->select('appid', 'configkey', 'configvalue', 'type', 'lazy');
+ if ($lazy !== null) {
+ if ($this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_ORACLE) {
+ // Oracle does not like empty string nor false boolean !?
+ if ($lazy) {
+ $qb->where($qb->expr()->eq('lazy', $qb->createNamedParameter('1', IQueryBuilder::PARAM_INT)));
+ } else {
+ $qb->where($qb->expr()->orX(
+ $qb->expr()->isNull('lazy'),
+ $qb->expr()->eq('lazy', $qb->createNamedParameter('0', IQueryBuilder::PARAM_INT))
+ ));
+ }
+ } else {
+ $qb->where($qb->expr()->eq('lazy', $qb->createNamedParameter($lazy, IQueryBuilder::PARAM_BOOL)));
+ }
+ }
+ }
- $sql = $this->conn->getQueryBuilder();
- $sql->select('*')
- ->from('appconfig');
- $result = $sql->execute();
+ try {
+ $result = $qb->executeQuery();
+ } catch (DBException $e) {
+ /**
+ * in case of issue with field name, it means that migration is not completed.
+ * Falling back to a request without select on lazy.
+ * This whole try/catch and the migrationCompleted variable can be removed in NC30.
+ */
+ if ($e->getReason() !== DBException::REASON_INVALID_FIELD_NAME) {
+ throw $e;
+ }
+
+ $this->migrationCompleted = false;
+ $this->loadConfig($lazy);
+
+ return;
+ }
- // we are going to store the result in memory anyway
$rows = $result->fetchAll();
foreach ($rows as $row) {
- if (!isset($this->cache[$row['appid']])) {
- $this->cache[(string)$row['appid']] = [];
+ // if migration is not completed, 'lazy' and 'type' does not exist in $row
+ // also on oracle, lazy can be null ...
+ if ($row['lazy'] ?? false) {
+ $cache = &$this->lazyCache;
+ } else {
+ $cache = &$this->fastCache;
}
-
- $this->cache[(string)$row['appid']][(string)$row['configkey']] = (string)$row['configvalue'];
+ $cache[$row['appid']][$row['configkey']] = $row['configvalue'] ?? '';
+ $this->valueTypes[$row['appid']][$row['configkey']] = (int)($row['type'] ?? 0);
}
$result->closeCursor();
+ $this->setAsLoaded($lazy);
+ }
+
+ /**
+ * if $lazy is:
+ * - false: will returns true if fast config is loaded
+ * - true : will returns true if lazy config is loaded
+ * - null : will returns true if both config are loaded
+ *
+ * @param bool $lazy
+ *
+ * @return bool
+ */
+ private function isLoaded(?bool $lazy): bool {
+ if ($lazy === null) {
+ return $this->lazyLoaded && $this->fastLoaded;
+ }
- $this->configLoaded = true;
+ return $lazy ? $this->lazyLoaded : $this->fastLoaded;
}
+ /**
+ * if $lazy is:
+ * - false: set fast config as loaded
+ * - true : set lazy config as loaded
+ * - null : set both config as loaded
+ *
+ * @param bool $lazy
+ */
+ private function setAsLoaded(?bool $lazy): void {
+ if ($lazy === null) {
+ $this->fastLoaded = true;
+ $this->lazyLoaded = true;
+
+ return;
+ }
+
+ if ($lazy) {
+ $this->lazyLoaded = true;
+ } else {
+ $this->fastLoaded = true;
+ }
+ }
+
+ /**
+ * Gets the config value
+ *
+ * @param string $app app
+ * @param string $key key
+ * @param string $default = null, default value if the key does not exist
+ *
+ * @return string the value or $default
+ * @deprecated - use getValue*()
+ *
+ * This function gets a value from the appconfig table. If the key does
+ * not exist the default value will be returned
+ */
+ public function getValue($app, $key, $default = null) {
+ $this->loadConfig();
+
+ return $this->fastCache[$app][$key] ?? $default;
+ }
+
+ /**
+ * Sets a value. If the key did not exist before it will be created.
+ *
+ * @param string $app app
+ * @param string $key key
+ * @param string|float|int $value value
+ *
+ * @return bool True if the value was inserted or updated, false if the value was the same
+ * @throws AppConfigTypeConflictException
+ * @throws AppConfigUnknownKeyException
+ * @deprecated
+ */
+ public function setValue($app, $key, $value) {
+ return $this->setTypedValue($app, $key, (string)$value, false, self::VALUE_MIXED);
+ }
+
+
+ /**
+ * get multiple values, either the app or key can be used as wildcard by setting it to false
+ *
+ * @param string|false $app
+ * @param string|false $key
+ *
+ * @return array|false
+ * @deprecated 29.0.0 use getAllValues()
+ */
+ public function getValues($app, $key) {
+ if (($app !== false) === ($key !== false)) {
+ return false;
+ }
+
+ $key = ($key === false) ? '' : $key;
+ if (!$app) {
+ return $this->searchValues($key);
+ } else {
+ return $this->getAllValues($app, $key);
+ }
+ }
+
+ /**
+ * get all values of the app or and filters out sensitive data
+ *
+ * @param string $app
+ *
+ * @return array
+ * @deprecated 29.0.0 use getAllValues()
+ */
+ public function getFilteredValues($app) {
+ return $this->getAllValues($app, filtered: true);
+ }
+
+ /**
+ * @param string $app
+ *
+ * @return string[]
+ * @deprecated data sensitivity should be set when calling setValue*()
+ */
+ private function getSensitiveKeys(string $app): array {
+ $sensitiveValues = [
+ 'circles' => [
+ '/^key_pairs$/',
+ '/^local_gskey$/',
+ ],
+ 'external' => [
+ '/^sites$/',
+ ],
+ 'integration_discourse' => [
+ '/^private_key$/',
+ '/^public_key$/',
+ ],
+ 'integration_dropbox' => [
+ '/^client_id$/',
+ '/^client_secret$/',
+ ],
+ 'integration_github' => [
+ '/^client_id$/',
+ '/^client_secret$/',
+ ],
+ 'integration_gitlab' => [
+ '/^client_id$/',
+ '/^client_secret$/',
+ '/^oauth_instance_url$/',
+ ],
+ 'integration_google' => [
+ '/^client_id$/',
+ '/^client_secret$/',
+ ],
+ 'integration_jira' => [
+ '/^client_id$/',
+ '/^client_secret$/',
+ '/^forced_instance_url$/',
+ ],
+ 'integration_onedrive' => [
+ '/^client_id$/',
+ '/^client_secret$/',
+ ],
+ 'integration_openproject' => [
+ '/^client_id$/',
+ '/^client_secret$/',
+ '/^oauth_instance_url$/',
+ ],
+ 'integration_reddit' => [
+ '/^client_id$/',
+ '/^client_secret$/',
+ ],
+ 'integration_suitecrm' => [
+ '/^client_id$/',
+ '/^client_secret$/',
+ '/^oauth_instance_url$/',
+ ],
+ 'integration_twitter' => [
+ '/^consumer_key$/',
+ '/^consumer_secret$/',
+ '/^followed_user$/',
+ ],
+ 'integration_zammad' => [
+ '/^client_id$/',
+ '/^client_secret$/',
+ '/^oauth_instance_url$/',
+ ],
+ 'notify_push' => [
+ '/^cookie$/',
+ ],
+ 'serverinfo' => [
+ '/^token$/',
+ ],
+ 'spreed' => [
+ '/^bridge_bot_password$/',
+ '/^hosted-signaling-server-(.*)$/',
+ '/^recording_servers$/',
+ '/^signaling_servers$/',
+ '/^signaling_ticket_secret$/',
+ '/^signaling_token_privkey_(.*)$/',
+ '/^signaling_token_pubkey_(.*)$/',
+ '/^sip_bridge_dialin_info$/',
+ '/^sip_bridge_shared_secret$/',
+ '/^stun_servers$/',
+ '/^turn_servers$/',
+ '/^turn_server_secret$/',
+ ],
+ 'support' => [
+ '/^last_response$/',
+ '/^potential_subscription_key$/',
+ '/^subscription_key$/',
+ ],
+ 'theming' => [
+ '/^imprintUrl$/',
+ '/^privacyUrl$/',
+ '/^slogan$/',
+ '/^url$/',
+ ],
+ 'user_ldap' => [
+ '/^(s..)?ldap_agent_password$/',
+ ],
+ 'user_saml' => [
+ '/^idp-x509cert$/',
+ ],
+ ];
+
+ return $sensitiveValues[$app] ?? [];
+ }
/**
* Clear all the cached app config values
* New cache will be generated next time a config value is retrieved
+ *
+ * @deprecated use {@see clearCache()}
*/
public function clearCachedConfig(): void {
- $this->configLoaded = false;
+ $this->clearCache();
}
}
],
];
- /** @var Config */
- private $config;
-
- public function __construct(Config $config) {
- $this->config = $config;
+ public function __construct(
+ private Config $config,
+ ) {
}
/**
use OCP\App\ManagerEvent;
use OCP\Authentication\IAlternativeLogin;
use OCP\EventDispatcher\IEventDispatcher;
+use OCP\IAppConfig;
use Psr\Container\ContainerExceptionInterface;
use Psr\Log\LoggerInterface;
static $versions;
if (!$versions) {
- $appConfig = \OC::$server->getAppConfig();
- $versions = $appConfig->getValues(false, 'installed_version');
+ /** @var IAppConfig $appConfig */
+ $appConfig = \OCP\Server::get(IAppConfig::class);
+ $versions = $appConfig->searchValues('installed_version');
}
return $versions;
}
--- /dev/null
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright 2023 Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @author Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @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 OCP\Exceptions;
+
+use Exception;
+
+/**
+ * @since 29.0.0
+ */
+class AppConfigException extends Exception {
+}
--- /dev/null
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright 2023 Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @author Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @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 OCP\Exceptions;
+
+/**
+ * @since 29.0.0
+ */
+class AppConfigIncorrectTypeException extends AppConfigException {
+}
--- /dev/null
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright 2023 Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @author Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @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 OCP\Exceptions;
+
+/**
+ * @since 29.0.0
+ */
+class AppConfigTypeConflictException extends AppConfigException {
+}
--- /dev/null
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright 2023 Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @author Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @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 OCP\Exceptions;
+
+/**
+ * @since 29.0.0
+ */
+class AppConfigUnknownKeyException extends AppConfigException {
+}
<?php
+
+declare(strict_types=1);
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Bart Visscher <bartv@thisnet.nl>
* @author Joas Schilling <coding@schilljs.com>
+ * @author Maxence Lange <maxence@artificial-owl.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <robin@icewind.nl>
* @author Robin McCorkell <robin@mccorkell.me.uk>
*/
namespace OCP;
+use OCP\Exceptions\AppConfigUnknownKeyException;
+
/**
* This class provides an easy way for apps to store config values in the
* database.
+ *
+ * **Note:** since 29.0.0, it supports **lazy loading**
+ *
+ * ### What is lazy loading ?
+ *
+ * By default, app config values are all loaded in memory; but in order to avoid
+ * loading useless config values in memory on each request on the cloud, it has
+ * been made possible to set your config keys as lazy.
+ * When set as lazy, the values will only be loaded in memory when needed.
+ * In fact, the cloud will load all config set as lazy loaded when a first one
+ * is requested.
+ *
+ * It is advised to set a config key as lazy when its value is only needed during
+ * really specific request, in part of code that is not called frequently.
+ *
+ * **Note:** some methods from this class are marked with a warning about ignoring
+ * lazy filtering, meaning it will load in memory all apps config values. use them
+ * wisely and only in part of code called during specific request/action.
+ *
+ * @since 29.0.0 supports lazy loading
* @since 7.0.0
*/
interface IAppConfig {
+ public const VALUE_SENSITIVE = 1;
+ public const VALUE_MIXED = 2;
+ public const VALUE_STRING = 4;
+ public const VALUE_INT = 8;
+ public const VALUE_FLOAT = 16;
+ public const VALUE_BOOL = 32;
+ public const VALUE_ARRAY = 64;
+
/**
- * check if a key is set in the appconfig
- * @param string $app
- * @param string $key
- * @return bool
+ * Get list of all apps that have at least one config value stored in database
+ *
+ * **WARNING:** ignore lazy filtering, all config values are loaded from database
+ *
+ * @return string[] list of app ids
+ * @since 7.0.0
+ */
+ public function getApps(): array;
+
+ /**
+ * Returns all keys stored in database, related to an app.
+ * Please note that the values are not returned.
+ *
+ * **WARNING:** ignore lazy filtering, all config values are loaded from database
+ *
+ * @param string $app id of the app
+ *
+ * @return string[] list of stored config keys
+ * @since 29.0.0
+ */
+ public function getKeys(string $app): array;
+
+ /**
+ * Check if a key exists in the list of stored config values.
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return bool TRUE if key exists
+ * @since 29.0.0 Added the $lazy argument
* @since 7.0.0
*/
- public function hasKey($app, $key);
+ public function hasKey(string $app, string $key, ?bool $lazy = false): bool;
+
+ /**
+ * best way to see if a value is set as sensitive (not displayed in report)
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param bool|null $lazy search within lazy loaded config
+ *
+ * @return bool TRUE if value is sensitive
+ * @throws AppConfigUnknownKeyException if config key is not known
+ * @since 29.0.0
+ */
+ public function isSensitive(string $app, string $key, ?bool $lazy = false): bool;
+
+ /**
+ * Returns if the config key stored in database is lazy loaded
+ *
+ * **WARNING:** ignore lazy filtering, all config values are loaded from database
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ *
+ * @return bool TRUE if config is lazy loaded
+ * @throws AppConfigUnknownKeyException if config key is not known
+ * @see IAppConfig for details about lazy loading
+ * @since 29.0.0
+ */
+ public function isLazy(string $app, string $key): bool;
+
+ /**
+ * List all config values from an app with config key starting with $key.
+ * Returns an array with config key as key, stored value as value.
+ *
+ * **WARNING:** ignore lazy filtering, all config values are loaded from database
+ *
+ * @param string $app id of the app
+ * @param string $key config keys prefix to search, can be empty.
+ * @param bool $filtered filter sensitive config values
+ *
+ * @return array<string, string> [configKey => configValue]
+ * @since 29.0.0
+ */
+ public function getAllValues(string $app, string $key = '', bool $filtered = false): array;
+
+ /**
+ * List all apps storing a specific config key and its stored value.
+ * Returns an array with appId as key, stored value as value.
+ *
+ * @param string $key config key
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return array<string, string> [appId => configValue]
+ * @since 29.0.0
+ */
+ public function searchValues(string $key, bool $lazy = false): array;
+
+ /**
+ * Get config value assigned to a config key.
+ * If config key is not found in database, default value is returned.
+ * If config key is set as lazy loaded, the $lazy argument needs to be set to TRUE.
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param string $default default value
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return string stored config value or $default if not set in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see getValueInt()
+ * @see getValueBigInt()
+ * @see getValueFloat()
+ * @see getValueBool()
+ * @see getValueArray()
+ */
+ public function getValueString(string $app, string $key, string $default = '', bool $lazy = false): string;
+
+ /**
+ * Get config value assigned to a config key.
+ * If config key is not found in database, default value is returned.
+ * If config key is set as lazy loaded, the $lazy argument needs to be set to TRUE.
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param int $default default value
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return int stored config value or $default if not set in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see getValueString()
+ * @see getValueBigInt()
+ * @see getValueFloat()
+ * @see getValueBool()
+ * @see getValueArray()
+ */
+ public function getValueInt(string $app, string $key, int $default = 0, bool $lazy = false): int;
+
+ /**
+ * Get config value assigned to a config key.
+ * If config key is not found in database, default value is returned.
+ * If config key is set as lazy loaded, the $lazy argument needs to be set to TRUE.
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param int|float $default default value
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return int|float stored config value or $default if not set in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see getValueString()
+ * @see getValueInt()
+ * @see getValueFloat()
+ * @see getValueBool()
+ * @see getValueArray()
+ */
+ public function getValueBigInt(string $app, string $key, int|float $default = 0, bool $lazy = false): int|float;
+
+ /**
+ * Get config value assigned to a config key.
+ * If config key is not found in database, default value is returned.
+ * If config key is set as lazy loaded, the $lazy argument needs to be set to TRUE.
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param float $default default value
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return float stored config value or $default if not set in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see getValueString()
+ * @see getValueInt()
+ * @see getValueBigInt()
+ * @see getValueBool()
+ * @see getValueArray()
+ */
+ public function getValueFloat(string $app, string $key, float $default = 0, bool $lazy = false): float;
+
+ /**
+ * Get config value assigned to a config key.
+ * If config key is not found in database, default value is returned.
+ * If config key is set as lazy loaded, the $lazy argument needs to be set to TRUE.
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param bool $default default value
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return bool stored config value or $default if not set in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see getValueString()
+ * @see getValueInt()
+ * @see getValueBigInt()
+ * @see getValueFloat()
+ * @see getValueArray()
+ */
+ public function getValueBool(string $app, string $key, bool $default = false, bool $lazy = false): bool;
+
+ /**
+ * Get config value assigned to a config key.
+ * If config key is not found in database, default value is returned.
+ * If config key is set as lazy loaded, the $lazy argument needs to be set to TRUE.
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param array $default default value
+ * @param bool $lazy search within lazy loaded config
+ *
+ * @return array stored config value or $default if not set in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy loading
+ * @see getValueString()
+ * @see getValueInt()
+ * @see getValueBigInt()
+ * @see getValueFloat()
+ * @see getValueBool()
+ */
+ public function getValueArray(string $app, string $key, array $default = [], bool $lazy = false): array;
+
+ /**
+ * returns the type of config value
+ *
+ * **WARNING:** ignore lazy filtering, all config values are loaded from database
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ *
+ * @return int
+ * @throws AppConfigUnknownKeyException
+ * @since 29.0.0
+ * @see VALUE_STRING
+ * @see VALUE_INT
+ * @see VALUE_FLOAT
+ * @see VALUE_BOOL
+ * @see VALUE_ARRAY
+ */
+ public function getValueType(string $app, string $key): int;
+
+ /**
+ * Store a config key and its value in database
+ *
+ * If config key is already known with the exact same config value, the database is not updated.
+ * If config key is not supposed to be read during the boot of the cloud, it is advised to set it as lazy loaded.
+ *
+ * If config value was previously stored as sensitive or lazy loaded, status cannot be altered without using {@see deleteKey()} first
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param string $value config value
+ * @param bool $sensitive if TRUE value will be hidden when listing config values.
+ * @param bool $lazy set config as lazy loaded
+ *
+ * @return bool TRUE if value was different, therefor updated in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy grouping
+ * @see setValueInt()
+ * @see setValueBigInt()
+ * @see setValueFloat()
+ * @see setValueBool()
+ * @see setValueArray()
+ */
+ public function setValueString(string $app, string $key, string $value, bool $lazy = false, bool $sensitive = false): bool;
+
+ /**
+ * Store a config key and its value in database
+ *
+ * If config key is already known with the exact same config value, the database is not updated.
+ * If config key is not supposed to be read during the boot of the cloud, it is advised to set it as lazy loaded.
+ *
+ * If config value was previously stored as sensitive or lazy loaded, status cannot be altered without using {@see deleteKey()} first
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param int $value config value
+ * @param bool $sensitive if TRUE value will be hidden when listing config values.
+ * @param bool $lazy set config as lazy loaded
+ *
+ * @return bool TRUE if value was different, therefor updated in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy grouping
+ * @see setValueString()
+ * @see setValueBigInt()
+ * @see setValueFloat()
+ * @see setValueBool()
+ * @see setValueArray()
+ */
+ public function setValueInt(string $app, string $key, int $value, bool $lazy = false, bool $sensitive = false): bool;
+
+
+ /**
+ * Store a config key and its value in database
+ *
+ * If config key is already known with the exact same config value, the database is not updated.
+ * If config key is not supposed to be read during the boot of the cloud, it is advised to set it as lazy loaded.
+ *
+ * If config value was previously stored as sensitive or lazy loaded, status cannot be altered without using {@see deleteKey()} first
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param int|float $value config value
+ * @param bool $sensitive if TRUE value will be hidden when listing config values.
+ * @param bool $lazy set config as lazy loaded
+ *
+ * @return bool TRUE if value was different, therefor updated in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy grouping
+ * @see setValueString()
+ * @see setValueBigInt()
+ * @see setValueFloat()
+ * @see setValueBool()
+ * @see setValueArray()
+ */
+ public function setValueBigInt(string $app, string $key, int|float $value, bool $lazy = false, bool $sensitive = false): bool;
+
+ /**
+ * Store a config key and its value in database
+ *
+ * If config key is already known with the exact same config value, the database is not updated.
+ * If config key is not supposed to be read during the boot of the cloud, it is advised to set it as lazy loaded.
+ *
+ * If config value was previously stored as sensitive or lazy loaded, status cannot be altered without using {@see deleteKey()} first
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param float $value config value
+ * @param bool $sensitive if TRUE value will be hidden when listing config values.
+ * @param bool $lazy set config as lazy loaded
+ *
+ * @return bool TRUE if value was different, therefor updated in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy grouping
+ * @see setValueString()
+ * @see setValueInt()
+ * @see setValueBigInt()
+ * @see setValueBool()
+ * @see setValueArray()
+ */
+ public function setValueFloat(string $app, string $key, float $value, bool $lazy = false, bool $sensitive = false): bool;
+
+ /**
+ * Store a config key and its value in database
+ *
+ * If config key is already known with the exact same config value, the database is not updated.
+ * If config key is not supposed to be read during the boot of the cloud, it is advised to set it as lazy loaded.
+ *
+ * If config value was previously stored as lazy loaded, status cannot be altered without using {@see deleteKey()} first
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param bool $value config value
+ * @param bool $lazy set config as lazy loaded
+ *
+ * @return bool TRUE if value was different, therefor updated in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy grouping
+ * @see setValueString()
+ * @see setValueInt()
+ * @see setValueBigInt()
+ * @see setValueFloat()
+ * @see setValueArray()
+ */
+ public function setValueBool(string $app, string $key, bool $value, bool $lazy = false): bool;
+
+ /**
+ * Store a config key and its value in database
+ *
+ * If config key is already known with the exact same config value, the database is not updated.
+ * If config key is not supposed to be read during the boot of the cloud, it is advised to set it as lazy loaded.
+ *
+ * If config value was previously stored as sensitive or lazy loaded, status cannot be altered without using {@see deleteKey()} first
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param array $value config value
+ * @param bool $sensitive if TRUE value will be hidden when listing config values.
+ * @param bool $lazy set config as lazy loaded
+ *
+ * @return bool TRUE if value was different, therefor updated in database
+ * @since 29.0.0
+ * @see IAppConfig for explanation about lazy grouping
+ * @see setValueString()
+ * @see setValueInt()
+ * @see setValueBigInt()
+ * @see setValueFloat()
+ * @see setValueBool()
+ */
+ public function setValueArray(string $app, string $key, array $value, bool $lazy = false, bool $sensitive = false): bool;
+
+ /**
+ * switch sensitive status of a config value
+ *
+ * **WARNING:** ignore lazy filtering, all config values are loaded from database
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param bool $sensitive TRUE to set as sensitive, FALSE to unset
+ *
+ * @return bool TRUE if database update were necessary
+ * @since 29.0.0
+ */
+ public function updateSensitive(string $app, string $key, bool $sensitive): bool;
+
+ /**
+ * switch lazy loading status of a config value
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @param bool $lazy TRUE to set as lazy loaded, FALSE to unset
+ *
+ * @return bool TRUE if database update was necessary
+ * @since 29.0.0
+ */
+ public function updateLazy(string $app, string $key, bool $lazy): bool;
+
+ /**
+ * returns an array contains details about a config value
+ *
+ * ```
+ * [
+ * "app" => "myapp",
+ * "key" => "mykey",
+ * "value" => "its_value",
+ * "lazy" => false,
+ * "type" => 4,
+ * "typeString" => "string",
+ * 'sensitive' => true
+ * ]
+ * ```
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ *
+ * @return array
+ * @throws AppConfigUnknownKeyException if config key is not known in database
+ * @since 29.0.0
+ */
+ public function getDetails(string $app, string $key): array;
+
+ /**
+ * Convert string like 'string', 'integer', 'float', 'bool' or 'array' to
+ * to bitflag {@see VALUE_STRING}, {@see VALUE_INT}, {@see VALUE_FLOAT},
+ * {@see VALUE_BOOL} and {@see VALUE_ARRAY}
+ *
+ * @param string $type
+ *
+ * @return int
+ * @since 29.0.0
+ */
+ public function convertTypeToInt(string $type): int;
+
+ /**
+ * Convert bitflag {@see VALUE_STRING}, {@see VALUE_INT}, {@see VALUE_FLOAT},
+ * {@see VALUE_BOOL} and {@see VALUE_ARRAY} to human-readable string
+ *
+ * @param int $type
+ *
+ * @return string
+ * @since 29.0.0
+ */
+ public function convertTypeToString(int $type): string;
+
+ /**
+ * Delete single config key from database.
+ *
+ * @param string $app id of the app
+ * @param string $key config key
+ * @since 29.0.0
+ */
+ public function deleteKey(string $app, string $key): void;
+
+ /**
+ * delete all config keys linked to an app
+ *
+ * @param string $app id of the app
+ * @since 29.0.0
+ */
+ public function deleteApp(string $app): void;
+
+ /**
+ * Clear the cache.
+ *
+ * The cache will be rebuilt only the next time a config value is requested.
+ *
+ * @param bool $reload set to TRUE to refill cache instantly after clearing it
+ * @since 29.0.0
+ */
+ public function clearCache(bool $reload = false): void;
/**
* get multiply values, either the app or key can be used as wildcard by setting it to false
*
* @param string|false $key
* @param string|false $app
+ *
* @return array|false
* @since 7.0.0
+ * @deprecated 29.0.0 Use {@see getAllValues()} or {@see searchValues()}
*/
public function getValues($app, $key);
* get all values of the app or and filters out sensitive data
*
* @param string $app
+ *
* @return array
* @since 12.0.0
+ * @deprecated 29.0.0 Use {@see getAllValues()} or {@see searchValues()}
*/
public function getFilteredValues($app);
-
- /**
- * Get all apps using the config
- * @return string[] an array of app ids
- *
- * This function returns a list of all apps that have at least one
- * entry in the appconfig table.
- * @since 7.0.0
- */
- public function getApps();
}
* @param string $appName the appName that we stored the value under
* @return string[] the keys stored for the app
* @since 8.0.0
+ * @deprecated 29.0.0 Use {@see IAppConfig} directly
*/
public function getAppKeys($appName);
* @param string $value the value that should be stored
* @return void
* @since 6.0.0
+ * @deprecated 29.0.0 Use {@see IAppConfig} directly
*/
public function setAppValue($appName, $key, $value);
* @param string $appName the appName that we stored the value under
* @param string $key the key of the value, under which it was saved
* @param string $default the default value to be returned if the value isn't set
+ *
* @return string the saved value
* @since 6.0.0 - parameter $default was added in 7.0.0
+ * @deprecated 29.0.0 Use {@see IAppConfig} directly
*/
public function getAppValue($appName, $key, $default = '');
* @param string $appName the appName that we stored the value under
* @param string $key the key of the value, under which it was saved
* @since 8.0.0
+ * @deprecated 29.0.0 Use {@see IAppConfig} directly
*/
public function deleteAppValue($appName, $key);
*
* @param string $appName the appName the configs are stored under
* @since 8.0.0
+ * @deprecated 29.0.0 Use {@see IAppConfig} directly
*/
public function deleteAppValues($appName);
namespace Tests\Core\Command\Config\App;
+use OC\AppConfig;
use OC\Core\Command\Config\App\GetConfig;
-use OCP\IConfig;
+use OCP\Exceptions\AppConfigUnknownKeyException;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Test\TestCase;
protected function setUp(): void {
parent::setUp();
- $config = $this->config = $this->getMockBuilder(IConfig::class)
+ $config = $this->config = $this->getMockBuilder(AppConfig::class)
->disableOriginalConstructor()
->getMock();
$this->consoleInput = $this->getMockBuilder(InputInterface::class)->getMock();
$this->consoleOutput = $this->getMockBuilder(OutputInterface::class)->getMock();
- /** @var \OCP\IConfig $config */
+ /** @var \OCP\IAppConfig $config */
$this->command = new GetConfig($config);
}
* @param string $expectedMessage
*/
public function testGet($configName, $value, $configExists, $defaultValue, $hasDefault, $outputFormat, $expectedReturn, $expectedMessage) {
- $this->config->expects($this->atLeastOnce())
- ->method('getAppKeys')
- ->with('app-name')
- ->willReturn($configExists ? [$configName] : []);
-
if (!$expectedReturn) {
if ($configExists) {
$this->config->expects($this->once())
- ->method('getAppValue')
+ ->method('getDetails')
->with('app-name', $configName)
- ->willReturn($value);
+ ->willReturn(['value' => $value]);
}
}
+ if (!$configExists) {
+ $this->config->expects($this->once())
+ ->method('getDetails')
+ ->with('app-name', $configName)
+ ->willThrowException(new AppConfigUnknownKeyException());
+ }
+
$this->consoleInput->expects($this->exactly(2))
->method('getArgument')
->willReturnMap([
namespace Tests\Core\Command\Config\App;
+use OC\AppConfig;
use OC\Core\Command\Config\App\SetConfig;
-use OCP\IConfig;
+use OCP\Exceptions\AppConfigUnknownKeyException;
+use OCP\IAppConfig;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Test\TestCase;
protected function setUp(): void {
parent::setUp();
- $config = $this->config = $this->getMockBuilder(IConfig::class)
+ $config = $this->config = $this->getMockBuilder(AppConfig::class)
->disableOriginalConstructor()
->getMock();
$this->consoleInput = $this->getMockBuilder(InputInterface::class)->getMock();
$this->consoleOutput = $this->getMockBuilder(OutputInterface::class)->getMock();
- /** @var \OCP\IConfig $config */
+ /** @var \OCP\IAppConfig $config */
$this->command = new SetConfig($config);
}
* @param string $expectedMessage
*/
public function testSet($configName, $newValue, $configExists, $updateOnly, $updated, $expectedMessage) {
- $this->config->expects($this->once())
- ->method('getAppKeys')
- ->with('app-name')
- ->willReturn($configExists ? [$configName] : []);
+ $this->config->expects($this->any())
+ ->method('hasKey')
+ ->with('app-name', $configName)
+ ->willReturn($configExists);
+
+ if (!$configExists) {
+ $this->config->expects($this->any())
+ ->method('getValueType')
+ ->willThrowException(new AppConfigUnknownKeyException());
+ } else {
+ $this->config->expects($this->any())
+ ->method('getValueType')
+ ->willReturn(IAppConfig::VALUE_MIXED);
+ }
if ($updated) {
$this->config->expects($this->once())
- ->method('setAppValue')
+ ->method('setValueMixed')
->with('app-name', $configName, $newValue);
}
]);
$this->consoleInput->expects($this->any())
->method('getOption')
- ->with('value')
- ->willReturn($newValue);
+ ->willReturnMap([
+ ['value', $newValue],
+ ['lazy', null],
+ ['sensitive', null],
+ ['no-interaction', true],
+ ]);
$this->consoleInput->expects($this->any())
->method('hasParameterOption')
- ->with('--update-only')
- ->willReturn($updateOnly);
-
+ ->willReturnMap([
+ ['--type', false, false],
+ ['--value', false, true],
+ ['--update-only', false, $updateOnly]
+ ]);
$this->consoleOutput->expects($this->any())
->method('writeln')
->with($this->stringContains($expectedMessage));
namespace Test;
use OC\AppConfig;
-use OC\DB\Connection;
use OCP\IConfig;
+use OCP\IDBConnection;
+use Psr\Log\LoggerInterface;
/**
* Class AppConfigTest
/** @var \OCP\IAppConfig */
protected $appConfig;
- /** @var Connection */
- protected $connection;
+ protected IDBConnection $connection;
+ private LoggerInterface $logger;
protected $originalConfig;
protected function setUp(): void {
parent::setUp();
- $this->connection = \OC::$server->get(Connection::class);
+ $this->connection = \OC::$server->get(IDBConnection::class);
+ $this->logger = \OC::$server->get(LoggerInterface::class);
+
$sql = $this->connection->getQueryBuilder();
$sql->select('*')
->from('appconfig');
$sql->delete('appconfig');
$sql->execute();
- $this->overwriteService(AppConfig::class, new \OC\AppConfig($this->connection));
+ $this->overwriteService(AppConfig::class, new \OC\AppConfig($this->connection, $this->logger));
$sql = $this->connection->getQueryBuilder();
$sql->insert('appconfig')
->values([
'appid' => $sql->createParameter('appid'),
'configkey' => $sql->createParameter('configkey'),
- 'configvalue' => $sql->createParameter('configvalue'),
+ 'configvalue' => $sql->createParameter('configvalue')
]);
$sql->setParameters([
'appid' => 'testapp',
'configkey' => 'enabled',
- 'configvalue' => 'true',
+ 'configvalue' => 'true'
])->execute();
$sql->setParameters([
'appid' => 'testapp',
'appid' => $sql->createParameter('appid'),
'configkey' => $sql->createParameter('configkey'),
'configvalue' => $sql->createParameter('configvalue'),
+ 'lazy' => $sql->createParameter('lazy'),
+ 'type' => $sql->createParameter('type'),
]);
foreach ($this->originalConfig as $configs) {
$sql->setParameter('appid', $configs['appid'])
->setParameter('configkey', $configs['configkey'])
- ->setParameter('configvalue', $configs['configvalue']);
+ ->setParameter('configvalue', $configs['configvalue'])
+ ->setParameter('lazy', ($configs['lazy'] === '1') ? '1' : '0')
+ ->setParameter('type', $configs['type']);
$sql->execute();
}
}
public function testGetApps() {
- $config = new \OC\AppConfig(\OC::$server->get(Connection::class));
+ $config = new \OC\AppConfig(\OC::$server->get(IDBConnection::class), \OC::$server->get(LoggerInterface::class));
$this->assertEqualsCanonicalizing([
'anotherapp',
}
public function testGetKeys() {
- $config = new \OC\AppConfig(\OC::$server->get(Connection::class));
+ $config = new \OC\AppConfig(\OC::$server->get(IDBConnection::class), \OC::$server->get(LoggerInterface::class));
$keys = $config->getKeys('testapp');
$this->assertEqualsCanonicalizing([
}
public function testGetValue() {
- $config = new \OC\AppConfig(\OC::$server->get(Connection::class));
+ $config = new \OC\AppConfig(\OC::$server->get(IDBConnection::class), \OC::$server->get(LoggerInterface::class));
$value = $config->getValue('testapp', 'installed_version');
$this->assertConfigKey('testapp', 'installed_version', $value);
}
public function testHasKey() {
- $config = new \OC\AppConfig(\OC::$server->get(Connection::class));
+ $config = new \OC\AppConfig(\OC::$server->get(IDBConnection::class), \OC::$server->get(LoggerInterface::class));
$this->assertTrue($config->hasKey('testapp', 'installed_version'));
$this->assertFalse($config->hasKey('testapp', 'nonexistant'));
}
public function testSetValueUpdate() {
- $config = new \OC\AppConfig(\OC::$server->get(Connection::class));
+ $config = new \OC\AppConfig(\OC::$server->get(IDBConnection::class), \OC::$server->get(LoggerInterface::class));
$this->assertEquals('1.2.3', $config->getValue('testapp', 'installed_version'));
$this->assertConfigKey('testapp', 'installed_version', '1.2.3');
$wasModified = $config->setValue('testapp', 'installed_version', '1.2.3');
- if (!(\OC::$server->get(Connection::class) instanceof \OC\DB\OracleConnection)) {
+ if (!(\OC::$server->get(IDBConnection::class) instanceof \OC\DB\OracleConnection)) {
$this->assertFalse($wasModified);
}
}
public function testSetValueInsert() {
- $config = new \OC\AppConfig(\OC::$server->get(Connection::class));
+ $config = new \OC\AppConfig(\OC::$server->get(IDBConnection::class), \OC::$server->get(LoggerInterface::class));
$this->assertFalse($config->hasKey('someapp', 'somekey'));
$this->assertNull($config->getValue('someapp', 'somekey'));
$this->assertConfigKey('someapp', 'somekey', 'somevalue');
$wasInserted = $config->setValue('someapp', 'somekey', 'somevalue');
- if (!(\OC::$server->get(Connection::class) instanceof \OC\DB\OracleConnection)) {
+ if (!(\OC::$server->get(IDBConnection::class) instanceof \OC\DB\OracleConnection)) {
$this->assertFalse($wasInserted);
}
}
public function testDeleteKey() {
- $config = new \OC\AppConfig(\OC::$server->get(Connection::class));
+ $config = new \OC\AppConfig(\OC::$server->get(IDBConnection::class), \OC::$server->get(LoggerInterface::class));
$this->assertTrue($config->hasKey('testapp', 'deletethis'));
}
public function testDeleteApp() {
- $config = new \OC\AppConfig(\OC::$server->get(Connection::class));
+ $config = new \OC\AppConfig(\OC::$server->get(IDBConnection::class), \OC::$server->get(LoggerInterface::class));
$this->assertTrue($config->hasKey('someapp', 'otherkey'));
}
public function testGetValuesNotAllowed() {
- $config = new \OC\AppConfig(\OC::$server->get(Connection::class));
+ $config = new \OC\AppConfig(\OC::$server->get(IDBConnection::class), \OC::$server->get(LoggerInterface::class));
$this->assertFalse($config->getValues('testapp', 'enabled'));
}
public function testGetValues() {
- $config = new \OC\AppConfig(\OC::$server->get(Connection::class));
+ $config = new \OC\AppConfig(\OC::$server->get(IDBConnection::class), \OC::$server->get(LoggerInterface::class));
$sql = \OC::$server->getDatabaseConnection()->getQueryBuilder();
$sql->select(['configkey', 'configvalue'])
}
public function testGetFilteredValues() {
- /** @var \OC\AppConfig|\PHPUnit\Framework\MockObject\MockObject $config */
- $config = $this->getMockBuilder(\OC\AppConfig::class)
- ->setConstructorArgs([\OC::$server->get(Connection::class)])
- ->setMethods(['getValues'])
- ->getMock();
-
- $config->expects($this->once())
- ->method('getValues')
- ->with('user_ldap', false)
- ->willReturn([
- 'ldap_agent_password' => 'secret',
- 's42ldap_agent_password' => 'secret',
- 'ldap_dn' => 'dn',
- ]);
+ $config = new \OC\AppConfig(\OC::$server->get(IDBConnection::class), \OC::$server->get(LoggerInterface::class));
+ $config->setValue('user_ldap', 'ldap_agent_password', 'secret');
+ $config->setValue('user_ldap', 's42ldap_agent_password', 'secret');
+ $config->setValue('user_ldap', 'ldap_dn', 'dn');
$values = $config->getFilteredValues('user_ldap');
$this->assertEquals([
}
public function testSettingConfigParallel() {
- $appConfig1 = new \OC\AppConfig(\OC::$server->get(Connection::class));
- $appConfig2 = new \OC\AppConfig(\OC::$server->get(Connection::class));
+ $appConfig1 = new \OC\AppConfig(\OC::$server->get(IDBConnection::class), \OC::$server->get(LoggerInterface::class));
+ $appConfig2 = new \OC\AppConfig(\OC::$server->get(IDBConnection::class), \OC::$server->get(LoggerInterface::class));
$appConfig1->getValue('testapp', 'foo', 'v1');
$appConfig2->getValue('testapp', 'foo', 'v1');
if ($real) {
$this->addDummyData();
$query->where($query->expr()->eq('appid', $query->createNamedParameter('group_concat')));
+ $query->orderBy('configkey', 'asc');
}
$query->select($query->func()->concat(...$arguments));
projects / nextcloud-server.git / commitdiff