Add occ files_external:create command to add new mounts

4 files changed, 345 insertions, 0 deletions

diff --git a/apps/files_external/appinfo/register_command.php b/apps/files_external/appinfo/register_command.php
index 929becce77a..5f6f42bf8c1 100644
--- a/apps/files_external/appinfo/register_command.php
+++ b/apps/files_external/appinfo/register_command.php
@@ -27,6 +27,8 @@ use OCA\Files_External\Command\Applicable;
 use OCA\Files_External\Command\Import;
 use OCA\Files_External\Command\Export;
 use OCA\Files_External\Command\Delete;
+use OCA\Files_External\Command\Create;
+use OCA\Files_External\Command\Backends;
 
 $userManager = OC::$server->getUserManager();
 $userSession = OC::$server->getUserSession();
@@ -47,3 +49,5 @@ $application->add(new Applicable($globalStorageService, $userManager, $groupMana
 $application->add(new Import($globalStorageService, $userStorageService, $userSession, $userManager, $importLegacyStorageService, $backendService));
 $application->add(new Export($globalStorageService, $userStorageService, $userSession, $userManager));
 $application->add(new Delete($globalStorageService, $userStorageService, $userSession, $userManager));
+$application->add(new Create($globalStorageService, $userStorageService, $userManager, $userSession, $backendService));
+$application->add(new Backends($backendService));
diff --git a/apps/files_external/command/backends.php b/apps/files_external/command/backends.php
new file mode 100644
index 00000000000..8219c5d80bb
--- /dev/null
+++ b/apps/files_external/command/backends.php
@@ -0,0 +1,109 @@
+<?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\Backend\Backend;
+use OCA\Files_External\Lib\DefinitionParameter;
+use OCA\Files_External\Service\BackendService;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Helper\TableHelper;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Input\Input;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class Backends extends Base {
+	/** @var BackendService */
+	private $backendService;
+
+	function __construct(BackendService $backendService
+	) {
+		parent::__construct();
+
+		$this->backendService = $backendService;
+	}
+
+	protected function configure() {
+		$this
+			->setName('files_external:backends')
+			->setDescription('Show available authentication and storage backends')
+			->addArgument(
+				'type',
+				InputArgument::OPTIONAL,
+				'only show backends of a certain type. Possible values are "authentication" or "storage"'
+			)->addArgument(
+				'backend',
+				InputArgument::OPTIONAL,
+				'only show information of a specific backend'
+			);
+		parent::configure();
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output) {
+		$authBackends = $this->backendService->getAuthMechanisms();
+		$storageBackends = $this->backendService->getBackends();
+
+		$data = [
+			'authentication' => array_map([$this, 'serializeAuthBackend'], $authBackends),
+			'storage' => array_map([$this, 'serializeAuthBackend'], $storageBackends)
+		];
+
+		$type = $input->getArgument('type');
+		$backend = $input->getArgument('backend');
+		if ($type) {
+			if (!isset($data[$type])) {
+				$output->writeln('<error>Invalid type "' . $type . '". Possible values are "authentication" or "storage"</error>');
+				return 1;
+			}
+			$data = $data[$type];
+
+			if ($backend) {
+				if (!isset($data[$backend])) {
+					$output->writeln('<error>Unknown backend "' . $backend . '" of type  "' . $type . '"</error>');
+					return 1;
+				}
+				$data = $data[$backend];
+			}
+		}
+
+		$this->writeArrayInOutputFormat($input, $output, $data);
+	}
+
+	private function serializeAuthBackend(\JsonSerializable $backend) {
+		$data = $backend->jsonSerialize();
+		$result = [
+			'name' => $data['name'],
+			'identifier' => $data['identifier'],
+			'configuration' => array_map(function (DefinitionParameter $parameter) {
+				return $parameter->getTypeName();
+			}, $data['configuration'])
+		];
+		if ($backend instanceof Backend) {
+			$result['storage_class'] = $backend->getStorageClass();
+		}
+		return $result;
+	}
+}
diff --git a/apps/files_external/command/create.php b/apps/files_external/command/create.php
new file mode 100644
index 00000000000..2f2f0ca8f73
--- /dev/null
+++ b/apps/files_external/command/create.php
@@ -0,0 +1,216 @@
+<?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 OC\Files\Filesystem;
+use OC\User\NoUserException;
+use OCA\Files_External\Lib\Auth\AuthMechanism;
+use OCA\Files_External\Lib\Backend\Backend;
+use OCA\Files_External\Lib\DefinitionParameter;
+use OCA\Files_external\Lib\StorageConfig;
+use OCA\Files_External\Service\BackendService;
+use OCA\Files_external\Service\GlobalStoragesService;
+use OCA\Files_external\Service\ImportLegacyStoragesService;
+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\ArrayInput;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Input\Input;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class Create extends Base {
+	/**
+	 * @var GlobalStoragesService
+	 */
+	private $globalService;
+
+	/**
+	 * @var UserStoragesService
+	 */
+	private $userService;
+
+	/**
+	 * @var IUserManager
+	 */
+	private $userManager;
+
+	/** @var BackendService */
+	private $backendService;
+
+	/** @var IUserSession */
+	private $userSession;
+
+	function __construct(GlobalStoragesService $globalService,
+						 UserStoragesService $userService,
+						 IUserManager $userManager,
+						 IUserSession $userSession,
+						 BackendService $backendService
+	) {
+		parent::__construct();
+		$this->globalService = $globalService;
+		$this->userService = $userService;
+		$this->userManager = $userManager;
+		$this->userSession = $userSession;
+		$this->backendService = $backendService;
+	}
+
+	protected function configure() {
+		$this
+			->setName('files_external:create')
+			->setDescription('Create a new mount configuration')
+			->addOption(
+				'user',
+				null,
+				InputOption::VALUE_OPTIONAL,
+				'user to add the mount configuration for, if not set the mount will be added as system mount'
+			)
+			->addArgument(
+				'mount_point',
+				InputArgument::REQUIRED,
+				'mount point for the new mount'
+			)
+			->addArgument(
+				'storage_backend',
+				InputArgument::REQUIRED,
+				'storage backend identifier for the new mount, see `occ files_external:backends` for possible values'
+			)
+			->addArgument(
+				'authentication_backend',
+				InputArgument::REQUIRED,
+				'authentication backend identifier for the new mount, see `occ files_external:backends` for possible values'
+			)
+			->addOption(
+				'config',
+				'c',
+				InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
+				'Mount configuration option in key=value format'
+			)
+			->addOption(
+				'dry',
+				null,
+				InputOption::VALUE_NONE,
+				'Don\'t save the created mount, only list the new mount'
+			);
+		parent::configure();
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output) {
+		$user = $input->getOption('user');
+		$mountPoint = $input->getArgument('mount_point');
+		$storageIdentifier = $input->getArgument('storage_backend');
+		$authIdentifier = $input->getArgument('authentication_backend');
+		$configInput = $input->getOption('config');
+
+		$storageBackend = $this->backendService->getBackend($storageIdentifier);
+		$authBackend = $this->backendService->getAuthMechanism($authIdentifier);
+
+		if (!Filesystem::isValidPath($mountPoint)) {
+			$output->writeln('<error>Invalid mountpoint "' . $mountPoint . '"</error>');
+			return 1;
+		}
+		if (is_null($storageBackend)) {
+			$output->writeln('<error>Storage backend with identifier "' . $storageIdentifier . '" not found (see `occ files_external:backends` for possible values)</error>');
+			return 404;
+		}
+		if (is_null($authBackend)) {
+			$output->writeln('<error>Authentication backend with identifier "' . $authIdentifier . '" not found (see `occ files_external:backends` for possible values)</error>');
+			return 404;
+		}
+
+		$config = [];
+		foreach ($configInput as $configOption) {
+			if (!strpos($configOption, '=')) {
+				$output->writeln('<error>Invalid mount configuration option "' . $configOption . '"</error>');
+				return 1;
+			}
+			list($key, $value) = explode('=', $configOption, 2);
+			if (!$this->validateParam($key, $value, $storageBackend, $authBackend)) {
+				$output->writeln('<error>Unknown configuration for backends "' . $key . '"</error>');
+				return 1;
+			}
+			$config[$key] = $value;
+		}
+
+		$mount = new StorageConfig();
+		$mount->setMountPoint($mountPoint);
+		$mount->setBackend($storageBackend);
+		$mount->setAuthMechanism($authBackend);
+		$mount->setBackendOptions($config);
+
+		if ($user) {
+			if (!$this->userManager->userExists($user)) {
+				$output->writeln('<error>User "' . $user . '" not found</error>');
+				return 1;
+			}
+			$mount->setApplicableUsers([$user]);
+		}
+
+		if ($input->getOption('dry')) {
+			$this->showMount($user, $mount, $input, $output);
+		} else {
+			$this->getStorageService($user)->addStorage($mount);
+		}
+		return 0;
+	}
+
+	private function validateParam($key, &$value, Backend $storageBackend, AuthMechanism $authBackend) {
+		$params = array_merge($storageBackend->getParameters(), $authBackend->getParameters());
+		foreach ($params as $param) {
+			/** @var DefinitionParameter $param */
+			if ($param->getName() === $key) {
+				if ($param->getType() === DefinitionParameter::VALUE_BOOLEAN) {
+					$value = ($value === 'true');
+				}
+				return true;
+			}
+		}
+		return false;
+	}
+
+	private function showMount($user, StorageConfig $mount, InputInterface $input, OutputInterface $output) {
+		$listCommand = new ListCommand($this->globalService, $this->userService, $this->userSession, $this->userManager);
+		$listInput = new ArrayInput([], $listCommand->getDefinition());
+		$listInput->setOption('output', $input->getOption('output'));
+		$listInput->setOption('show-password', true);
+		$listCommand->listMounts($user, [$mount], $listInput, $output);
+	}
+
+	protected function getStorageService($userId) {
+		if (!empty($userId)) {
+			$user = $this->userManager->get($userId);
+			if (is_null($user)) {
+				throw new NoUserException("user $userId not found");
+			}
+			$this->userSession->setUser($user);
+			return $this->userService;
+		} else {
+			return $this->globalService;
+		}
+	}
+}
diff --git a/apps/files_external/lib/definitionparameter.php b/apps/files_external/lib/definitionparameter.php
index 27c6af0fcda..4d4bb13bebd 100644
--- a/apps/files_external/lib/definitionparameter.php
+++ b/apps/files_external/lib/definitionparameter.php
@@ -93,6 +93,22 @@ class DefinitionParameter implements \JsonSerializable {
 	}
 
 	/**
+	 * @return string
+	 */
+	public function getTypeName() {
+		switch ($this->type) {
+			case self::VALUE_BOOLEAN:
+				return 'boolean';
+			case self::VALUE_TEXT:
+				return 'text';
+			case self::VALUE_PASSWORD:
+				return 'password';
+			default:
+				return 'unknown';
+		}
+	}
+
+	/**
 	 * @return int
 	 */
 	public function getFlags() {