Use storage id + appframework for ext storage CRUD

- Added StorageConfig class to replace ugly arrays
- Implemented StorageService and StorageController for Global and User
  storages
- Async status checking for storages (from Xenopathic)
- Auto-generate id for external storage configs (not the same as
  storage_id)
- Refactor JS classes for external storage settings, this mostly
  moves/encapsulated existing global event handlers into the
  MountConfigListView class.
- Added some JS unit tests for the external storage UI

3 files changed, 474 insertions, 0 deletions

diff --git a/apps/files_external/controller/globalstoragescontroller.php b/apps/files_external/controller/globalstoragescontroller.php
new file mode 100644
index 00000000000..3aa64f0d85d
--- /dev/null
+++ b/apps/files_external/controller/globalstoragescontroller.php
@@ -0,0 +1,145 @@
+<?php
+/**
+ * ownCloud - files_external
+ *
+ * This file is licensed under the Affero General Public License version 3 or
+ * later. See the COPYING file.
+ *
+ * @author Vincent Petry <pvince81@owncloud.com>
+ * @copyright Vincent Petry 2015
+ */
+
+namespace OCA\Files_External\Controller;
+
+
+use \OCP\IConfig;
+use \OCP\IUserSession;
+use \OCP\IRequest;
+use \OCP\AppFramework\Http\DataResponse;
+use \OCP\AppFramework\Controller;
+use \OCP\AppFramework\Http;
+use \OCA\Files_external\Service\GlobalStoragesService;
+use \OCA\Files_external\NotFoundException;
+use \OCA\Files_external\Lib\StorageConfig;
+
+class GlobalStoragesController extends StoragesController {
+	/**
+	 * @param string $appName
+	 * @param IRequest $request
+	 * @param IConfig $config
+	 * @param GlobalStoragesService $globalStoragesService
+	 */
+	public function __construct(
+		$AppName,
+		IRequest $request,
+		\OCP\IL10N $l10n,
+		GlobalStoragesService $globalStoragesService
+	){
+		parent::__construct(
+			$AppName,
+			$request,
+			$l10n,
+			$globalStoragesService
+		);
+	}
+
+	/**
+	 * Create an external storage entry.
+	 *
+	 * @param string $mountPoint storage mount point
+	 * @param string $backendClass backend class name
+	 * @param array $backendOptions backend-specific options
+	 * @param array $applicableUsers users for which to mount the storage
+	 * @param array $applicableGroups groups for which to mount the storage
+	 * @param int $priority priority
+	 *
+	 * @return DataResponse
+	 */
+	public function create(
+		$mountPoint,
+		$backendClass,
+		$backendOptions,
+		$applicableUsers,
+		$applicableGroups,
+		$priority
+	) {
+		$newStorage = new StorageConfig();
+		$newStorage->setMountPoint($mountPoint);
+		$newStorage->setBackendClass($backendClass);
+		$newStorage->setBackendOptions($backendOptions);
+		$newStorage->setApplicableUsers($applicableUsers);
+		$newStorage->setApplicableGroups($applicableGroups);
+		$newStorage->setPriority($priority);
+
+		$response = $this->validate($newStorage);
+		if (!empty($response)) {
+			return $response;
+		}
+
+		$newStorage = $this->service->addStorage($newStorage);
+
+		$this->updateStorageStatus($newStorage);
+
+		return new DataResponse(
+			$newStorage,
+			Http::STATUS_CREATED
+		);
+	}
+
+	/**
+	 * Update an external storage entry.
+	 *
+	 * @param int $id storage id
+	 * @param string $mountPoint storage mount point
+	 * @param string $backendClass backend class name
+	 * @param array $backendOptions backend-specific options
+	 * @param array $applicableUsers users for which to mount the storage
+	 * @param array $applicableGroups groups for which to mount the storage
+	 * @param int $priority priority
+	 *
+	 * @return DataResponse
+	 */
+	public function update(
+		$id,
+		$mountPoint,
+		$backendClass,
+		$backendOptions,
+		$applicableUsers,
+		$applicableGroups,
+		$priority
+	) {
+		$storage = new StorageConfig($id);
+		$storage->setMountPoint($mountPoint);
+		$storage->setBackendClass($backendClass);
+		$storage->setBackendOptions($backendOptions);
+		$storage->setApplicableUsers($applicableUsers);
+		$storage->setApplicableGroups($applicableGroups);
+		$storage->setPriority($priority);
+
+		$response = $this->validate($storage);
+		if (!empty($response)) {
+			return $response;
+		}
+
+		try {
+			$storage = $this->service->updateStorage($storage);
+		} catch (NotFoundException $e) {
+			return new DataResponse(
+				[
+					'message' => (string)$this->l10n->t('Storage with id "%i" not found', array($id))
+				],
+				Http::STATUS_NOT_FOUND
+			);
+		}
+
+		$this->updateStorageStatus($storage);
+
+		return new DataResponse(
+			$storage,
+			Http::STATUS_OK
+		);
+
+	}
+
+}
+
diff --git a/apps/files_external/controller/storagescontroller.php b/apps/files_external/controller/storagescontroller.php
new file mode 100644
index 00000000000..f047ba34b50
--- /dev/null
+++ b/apps/files_external/controller/storagescontroller.php
@@ -0,0 +1,157 @@
+<?php
+/**
+ * ownCloud - files_external
+ *
+ * This file is licensed under the Affero General Public License version 3 or
+ * later. See the COPYING file.
+ *
+ * @author Vincent Petry <pvince81@owncloud.com>
+ * @copyright Vincent Petry 2014
+ */
+
+namespace OCA\Files_External\Controller;
+
+
+use \OCP\IConfig;
+use \OCP\IUserSession;
+use \OCP\IRequest;
+use \OCP\AppFramework\Http\DataResponse;
+use \OCP\AppFramework\Controller;
+use \OCP\AppFramework\Http;
+use \OCA\Files_external\Service\StoragesService;
+use \OCA\Files_external\NotFoundException;
+use \OCA\Files_external\Lib\StorageConfig;
+
+abstract class StoragesController extends Controller {
+
+	/**
+	 * @var \OCP\IL10N
+	 */
+	protected $l10n;
+
+	/**
+	 * @var StoragesService
+	 */
+	protected $service;
+
+	/**
+	 * @param string $appName
+	 * @param IRequest $request
+	 * @param IConfig $config
+	 * @param StoragesService $storagesService
+	 */
+	public function __construct(
+		$AppName,
+		IRequest $request,
+		\OCP\IL10N $l10n,
+		StoragesService $storagesService
+	){
+		parent::__construct($AppName, $request);
+		$this->l10n = $l10n;
+		$this->service = $storagesService;
+	}
+
+	/**
+	 * Validate storage config
+	 *
+	 * @param StorageConfig $storage storage config
+	 *
+	 * @return DataResponse|null returns response in case of validation error
+	 */
+	protected function validate(StorageConfig $storage) {
+		$mountPoint = $storage->getMountPoint();
+		if ($mountPoint === '' || $mountPoint === '/') {
+			return new DataResponse(
+				array(
+					'message' => (string)$this->l10n->t('Invalid mount point')
+				),
+				Http::STATUS_UNPROCESSABLE_ENTITY
+			);
+		}
+
+		// TODO: validate that other attrs are set
+
+		$backends = \OC_Mount_Config::getBackends();
+		if (!isset($backends[$storage->getBackendClass()])) {
+			// invalid backend
+			return new DataResponse(
+				array(
+					'message' => (string)$this->l10n->t('Invalid storage backend "%s"', array($storage->getBackendClass()))
+				),
+				Http::STATUS_UNPROCESSABLE_ENTITY
+			);
+		}
+
+		return null;
+	}
+
+	/**
+	 * Check whether the given storage is available / valid.
+	 *
+	 * Note that this operation can be time consuming depending
+	 * on whether the remote storage is available or not.
+	 *
+	 * @param StorageConfig $storage
+	 */
+	protected function updateStorageStatus(StorageConfig &$storage) {
+		// update status (can be time-consuming)
+		$storage->setStatus(
+			\OC_Mount_Config::getBackendStatus(
+				$storage->getBackendClass(),
+				$storage->getBackendOptions(),
+				false
+			)
+		);
+	}
+
+	/**
+	 * Get an external storage entry.
+	 *
+	 * @param int $id storage id
+	 *
+	 * @return DataResponse
+	 */
+	public function show($id) {
+		try {
+			$storage = $this->service->getStorage($id);
+
+			$this->updateStorageStatus($storage);
+		} catch (NotFoundException $e) {
+			return new DataResponse(
+				[
+					'message' => (string)$this->l10n->t('Storage with id "%i" not found', array($id))
+				],
+				Http::STATUS_NOT_FOUND
+			);
+		}
+
+		return new DataResponse(
+			$storage,
+			Http::STATUS_OK
+		);
+	}
+
+	/**
+	 * Deletes the storage with the given id.
+	 *
+	 * @param int $id storage id
+	 *
+	 * @return DataResponse
+	 */
+	public function destroy($id) {
+		try {
+			$this->service->removeStorage($id);
+		} catch (NotFoundException $e) {
+			return new DataResponse(
+				[
+					'message' => (string)$this->l10n->t('Storage with id "%i" not found', array($id))
+				],
+				Http::STATUS_NOT_FOUND
+			);
+		}
+
+		return new DataResponse([], Http::STATUS_NO_CONTENT);
+	}
+
+}
+
diff --git a/apps/files_external/controller/userstoragescontroller.php b/apps/files_external/controller/userstoragescontroller.php
new file mode 100644
index 00000000000..b77cbca59fd
--- /dev/null
+++ b/apps/files_external/controller/userstoragescontroller.php
@@ -0,0 +1,172 @@
+<?php
+/**
+ * ownCloud - files_external
+ *
+ * This file is licensed under the Affero General Public License version 3 or
+ * later. See the COPYING file.
+ *
+ * @author Vincent Petry <pvince81@owncloud.com>
+ * @copyright Vincent Petry 2015
+ */
+
+namespace OCA\Files_External\Controller;
+
+
+use \OCP\IConfig;
+use \OCP\IUserSession;
+use \OCP\IRequest;
+use \OCP\AppFramework\Http\DataResponse;
+use \OCP\AppFramework\Controller;
+use \OCP\AppFramework\Http;
+use \OCA\Files_external\Service\UserStoragesService;
+use \OCA\Files_external\NotFoundException;
+use \OCA\Files_external\Lib\StorageConfig;
+
+class UserStoragesController extends StoragesController {
+	/**
+	 * @param string $appName
+	 * @param IRequest $request
+	 * @param IConfig $config
+	 * @param UserStoragesService $userStoragesService
+	 */
+	public function __construct(
+		$AppName,
+		IRequest $request,
+		\OCP\IL10N $l10n,
+		UserStoragesService $userStoragesService
+	){
+		parent::__construct(
+			$AppName,
+			$request,
+			$l10n,
+			$userStoragesService
+		);
+	}
+
+	/**
+	 * Validate storage config
+	 *
+	 * @param StorageConfig $storage storage config
+	 *
+	 * @return DataResponse|null returns response in case of validation error
+	 */
+	protected function validate(StorageConfig $storage) {
+		$result = parent::validate($storage);
+
+		if ($result != null) {
+			return $result;
+		}
+
+		// Verify that the mount point applies for the current user
+		// Prevent non-admin users from mounting local storage and other disabled backends
+		$allowedBackends = \OC_Mount_Config::getPersonalBackends();
+		if (!isset($allowedBackends[$storage->getBackendClass()])) {
+			return new DataResponse(
+				array(
+					'message' => (string)$this->l10n->t('Invalid storage backend "%s"', array($storage->getBackendClass()))
+				),
+				Http::STATUS_UNPROCESSABLE_ENTITY
+			);
+		}
+
+		return null;
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @{inheritdoc}
+	 */
+	public function show($id) {
+		return parent::show($id);
+	}
+
+	/**
+	 * Create an external storage entry.
+	 *
+	 * @param string $mountPoint storage mount point
+	 * @param string $backendClass backend class name
+	 * @param array $backendOptions backend-specific options
+	 *
+	 * @return DataResponse
+	 *
+	 * @NoAdminRequired
+	 */
+	public function create(
+		$mountPoint,
+		$backendClass,
+		$backendOptions
+	) {
+		$newStorage = new StorageConfig();
+		$newStorage->setMountPoint($mountPoint);
+		$newStorage->setBackendClass($backendClass);
+		$newStorage->setBackendOptions($backendOptions);
+
+		$response = $this->validate($newStorage);
+		if (!empty($response)) {
+			return $response;
+		}
+
+		$newStorage = $this->service->addStorage($newStorage);
+		$this->updateStorageStatus($newStorage);
+
+		return new DataResponse(
+			$newStorage,
+			Http::STATUS_CREATED
+		);
+	}
+
+	/**
+	 * Update an external storage entry.
+	 *
+	 * @param int $id storage id
+	 * @param string $mountPoint storage mount point
+	 * @param string $backendClass backend class name
+	 * @param array $backendOptions backend-specific options
+	 *
+	 * @return DataResponse
+	 */
+	public function update(
+		$id,
+		$mountPoint,
+		$backendClass,
+		$backendOptions
+	) {
+		$storage = new StorageConfig($id);
+		$storage->setMountPoint($mountPoint);
+		$storage->setBackendClass($backendClass);
+		$storage->setBackendOptions($backendOptions);
+
+		$response = $this->validate($storage);
+		if (!empty($response)) {
+			return $response;
+		}
+
+		try {
+			$storage = $this->service->updateStorage($storage);
+		} catch (NotFoundException $e) {
+			return new DataResponse(
+				[
+					'message' => (string)$this->l10n->t('Storage with id "%i" not found', array($id))
+				],
+				Http::STATUS_NOT_FOUND
+			);
+		}
+
+		$this->updateStorageStatus($storage);
+
+		return new DataResponse(
+			$storage,
+			Http::STATUS_OK
+		);
+
+	}
+
+	/**
+	 * {@inheritdoc}
+	 * @NoAdminRequired
+	 */
+	public function destroy($id) {
+		return parent::destroy($id);
+	}
+}
+