nextcloud/apps/files_external/lib/Lib/Storage/Swift.php

630 lines
15 KiB
PHP
Raw Normal View History

<?php
declare(strict_types=1);
/**
2016-07-21 17:49:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
2015-03-26 13:44:34 +03:00
* @author Bart Visscher <bartv@thisnet.nl>
* @author Benjamin Liles <benliles@arch.tamu.edu>
* @author Christian Berendt <berendt@b1-systems.de>
* @author Christopher Bartz <bartz@dkrz.de>
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
2015-03-26 13:44:34 +03:00
* @author Felix Moeller <mail@felixmoeller.de>
* @author Joas Schilling <coding@schilljs.com>
2015-03-26 13:44:34 +03:00
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
2015-10-05 21:54:56 +03:00
* @author Martin Mattel <martin.mattel@diemattels.at>
* @author Michael Zamot <michael@zamot.io>
2015-03-26 13:44:34 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
* @author Philipp Kapfer <philipp.kapfer@gmx.at>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2016-01-12 17:02:16 +03:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
* @author Roeland Jago Douma <roeland@famdouma.nl>
2015-03-26 13:44:34 +03:00
* @author Thomas Müller <thomas.mueller@tmit.eu>
2016-01-12 17:02:16 +03:00
* @author Tim Dettrick <t.dettrick@uq.edu.au>
2015-03-26 13:44:34 +03:00
* @author Vincent Petry <pvince81@owncloud.com>
2013-10-22 16:59:09 +04:00
*
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
2013-10-22 16:59:09 +04:00
*
2015-03-26 13:44:34 +03:00
* 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.
2013-10-22 16:59:09 +04:00
*
2015-03-26 13:44:34 +03:00
* This program is distributed in the hope that it will be useful,
2013-10-22 16:59:09 +04:00
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-03-26 13:44:34 +03:00
* 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/>
2013-10-22 16:59:09 +04:00
*
*/
namespace OCA\Files_External\Lib\Storage;
2012-09-07 20:30:48 +04:00
use GuzzleHttp\Psr7\Uri;
use Icewind\Streams\CallbackWrapper;
use Icewind\Streams\IteratorDirectory;
use OC\Files\ObjectStore\SwiftFactory;
use OCP\Files\StorageBadConfigException;
use OCP\ILogger;
use OpenStack\Common\Error\BadResponseError;
use OpenStack\ObjectStore\v1\Models\StorageObject;
2013-10-22 16:59:09 +04:00
class Swift extends \OC\Files\Storage\Common {
/** @var SwiftFactory */
private $connectionFactory;
2014-05-16 00:47:28 +04:00
/**
* @var \OpenStack\ObjectStore\v1\Models\Container
2014-05-16 00:47:28 +04:00
*/
2013-10-22 16:59:09 +04:00
private $container;
2014-05-16 00:47:28 +04:00
/**
* @var string
*/
2013-10-22 16:59:09 +04:00
private $bucket;
/**
* Connection parameters
*
* @var array
*/
private $params;
2016-07-05 23:45:05 +03:00
/** @var string */
2016-07-05 23:45:05 +03:00
private $id;
/** @var \OC\Files\ObjectStore\Swift */
private $objectStore;
/**
* Key value cache mapping path to data object. Maps path to
* \OpenCloud\OpenStack\ObjectStorage\Resource\DataObject for existing
* paths and path to false for not existing paths.
*
* @var \OCP\ICache
*/
private $objectCache;
/**
* @param string $path
* @return mixed|string
*/
private function normalizePath(string $path) {
2013-10-22 16:59:09 +04:00
$path = trim($path, '/');
if (!$path) {
$path = '.';
}
2013-10-22 16:59:09 +04:00
$path = str_replace('#', '%23', $path);
2013-10-22 16:59:09 +04:00
return $path;
}
2014-09-05 15:22:35 +04:00
const SUBCONTAINER_FILE = '.subcontainers';
/**
* translate directory path to container name
2014-09-05 15:22:35 +04:00
*
* @param string $path
* @return string
*/
/**
* Fetches an object from the API.
* If the object is cached already or a
* failed "doesn't exist" response was cached,
* that one will be returned.
*
* @param string $path
* @return StorageObject|bool object
* or false if the object did not exist
* @throws \OCP\Files\StorageAuthException
* @throws \OCP\Files\StorageNotAvailableException
*/
private function fetchObject(string $path) {
if ($this->objectCache->hasKey($path)) {
// might be "false" if object did not exist from last check
return $this->objectCache->get($path);
}
2013-10-22 16:59:09 +04:00
try {
$object = $this->getContainer()->getObject($path);
$object->retrieve();
$this->objectCache->set($path, $object);
return $object;
} catch (BadResponseError $e) {
// Expected response is "404 Not Found", so only log if it isn't
if ($e->getResponse()->getStatusCode() !== 404) {
\OC::$server->getLogger()->logException($e, [
'level' => ILogger::ERROR,
'app' => 'files_external',
]);
}
$this->objectCache->set($path, false);
2013-10-22 16:59:09 +04:00
return false;
}
}
/**
* Returns whether the given path exists.
*
* @param string $path
*
* @return bool true if the object exist, false otherwise
* @throws \OCP\Files\StorageAuthException
* @throws \OCP\Files\StorageNotAvailableException
*/
private function doesObjectExist($path) {
return $this->fetchObject($path) !== false;
}
2013-10-22 16:59:09 +04:00
public function __construct($params) {
2014-09-05 15:22:35 +04:00
if ((empty($params['key']) and empty($params['password']))
or (empty($params['user']) && empty($params['userid'])) or empty($params['bucket'])
2014-09-05 15:22:35 +04:00
or empty($params['region'])
) {
throw new StorageBadConfigException("API Key or password, Username, Bucket and Region have to be configured.");
}
2013-10-22 16:59:09 +04:00
$user = $params['user'];
$this->id = 'swift::' . $user . md5($params['bucket']);
$bucketUrl = new Uri($params['bucket']);
if ($bucketUrl->getHost()) {
$params['bucket'] = basename($bucketUrl->getPath());
$params['endpoint_url'] = (string)$bucketUrl->withPath(dirname($bucketUrl->getPath()));
}
2013-10-22 16:59:09 +04:00
2014-09-05 15:22:35 +04:00
if (empty($params['url'])) {
2013-10-22 16:59:09 +04:00
$params['url'] = 'https://identity.api.rackspacecloud.com/v2.0/';
}
2014-09-05 15:22:35 +04:00
if (empty($params['service_name'])) {
2013-10-22 16:59:09 +04:00
$params['service_name'] = 'cloudFiles';
}
$params['autocreate'] = true;
if (isset($params['domain'])) {
$params['user'] = [
'name' => $params['user'],
'password' => $params['password'],
'domain' => [
'name' => $params['domain'],
]
];
}
$this->params = $params;
// FIXME: private class...
$this->objectCache = new \OC\Cache\CappedMemoryCache();
$this->connectionFactory = new SwiftFactory(
\OC::$server->getMemCacheFactory()->createDistributed('swift/'),
$this->params,
\OC::$server->getLogger()
);
$this->objectStore = new \OC\Files\ObjectStore\Swift($this->params, $this->connectionFactory);
$this->bucket = $params['bucket'];
}
2013-10-22 16:59:09 +04:00
public function mkdir($path) {
$path = $this->normalizePath($path);
if ($this->is_dir($path)) {
return false;
}
2014-09-05 15:22:35 +04:00
if ($path !== '.') {
2013-10-22 16:59:09 +04:00
$path .= '/';
}
2013-10-22 16:59:09 +04:00
try {
$this->getContainer()->createObject([
'name' => $path,
'content' => '',
'headers' => ['content-type' => 'httpd/unix-directory']
]);
// invalidate so that the next access gets the real object
// with all properties
$this->objectCache->remove($path);
} catch (BadResponseError $e) {
\OC::$server->getLogger()->logException($e, [
'level' => ILogger::ERROR,
'app' => 'files_external',
]);
return false;
}
return true;
}
2013-10-22 16:59:09 +04:00
public function file_exists($path) {
$path = $this->normalizePath($path);
2013-10-22 16:59:09 +04:00
if ($path !== '.' && $this->is_dir($path)) {
$path .= '/';
}
2012-08-29 10:42:49 +04:00
2013-10-22 16:59:09 +04:00
return $this->doesObjectExist($path);
}
2013-10-22 16:59:09 +04:00
public function rmdir($path) {
$path = $this->normalizePath($path);
if (!$this->is_dir($path) || !$this->isDeletable($path)) {
2013-10-22 16:59:09 +04:00
return false;
}
2013-10-22 16:59:09 +04:00
$dh = $this->opendir($path);
while ($file = readdir($dh)) {
if (\OC\Files\Filesystem::isIgnoredDir($file)) {
2013-10-22 16:59:09 +04:00
continue;
}
2012-08-29 10:42:49 +04:00
2013-10-22 16:59:09 +04:00
if ($this->is_dir($path . '/' . $file)) {
$this->rmdir($path . '/' . $file);
} else {
$this->unlink($path . '/' . $file);
}
}
2013-10-22 16:59:09 +04:00
try {
$this->objectStore->deleteObject($path . '/');
$this->objectCache->remove($path . '/');
} catch (BadResponseError $e) {
\OC::$server->getLogger()->logException($e, [
'level' => ILogger::ERROR,
'app' => 'files_external',
]);
2013-10-22 16:59:09 +04:00
return false;
}
2013-10-22 16:59:09 +04:00
return true;
}
2013-10-22 16:59:09 +04:00
public function opendir($path) {
$path = $this->normalizePath($path);
2013-10-22 16:59:09 +04:00
if ($path === '.') {
$path = '';
} else {
2013-10-22 16:59:09 +04:00
$path .= '/';
}
// $path = str_replace('%23', '#', $path); // the prefix is sent as a query param, so revert the encoding of #
2013-10-22 16:59:09 +04:00
try {
$files = [];
$objects = $this->getContainer()->listObjects([
'prefix' => $path,
'delimiter' => '/'
]);
2013-10-22 16:59:09 +04:00
/** @var StorageObject $object */
foreach ($objects as $object) {
$file = basename($object->name);
if ($file !== basename($path) && $file !== '.') {
2013-10-22 16:59:09 +04:00
$files[] = $file;
}
}
2012-08-29 10:42:49 +04:00
return IteratorDirectory::wrap($files);
2014-09-05 15:22:35 +04:00
} catch (\Exception $e) {
\OC::$server->getLogger()->logException($e, [
'level' => ILogger::ERROR,
'app' => 'files_external',
]);
2013-10-22 16:59:09 +04:00
return false;
}
2013-10-22 16:59:09 +04:00
}
2013-10-22 16:59:09 +04:00
public function stat($path) {
$path = $this->normalizePath($path);
2014-09-05 15:22:35 +04:00
if ($path === '.') {
$path = '';
} else if ($this->is_dir($path)) {
2013-10-22 16:59:09 +04:00
$path .= '/';
}
2013-10-22 16:59:09 +04:00
try {
$object = $this->fetchObject($path);
if (!$object) {
return false;
}
} catch (BadResponseError $e) {
\OC::$server->getLogger()->logException($e, [
'level' => ILogger::ERROR,
'app' => 'files_external',
]);
2013-10-22 16:59:09 +04:00
return false;
}
$dateTime = $object->lastModified ? \DateTime::createFromFormat(\DateTime::RFC1123, $object->lastModified) : false;
$mtime = $dateTime ? $dateTime->getTimestamp() : null;
$objectMetadata = $object->getMetadata();
if (isset($objectMetadata['timestamp'])) {
$mtime = $objectMetadata['timestamp'];
}
2013-10-22 16:59:09 +04:00
if (!empty($mtime)) {
$mtime = floor($mtime);
}
$stat = [];
$stat['size'] = (int)$object->contentLength;
2013-10-22 16:59:09 +04:00
$stat['mtime'] = $mtime;
$stat['atime'] = time();
return $stat;
}
2012-09-07 17:22:01 +04:00
public function filetype($path) {
2013-10-22 16:59:09 +04:00
$path = $this->normalizePath($path);
if ($path !== '.' && $this->doesObjectExist($path)) {
return 'file';
}
2013-10-22 16:59:09 +04:00
if ($path !== '.') {
$path .= '/';
}
if ($this->doesObjectExist($path)) {
return 'dir';
}
}
2013-10-22 16:59:09 +04:00
public function unlink($path) {
$path = $this->normalizePath($path);
if ($this->is_dir($path)) {
return $this->rmdir($path);
}
2013-10-22 16:59:09 +04:00
try {
$this->objectStore->deleteObject($path);
$this->objectCache->remove($path);
$this->objectCache->remove($path . '/');
} catch (BadResponseError $e) {
if ($e->getResponse()->getStatusCode() !== 404) {
\OC::$server->getLogger()->logException($e, [
'level' => ILogger::ERROR,
'app' => 'files_external',
]);
throw $e;
}
}
2013-10-22 16:59:09 +04:00
return true;
}
2012-11-02 22:53:02 +04:00
public function fopen($path, $mode) {
2013-10-22 16:59:09 +04:00
$path = $this->normalizePath($path);
switch ($mode) {
case 'a':
case 'ab':
case 'a+':
return false;
case 'r':
case 'rb':
2013-10-22 16:59:09 +04:00
try {
return $this->objectStore->readObject($path);
} catch (BadResponseError $e) {
\OC::$server->getLogger()->logException($e, [
'level' => ILogger::ERROR,
'app' => 'files_external',
]);
2013-10-22 16:59:09 +04:00
return false;
}
case 'w':
case 'wb':
case 'r+':
case 'w+':
case 'wb+':
case 'x':
case 'x+':
case 'c':
case 'c+':
2013-10-22 16:59:09 +04:00
if (strrpos($path, '.') !== false) {
$ext = substr($path, strrpos($path, '.'));
} else {
$ext = '';
}
$tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext);
// Fetch existing file if required
if ($mode[0] !== 'w' && $this->file_exists($path)) {
if ($mode[0] === 'x') {
// File cannot already exist
return false;
}
2013-10-22 16:59:09 +04:00
$source = $this->fopen($path, 'r');
file_put_contents($tmpFile, $source);
}
$handle = fopen($tmpFile, $mode);
return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
$this->writeBack($tmpFile, $path);
});
}
}
2013-10-22 16:59:09 +04:00
public function touch($path, $mtime = null) {
$path = $this->normalizePath($path);
if (is_null($mtime)) {
$mtime = time();
}
$metadata = ['timestamp' => (string)$mtime];
2013-10-22 16:59:09 +04:00
if ($this->file_exists($path)) {
if ($this->is_dir($path) && $path !== '.') {
2013-10-22 16:59:09 +04:00
$path .= '/';
}
$object = $this->fetchObject($path);
if ($object->mergeMetadata($metadata)) {
// invalidate target object to force repopulation on fetch
$this->objectCache->remove($path);
}
return true;
2013-10-22 16:59:09 +04:00
} else {
$mimeType = \OC::$server->getMimeTypeDetector()->detectPath($path);
$this->getContainer()->createObject([
'name' => $path,
'content' => '',
'headers' => ['content-type' => 'httpd/unix-directory']
]);
// invalidate target object to force repopulation on fetch
$this->objectCache->remove($path);
return true;
}
}
2012-11-02 22:53:02 +04:00
public function copy($path1, $path2) {
2013-10-22 16:59:09 +04:00
$path1 = $this->normalizePath($path1);
$path2 = $this->normalizePath($path2);
$fileType = $this->filetype($path1);
if ($fileType) {
// make way
$this->unlink($path2);
}
if ($fileType === 'file') {
2013-10-22 16:59:09 +04:00
try {
$source = $this->fetchObject($path1);
$source->copy([
'destination' => $this->bucket . '/' . $path2
]);
// invalidate target object to force repopulation on fetch
$this->objectCache->remove($path2);
$this->objectCache->remove($path2 . '/');
} catch (BadResponseError $e) {
\OC::$server->getLogger()->logException($e, [
'level' => ILogger::ERROR,
'app' => 'files_external',
]);
2013-10-22 16:59:09 +04:00
return false;
}
} else if ($fileType === 'dir') {
2013-10-22 16:59:09 +04:00
try {
$source = $this->fetchObject($path1 . '/');
$source->copy([
'destination' => $this->bucket . '/' . $path2 . '/'
]);
// invalidate target object to force repopulation on fetch
$this->objectCache->remove($path2);
$this->objectCache->remove($path2 . '/');
} catch (BadResponseError $e) {
\OC::$server->getLogger()->logException($e, [
'level' => ILogger::ERROR,
'app' => 'files_external',
]);
2013-10-22 16:59:09 +04:00
return false;
}
2012-10-11 17:52:21 +04:00
2013-10-22 16:59:09 +04:00
$dh = $this->opendir($path1);
while ($file = readdir($dh)) {
if (\OC\Files\Filesystem::isIgnoredDir($file)) {
2013-10-22 16:59:09 +04:00
continue;
}
2013-10-22 16:59:09 +04:00
$source = $path1 . '/' . $file;
$target = $path2 . '/' . $file;
$this->copy($source, $target);
}
} else {
//file does not exist
return false;
}
2013-10-22 16:59:09 +04:00
return true;
}
2013-10-22 16:59:09 +04:00
public function rename($path1, $path2) {
$path1 = $this->normalizePath($path1);
$path2 = $this->normalizePath($path2);
$fileType = $this->filetype($path1);
if ($fileType === 'dir' || $fileType === 'file') {
// copy
2013-10-22 16:59:09 +04:00
if ($this->copy($path1, $path2) === false) {
return false;
}
// cleanup
2013-10-22 16:59:09 +04:00
if ($this->unlink($path1) === false) {
throw new \Exception('failed to remove original');
2013-10-22 16:59:09 +04:00
$this->unlink($path2);
return false;
}
return true;
}
2013-10-22 16:59:09 +04:00
return false;
}
2013-10-22 16:59:09 +04:00
public function getId() {
return $this->id;
}
/**
* Returns the initialized object store container.
*
* @return \OpenStack\ObjectStore\v1\Models\Container
* @throws \OCP\Files\StorageAuthException
* @throws \OCP\Files\StorageNotAvailableException
*/
public function getContainer() {
if (is_null($this->container)) {
$this->container = $this->connectionFactory->getContainer();
if (!$this->file_exists('.')) {
$this->mkdir('.');
}
}
return $this->container;
}
public function writeBack($tmpFile, $path) {
$fileData = fopen($tmpFile, 'r');
$this->objectStore->writeObject($path, $fileData);
// invalidate target object to force repopulation on fetch
$this->objectCache->remove($path);
2013-10-22 16:59:09 +04:00
unlink($tmpFile);
}
public function hasUpdated($path, $time) {
if ($this->is_file($path)) {
return parent::hasUpdated($path, $time);
}
$path = $this->normalizePath($path);
$dh = $this->opendir($path);
$content = [];
while (($file = readdir($dh)) !== false) {
$content[] = $file;
}
if ($path === '.') {
$path = '';
}
$cachedContent = $this->getCache()->getFolderContents($path);
$cachedNames = array_map(function ($content) {
return $content['name'];
}, $cachedContent);
sort($cachedNames);
sort($content);
return $cachedNames !== $content;
}
/**
* check if curl is installed
*/
public static function checkDependencies() {
return true;
}
}