nextcloud / server

lib/private/Files/Mount/ObjectHomeMountProvider.php

Indentation +100 added lines, -100 removed lines

@@ -32,107 +32,107 @@
  * Mount provider for object store home storages
  */
 class ObjectHomeMountProvider implements IHomeMountProvider {
-	/**
-	 * @var IConfig
-	 */
-	private $config;
-
-	/**
-	 * ObjectStoreHomeMountProvider constructor.
-	 *
-	 * @param IConfig $config
-	 */
-	public function __construct(IConfig $config) {
-		$this->config = $config;
-	}
-
-	/**
-	 * Get the cache mount for a user
-	 *
-	 * @param IUser $user
-	 * @param IStorageFactory $loader
-	 * @return \OCP\Files\Mount\IMountPoint
-	 */
-	public function getHomeMountForUser(IUser $user, IStorageFactory $loader) {
-
-		$config = $this->getMultiBucketObjectStoreConfig($user);
-		if ($config === null) {
-			$config = $this->getSingleBucketObjectStoreConfig($user);
-		}
-
-		if ($config === null) {
-			return null;
-		}
-
-		return new MountPoint('\OC\Files\ObjectStore\HomeObjectStoreStorage', '/' . $user->getUID(), $config['arguments'], $loader);
-	}
-
-	/**
-	 * @param IUser $user
-	 * @return array|null
-	 */
-	private function getSingleBucketObjectStoreConfig(IUser $user) {
-		$config = $this->config->getSystemValue('objectstore');
-		if (!is_array($config)) {
-			return null;
-		}
-
-		// sanity checks
-		if (empty($config['class'])) {
-			\OCP\Util::writeLog('files', 'No class given for objectstore', \OCP\Util::ERROR);
-		}
-		if (!isset($config['arguments'])) {
-			$config['arguments'] = [];
-		}
-		// instantiate object store implementation
-		$config['arguments']['objectstore'] = new $config['class']($config['arguments']);
-
-		$config['arguments']['user'] = $user;
-
-		return $config;
-	}
-
-	/**
-	 * @param IUser $user
-	 * @return array|null
-	 */
-	private function getMultiBucketObjectStoreConfig(IUser $user) {
-		$config = $this->config->getSystemValue('objectstore_multibucket');
-		if (!is_array($config)) {
-			return null;
-		}
-
-		// sanity checks
-		if (empty($config['class'])) {
-			\OCP\Util::writeLog('files', 'No class given for objectstore', \OCP\Util::ERROR);
-		}
-		if (!isset($config['arguments'])) {
-			$config['arguments'] = [];
-		}
-		$config['arguments']['user'] = $user;
-
-		$bucket = $this->config->getUserValue($user->getUID(), 'homeobjectstore', 'bucket', null);
-
-		if ($bucket === null) {
-			/*
+    /**
+     * @var IConfig
+     */
+    private $config;
+
+    /**
+     * ObjectStoreHomeMountProvider constructor.
+     *
+     * @param IConfig $config
+     */
+    public function __construct(IConfig $config) {
+        $this->config = $config;
+    }
+
+    /**
+     * Get the cache mount for a user
+     *
+     * @param IUser $user
+     * @param IStorageFactory $loader
+     * @return \OCP\Files\Mount\IMountPoint
+     */
+    public function getHomeMountForUser(IUser $user, IStorageFactory $loader) {
+
+        $config = $this->getMultiBucketObjectStoreConfig($user);
+        if ($config === null) {
+            $config = $this->getSingleBucketObjectStoreConfig($user);
+        }
+
+        if ($config === null) {
+            return null;
+        }
+
+        return new MountPoint('\OC\Files\ObjectStore\HomeObjectStoreStorage', '/' . $user->getUID(), $config['arguments'], $loader);
+    }
+
+    /**
+     * @param IUser $user
+     * @return array|null
+     */
+    private function getSingleBucketObjectStoreConfig(IUser $user) {
+        $config = $this->config->getSystemValue('objectstore');
+        if (!is_array($config)) {
+            return null;
+        }
+
+        // sanity checks
+        if (empty($config['class'])) {
+            \OCP\Util::writeLog('files', 'No class given for objectstore', \OCP\Util::ERROR);
+        }
+        if (!isset($config['arguments'])) {
+            $config['arguments'] = [];
+        }
+        // instantiate object store implementation
+        $config['arguments']['objectstore'] = new $config['class']($config['arguments']);
+
+        $config['arguments']['user'] = $user;
+
+        return $config;
+    }
+
+    /**
+     * @param IUser $user
+     * @return array|null
+     */
+    private function getMultiBucketObjectStoreConfig(IUser $user) {
+        $config = $this->config->getSystemValue('objectstore_multibucket');
+        if (!is_array($config)) {
+            return null;
+        }
+
+        // sanity checks
+        if (empty($config['class'])) {
+            \OCP\Util::writeLog('files', 'No class given for objectstore', \OCP\Util::ERROR);
+        }
+        if (!isset($config['arguments'])) {
+            $config['arguments'] = [];
+        }
+        $config['arguments']['user'] = $user;
+
+        $bucket = $this->config->getUserValue($user->getUID(), 'homeobjectstore', 'bucket', null);
+
+        if ($bucket === null) {
+            /*
 			 * Use any provided bucket argument as prefix
 			 * and add the mapping from username => bucket
 			 */
-			if (!isset($config['arguments']['bucket'])) {
-				$config['arguments']['bucket'] = '';
-			}
-			$mapper = new \OC\Files\ObjectStore\Mapper($user);
-			$numBuckets = isset($config['arguments']['num_buckets']) ? $config['arguments']['num_buckets'] : 64;
-			$config['arguments']['bucket'] .= $mapper->getBucket($numBuckets);
-
-			$this->config->setUserValue($user->getUID(), 'homeobjectstore', 'bucket', $config['arguments']['bucket']);
-		} else {
-			$config['arguments']['bucket'] = $bucket;
-		}
-
-		// instantiate object store implementation
-		$config['arguments']['objectstore'] = new $config['class']($config['arguments']);
-
-		return $config;
-	}
+            if (!isset($config['arguments']['bucket'])) {
+                $config['arguments']['bucket'] = '';
+            }
+            $mapper = new \OC\Files\ObjectStore\Mapper($user);
+            $numBuckets = isset($config['arguments']['num_buckets']) ? $config['arguments']['num_buckets'] : 64;
+            $config['arguments']['bucket'] .= $mapper->getBucket($numBuckets);
+
+            $this->config->setUserValue($user->getUID(), 'homeobjectstore', 'bucket', $config['arguments']['bucket']);
+        } else {
+            $config['arguments']['bucket'] = $bucket;
+        }
+
+        // instantiate object store implementation
+        $config['arguments']['objectstore'] = new $config['class']($config['arguments']);
+
+        return $config;
+    }
 }

lib/private/Files/ObjectStore/Swift.php

Indentation +248 added lines, -248 removed lines

@@ -39,253 +39,253 @@
 
 class Swift implements IObjectStore {
 
-	/**
-	 * @var \OpenCloud\OpenStack
-	 */
-	private $client;
-
-	/**
-	 * @var array
-	 */
-	private $params;
-
-	/**
-	 * @var \OpenCloud\ObjectStore\Service
-	 */
-	private $objectStoreService;
-
-	/**
-	 * @var \OpenCloud\ObjectStore\Resource\Container
-	 */
-	private $container;
-
-	private $memcache;
-
-	public function __construct($params) {
-		if (isset($params['bucket'])) {
-			$params['container'] = $params['bucket'];
-		}
-		if (!isset($params['container'])) {
-			$params['container'] = 'owncloud';
-		}
-		if (!isset($params['autocreate'])) {
-			// should only be true for tests
-			$params['autocreate'] = false;
-		}
-
-		if (isset($params['apiKey'])) {
-			$this->client = new Rackspace($params['url'], $params);
-			$cacheKey = $params['username'] . '@' . $params['url'] . '/' . $params['bucket'];
-		} else {
-			$this->client = new OpenStack($params['url'], $params);
-			$cacheKey = $params['username'] . '@' . $params['url'] . '/' . $params['bucket'];
-		}
-
-		$cacheFactory = \OC::$server->getMemCacheFactory();
-		$this->memcache = $cacheFactory->createDistributed('swift::' . $cacheKey);
-
-		$this->params = $params;
-	}
-
-	protected function init() {
-		if ($this->container) {
-			return;
-		}
-
-		$this->importToken();
-
-		/** @var Token $token */
-		$token = $this->client->getTokenObject();
-
-		if (!$token || $token->hasExpired()) {
-			try {
-				$this->client->authenticate();
-				$this->exportToken();
-			} catch (ClientErrorResponseException $e) {
-				$statusCode = $e->getResponse()->getStatusCode();
-				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);
-				}
-			}
-		}
-
-
-		/** @var Catalog $catalog */
-		$catalog = $this->client->getCatalog();
-
-		if (count($catalog->getItems()) === 0) {
-			throw new StorageAuthException('Keystone did not provide a valid catalog, verify the credentials');
-		}
-
-		if (isset($this->params['serviceName'])) {
-			$serviceName = $this->params['serviceName'];
-		} else {
-			$serviceName = Service::DEFAULT_NAME;
-		}
-
-		if (isset($this->params['urlType'])) {
-			$urlType = $this->params['urlType'];
-			if ($urlType !== 'internalURL' && $urlType !== 'publicURL') {
-				throw new StorageNotAvailableException('Invalid url type');
-			}
-		} else {
-			$urlType = Service::DEFAULT_URL_TYPE;
-		}
-
-		$catalogItem = $this->getCatalogForService($catalog, $serviceName);
-		if (!$catalogItem) {
-			$available = implode(', ', $this->getAvailableServiceNames($catalog));
-			throw new StorageNotAvailableException(
-				"Service $serviceName not found in service catalog, available services: $available"
-			);
-		} else if (isset($this->params['region'])) {
-			$this->validateRegion($catalogItem, $this->params['region']);
-		}
-
-		$this->objectStoreService = $this->client->objectStoreService($serviceName, $this->params['region'], $urlType);
-
-		try {
-			$this->container = $this->objectStoreService->getContainer($this->params['container']);
-		} catch (ClientErrorResponseException $ex) {
-			// if the container does not exist and autocreate is true try to create the container on the fly
-			if (isset($this->params['autocreate']) && $this->params['autocreate'] === true) {
-				$this->container = $this->objectStoreService->createContainer($this->params['container']);
-			} else {
-				throw $ex;
-			}
-		}
-	}
-
-	private function exportToken() {
-		$export = $this->client->exportCredentials();
-		$export['catalog'] = array_map(function (CatalogItem $item) {
-			return [
-				'name' => $item->getName(),
-				'endpoints' => $item->getEndpoints(),
-				'type' => $item->getType()
-			];
-		}, $export['catalog']->getItems());
-		$this->memcache->set('token', json_encode($export));
-	}
-
-	private function importToken() {
-		$cachedTokenString = $this->memcache->get('token');
-		if ($cachedTokenString) {
-			$cachedToken = json_decode($cachedTokenString, true);
-			$cachedToken['catalog'] = array_map(function (array $item) {
-				$itemClass = new \stdClass();
-				$itemClass->name = $item['name'];
-				$itemClass->endpoints = array_map(function (array $endpoint) {
-					return (object) $endpoint;
-				}, $item['endpoints']);
-				$itemClass->type = $item['type'];
-
-				return $itemClass;
-			}, $cachedToken['catalog']);
-			try {
-				$this->client->importCredentials($cachedToken);
-			} catch (\Exception $e) {
-				$this->client->setTokenObject(new Token());
-			}
-		}
-	}
-
-	/**
-	 * @param Catalog $catalog
-	 * @param $name
-	 * @return null|CatalogItem
-	 */
-	private function getCatalogForService(Catalog $catalog, $name) {
-		foreach ($catalog->getItems() as $item) {
-			/** @var CatalogItem $item */
-			if ($item->hasType(Service::DEFAULT_TYPE) && $item->hasName($name)) {
-				return $item;
-			}
-		}
-
-		return null;
-	}
-
-	private function validateRegion(CatalogItem $item, $region) {
-		$endPoints = $item->getEndpoints();
-		foreach ($endPoints as $endPoint) {
-			if ($endPoint->region === $region) {
-				return;
-			}
-		}
-
-		$availableRegions = implode(', ', array_map(function ($endpoint) {
-			return $endpoint->region;
-		}, $endPoints));
-
-		throw new StorageNotAvailableException("Invalid region '$region', available regions: $availableRegions");
-	}
-
-	private function getAvailableServiceNames(Catalog $catalog) {
-		return array_map(function (CatalogItem $item) {
-			return $item->getName();
-		}, array_filter($catalog->getItems(), function (CatalogItem $item) {
-			return $item->hasType(Service::DEFAULT_TYPE);
-		}));
-	}
-
-	/**
-	 * @return string the container name where objects are stored
-	 */
-	public function getStorageId() {
-		return $this->params['container'];
-	}
-
-	/**
-	 * @param string $urn the unified resource name used to identify the object
-	 * @param resource $stream stream with the data to write
-	 * @throws Exception from openstack lib when something goes wrong
-	 */
-	public function writeObject($urn, $stream) {
-		$this->init();
-		$this->container->uploadObject($urn, $stream);
-	}
-
-	/**
-	 * @param string $urn the unified resource name used to identify the object
-	 * @return resource stream with the read data
-	 * @throws Exception from openstack lib when something goes wrong
-	 */
-	public function readObject($urn) {
-		$this->init();
-		$object = $this->container->getObject($urn);
-
-		// 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 * */
-		$objectContent = $object->getContent();
-		$objectContent->rewind();
-
-		$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);
-
-		return RetryWrapper::wrap($stream);
-	}
-
-	/**
-	 * @param string $urn Unified Resource Name
-	 * @return void
-	 * @throws Exception from openstack lib when something goes wrong
-	 */
-	public function deleteObject($urn) {
-		$this->init();
-		// see https://github.com/rackspace/php-opencloud/issues/243#issuecomment-30032242
-		$this->container->dataObject()->setName($urn)->delete();
-	}
-
-	public function deleteContainer($recursive = false) {
-		$this->init();
-		$this->container->delete($recursive);
-	}
+    /**
+     * @var \OpenCloud\OpenStack
+     */
+    private $client;
+
+    /**
+     * @var array
+     */
+    private $params;
+
+    /**
+     * @var \OpenCloud\ObjectStore\Service
+     */
+    private $objectStoreService;
+
+    /**
+     * @var \OpenCloud\ObjectStore\Resource\Container
+     */
+    private $container;
+
+    private $memcache;
+
+    public function __construct($params) {
+        if (isset($params['bucket'])) {
+            $params['container'] = $params['bucket'];
+        }
+        if (!isset($params['container'])) {
+            $params['container'] = 'owncloud';
+        }
+        if (!isset($params['autocreate'])) {
+            // should only be true for tests
+            $params['autocreate'] = false;
+        }
+
+        if (isset($params['apiKey'])) {
+            $this->client = new Rackspace($params['url'], $params);
+            $cacheKey = $params['username'] . '@' . $params['url'] . '/' . $params['bucket'];
+        } else {
+            $this->client = new OpenStack($params['url'], $params);
+            $cacheKey = $params['username'] . '@' . $params['url'] . '/' . $params['bucket'];
+        }
+
+        $cacheFactory = \OC::$server->getMemCacheFactory();
+        $this->memcache = $cacheFactory->createDistributed('swift::' . $cacheKey);
+
+        $this->params = $params;
+    }
+
+    protected function init() {
+        if ($this->container) {
+            return;
+        }
+
+        $this->importToken();
+
+        /** @var Token $token */
+        $token = $this->client->getTokenObject();
+
+        if (!$token || $token->hasExpired()) {
+            try {
+                $this->client->authenticate();
+                $this->exportToken();
+            } catch (ClientErrorResponseException $e) {
+                $statusCode = $e->getResponse()->getStatusCode();
+                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);
+                }
+            }
+        }
+
+
+        /** @var Catalog $catalog */
+        $catalog = $this->client->getCatalog();
+
+        if (count($catalog->getItems()) === 0) {
+            throw new StorageAuthException('Keystone did not provide a valid catalog, verify the credentials');
+        }
+
+        if (isset($this->params['serviceName'])) {
+            $serviceName = $this->params['serviceName'];
+        } else {
+            $serviceName = Service::DEFAULT_NAME;
+        }
+
+        if (isset($this->params['urlType'])) {
+            $urlType = $this->params['urlType'];
+            if ($urlType !== 'internalURL' && $urlType !== 'publicURL') {
+                throw new StorageNotAvailableException('Invalid url type');
+            }
+        } else {
+            $urlType = Service::DEFAULT_URL_TYPE;
+        }
+
+        $catalogItem = $this->getCatalogForService($catalog, $serviceName);
+        if (!$catalogItem) {
+            $available = implode(', ', $this->getAvailableServiceNames($catalog));
+            throw new StorageNotAvailableException(
+                "Service $serviceName not found in service catalog, available services: $available"
+            );
+        } else if (isset($this->params['region'])) {
+            $this->validateRegion($catalogItem, $this->params['region']);
+        }
+
+        $this->objectStoreService = $this->client->objectStoreService($serviceName, $this->params['region'], $urlType);
+
+        try {
+            $this->container = $this->objectStoreService->getContainer($this->params['container']);
+        } catch (ClientErrorResponseException $ex) {
+            // if the container does not exist and autocreate is true try to create the container on the fly
+            if (isset($this->params['autocreate']) && $this->params['autocreate'] === true) {
+                $this->container = $this->objectStoreService->createContainer($this->params['container']);
+            } else {
+                throw $ex;
+            }
+        }
+    }
+
+    private function exportToken() {
+        $export = $this->client->exportCredentials();
+        $export['catalog'] = array_map(function (CatalogItem $item) {
+            return [
+                'name' => $item->getName(),
+                'endpoints' => $item->getEndpoints(),
+                'type' => $item->getType()
+            ];
+        }, $export['catalog']->getItems());
+        $this->memcache->set('token', json_encode($export));
+    }
+
+    private function importToken() {
+        $cachedTokenString = $this->memcache->get('token');
+        if ($cachedTokenString) {
+            $cachedToken = json_decode($cachedTokenString, true);
+            $cachedToken['catalog'] = array_map(function (array $item) {
+                $itemClass = new \stdClass();
+                $itemClass->name = $item['name'];
+                $itemClass->endpoints = array_map(function (array $endpoint) {
+                    return (object) $endpoint;
+                }, $item['endpoints']);
+                $itemClass->type = $item['type'];
+
+                return $itemClass;
+            }, $cachedToken['catalog']);
+            try {
+                $this->client->importCredentials($cachedToken);
+            } catch (\Exception $e) {
+                $this->client->setTokenObject(new Token());
+            }
+        }
+    }
+
+    /**
+     * @param Catalog $catalog
+     * @param $name
+     * @return null|CatalogItem
+     */
+    private function getCatalogForService(Catalog $catalog, $name) {
+        foreach ($catalog->getItems() as $item) {
+            /** @var CatalogItem $item */
+            if ($item->hasType(Service::DEFAULT_TYPE) && $item->hasName($name)) {
+                return $item;
+            }
+        }
+
+        return null;
+    }
+
+    private function validateRegion(CatalogItem $item, $region) {
+        $endPoints = $item->getEndpoints();
+        foreach ($endPoints as $endPoint) {
+            if ($endPoint->region === $region) {
+                return;
+            }
+        }
+
+        $availableRegions = implode(', ', array_map(function ($endpoint) {
+            return $endpoint->region;
+        }, $endPoints));
+
+        throw new StorageNotAvailableException("Invalid region '$region', available regions: $availableRegions");
+    }
+
+    private function getAvailableServiceNames(Catalog $catalog) {
+        return array_map(function (CatalogItem $item) {
+            return $item->getName();
+        }, array_filter($catalog->getItems(), function (CatalogItem $item) {
+            return $item->hasType(Service::DEFAULT_TYPE);
+        }));
+    }
+
+    /**
+     * @return string the container name where objects are stored
+     */
+    public function getStorageId() {
+        return $this->params['container'];
+    }
+
+    /**
+     * @param string $urn the unified resource name used to identify the object
+     * @param resource $stream stream with the data to write
+     * @throws Exception from openstack lib when something goes wrong
+     */
+    public function writeObject($urn, $stream) {
+        $this->init();
+        $this->container->uploadObject($urn, $stream);
+    }
+
+    /**
+     * @param string $urn the unified resource name used to identify the object
+     * @return resource stream with the read data
+     * @throws Exception from openstack lib when something goes wrong
+     */
+    public function readObject($urn) {
+        $this->init();
+        $object = $this->container->getObject($urn);
+
+        // 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 * */
+        $objectContent = $object->getContent();
+        $objectContent->rewind();
+
+        $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);
+
+        return RetryWrapper::wrap($stream);
+    }
+
+    /**
+     * @param string $urn Unified Resource Name
+     * @return void
+     * @throws Exception from openstack lib when something goes wrong
+     */
+    public function deleteObject($urn) {
+        $this->init();
+        // see https://github.com/rackspace/php-opencloud/issues/243#issuecomment-30032242
+        $this->container->dataObject()->setName($urn)->delete();
+    }
+
+    public function deleteContainer($recursive = false) {
+        $this->init();
+        $this->container->delete($recursive);
+    }
 
 }