Merge pull request #8314 from nextcloud/openstack

update openstack sdk

1 files changed, 174 insertions, 0 deletions

diff --git a/lib/private/Files/ObjectStore/SwiftFactory.php b/lib/private/Files/ObjectStore/SwiftFactory.php
new file mode 100644
index 00000000000..0df6fb6efcd
--- /dev/null
+++ b/lib/private/Files/ObjectStore/SwiftFactory.php
@@ -0,0 +1,174 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2018 Robin Appelman <robin@icewind.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Files\ObjectStore;
+
+use GuzzleHttp\Client;
+use GuzzleHttp\Exception\ClientException;
+use GuzzleHttp\Exception\ConnectException;
+use GuzzleHttp\Exception\RequestException;
+use GuzzleHttp\HandlerStack;
+use OCP\Files\StorageAuthException;
+use OCP\Files\StorageNotAvailableException;
+use OCP\ICache;
+use OpenStack\Common\Error\BadResponseError;
+use OpenStack\Identity\v2\Models\Token;
+use OpenStack\Identity\v2\Service;
+use OpenStack\OpenStack;
+use OpenStack\Common\Transport\Utils as TransportUtils;
+use Psr\Http\Message\RequestInterface;
+use OpenStack\ObjectStore\v1\Models\Container;
+
+class SwiftFactory {
+	private $cache;
+	private $params;
+	/** @var Container|null */
+	private $container = null;
+
+	public function __construct(ICache $cache, array $params) {
+		$this->cache = $cache;
+		$this->params = $params;
+	}
+
+	private function getCachedToken(string $cacheKey) {
+		$cachedTokenString = $this->cache->get($cacheKey . '/token');
+		if ($cachedTokenString) {
+			return json_decode($cachedTokenString);
+		} else {
+			return null;
+		}
+	}
+
+	private function cacheToken(Token $token, string $cacheKey) {
+		$this->cache->set($cacheKey . '/token', json_encode($token));
+	}
+
+	/**
+	 * @return OpenStack
+	 * @throws StorageAuthException
+	 */
+	private function getClient() {
+		if (isset($this->params['bucket'])) {
+			$this->params['container'] = $this->params['bucket'];
+		}
+		if (!isset($this->params['container'])) {
+			$this->params['container'] = 'owncloud';
+		}
+		if (!isset($this->params['autocreate'])) {
+			// should only be true for tests
+			$this->params['autocreate'] = false;
+		}
+		if (!isset($this->params['username']) && isset($this->params['user'])) {
+			$this->params['username'] = $this->params['user'];
+		}
+		if (!isset($this->params['tenantName']) && isset($this->params['tenant'])) {
+			$this->params['tenantName'] = $this->params['tenant'];
+		}
+
+		$cacheKey = $this->params['username'] . '@' . $this->params['url'] . '/' . $this->params['bucket'];
+		$token = $this->getCachedToken($cacheKey);
+		$hasToken = is_array($token) && (new \DateTimeImmutable($token['expires_at'])) > (new \DateTimeImmutable('now'));
+		if ($hasToken) {
+			$this->params['cachedToken'] = $token;
+		}
+		$httpClient = new Client([
+			'base_uri' => TransportUtils::normalizeUrl($this->params['url']),
+			'handler' => HandlerStack::create()
+		]);
+
+		$authService = Service::factory($httpClient);
+		$this->params['identityService'] = $authService;
+		$this->params['authUrl'] = $this->params['url'];
+		$client = new OpenStack($this->params);
+
+		if (!$hasToken) {
+			try {
+				$token = $authService->generateToken($this->params);
+				$this->cacheToken($token, $cacheKey);
+			} catch (ConnectException $e) {
+				throw new StorageAuthException('Failed to connect to keystone, verify the keystone url', $e);
+			} catch (ClientException $e) {
+				$statusCode = $e->getResponse()->getStatusCode();
+				if ($statusCode === 404) {
+					throw new StorageAuthException('Keystone not found, verify the keystone url', $e);
+				} else if ($statusCode === 412) {
+					throw new StorageAuthException('Precondition failed, verify the keystone url', $e);
+				} else if ($statusCode === 401) {
+					throw new StorageAuthException('Authentication failed, verify the username, password and possibly tenant', $e);
+				} else {
+					throw new StorageAuthException('Unknown error', $e);
+				}
+			} catch (RequestException $e) {
+				throw new StorageAuthException('Connection reset while connecting to keystone, verify the keystone url', $e);
+			}
+		}
+
+		return $client;
+	}
+
+	/**
+	 * @return \OpenStack\ObjectStore\v1\Models\Container
+	 * @throws StorageAuthException
+	 * @throws StorageNotAvailableException
+	 */
+	public function getContainer() {
+		if (is_null($this->container)) {
+			$this->container = $this->createContainer();
+		}
+
+		return $this->container;
+	}
+
+	/**
+	 * @return \OpenStack\ObjectStore\v1\Models\Container
+	 * @throws StorageAuthException
+	 * @throws StorageNotAvailableException
+	 */
+	private function createContainer() {
+		$client = $this->getClient();
+		$objectStoreService = $client->objectStoreV1();
+
+		$autoCreate = isset($this->params['autocreate']) && $this->params['autocreate'] === true;
+		try {
+			$container = $objectStoreService->getContainer($this->params['container']);
+			if ($autoCreate) {
+				$container->getMetadata();
+			}
+			return $container;
+		} catch (BadResponseError $ex) {
+			// if the container does not exist and autocreate is true try to create the container on the fly
+			if ($ex->getResponse()->getStatusCode() === 404 && $autoCreate) {
+				return $objectStoreService->createContainer([
+					'name' => $this->params['container']
+				]);
+			} else {
+				throw new StorageNotAvailableException('Invalid response while trying to get container info', StorageNotAvailableException::STATUS_ERROR, $e);
+			}
+		} catch (ConnectException $e) {
+			/** @var RequestInterface $request */
+			$request = $e->getRequest();
+			$host = $request->getUri()->getHost() . ':' . $request->getUri()->getPort();
+			\OC::$server->getLogger()->error("Can't connect to object storage server at $host");
+			throw new StorageNotAvailableException("Can't connect to object storage server at $host", StorageNotAvailableException::STATUS_ERROR, $e);
+		}
+	}
+}