Merge pull request #18432 from owncloud/ext-backends.simple

Migrate simple external storage backends to new registration API [part 1]
owncloud · Aug 19, 2015 · b3356b1 · b3356b1
2 parents 9dda39b + 1638927
commit b3356b1
Show file tree

Hide file tree

Showing 15 changed files with 505 additions and 105 deletions.
diff --git a/apps/files_external/appinfo/app.php b/apps/files_external/appinfo/app.php
@@ -70,18 +70,6 @@
 OCP\Util::connectHook('OC_Filesystem', 'post_initMountPoints', '\OC_Mount_Config', 'initMountPointsHook');
 OCP\Util::connectHook('OC_User', 'post_login', 'OC\Files\Storage\SMB_OC', 'login');
 
-OC_Mount_Config::registerBackend('\OC\Files\Storage\Local', [
-	'backend' => (string)$l->t('Local'),
-	'priority' => 150,
-	'configuration' => [
-		'datadir' => (string)$l->t('Location')
-	],
-]);
-// Local must only be visible to the admin
-$appContainer->query('OCA\Files_External\Service\BackendService')
-	->getBackend('\OC\Files\Storage\Local')
-	->setAllowedVisibility(\OCA\Files_External\Service\BackendService::VISIBILITY_ADMIN);
-
 OC_Mount_Config::registerBackend('\OC\Files\Storage\AmazonS3', [
 	'backend' => (string)$l->t('Amazon S3'),
 	'priority' => 100,
@@ -123,19 +111,6 @@
 	'has_dependencies' => true,
 ]);
 
-OC_Mount_Config::registerBackend('\OC\Files\Storage\FTP', [
-	'backend' => 'FTP',
-	'priority' => 100,
-	'configuration' => [
-		'host' => (string)$l->t('Host'),
-		'user' => (string)$l->t('Username'),
-		'password' => '*'.$l->t('Password'),
-		'root' => '&'.$l->t('Remote subfolder'),
-		'secure' => '!'.$l->t('Secure ftps://')
-	],
-	'has_dependencies' => true,
-]);
-
 OC_Mount_Config::registerBackend('\OC\Files\Storage\Google', [
 	'backend' => 'Google Drive',
 	'priority' => 100,
@@ -169,19 +144,6 @@
 
 
 if (!OC_Util::runningOnWindows()) {
-	OC_Mount_Config::registerBackend('\OC\Files\Storage\SMB', [
-		'backend' => 'SMB / CIFS',
-		'priority' => 100,
-		'configuration' => [
-			'host' => (string)$l->t('Host'),
-			'user' => (string)$l->t('Username'),
-			'password' => '*'.$l->t('Password'),
-			'share' => (string)$l->t('Share'),
-			'root' => '&'.$l->t('Remote subfolder'),
-		],
-		'has_dependencies' => true,
-	]);
-
 	OC_Mount_Config::registerBackend('\OC\Files\Storage\SMB_OC', [
 			'backend' => (string)$l->t('SMB / CIFS using OC login'),
 			'priority' => 90,
@@ -195,43 +157,6 @@
 	]);
 }
 
-OC_Mount_Config::registerBackend('\OC\Files\Storage\DAV', [
-	'backend' => 'WebDAV',
-	'priority' => 100,
-	'configuration' => [
-		'host' => (string)$l->t('URL'),
-		'user' => (string)$l->t('Username'),
-		'password' => '*'.$l->t('Password'),
-		'root' => '&'.$l->t('Remote subfolder'),
-		'secure' => '!'.$l->t('Secure https://'),
-	],
-	'has_dependencies' => true,
-]);
-
-OC_Mount_Config::registerBackend('\OC\Files\Storage\OwnCloud', [
-	'backend' => 'ownCloud',
-	'priority' => 100,
-	'configuration' => [
-		'host' => (string)$l->t('URL'),
-		'user' => (string)$l->t('Username'),
-		'password' => '*'.$l->t('Password'),
-		'root' => '&'.$l->t('Remote subfolder'),
-		'secure' => '!'.$l->t('Secure https://'),
-	],
-]);
-
-
-OC_Mount_Config::registerBackend('\OC\Files\Storage\SFTP', [
-	'backend' => 'SFTP',
-	'priority' => 100,
-	'configuration' => [
-		'host' => (string)$l->t('Host'),
-		'user' => (string)$l->t('Username'),
-		'password' => '*'.$l->t('Password'),
-		'root' => '&'.$l->t('Remote subfolder'),
-	],
-]);
-
 OC_Mount_Config::registerBackend('\OC\Files\Storage\SFTP_Key', [
 	'backend' => (string)$l->t('SFTP with secret key login'),
 	'priority' => 100,

diff --git a/apps/files_external/appinfo/application.php b/apps/files_external/appinfo/application.php
@@ -28,8 +28,6 @@
 use \OCP\AppFramework\App;
 use \OCP\IContainer;
 use \OCA\Files_External\Service\BackendService;
-use \OCA\Files_External\Lib\BackendConfig;
-use \OCA\Files_External\Lib\BackendParameter;
 
 /**
  * @package OCA\Files_External\Appinfo
@@ -60,6 +58,20 @@ public function __construct(array $urlParams=array()) {
 	protected function loadBackends() {
 		$container = $this->getContainer();
 		$service = $container->query('OCA\\Files_External\\Service\\BackendService');
+
+		$service->registerBackends([
+			$container->query('OCA\Files_External\Lib\Backend\Local'),
+			$container->query('OCA\Files_External\Lib\Backend\FTP'),
+			$container->query('OCA\Files_External\Lib\Backend\DAV'),
+			$container->query('OCA\Files_External\Lib\Backend\OwnCloud'),
+			$container->query('OCA\Files_External\Lib\Backend\SFTP'),
+		]);
+
+		if (!\OC_Util::runningOnWindows()) {
+			$service->registerBackends([
+				$container->query('OCA\Files_External\Lib\Backend\SMB'),
+			]);
+		}
 	}
 
 	/**
@@ -75,6 +87,10 @@ protected function loadAuthMechanisms() {
 
 			// AuthMechanism::SCHEME_BUILTIN mechanism
 			$container->query('OCA\Files_External\Lib\Auth\Builtin'),
+
+			// AuthMechanism::SCHEME_PASSWORD mechanisms
+			$container->query('OCA\Files_External\Lib\Auth\Password\Password'),
+			$container->query('OCA\Files_External\Lib\Auth\Password\SessionCredentials'),
 		]);
 	}
 

diff --git a/apps/files_external/lib/auth/password/password.php b/apps/files_external/lib/auth/password/password.php
@@ -0,0 +1,45 @@
+<?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\Auth\Password;
+
+use \OCP\IL10N;
+use \OCA\Files_External\Lib\DefinitionParameter;
+use \OCA\Files_External\Lib\Auth\AuthMechanism;
+
+/**
+ * Basic password authentication mechanism
+ */
+class Password extends AuthMechanism {
+
+	public function __construct(IL10N $l) {
+		$this
+			->setIdentifier('password::password')
+			->setScheme(self::SCHEME_PASSWORD)
+			->setText($l->t('Username and password'))
+			->addParameters([
+				(new DefinitionParameter('user', $l->t('Username'))),
+				(new DefinitionParameter('password', $l->t('Password')))
+					->setType(DefinitionParameter::VALUE_PASSWORD),
+			]);
+	}
+
+}
diff --git a/apps/files_external/lib/auth/password/sessioncredentials.php b/apps/files_external/lib/auth/password/sessioncredentials.php
@@ -0,0 +1,84 @@
+<?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\Auth\Password;
+
+use \OCP\IL10N;
+use \OCA\Files_External\Lib\DefinitionParameter;
+use \OCA\Files_External\Lib\Auth\AuthMechanism;
+use \OCA\Files_External\Lib\StorageConfig;
+use \OCP\ISession;
+use \OCP\Security\ICrypto;
+use \OCP\Files\Storage;
+use \OCA\Files_External\Lib\SessionStorageWrapper;
+use \OCA\Files_External\Lib\InsufficientDataForMeaningfulAnswerException;
+
+/**
+ * Username and password from login credentials, saved in session
+ */
+class SessionCredentials extends AuthMechanism {
+
+	/** @var ISession */
+	protected $session;
+
+	/** @var ICrypto */
+	protected $crypto;
+
+	public function __construct(IL10N $l, ISession $session, ICrypto $crypto) {
+		$this->session = $session;
+		$this->crypto = $crypto;
+
+		$this
+			->setIdentifier('password::sessioncredentials')
+			->setScheme(self::SCHEME_PASSWORD)
+			->setText($l->t('Session credentials'))
+			->addParameters([
+			])
+		;
+
+		\OCP\Util::connectHook('OC_User', 'post_login', $this, 'authenticate');
+	}
+
+	/**
+	 * Hook listener on post login
+	 *
+	 * @param array $params
+	 */
+	public function authenticate(array $params) {
+		$this->session->set('password::sessioncredentials/credentials', $this->crypto->encrypt(json_encode($params)));
+	}
+
+	public function manipulateStorageConfig(StorageConfig &$storage) {
+		$encrypted = $this->session->get('password::sessioncredentials/credentials');
+		if (!isset($encrypted)) {
+			throw new InsufficientDataForMeaningfulAnswerException('No session credentials saved');
+		}
+
+		$credentials = json_decode($this->crypto->decrypt($encrypted), true);
+		$storage->setBackendOption('user', $this->session->get('loginname'));
+		$storage->setBackendOption('password', $credentials['password']);
+	}
+
+	public function wrapStorage(Storage $storage) {
+		return new SessionStorageWrapper(['storage' => $storage]);
+	}
+
+}
diff --git a/apps/files_external/lib/backend/dav.php b/apps/files_external/lib/backend/dav.php
@@ -0,0 +1,53 @@
+<?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 \OCP\IL10N;
+use \OCA\Files_External\Lib\Backend\Backend;
+use \OCA\Files_External\Lib\DefinitionParameter;
+use \OCA\Files_External\Lib\Auth\AuthMechanism;
+use \OCA\Files_External\Service\BackendService;
+
+use \OCA\Files_External\Lib\Auth\Password\Password;
+
+class DAV extends Backend {
+
+	public function __construct(IL10N $l, Password $legacyAuth) {
+		$this
+			->setIdentifier('dav')
+			->addIdentifierAlias('\OC\Files\Storage\DAV') // legacy compat
+			->setStorageClass('\OC\Files\Storage\DAV')
+			->setText($l->t('WebDAV'))
+			->addParameters([
+				(new DefinitionParameter('host', $l->t('URL'))),
+				(new DefinitionParameter('root', $l->t('Remote subfolder')))
+					->setFlag(DefinitionParameter::FLAG_OPTIONAL),
+				(new DefinitionParameter('secure', $l->t('Secure https://')))
+					->setType(DefinitionParameter::VALUE_BOOLEAN),
+			])
+			->setDependencyCheck('\OC\Files\Storage\DAV::checkDependencies')
+			->addAuthScheme(AuthMechanism::SCHEME_PASSWORD)
+			->setLegacyAuthMechanism($legacyAuth)
+		;
+	}
+
+}
diff --git a/apps/files_external/lib/backend/ftp.php b/apps/files_external/lib/backend/ftp.php
@@ -0,0 +1,53 @@
+<?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 \OCP\IL10N;
+use \OCA\Files_External\Lib\Backend\Backend;
+use \OCA\Files_External\Lib\DefinitionParameter;
+use \OCA\Files_External\Lib\Auth\AuthMechanism;
+use \OCA\Files_External\Service\BackendService;
+
+use \OCA\Files_External\Lib\Auth\Password\Password;
+
+class FTP extends Backend {
+
+	public function __construct(IL10N $l, Password $legacyAuth) {
+		$this
+			->setIdentifier('ftp')
+			->addIdentifierAlias('\OC\Files\Storage\FTP') // legacy compat
+			->setStorageClass('\OC\Files\Storage\FTP')
+			->setText($l->t('FTP'))
+			->addParameters([
+				(new DefinitionParameter('host', $l->t('Host'))),
+				(new DefinitionParameter('root', $l->t('Remote subfolder')))
+					->setFlag(DefinitionParameter::FLAG_OPTIONAL),
+				(new DefinitionParameter('secure', $l->t('Secure ftps://')))
+					->setType(DefinitionParameter::VALUE_BOOLEAN),
+			])
+			->setDependencyCheck('\OC\Files\Storage\FTP::checkDependencies')
+			->addAuthScheme(AuthMechanism::SCHEME_PASSWORD)
+			->setLegacyAuthMechanism($legacyAuth)
+		;
+	}
+
+}