Merge pull request #20710 from owncloud/files_external_config_command

Add command to get and set config for external mounts
2015-12-01 15:27:32 +01:00 · 2015-12-01 15:27:32 +01:00 · 27da63886f
parent d5fe052838 1347e3332b
commit 27da63886f
4 changed files with 220 additions and 0 deletions
--- a/apps/files_external/appinfo/register_command.php
+++ b/apps/files_external/appinfo/register_command.php
@ -21,6 +21,8 @@


 use OCA\Files_External\Command\ListCommand;
+use OCA\Files_External\Command\Config;
+use OCA\Files_External\Command\Option;

 $userManager = OC::$server->getUserManager();
 $userSession = OC::$server->getUserSession();
@ -32,3 +34,5 @@ $userStorageService = $app->getContainer()->query('\OCA\Files_external\Service\U

 /** @var Symfony\Component\Console\Application $application */
 $application->add(new ListCommand($globalStorageService, $userStorageService, $userSession, $userManager));
+$application->add(new Config($globalStorageService));
+$application->add(new Option($globalStorageService));
--- a/apps/files_external/command/config.php
+++ b/apps/files_external/command/config.php
@ -0,0 +1,112 @@
+<?php
+/**
+ * @author Robin Appelman <icewind@owncloud.com>
+ *
+ * @copyright Copyright (c) 2015, 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 OCA\Files_External\Command;
+
+use OC\Core\Command\Base;
+use OCA\Files_external\Lib\StorageConfig;
+use OCA\Files_external\NotFoundException;
+use OCA\Files_external\Service\GlobalStoragesService;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Helper\TableHelper;
+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 Config extends Base {
+	/**
+	 * @var GlobalStoragesService
+	 */
+	protected $globalService;
+
+	function __construct(GlobalStoragesService $globalService) {
+		parent::__construct();
+		$this->globalService = $globalService;
+	}
+
+	protected function configure() {
+		$this
+			->setName('files_external:config')
+			->setDescription('Manage backend configuration for a mount')
+			->addArgument(
+				'mount_id',
+				InputArgument::REQUIRED,
+				'The id of the mount to edit'
+			)->addArgument(
+				'key',
+				InputArgument::REQUIRED,
+				'key of the config option to set/get'
+			)->addArgument(
+				'value',
+				InputArgument::OPTIONAL,
+				'value to set the config option to, when no value is provided the existing value will be printed'
+			);
+		parent::configure();
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output) {
+		$mountId = $input->getArgument('mount_id');
+		$key = $input->getArgument('key');
+		try {
+			$mount = $this->globalService->getStorage($mountId);
+		} catch (NotFoundException $e) {
+			$output->writeln('<error>Mount with id "' . $mountId . ' not found, check "occ files_external:list" to get available mounts"</error>');
+			return 404;
+		}
+
+		$value = $input->getArgument('value');
+		if ($value) {
+			$this->setOption($mount, $key, $value, $output);
+		} else {
+			$this->getOption($mount, $key, $output);
+		}
+	}
+
+	/**
+	 * @param StorageConfig $mount
+	 * @param string $key
+	 * @param OutputInterface $output
+	 */
+	protected function getOption(StorageConfig $mount, $key, OutputInterface $output) {
+		$value = $mount->getBackendOption($key);
+		if (!is_string($value)) { // show bools and objects correctly
+			$value = json_encode($value);
+		}
+		$output->writeln($value);
+	}
+
+	/**
+	 * @param StorageConfig $mount
+	 * @param string $key
+	 * @param string $value
+	 * @param OutputInterface $output
+	 */
+	protected function setOption(StorageConfig $mount, $key, $value, OutputInterface $output) {
+		$decoded = json_decode($value, true);
+		if (!is_null($decoded)) {
+			$value = $decoded;
+		}
+		$mount->setBackendOption($key, $value);
+		$this->globalService->updateStorage($mount);
+	}
+}
--- a/apps/files_external/command/option.php
+++ b/apps/files_external/command/option.php
@ -0,0 +1,85 @@
+<?php
+/**
+ * @author Robin Appelman <icewind@owncloud.com>
+ *
+ * @copyright Copyright (c) 2015, 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 OCA\Files_External\Command;
+
+use OC\Core\Command\Base;
+use OCA\Files_external\Lib\StorageConfig;
+use OCA\Files_external\Service\GlobalStoragesService;
+use OCA\Files_external\Service\UserStoragesService;
+use OCP\IUserManager;
+use OCP\IUserSession;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Helper\TableHelper;
+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 Option extends Config {
+	protected function configure() {
+		$this
+			->setName('files_external:option')
+			->setDescription('Manage mount options for a mount')
+			->addArgument(
+				'mount_id',
+				InputArgument::REQUIRED,
+				'The id of the mount to edit'
+			)->addArgument(
+				'key',
+				InputArgument::REQUIRED,
+				'key of the mount option to set/get'
+			)->addArgument(
+				'value',
+				InputArgument::OPTIONAL,
+				'value to set the mount option to, when no value is provided the existing value will be printed'
+			);
+	}
+
+	/**
+	 * @param StorageConfig $mount
+	 * @param string $key
+	 * @param OutputInterface $output
+	 */
+	protected function getOption(StorageConfig $mount, $key, OutputInterface $output) {
+		$value = $mount->getMountOption($key);
+		if (!is_string($value)) { // show bools and objects correctly
+			$value = json_encode($value);
+		}
+		$output->writeln($value);
+	}
+
+	/**
+	 * @param StorageConfig $mount
+	 * @param string $key
+	 * @param string $value
+	 * @param OutputInterface $output
+	 */
+	protected function setOption(StorageConfig $mount, $key, $value, OutputInterface $output) {
+		$decoded = json_decode($value, true);
+		if (!is_null($decoded)) {
+			$value = $decoded;
+		}
+		$mount->setMountOption($key, $value);
+		$this->globalService->updateStorage($mount);
+	}
+}
--- a/apps/files_external/lib/storageconfig.php
+++ b/apps/files_external/lib/storageconfig.php
@ -301,6 +301,25 @@ class StorageConfig implements \JsonSerializable {
 		$this->mountOptions = $mountOptions;
 	}

+	/**
+	 * @param string $key
+	 * @return mixed
+	 */
+	public function getMountOption($key) {
+		if (isset($this->mountOptions[$key])) {
+			return $this->mountOptions[$key];
+		}
+		return null;
+	}
+
+	/**
+	 * @param string $key
+	 * @param mixed $value
+	 */
+	public function setMountOption($key, $value) {
+		$this->mountOptions[$key] = $value;
+	}
+
 	/**
 	 * Gets the storage status, whether the config worked last time
 	 *