Add a occ command to list/get user preferences

diff --git a/core/Command/User/Setting.php b/core/Command/User/Setting.php
new file mode 100644 (file)
index 0000000..887439b
--- /dev/null
+++ b/core/Command/User/Setting.php
@@ -0,0 +1,160 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Laurens Post <lkpost@scept.re>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @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/>
+ *
+ */
+
+namespace OC\Core\Command\User;
+
+use OC\Core\Command\Base;
+use OCP\IConfig;
+use OCP\IDBConnection;
+use OCP\IUserManager;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Input\InputArgument;
+
+class Setting extends Base {
+       /** @var IUserManager */
+       protected $userManager;
+
+       /** @var IConfig */
+       protected $config;
+
+       /** @var IDBConnection */
+       protected $connection;
+
+       /**
+        * @param IUserManager $userManager
+        * @param IConfig $config
+        * @param IDBConnection $connection
+        */
+       public function __construct(IUserManager $userManager, IConfig $config, IDBConnection $connection) {
+               parent::__construct();
+               $this->userManager = $userManager;
+               $this->config = $config;
+               $this->connection = $connection;
+       }
+
+       protected function configure() {
+               parent::configure();
+               $this
+                       ->setName('user:setting')
+                       ->setDescription('adds a user')
+                       ->addArgument(
+                               'uid',
+                               InputArgument::REQUIRED,
+                               'User ID used to login'
+                       )
+                       ->addArgument(
+                               'app',
+                               InputArgument::OPTIONAL,
+                               'Restrict the preferences to a given app',
+                               ''
+                       )
+                       ->addArgument(
+                               'key',
+                               InputArgument::OPTIONAL,
+                               'Setting key to set, get or delete',
+                               ''
+                       )
+                       ->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'
+                       )
+                       ->addOption(
+                               'ignore-missing-user',
+                               null,
+                               InputOption::VALUE_NONE,
+                               'Use this option to ignore errors when the user does not exist'
+                       )
+               ;
+       }
+
+       protected function checkInput(InputInterface $input) {
+               $uid = $input->getArgument('uid');
+               if (!$input->getOption('ignore-missing-user') && !$this->userManager->userExists($uid)) {
+                       throw new \InvalidArgumentException('The user "' . $uid . '" does not exists.');
+               }
+
+               if ($input->getArgument('key') === '' && $input->hasParameterOption('--default-value')) {
+                       throw new \InvalidArgumentException('The default-value option can only be used when getting a single setting.');
+               }
+       }
+
+       protected function execute(InputInterface $input, OutputInterface $output) {
+               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 ($value !== null) {
+                               $output->writeln($value);
+                       } else {
+                               if ($input->hasParameterOption('--default-value')) {
+                                       $output->writeln($input->getOption('default-value'));
+                               } else {
+                                       $output->writeln('<error>The setting does not exist for user "' . $uid . '".</error>');
+                                       return 1;
+                               }
+                       }
+               } else {
+                       $this->listUserSettings($input, $output, $uid, $app);
+               }
+
+               return 0;
+       }
+
+       protected function listUserSettings(InputInterface $input, OutputInterface $output, $uid, $app) {
+               $settings = $this->getUserSettings($uid, $app);
+
+               $this->writeArrayInOutputFormat($input, $output, $settings);
+       }
+
+       protected function getUserSettings($uid, $app) {
+               $query = $this->connection->getQueryBuilder();
+               $query->select('*')
+                       ->from('preferences')
+                       ->where($query->expr()->eq('userid', $query->createNamedParameter($uid)));
+
+               if ($app !== '') {
+                       $query->andWhere($query->expr()->eq('appid', $query->createNamedParameter($app)));
+               }
+
+               $result = $query->execute();
+               $settings = [];
+               while ($row = $result->fetch()) {
+                       $settings[$row['appid']][$row['configkey']] = $row['configvalue'];
+               }
+               $result->closeCursor();
+
+               return $settings;
+       }
+}

diff --git a/core/register_command.php b/core/register_command.php
index ebb6ce8b7235b3ed8e295e1dbe7d5db90ac79152..91b00df20f13d6c053e1b767963bd8084d5fccec 100644 (file)
--- a/core/register_command.php
+++ b/core/register_command.php
@@ -136,6 +136,7 @@ if (\OC::$server->getConfig()->getSystemValue('installed', false)) {
        $application->add(new OC\Core\Command\User\LastSeen(\OC::$server->getUserManager()));
        $application->add(new OC\Core\Command\User\Report(\OC::$server->getUserManager()));
        $application->add(new OC\Core\Command\User\ResetPassword(\OC::$server->getUserManager()));
+       $application->add(new OC\Core\Command\User\Setting(\OC::$server->getUserManager(), \OC::$server->getConfig(), \OC::$server->getDatabaseConnection()));
 
        $application->add(new OC\Core\Command\Security\ListCertificates(\OC::$server->getCertificateManager(null), \OC::$server->getL10N('core')));
        $application->add(new OC\Core\Command\Security\ImportCertificate(\OC::$server->getCertificateManager(null)));