2014-06-11 11:57:24 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
|
|
* @author Robin Appelman <icewind@owncloud.com>
|
2014-06-11 11:57:24 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00:00
|
|
|
* @copyright Copyright (c) 2015, ownCloud, Inc.
|
|
|
|
* @license AGPL-3.0
|
2014-06-11 11:57:24 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00: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.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
2014-06-11 11:57:24 +00:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-03-26 10:44:34 +00:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
2014-06-11 11:57:24 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00:00
|
|
|
* 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/>
|
2014-06-11 11:57:24 +00:00
|
|
|
*
|
|
|
|
*/
|
2015-02-26 10:37:37 +00:00
|
|
|
|
2014-06-11 11:57:24 +00:00
|
|
|
namespace OC\Files\ObjectStore;
|
|
|
|
|
2014-06-13 15:22:21 +00:00
|
|
|
use Guzzle\Http\Exception\ClientErrorResponseException;
|
2014-06-20 10:27:47 +00:00
|
|
|
use OCP\Files\ObjectStore\IObjectStore;
|
2014-06-11 11:57:24 +00:00
|
|
|
use OpenCloud\OpenStack;
|
2014-06-24 12:36:29 +00:00
|
|
|
use OpenCloud\Rackspace;
|
2014-06-11 11:57:24 +00:00
|
|
|
|
2014-06-20 10:27:47 +00:00
|
|
|
class Swift implements IObjectStore {
|
2014-06-24 12:42:52 +00:00
|
|
|
/**
|
|
|
|
* @var \OpenCloud\OpenStack
|
|
|
|
*/
|
|
|
|
private $client;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
private $params;
|
2014-06-11 11:57:24 +00:00
|
|
|
|
2014-06-13 15:22:21 +00:00
|
|
|
/**
|
|
|
|
* @var \OpenCloud\ObjectStore\Service
|
|
|
|
*/
|
|
|
|
private $objectStoreService;
|
2014-06-20 10:27:47 +00:00
|
|
|
|
2014-06-11 11:57:24 +00:00
|
|
|
/**
|
|
|
|
* @var \OpenCloud\ObjectStore\Resource\Container
|
|
|
|
*/
|
|
|
|
private $container;
|
|
|
|
|
|
|
|
public function __construct($params) {
|
2014-06-13 15:22:21 +00:00
|
|
|
if (!isset($params['container'])) {
|
|
|
|
$params['container'] = 'owncloud';
|
|
|
|
}
|
|
|
|
if (!isset($params['autocreate'])) {
|
|
|
|
// should only be true for tests
|
|
|
|
$params['autocreate'] = false;
|
|
|
|
}
|
2014-06-11 11:57:24 +00:00
|
|
|
|
2014-06-24 12:36:29 +00:00
|
|
|
if (isset($params['apiKey'])) {
|
2014-06-24 12:42:52 +00:00
|
|
|
$this->client = new Rackspace($params['url'], $params);
|
2014-06-24 12:36:29 +00:00
|
|
|
} else {
|
2014-06-24 12:42:52 +00:00
|
|
|
$this->client = new OpenStack($params['url'], $params);
|
|
|
|
}
|
|
|
|
$this->params = $params;
|
|
|
|
}
|
|
|
|
|
|
|
|
protected function init() {
|
|
|
|
if ($this->container) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
// the OpenCloud client library will default to 'cloudFiles' if $serviceName is null
|
|
|
|
$serviceName = null;
|
|
|
|
if ($this->params['serviceName']) {
|
|
|
|
$serviceName = $this->params['serviceName'];
|
2014-06-24 12:36:29 +00:00
|
|
|
}
|
2014-06-11 11:57:24 +00:00
|
|
|
|
2014-06-24 12:42:52 +00:00
|
|
|
$this->objectStoreService = $this->client->objectStoreService($serviceName, $this->params['region']);
|
2014-06-13 15:22:21 +00:00
|
|
|
|
|
|
|
try {
|
2014-06-24 12:42:52 +00:00
|
|
|
$this->container = $this->objectStoreService->getContainer($this->params['container']);
|
2014-06-13 15:22:21 +00:00
|
|
|
} catch (ClientErrorResponseException $ex) {
|
|
|
|
// if the container does not exist and autocreate is true try to create the container on the fly
|
2014-06-26 09:30:00 +00:00
|
|
|
if (isset($this->params['autocreate']) && $this->params['autocreate'] === true) {
|
2014-06-24 12:42:52 +00:00
|
|
|
$this->container = $this->objectStoreService->createContainer($this->params['container']);
|
2014-06-13 15:22:21 +00:00
|
|
|
} else {
|
|
|
|
throw $ex;
|
|
|
|
}
|
|
|
|
}
|
2014-06-11 11:57:24 +00:00
|
|
|
}
|
|
|
|
|
2014-06-20 10:27:47 +00:00
|
|
|
/**
|
|
|
|
* @return string the container name where objects are stored
|
|
|
|
*/
|
2014-06-18 13:20:26 +00:00
|
|
|
public function getStorageId() {
|
2014-06-24 12:42:52 +00:00
|
|
|
return $this->params['container'];
|
2014-06-18 13:20:26 +00:00
|
|
|
}
|
2014-06-17 20:06:56 +00:00
|
|
|
|
2014-06-11 20:15:42 +00:00
|
|
|
/**
|
2014-06-20 10:27:47 +00:00
|
|
|
* @param string $urn the unified resource name used to identify the object
|
|
|
|
* @param resource $stream stream with the data to write
|
2014-06-11 20:15:42 +00:00
|
|
|
* @throws Exception from openstack lib when something goes wrong
|
|
|
|
*/
|
2014-06-20 10:27:47 +00:00
|
|
|
public function writeObject($urn, $stream) {
|
2014-06-24 12:42:52 +00:00
|
|
|
$this->init();
|
2014-06-20 10:27:47 +00:00
|
|
|
$this->container->uploadObject($urn, $stream);
|
2014-06-11 11:57:24 +00:00
|
|
|
}
|
2014-06-11 20:15:42 +00:00
|
|
|
|
|
|
|
/**
|
2014-06-20 10:27:47 +00:00
|
|
|
* @param string $urn the unified resource name used to identify the object
|
|
|
|
* @return resource stream with the read data
|
2014-06-11 20:15:42 +00:00
|
|
|
* @throws Exception from openstack lib when something goes wrong
|
|
|
|
*/
|
2014-06-20 10:27:47 +00:00
|
|
|
public function readObject($urn) {
|
2014-06-24 12:42:52 +00:00
|
|
|
$this->init();
|
2014-06-11 11:57:24 +00:00
|
|
|
$object = $this->container->getObject($urn);
|
|
|
|
|
2014-06-20 10:27:47 +00:00
|
|
|
// we need to keep a reference to objectContent or
|
|
|
|
// the stream will be closed before we can do anything with it
|
|
|
|
/** @var $objectContent \Guzzle\Http\EntityBody * */
|
2014-06-11 11:57:24 +00:00
|
|
|
$objectContent = $object->getContent();
|
|
|
|
$objectContent->rewind();
|
2014-06-20 10:27:47 +00:00
|
|
|
|
2014-08-22 12:11:21 +00:00
|
|
|
$stream = $objectContent->getStream();
|
|
|
|
// save the object content in the context of the stream to prevent it being gc'd until the stream is closed
|
|
|
|
stream_context_set_option($stream, 'swift','content', $objectContent);
|
2014-06-20 10:27:47 +00:00
|
|
|
|
2014-08-22 12:11:21 +00:00
|
|
|
return $stream;
|
2014-06-11 11:57:24 +00:00
|
|
|
}
|
2014-06-11 20:15:42 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $urn Unified Resource Name
|
|
|
|
* @return void
|
|
|
|
* @throws Exception from openstack lib when something goes wrong
|
|
|
|
*/
|
2014-06-17 20:06:56 +00:00
|
|
|
public function deleteObject($urn) {
|
2014-06-24 12:42:52 +00:00
|
|
|
$this->init();
|
2014-06-25 12:53:38 +00:00
|
|
|
// see https://github.com/rackspace/php-opencloud/issues/243#issuecomment-30032242
|
|
|
|
$this->container->dataObject()->setName($urn)->delete();
|
2014-06-11 11:57:24 +00:00
|
|
|
}
|
|
|
|
|
2014-06-13 15:22:21 +00:00
|
|
|
public function deleteContainer($recursive = false) {
|
2014-06-24 12:42:52 +00:00
|
|
|
$this->init();
|
2014-06-13 15:22:21 +00:00
|
|
|
$this->container->delete($recursive);
|
|
|
|
}
|
|
|
|
|
2014-06-11 11:57:24 +00:00
|
|
|
}
|