aboutsummaryrefslogtreecommitdiffstats
path: root/core/Command/Config/App
diff options
context:
space:
mode:
Diffstat (limited to 'core/Command/Config/App')
-rw-r--r--core/Command/Config/App/Base.php37
-rw-r--r--core/Command/Config/App/DeleteConfig.php38
-rw-r--r--core/Command/Config/App/GetConfig.php69
-rw-r--r--core/Command/Config/App/SetConfig.php216
4 files changed, 243 insertions, 117 deletions
diff --git a/core/Command/Config/App/Base.php b/core/Command/Config/App/Base.php
index b40f7c9e48d..e90a8e78f5b 100644
--- a/core/Command/Config/App/Base.php
+++ b/core/Command/Config/App/Base.php
@@ -1,32 +1,23 @@
<?php
+
+declare(strict_types=1);
/**
- * @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com>
- *
- * @author Joas Schilling <coding@schilljs.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/>.
- *
+ * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\Core\Command\Config\App;
-use OCP\IConfig;
+use OC\Config\ConfigManager;
+use OCP\IAppConfig;
use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
abstract class Base extends \OC\Core\Command\Base {
- protected IConfig $config;
+ public function __construct(
+ protected IAppConfig $appConfig,
+ protected readonly ConfigManager $configManager,
+ ) {
+ parent::__construct();
+ }
/**
* @param string $argumentName
@@ -35,12 +26,12 @@ abstract class Base extends \OC\Core\Command\Base {
*/
public function completeArgumentValues($argumentName, CompletionContext $context) {
if ($argumentName === 'app') {
- return \OC_App::getAllApps();
+ return $this->appConfig->getApps();
}
if ($argumentName === 'name') {
$appName = $context->getWordAtIndex($context->getWordIndex() - 1);
- return $this->config->getAppKeys($appName);
+ return $this->appConfig->getKeys($appName);
}
return [];
}
diff --git a/core/Command/Config/App/DeleteConfig.php b/core/Command/Config/App/DeleteConfig.php
index 0da1e965bd0..5a08ecbdc42 100644
--- a/core/Command/Config/App/DeleteConfig.php
+++ b/core/Command/Config/App/DeleteConfig.php
@@ -1,43 +1,19 @@
<?php
+
+declare(strict_types=1);
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Joas Schilling <coding@schilljs.com>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * 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, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OC\Core\Command\Config\App;
-use OCP\IConfig;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
class DeleteConfig extends Base {
- protected IConfig $config;
-
- /**
- * @param IConfig $config
- */
- public function __construct(IConfig $config) {
- parent::__construct();
- $this->config = $config;
- }
-
protected function configure() {
parent::configure();
@@ -67,12 +43,12 @@ class DeleteConfig extends Base {
$appName = $input->getArgument('app');
$configName = $input->getArgument('name');
- if ($input->hasParameterOption('--error-if-not-exists') && !in_array($configName, $this->config->getAppKeys($appName))) {
+ if ($input->hasParameterOption('--error-if-not-exists') && !in_array($configName, $this->appConfig->getKeys($appName), true)) {
$output->writeln('<error>Config ' . $configName . ' of app ' . $appName . ' could not be deleted because it did not exist</error>');
return 1;
}
- $this->config->deleteAppValue($appName, $configName);
+ $this->appConfig->deleteKey($appName, $configName);
$output->writeln('<info>Config value ' . $configName . ' of app ' . $appName . ' deleted</info>');
return 0;
}
diff --git a/core/Command/Config/App/GetConfig.php b/core/Command/Config/App/GetConfig.php
index 7fdff2be732..af0c5648232 100644
--- a/core/Command/Config/App/GetConfig.php
+++ b/core/Command/Config/App/GetConfig.php
@@ -1,40 +1,20 @@
<?php
+
+declare(strict_types=1);
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Joas Schilling <coding@schilljs.com>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * 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, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OC\Core\Command\Config\App;
-use OCP\IConfig;
+use OCP\Exceptions\AppConfigUnknownKeyException;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
class GetConfig extends Base {
- protected IConfig $config;
-
- public function __construct(IConfig $config) {
- parent::__construct();
- $this->config = $config;
- }
-
protected function configure() {
parent::configure();
@@ -52,6 +32,18 @@ class GetConfig extends Base {
'Name of the config to get'
)
->addOption(
+ 'details',
+ null,
+ InputOption::VALUE_NONE,
+ 'returns complete details about the app config value'
+ )
+ ->addOption(
+ '--key-details',
+ null,
+ InputOption::VALUE_NONE,
+ 'returns complete details about the app config key'
+ )
+ ->addOption(
'default-value',
null,
InputOption::VALUE_OPTIONAL,
@@ -63,7 +55,7 @@ class GetConfig extends Base {
/**
* Executes the current command.
*
- * @param InputInterface $input An InputInterface instance
+ * @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
* @return int 0 if everything went fine, or an error code
*/
@@ -72,14 +64,27 @@ class GetConfig extends Base {
$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);
+ $details['type'] = $details['typeString'];
+ unset($details['typeString']);
+ $this->writeArrayInOutputFormat($input, $output, $details);
+ return 0;
+ }
+
+ if ($input->getOption('key-details')) {
+ $details = $this->appConfig->getKeyDetails($appName, $configName);
+ $this->writeArrayInOutputFormat($input, $output, $details);
+ 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);
diff --git a/core/Command/Config/App/SetConfig.php b/core/Command/Config/App/SetConfig.php
index 89a5f6ba5d1..c818404fc0e 100644
--- a/core/Command/Config/App/SetConfig.php
+++ b/core/Command/Config/App/SetConfig.php
@@ -1,40 +1,24 @@
<?php
+
+declare(strict_types=1);
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Joas Schilling <coding@schilljs.com>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * 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, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OC\Core\Command\Config\App;
-use OCP\IConfig;
+use OC\AppConfig;
+use OCP\Exceptions\AppConfigUnknownKeyException;
+use OCP\IAppConfig;
+use Symfony\Component\Console\Helper\QuestionHelper;
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 {
- protected IConfig $config;
-
- public function __construct(IConfig $config) {
- parent::__construct();
- $this->config = $config;
- }
-
protected function configure() {
parent::configure();
@@ -58,6 +42,25 @@ class SetConfig extends Base {
'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,
InputOption::VALUE_NONE,
@@ -70,15 +73,166 @@ class SetConfig extends Base {
$appName = $input->getArgument('app');
$configName = $input->getArgument('name');
- 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>');
+ 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>'
+ );
+
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($input, $output, 'NOT LAZY')) {
+ $updated = $this->appConfig->updateLazy($appName, $configName, false);
+ }
+ if ($input->getOption('lazy') && !$this->appConfig->isLazy($appName, $configName) && $this->ask($input, $output, 'LAZY')) {
+ $updated = $this->appConfig->updateLazy($appName, $configName, true) || $updated;
+ }
+ if (!$input->getOption('sensitive') && $this->appConfig->isSensitive($appName, $configName) && $this->ask($input, $output, 'NOT SENSITIVE')) {
+ $updated = $this->appConfig->updateSensitive($appName, $configName, false) || $updated;
+ }
+ if ($input->getOption('sensitive') && !$this->appConfig->isSensitive($appName, $configName) && $this->ask($input, $output, 'SENSITIVE')) {
+ $updated = $this->appConfig->updateSensitive($appName, $configName, true) || $updated;
+ }
+ if ($type !== null && $type !== $this->appConfig->getValueType($appName, $configName) && $typeString !== null && $this->ask($input, $output, $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 || $typeString === null || $type === $currType || !$this->ask($input, $output, $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($input, $output, ($lazy) ? 'LAZY' : 'NOT LAZY')) {
+ $lazy = $currLazy;
+ }
+ } catch (AppConfigUnknownKeyException) {
+ $lazy = $lazy ?? false;
+ }
+
+ /**
+ * same with sensitive status
+ */
+ $sensitive = $input->getOption('sensitive');
+ try {
+ $currSensitive = $this->appConfig->isSensitive($appName, $configName, null);
+ if ($sensitive === null || $sensitive === $currSensitive || !$this->ask($input, $output, ($sensitive) ? 'SENSITIVE' : 'NOT SENSITIVE')) {
+ $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:
+ $updated = $this->appConfig->setValueInt($appName, $configName, $this->configManager->convertToInt($value), $lazy, $sensitive);
+ break;
+
+ case IAppConfig::VALUE_FLOAT:
+ $updated = $this->appConfig->setValueFloat($appName, $configName, $this->configManager->convertToFloat($value), $lazy, $sensitive);
+ break;
+
+ case IAppConfig::VALUE_BOOL:
+ $updated = $this->appConfig->setValueBool($appName, $configName, $this->configManager->convertToBool($value), $lazy);
+ break;
+
+ case IAppConfig::VALUE_ARRAY:
+ $updated = $this->appConfig->setValueArray($appName, $configName, $this->configManager->convertToArray($value), $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['sensitive'] ? '<sensitive>' : $current['value'],
+ $current['typeString'],
+ $current['lazy'] ? 'lazy cache' : 'fast cache'
+ )
+ );
+ $keyDetails = $this->appConfig->getKeyDetails($appName, $configName);
+ if (($keyDetails['note'] ?? '') !== '') {
+ $output->writeln('<comment>Note:</comment> ' . $keyDetails['note']);
+ }
+
+ } 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(InputInterface $input, OutputInterface $output, string $request): bool {
+ /** @var QuestionHelper $helper */
+ $helper = $this->getHelper('question');
+ if ($input->getOption('no-interaction')) {
+ return true;
+ }
+
+ $output->writeln(sprintf('You are about to set config value %s as <info>%s</info>',
+ '<info>' . $input->getArgument('app') . '</info>/<info>' . $input->getArgument('name') . '</info>',
+ strtoupper($request)
+ ));
+ $output->writeln('');
+ $output->writeln('<comment>This might break thing, affect performance on your instance or its security!</comment>');
+
+ $result = (strtolower((string)$helper->ask(
+ $input,
+ $output,
+ new Question('<comment>Confirm this action by typing \'yes\'</comment>: '))) === 'yes');
+
+ $output->writeln(($result) ? 'done' : 'cancelled');
+ $output->writeln('');
+
+ return $result;
+ }
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-14 18:32:14 +0000