From 37beb58c6f395523d8e2934870c5f52a8c6f6df0 Mon Sep 17 00:00:00 2001
From: Robin McCorkell <rmccorkell@owncloud.com>
Date: Tue, 11 Aug 2015 18:45:07 +0100
Subject: Introduce BackendService for managing external storage backends

Backends are registered to the BackendService through new data
structures:

Backends are concrete classes, deriving from
\OCA\Files_External\Lib\Backend\Backend. During construction, the
various configuration parameters of the Backend can be set, in a design
similar to Symfony Console.

DefinitionParameter stores a parameter configuration for an external
storage: name of parameter, human-readable name, type of parameter
(text, password, hidden, checkbox), flags (optional or not).

Storages in the StoragesController now get their parameters validated
server-side (fixes a TODO).
---
 apps/files_external/lib/backend/backend.php | 94 +++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 apps/files_external/lib/backend/backend.php

(limited to 'apps/files_external/lib/backend/backend.php')

diff --git a/apps/files_external/lib/backend/backend.php b/apps/files_external/lib/backend/backend.php
new file mode 100644
index 00000000000..e7cd27a1d6c
--- /dev/null
+++ b/apps/files_external/lib/backend/backend.php
@@ -0,0 +1,94 @@
+<?php
+/**
+ * @author Robin McCorkell <rmccorkell@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\Lib\Backend;
+
+use \OCA\Files_External\Lib\StorageConfig;
+use \OCA\Files_External\Lib\VisibilityTrait;
+use \OCA\Files_External\Lib\FrontendDefinitionTrait;
+use \OCA\Files_External\Lib\PriorityTrait;
+use \OCA\Files_External\Lib\DependencyTrait;
+use \OCA\Files_External\Lib\StorageModifierTrait;
+
+/**
+ * Storage backend
+ */
+class Backend implements \JsonSerializable {
+
+	use VisibilityTrait;
+	use FrontendDefinitionTrait;
+	use PriorityTrait;
+	use DependencyTrait;
+	use StorageModifierTrait;
+
+	/** @var string storage class */
+	private $storageClass;
+
+	/**
+	 * @return string
+	 */
+	public function getClass() {
+		// return storage class for legacy compat
+		return $this->getStorageClass();
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getStorageClass() {
+		return $this->storageClass;
+	}
+
+	/**
+	 * @param string $class
+	 * @return self
+	 */
+	public function setStorageClass($class) {
+		$this->storageClass = $class;
+		return $this;
+	}
+
+	/**
+	 * Serialize into JSON for client-side JS
+	 *
+	 * @return array
+	 */
+	public function jsonSerialize() {
+		$data = $this->jsonSerializeDefinition();
+
+		$data['backend'] = $data['name']; // legacy compat
+		$data['priority'] = $this->getPriority();
+
+		return $data;
+	}
+
+	/**
+	 * Check if parameters are satisfied in a StorageConfig
+	 *
+	 * @param StorageConfig $storage
+	 * @return bool
+	 */
+	public function validateStorage(StorageConfig $storage) {
+		return $this->validateStorageDefinition($storage);
+	}
+
+}
+
-- 
cgit v1.2.3