mirror of
https://github.com/nextcloud/server.git
synced 2025-02-07 09:59:46 +00:00
5867231247
If `ignore-missing-user` all sub commands work, except listing all settings for a user like `occ user:settings --ignore-missing-user user core`. Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
263 lines
8.3 KiB
PHP
263 lines
8.3 KiB
PHP
<?php
|
|
|
|
/**
|
|
* 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\User;
|
|
|
|
use OC\Core\Command\Base;
|
|
use OCP\IConfig;
|
|
use OCP\IUser;
|
|
use OCP\IUserManager;
|
|
use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
|
|
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 Setting extends Base {
|
|
public function __construct(
|
|
protected IUserManager $userManager,
|
|
protected IConfig $config,
|
|
) {
|
|
parent::__construct();
|
|
}
|
|
|
|
protected function configure() {
|
|
parent::configure();
|
|
$this
|
|
->setName('user:setting')
|
|
->setDescription('Read and modify user settings')
|
|
->addArgument(
|
|
'uid',
|
|
InputArgument::REQUIRED,
|
|
'Account ID used to login'
|
|
)
|
|
->addArgument(
|
|
'app',
|
|
InputArgument::OPTIONAL,
|
|
'Restrict the settings to a given app',
|
|
''
|
|
)
|
|
->addArgument(
|
|
'key',
|
|
InputArgument::OPTIONAL,
|
|
'Setting key to set, get or delete',
|
|
''
|
|
)
|
|
->addOption(
|
|
'ignore-missing-user',
|
|
null,
|
|
InputOption::VALUE_NONE,
|
|
'Use this option to ignore errors when the user does not exist'
|
|
)
|
|
|
|
// Get
|
|
->addOption(
|
|
'default-value',
|
|
null,
|
|
InputOption::VALUE_REQUIRED,
|
|
'(Only applicable on get) If no default value is set and the config does not exist, the command will exit with 1'
|
|
)
|
|
|
|
// Set
|
|
->addArgument(
|
|
'value',
|
|
InputArgument::OPTIONAL,
|
|
'The new value of the setting',
|
|
null
|
|
)
|
|
->addOption(
|
|
'update-only',
|
|
null,
|
|
InputOption::VALUE_NONE,
|
|
'Only updates the value, if it is not set before, it is not being added'
|
|
)
|
|
|
|
// Delete
|
|
->addOption(
|
|
'delete',
|
|
null,
|
|
InputOption::VALUE_NONE,
|
|
'Specify this option to delete the config'
|
|
)
|
|
->addOption(
|
|
'error-if-not-exists',
|
|
null,
|
|
InputOption::VALUE_NONE,
|
|
'Checks whether the setting exists before deleting it'
|
|
)
|
|
;
|
|
}
|
|
|
|
protected function checkInput(InputInterface $input) {
|
|
if (!$input->getOption('ignore-missing-user')) {
|
|
$uid = $input->getArgument('uid');
|
|
$user = $this->userManager->get($uid);
|
|
if (!$user) {
|
|
throw new \InvalidArgumentException('The user "' . $uid . '" does not exist.');
|
|
}
|
|
// normalize uid
|
|
$input->setArgument('uid', $user->getUID());
|
|
}
|
|
|
|
if ($input->getArgument('key') === '' && $input->hasParameterOption('--default-value')) {
|
|
throw new \InvalidArgumentException('The "default-value" option can only be used when specifying a key.');
|
|
}
|
|
|
|
if ($input->getArgument('key') === '' && $input->getArgument('value') !== null) {
|
|
throw new \InvalidArgumentException('The value argument can only be used when specifying a key.');
|
|
}
|
|
if ($input->getArgument('value') !== null && $input->hasParameterOption('--default-value')) {
|
|
throw new \InvalidArgumentException('The value argument can not be used together with "default-value".');
|
|
}
|
|
if ($input->getOption('update-only') && $input->getArgument('value') === null) {
|
|
throw new \InvalidArgumentException('The "update-only" option can only be used together with "value".');
|
|
}
|
|
|
|
if ($input->getArgument('key') === '' && $input->getOption('delete')) {
|
|
throw new \InvalidArgumentException('The "delete" option can only be used when specifying a key.');
|
|
}
|
|
if ($input->getOption('delete') && $input->hasParameterOption('--default-value')) {
|
|
throw new \InvalidArgumentException('The "delete" option can not be used together with "default-value".');
|
|
}
|
|
if ($input->getOption('delete') && $input->getArgument('value') !== null) {
|
|
throw new \InvalidArgumentException('The "delete" option can not be used together with "value".');
|
|
}
|
|
if ($input->getOption('error-if-not-exists') && !$input->getOption('delete')) {
|
|
throw new \InvalidArgumentException('The "error-if-not-exists" option can only be used together with "delete".');
|
|
}
|
|
}
|
|
|
|
protected function execute(InputInterface $input, OutputInterface $output): int {
|
|
try {
|
|
$this->checkInput($input);
|
|
} catch (\InvalidArgumentException $e) {
|
|
$output->writeln('<error>' . $e->getMessage() . '</error>');
|
|
return 1;
|
|
}
|
|
|
|
$uid = $input->getArgument('uid');
|
|
$app = $input->getArgument('app');
|
|
$key = $input->getArgument('key');
|
|
|
|
if ($key !== '') {
|
|
$value = $this->config->getUserValue($uid, $app, $key, null);
|
|
if ($input->getArgument('value') !== null) {
|
|
if ($input->hasParameterOption('--update-only') && $value === null) {
|
|
$output->writeln('<error>The setting does not exist for user "' . $uid . '".</error>');
|
|
return 1;
|
|
}
|
|
|
|
if ($app === 'settings' && in_array($key, ['email', 'display_name'])) {
|
|
$user = $this->userManager->get($uid);
|
|
if ($user instanceof IUser) {
|
|
if ($key === 'email') {
|
|
$user->setEMailAddress($input->getArgument('value'));
|
|
} elseif ($key === 'display_name') {
|
|
if (!$user->setDisplayName($input->getArgument('value'))) {
|
|
if ($user->getDisplayName() === $input->getArgument('value')) {
|
|
$output->writeln('<error>New and old display name are the same</error>');
|
|
} elseif ($input->getArgument('value') === '') {
|
|
$output->writeln('<error>New display name can\'t be empty</error>');
|
|
} else {
|
|
$output->writeln('<error>Could not set display name</error>');
|
|
}
|
|
return 1;
|
|
}
|
|
}
|
|
// setEmailAddress and setDisplayName both internally set the value
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
$this->config->setUserValue($uid, $app, $key, $input->getArgument('value'));
|
|
return 0;
|
|
} elseif ($input->hasParameterOption('--delete')) {
|
|
if ($input->hasParameterOption('--error-if-not-exists') && $value === null) {
|
|
$output->writeln('<error>The setting does not exist for user "' . $uid . '".</error>');
|
|
return 1;
|
|
}
|
|
|
|
if ($app === 'settings' && in_array($key, ['email', 'display_name'])) {
|
|
$user = $this->userManager->get($uid);
|
|
if ($user instanceof IUser) {
|
|
if ($key === 'email') {
|
|
$user->setEMailAddress('');
|
|
// setEmailAddress already deletes the value
|
|
return 0;
|
|
} elseif ($key === 'display_name') {
|
|
$output->writeln('<error>Display name can\'t be deleted.</error>');
|
|
return 1;
|
|
}
|
|
}
|
|
}
|
|
|
|
$this->config->deleteUserValue($uid, $app, $key);
|
|
return 0;
|
|
} elseif ($value !== null) {
|
|
$output->writeln($value);
|
|
return 0;
|
|
} elseif ($input->hasParameterOption('--default-value')) {
|
|
$output->writeln($input->getOption('default-value'));
|
|
return 0;
|
|
} else {
|
|
if ($app === 'settings' && $key === 'display_name') {
|
|
$user = $this->userManager->get($uid);
|
|
$output->writeln($user->getDisplayName());
|
|
return 0;
|
|
}
|
|
$output->writeln('<error>The setting does not exist for user "' . $uid . '".</error>');
|
|
return 1;
|
|
}
|
|
} else {
|
|
$settings = $this->getUserSettings($uid, $app);
|
|
$this->writeArrayInOutputFormat($input, $output, $settings);
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
protected function getUserSettings(string $uid, string $app): array {
|
|
$settings = $this->config->getAllUserValues($uid);
|
|
if ($app !== '') {
|
|
if (isset($settings[$app])) {
|
|
$settings = [$app => $settings[$app]];
|
|
} else {
|
|
$settings = [];
|
|
}
|
|
}
|
|
|
|
$user = $this->userManager->get($uid);
|
|
if ($user !== null) {
|
|
// Only add the display name if the user exists
|
|
$settings['settings']['display_name'] = $user->getDisplayName();
|
|
}
|
|
|
|
return $settings;
|
|
}
|
|
|
|
/**
|
|
* @param string $argumentName
|
|
* @param CompletionContext $context
|
|
* @return string[]
|
|
*/
|
|
public function completeArgumentValues($argumentName, CompletionContext $context) {
|
|
if ($argumentName === 'uid') {
|
|
return array_map(static fn (IUser $user) => $user->getUID(), $this->userManager->search($context->getCurrentWord()));
|
|
}
|
|
if ($argumentName === 'app') {
|
|
$userId = $context->getWordAtIndex($context->getWordIndex() - 1);
|
|
$settings = $this->getUserSettings($userId, '');
|
|
return array_keys($settings);
|
|
}
|
|
if ($argumentName === 'key') {
|
|
$userId = $context->getWordAtIndex($context->getWordIndex() - 2);
|
|
$app = $context->getWordAtIndex($context->getWordIndex() - 1);
|
|
$settings = $this->getUserSettings($userId, $app);
|
|
return array_keys($settings[$app]);
|
|
}
|
|
return [];
|
|
}
|
|
}
|