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

Migrate simple external storage backends to new registration API [part 1]

9 files changed, 481 insertions, 0 deletions

diff --git a/apps/files_external/lib/auth/password/password.php b/apps/files_external/lib/auth/password/password.php
new file mode 100644
index 00000000000..96ad4b496d4
--- /dev/null
+++ 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
new file mode 100644
index 00000000000..37cfd97a176
--- /dev/null
+++ 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
new file mode 100644
index 00000000000..5ae6d122588
--- /dev/null
+++ 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
new file mode 100644
index 00000000000..df6ca37679e
--- /dev/null
+++ 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)
+		;
+	}
+
+}
diff --git a/apps/files_external/lib/backend/local.php b/apps/files_external/lib/backend/local.php
new file mode 100644
index 00000000000..a80b437fab7
--- /dev/null
+++ b/apps/files_external/lib/backend/local.php
@@ -0,0 +1,49 @@
+<?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\NullMechanism;
+
+class Local extends Backend {
+
+	public function __construct(IL10N $l, NullMechanism $legacyAuth) {
+		$this
+			->setIdentifier('local')
+			->addIdentifierAlias('\OC\Files\Storage\Local') // legacy compat
+			->setStorageClass('\OC\Files\Storage\Local')
+			->setText($l->t('Local'))
+			->addParameters([
+				(new DefinitionParameter('datadir', $l->t('Location'))),
+			])
+			->setAllowedVisibility(BackendService::VISIBILITY_ADMIN)
+			->setPriority(BackendService::PRIORITY_DEFAULT + 50)
+			->addAuthScheme(AuthMechanism::SCHEME_NULL)
+			->setLegacyAuthMechanism($legacyAuth)
+		;
+	}
+
+}
diff --git a/apps/files_external/lib/backend/owncloud.php b/apps/files_external/lib/backend/owncloud.php
new file mode 100644
index 00000000000..d06625de241
--- /dev/null
+++ b/apps/files_external/lib/backend/owncloud.php
@@ -0,0 +1,52 @@
+<?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 OwnCloud extends Backend {
+
+	public function __construct(IL10N $l, Password $legacyAuth) {
+		$this
+			->setIdentifier('owncloud')
+			->addIdentifierAlias('\OC\Files\Storage\OwnCloud') // legacy compat
+			->setStorageClass('\OC\Files\Storage\OwnCloud')
+			->setText($l->t('ownCloud'))
+			->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),
+			])
+			->addAuthScheme(AuthMechanism::SCHEME_PASSWORD)
+			->setLegacyAuthMechanism($legacyAuth)
+		;
+	}
+
+}
diff --git a/apps/files_external/lib/backend/sftp.php b/apps/files_external/lib/backend/sftp.php
new file mode 100644
index 00000000000..dd0f5d8e2e0
--- /dev/null
+++ b/apps/files_external/lib/backend/sftp.php
@@ -0,0 +1,50 @@
+<?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 SFTP extends Backend {
+
+	public function __construct(IL10N $l, Password $legacyAuth) {
+		$this
+			->setIdentifier('sftp')
+			->addIdentifierAlias('\OC\Files\Storage\SFTP') // legacy compat
+			->setStorageClass('\OC\Files\Storage\SFTP')
+			->setText($l->t('SFTP'))
+			->addParameters([
+				(new DefinitionParameter('host', $l->t('Host'))),
+				(new DefinitionParameter('root', $l->t('Root')))
+					->setFlag(DefinitionParameter::FLAG_OPTIONAL),
+			])
+			->addAuthScheme(AuthMechanism::SCHEME_PASSWORD)
+			->setLegacyAuthMechanism($legacyAuth)
+		;
+	}
+
+}
diff --git a/apps/files_external/lib/backend/smb.php b/apps/files_external/lib/backend/smb.php
new file mode 100644
index 00000000000..3d950a80c31
--- /dev/null
+++ b/apps/files_external/lib/backend/smb.php
@@ -0,0 +1,52 @@
+<?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 SMB extends Backend {
+
+	public function __construct(IL10N $l, Password $legacyAuth) {
+		$this
+			->setIdentifier('smb')
+			->addIdentifierAlias('\OC\Files\Storage\SMB') // legacy compat
+			->setStorageClass('\OC\Files\Storage\SMB')
+			->setText($l->t('SMB / CIFS'))
+			->addParameters([
+				(new DefinitionParameter('host', $l->t('Host'))),
+				(new DefinitionParameter('share', $l->t('Share'))),
+				(new DefinitionParameter('root', $l->t('Remote subfolder')))
+					->setFlag(DefinitionParameter::FLAG_OPTIONAL),
+			])
+			->setDependencyCheck('\OC\Files\Storage\SMB::checkDependencies')
+			->addAuthScheme(AuthMechanism::SCHEME_PASSWORD)
+			->setLegacyAuthMechanism($legacyAuth)
+		;
+	}
+
+}
diff --git a/apps/files_external/lib/sessionstoragewrapper.php b/apps/files_external/lib/sessionstoragewrapper.php
new file mode 100644
index 00000000000..91be7eb1903
--- /dev/null
+++ b/apps/files_external/lib/sessionstoragewrapper.php
@@ -0,0 +1,43 @@
+<?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;
+
+use \OCP\Files\Storage;
+use \OC\Files\Storage\Wrapper\PermissionsMask;
+use \OCP\Constants;
+
+/**
+ * Wrap Storage in PermissionsMask for session ephemeral use
+ */
+class SessionStorageWrapper extends PermissionsMask {
+
+	/**
+	 * @param array $arguments ['storage' => $storage]
+	 */
+	public function __construct(array $arguments) {
+		// disable sharing permission
+		$arguments['mask'] = Constants::PERMISSION_ALL & ~Constants::PERMISSION_SHARE;
+		parent::__construct($arguments);
+	}
+
+}
+