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/ObjectStoreStorage.php

Indentation +392 added lines, -392 removed lines

@@ -31,396 +31,396 @@
 use OCP\Files\ObjectStore\IObjectStore;
 
 class ObjectStoreStorage extends \OC\Files\Storage\Common {
-	/**
-	 * @var \OCP\Files\ObjectStore\IObjectStore $objectStore
-	 */
-	protected $objectStore;
-	/**
-	 * @var string $id
-	 */
-	protected $id;
-	/**
-	 * @var \OC\User\User $user
-	 */
-	protected $user;
-
-	private $objectPrefix = 'urn:oid:';
-
-	private $logger;
-
-	public function __construct($params) {
-		if (isset($params['objectstore']) && $params['objectstore'] instanceof IObjectStore) {
-			$this->objectStore = $params['objectstore'];
-		} else {
-			throw new \Exception('missing IObjectStore instance');
-		}
-		if (isset($params['storageid'])) {
-			$this->id = 'object::store:' . $params['storageid'];
-		} else {
-			$this->id = 'object::store:' . $this->objectStore->getStorageId();
-		}
-		if (isset($params['objectPrefix'])) {
-			$this->objectPrefix = $params['objectPrefix'];
-		}
-		//initialize cache with root directory in cache
-		if (!$this->is_dir('/')) {
-			$this->mkdir('/');
-		}
-
-		$this->logger = \OC::$server->getLogger();
-	}
-
-	public function mkdir($path) {
-		$path = $this->normalizePath($path);
-
-		if ($this->file_exists($path)) {
-			return false;
-		}
-
-		$mTime = time();
-		$data = [
-			'mimetype' => 'httpd/unix-directory',
-			'size' => 0,
-			'mtime' => $mTime,
-			'storage_mtime' => $mTime,
-			'permissions' => \OCP\Constants::PERMISSION_ALL,
-		];
-		if ($path === '') {
-			//create root on the fly
-			$data['etag'] = $this->getETag('');
-			$this->getCache()->put('', $data);
-			return true;
-		} else {
-			// if parent does not exist, create it
-			$parent = $this->normalizePath(dirname($path));
-			$parentType = $this->filetype($parent);
-			if ($parentType === false) {
-				if (!$this->mkdir($parent)) {
-					// something went wrong
-					return false;
-				}
-			} else if ($parentType === 'file') {
-				// parent is a file
-				return false;
-			}
-			// finally create the new dir
-			$mTime = time(); // update mtime
-			$data['mtime'] = $mTime;
-			$data['storage_mtime'] = $mTime;
-			$data['etag'] = $this->getETag($path);
-			$this->getCache()->put($path, $data);
-			return true;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	private function normalizePath($path) {
-		$path = trim($path, '/');
-		//FIXME why do we sometimes get a path like 'files//username'?
-		$path = str_replace('//', '/', $path);
-
-		// dirname('/folder') returns '.' but internally (in the cache) we store the root as ''
-		if (!$path || $path === '.') {
-			$path = '';
-		}
-
-		return $path;
-	}
-
-	/**
-	 * Object Stores use a NoopScanner because metadata is directly stored in
-	 * the file cache and cannot really scan the filesystem. The storage passed in is not used anywhere.
-	 *
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner
-	 * @return \OC\Files\ObjectStore\NoopScanner
-	 */
-	public function getScanner($path = '', $storage = null) {
-		if (!$storage) {
-			$storage = $this;
-		}
-		if (!isset($this->scanner)) {
-			$this->scanner = new NoopScanner($storage);
-		}
-		return $this->scanner;
-	}
-
-	public function getId() {
-		return $this->id;
-	}
-
-	public function rmdir($path) {
-		$path = $this->normalizePath($path);
-
-		if (!$this->is_dir($path)) {
-			return false;
-		}
-
-		$this->rmObjects($path);
-
-		$this->getCache()->remove($path);
-
-		return true;
-	}
-
-	private function rmObjects($path) {
-		$children = $this->getCache()->getFolderContents($path);
-		foreach ($children as $child) {
-			if ($child['mimetype'] === 'httpd/unix-directory') {
-				$this->rmObjects($child['path']);
-			} else {
-				$this->unlink($child['path']);
-			}
-		}
-	}
-
-	public function unlink($path) {
-		$path = $this->normalizePath($path);
-		$stat = $this->stat($path);
-
-		if ($stat && isset($stat['fileid'])) {
-			if ($stat['mimetype'] === 'httpd/unix-directory') {
-				return $this->rmdir($path);
-			}
-			try {
-				$this->objectStore->deleteObject($this->getURN($stat['fileid']));
-			} catch (\Exception $ex) {
-				if ($ex->getCode() !== 404) {
-					$this->logger->logException($ex, [
-						'app' => 'objectstore',
-						'message' => 'Could not delete object ' . $this->getURN($stat['fileid']) . ' for ' . $path,
-					]);
-					return false;
-				}
-				//removing from cache is ok as it does not exist in the objectstore anyway
-			}
-			$this->getCache()->remove($path);
-			return true;
-		}
-		return false;
-	}
-
-	public function stat($path) {
-		$path = $this->normalizePath($path);
-		$cacheEntry = $this->getCache()->get($path);
-		if ($cacheEntry instanceof CacheEntry) {
-			return $cacheEntry->getData();
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * Override this method if you need a different unique resource identifier for your object storage implementation.
-	 * The default implementations just appends the fileId to 'urn:oid:'. Make sure the URN is unique over all users.
-	 * You may need a mapping table to store your URN if it cannot be generated from the fileid.
-	 *
-	 * @param int $fileId the fileid
-	 * @return null|string the unified resource name used to identify the object
-	 */
-	protected function getURN($fileId) {
-		if (is_numeric($fileId)) {
-			return $this->objectPrefix . $fileId;
-		}
-		return null;
-	}
-
-	public function opendir($path) {
-		$path = $this->normalizePath($path);
-
-		try {
-			$files = array();
-			$folderContents = $this->getCache()->getFolderContents($path);
-			foreach ($folderContents as $file) {
-				$files[] = $file['name'];
-			}
-
-			return IteratorDirectory::wrap($files);
-		} catch (\Exception $e) {
-			$this->logger->logException($e);
-			return false;
-		}
-	}
-
-	public function filetype($path) {
-		$path = $this->normalizePath($path);
-		$stat = $this->stat($path);
-		if ($stat) {
-			if ($stat['mimetype'] === 'httpd/unix-directory') {
-				return 'dir';
-			}
-			return 'file';
-		} else {
-			return false;
-		}
-	}
-
-	public function fopen($path, $mode) {
-		$path = $this->normalizePath($path);
-
-		switch ($mode) {
-			case 'r':
-			case 'rb':
-				$stat = $this->stat($path);
-				if (is_array($stat)) {
-					try {
-						return $this->objectStore->readObject($this->getURN($stat['fileid']));
-					} catch (\Exception $ex) {
-						$this->logger->logException($ex, [
-							'app' => 'objectstore',
-							'message' => 'Count not get object ' . $this->getURN($stat['fileid']) . ' for file ' . $path,
-						]);
-						return false;
-					}
-				} else {
-					return false;
-				}
-			case 'w':
-			case 'wb':
-			case 'a':
-			case 'ab':
-			case 'r+':
-			case 'w+':
-			case 'wb+':
-			case 'a+':
-			case 'x':
-			case 'x+':
-			case 'c':
-			case 'c+':
-				if (strrpos($path, '.') !== false) {
-					$ext = substr($path, strrpos($path, '.'));
-				} else {
-					$ext = '';
-				}
-				$tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext);
-				if ($this->file_exists($path)) {
-					$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);
-				});
-		}
-		return false;
-	}
-
-	public function file_exists($path) {
-		$path = $this->normalizePath($path);
-		return (bool)$this->stat($path);
-	}
-
-	public function rename($source, $target) {
-		$source = $this->normalizePath($source);
-		$target = $this->normalizePath($target);
-		$this->remove($target);
-		$this->getCache()->move($source, $target);
-		$this->touch(dirname($target));
-		return true;
-	}
-
-	public function getMimeType($path) {
-		$path = $this->normalizePath($path);
-		$stat = $this->stat($path);
-		if (is_array($stat)) {
-			return $stat['mimetype'];
-		} else {
-			return false;
-		}
-	}
-
-	public function touch($path, $mtime = null) {
-		if (is_null($mtime)) {
-			$mtime = time();
-		}
-
-		$path = $this->normalizePath($path);
-		$dirName = dirname($path);
-		$parentExists = $this->is_dir($dirName);
-		if (!$parentExists) {
-			return false;
-		}
-
-		$stat = $this->stat($path);
-		if (is_array($stat)) {
-			// update existing mtime in db
-			$stat['mtime'] = $mtime;
-			$this->getCache()->update($stat['fileid'], $stat);
-		} else {
-			try {
-				//create a empty file, need to have at least on char to make it
-				// work with all object storage implementations
-				$this->file_put_contents($path, ' ');
-				$mimeType = \OC::$server->getMimeTypeDetector()->detectPath($path);
-				$stat = array(
-					'etag' => $this->getETag($path),
-					'mimetype' => $mimeType,
-					'size' => 0,
-					'mtime' => $mtime,
-					'storage_mtime' => $mtime,
-					'permissions' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_CREATE,
-				);
-				$this->getCache()->put($path, $stat);
-			} catch (\Exception $ex) {
-				$this->logger->logException($ex, [
-					'app' => 'objectstore',
-					'message' => 'Could not create object for ' . $path,
-				]);
-				throw $ex;
-			}
-		}
-		return true;
-	}
-
-	public function writeBack($tmpFile, $path) {
-		$stat = $this->stat($path);
-		if (empty($stat)) {
-			// create new file
-			$stat = array(
-				'permissions' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_CREATE,
-			);
-		}
-		// update stat with new data
-		$mTime = time();
-		$stat['size'] = filesize($tmpFile);
-		$stat['mtime'] = $mTime;
-		$stat['storage_mtime'] = $mTime;
-
-		// run path based detection first, to use file extension because $tmpFile is only a random string
-		$mimetypeDetector = \OC::$server->getMimeTypeDetector();
-		$mimetype = $mimetypeDetector->detectPath($path);
-		if ($mimetype === 'application/octet-stream') {
-			$mimetype = $mimetypeDetector->detect($tmpFile);
-		}
-
-		$stat['mimetype'] = $mimetype;
-		$stat['etag'] = $this->getETag($path);
-
-		$fileId = $this->getCache()->put($path, $stat);
-		try {
-			//upload to object storage
-			$this->objectStore->writeObject($this->getURN($fileId), fopen($tmpFile, 'r'));
-		} catch (\Exception $ex) {
-			$this->getCache()->remove($path);
-			$this->logger->logException($ex, [
-				'app' => 'objectstore',
-				'message' => 'Could not create object ' . $this->getURN($fileId) . ' for ' . $path,
-			]);
-			throw $ex; // make this bubble up
-		}
-	}
-
-	/**
-	 * external changes are not supported, exclusive access to the object storage is assumed
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @return false
-	 */
-	public function hasUpdated($path, $time) {
-		return false;
-	}
+    /**
+     * @var \OCP\Files\ObjectStore\IObjectStore $objectStore
+     */
+    protected $objectStore;
+    /**
+     * @var string $id
+     */
+    protected $id;
+    /**
+     * @var \OC\User\User $user
+     */
+    protected $user;
+
+    private $objectPrefix = 'urn:oid:';
+
+    private $logger;
+
+    public function __construct($params) {
+        if (isset($params['objectstore']) && $params['objectstore'] instanceof IObjectStore) {
+            $this->objectStore = $params['objectstore'];
+        } else {
+            throw new \Exception('missing IObjectStore instance');
+        }
+        if (isset($params['storageid'])) {
+            $this->id = 'object::store:' . $params['storageid'];
+        } else {
+            $this->id = 'object::store:' . $this->objectStore->getStorageId();
+        }
+        if (isset($params['objectPrefix'])) {
+            $this->objectPrefix = $params['objectPrefix'];
+        }
+        //initialize cache with root directory in cache
+        if (!$this->is_dir('/')) {
+            $this->mkdir('/');
+        }
+
+        $this->logger = \OC::$server->getLogger();
+    }
+
+    public function mkdir($path) {
+        $path = $this->normalizePath($path);
+
+        if ($this->file_exists($path)) {
+            return false;
+        }
+
+        $mTime = time();
+        $data = [
+            'mimetype' => 'httpd/unix-directory',
+            'size' => 0,
+            'mtime' => $mTime,
+            'storage_mtime' => $mTime,
+            'permissions' => \OCP\Constants::PERMISSION_ALL,
+        ];
+        if ($path === '') {
+            //create root on the fly
+            $data['etag'] = $this->getETag('');
+            $this->getCache()->put('', $data);
+            return true;
+        } else {
+            // if parent does not exist, create it
+            $parent = $this->normalizePath(dirname($path));
+            $parentType = $this->filetype($parent);
+            if ($parentType === false) {
+                if (!$this->mkdir($parent)) {
+                    // something went wrong
+                    return false;
+                }
+            } else if ($parentType === 'file') {
+                // parent is a file
+                return false;
+            }
+            // finally create the new dir
+            $mTime = time(); // update mtime
+            $data['mtime'] = $mTime;
+            $data['storage_mtime'] = $mTime;
+            $data['etag'] = $this->getETag($path);
+            $this->getCache()->put($path, $data);
+            return true;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    private function normalizePath($path) {
+        $path = trim($path, '/');
+        //FIXME why do we sometimes get a path like 'files//username'?
+        $path = str_replace('//', '/', $path);
+
+        // dirname('/folder') returns '.' but internally (in the cache) we store the root as ''
+        if (!$path || $path === '.') {
+            $path = '';
+        }
+
+        return $path;
+    }
+
+    /**
+     * Object Stores use a NoopScanner because metadata is directly stored in
+     * the file cache and cannot really scan the filesystem. The storage passed in is not used anywhere.
+     *
+     * @param string $path
+     * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner
+     * @return \OC\Files\ObjectStore\NoopScanner
+     */
+    public function getScanner($path = '', $storage = null) {
+        if (!$storage) {
+            $storage = $this;
+        }
+        if (!isset($this->scanner)) {
+            $this->scanner = new NoopScanner($storage);
+        }
+        return $this->scanner;
+    }
+
+    public function getId() {
+        return $this->id;
+    }
+
+    public function rmdir($path) {
+        $path = $this->normalizePath($path);
+
+        if (!$this->is_dir($path)) {
+            return false;
+        }
+
+        $this->rmObjects($path);
+
+        $this->getCache()->remove($path);
+
+        return true;
+    }
+
+    private function rmObjects($path) {
+        $children = $this->getCache()->getFolderContents($path);
+        foreach ($children as $child) {
+            if ($child['mimetype'] === 'httpd/unix-directory') {
+                $this->rmObjects($child['path']);
+            } else {
+                $this->unlink($child['path']);
+            }
+        }
+    }
+
+    public function unlink($path) {
+        $path = $this->normalizePath($path);
+        $stat = $this->stat($path);
+
+        if ($stat && isset($stat['fileid'])) {
+            if ($stat['mimetype'] === 'httpd/unix-directory') {
+                return $this->rmdir($path);
+            }
+            try {
+                $this->objectStore->deleteObject($this->getURN($stat['fileid']));
+            } catch (\Exception $ex) {
+                if ($ex->getCode() !== 404) {
+                    $this->logger->logException($ex, [
+                        'app' => 'objectstore',
+                        'message' => 'Could not delete object ' . $this->getURN($stat['fileid']) . ' for ' . $path,
+                    ]);
+                    return false;
+                }
+                //removing from cache is ok as it does not exist in the objectstore anyway
+            }
+            $this->getCache()->remove($path);
+            return true;
+        }
+        return false;
+    }
+
+    public function stat($path) {
+        $path = $this->normalizePath($path);
+        $cacheEntry = $this->getCache()->get($path);
+        if ($cacheEntry instanceof CacheEntry) {
+            return $cacheEntry->getData();
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Override this method if you need a different unique resource identifier for your object storage implementation.
+     * The default implementations just appends the fileId to 'urn:oid:'. Make sure the URN is unique over all users.
+     * You may need a mapping table to store your URN if it cannot be generated from the fileid.
+     *
+     * @param int $fileId the fileid
+     * @return null|string the unified resource name used to identify the object
+     */
+    protected function getURN($fileId) {
+        if (is_numeric($fileId)) {
+            return $this->objectPrefix . $fileId;
+        }
+        return null;
+    }
+
+    public function opendir($path) {
+        $path = $this->normalizePath($path);
+
+        try {
+            $files = array();
+            $folderContents = $this->getCache()->getFolderContents($path);
+            foreach ($folderContents as $file) {
+                $files[] = $file['name'];
+            }
+
+            return IteratorDirectory::wrap($files);
+        } catch (\Exception $e) {
+            $this->logger->logException($e);
+            return false;
+        }
+    }
+
+    public function filetype($path) {
+        $path = $this->normalizePath($path);
+        $stat = $this->stat($path);
+        if ($stat) {
+            if ($stat['mimetype'] === 'httpd/unix-directory') {
+                return 'dir';
+            }
+            return 'file';
+        } else {
+            return false;
+        }
+    }
+
+    public function fopen($path, $mode) {
+        $path = $this->normalizePath($path);
+
+        switch ($mode) {
+            case 'r':
+            case 'rb':
+                $stat = $this->stat($path);
+                if (is_array($stat)) {
+                    try {
+                        return $this->objectStore->readObject($this->getURN($stat['fileid']));
+                    } catch (\Exception $ex) {
+                        $this->logger->logException($ex, [
+                            'app' => 'objectstore',
+                            'message' => 'Count not get object ' . $this->getURN($stat['fileid']) . ' for file ' . $path,
+                        ]);
+                        return false;
+                    }
+                } else {
+                    return false;
+                }
+            case 'w':
+            case 'wb':
+            case 'a':
+            case 'ab':
+            case 'r+':
+            case 'w+':
+            case 'wb+':
+            case 'a+':
+            case 'x':
+            case 'x+':
+            case 'c':
+            case 'c+':
+                if (strrpos($path, '.') !== false) {
+                    $ext = substr($path, strrpos($path, '.'));
+                } else {
+                    $ext = '';
+                }
+                $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext);
+                if ($this->file_exists($path)) {
+                    $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);
+                });
+        }
+        return false;
+    }
+
+    public function file_exists($path) {
+        $path = $this->normalizePath($path);
+        return (bool)$this->stat($path);
+    }
+
+    public function rename($source, $target) {
+        $source = $this->normalizePath($source);
+        $target = $this->normalizePath($target);
+        $this->remove($target);
+        $this->getCache()->move($source, $target);
+        $this->touch(dirname($target));
+        return true;
+    }
+
+    public function getMimeType($path) {
+        $path = $this->normalizePath($path);
+        $stat = $this->stat($path);
+        if (is_array($stat)) {
+            return $stat['mimetype'];
+        } else {
+            return false;
+        }
+    }
+
+    public function touch($path, $mtime = null) {
+        if (is_null($mtime)) {
+            $mtime = time();
+        }
+
+        $path = $this->normalizePath($path);
+        $dirName = dirname($path);
+        $parentExists = $this->is_dir($dirName);
+        if (!$parentExists) {
+            return false;
+        }
+
+        $stat = $this->stat($path);
+        if (is_array($stat)) {
+            // update existing mtime in db
+            $stat['mtime'] = $mtime;
+            $this->getCache()->update($stat['fileid'], $stat);
+        } else {
+            try {
+                //create a empty file, need to have at least on char to make it
+                // work with all object storage implementations
+                $this->file_put_contents($path, ' ');
+                $mimeType = \OC::$server->getMimeTypeDetector()->detectPath($path);
+                $stat = array(
+                    'etag' => $this->getETag($path),
+                    'mimetype' => $mimeType,
+                    'size' => 0,
+                    'mtime' => $mtime,
+                    'storage_mtime' => $mtime,
+                    'permissions' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_CREATE,
+                );
+                $this->getCache()->put($path, $stat);
+            } catch (\Exception $ex) {
+                $this->logger->logException($ex, [
+                    'app' => 'objectstore',
+                    'message' => 'Could not create object for ' . $path,
+                ]);
+                throw $ex;
+            }
+        }
+        return true;
+    }
+
+    public function writeBack($tmpFile, $path) {
+        $stat = $this->stat($path);
+        if (empty($stat)) {
+            // create new file
+            $stat = array(
+                'permissions' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_CREATE,
+            );
+        }
+        // update stat with new data
+        $mTime = time();
+        $stat['size'] = filesize($tmpFile);
+        $stat['mtime'] = $mTime;
+        $stat['storage_mtime'] = $mTime;
+
+        // run path based detection first, to use file extension because $tmpFile is only a random string
+        $mimetypeDetector = \OC::$server->getMimeTypeDetector();
+        $mimetype = $mimetypeDetector->detectPath($path);
+        if ($mimetype === 'application/octet-stream') {
+            $mimetype = $mimetypeDetector->detect($tmpFile);
+        }
+
+        $stat['mimetype'] = $mimetype;
+        $stat['etag'] = $this->getETag($path);
+
+        $fileId = $this->getCache()->put($path, $stat);
+        try {
+            //upload to object storage
+            $this->objectStore->writeObject($this->getURN($fileId), fopen($tmpFile, 'r'));
+        } catch (\Exception $ex) {
+            $this->getCache()->remove($path);
+            $this->logger->logException($ex, [
+                'app' => 'objectstore',
+                'message' => 'Could not create object ' . $this->getURN($fileId) . ' for ' . $path,
+            ]);
+            throw $ex; // make this bubble up
+        }
+    }
+
+    /**
+     * external changes are not supported, exclusive access to the object storage is assumed
+     *
+     * @param string $path
+     * @param int $time
+     * @return false
+     */
+    public function hasUpdated($path, $time) {
+        return false;
+    }
 }

lib/private/Files/ObjectStore/Swift.php

Indentation +255 added lines, -255 removed lines

@@ -40,260 +40,260 @@
 
 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;
-			}
-		} catch (CurlException $e) {
-			if ($e->getErrorNo() === 7) {
-				$host = $e->getCurlHandle()->getUrl()->getHost() . ':' . $e->getCurlHandle()->getUrl()->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);
-			}
-			throw $e;
-		}
-	}
-
-	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;
+            }
+        } catch (CurlException $e) {
+            if ($e->getErrorNo() === 7) {
+                $host = $e->getCurlHandle()->getUrl()->getHost() . ':' . $e->getCurlHandle()->getUrl()->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);
+            }
+            throw $e;
+        }
+    }
+
+    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);
+    }
 
 }