nextcloud / server

lib/private/App/Platform.php

Unused Use Statements -1 removed lines

@@ -23,7 +23,6 @@
 
 namespace OC\App;
 
-use OC_Util;
 use OCP\IConfig;
 
 /**

Indentation +54 added lines, -54 removed lines

@@ -36,66 +36,66 @@
  */
 class Platform {
 
-	/**
-	 * @param IConfig $config
-	 */
-	function __construct(IConfig $config) {
-		$this->config = $config;
-	}
+    /**
+     * @param IConfig $config
+     */
+    function __construct(IConfig $config) {
+        $this->config = $config;
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getPhpVersion() {
-		return phpversion();
-	}
+    /**
+     * @return string
+     */
+    public function getPhpVersion() {
+        return phpversion();
+    }
 
-	/**
-	 * @return int
-	 */
-	public function getIntSize() {
-		return PHP_INT_SIZE;
-	}
+    /**
+     * @return int
+     */
+    public function getIntSize() {
+        return PHP_INT_SIZE;
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getOcVersion() {
-		$v = \OCP\Util::getVersion();
-		return join('.', $v);
-	}
+    /**
+     * @return string
+     */
+    public function getOcVersion() {
+        $v = \OCP\Util::getVersion();
+        return join('.', $v);
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getDatabase() {
-		$dbType = $this->config->getSystemValue('dbtype', 'sqlite');
-		if ($dbType === 'sqlite3') {
-			$dbType = 'sqlite';
-		}
+    /**
+     * @return string
+     */
+    public function getDatabase() {
+        $dbType = $this->config->getSystemValue('dbtype', 'sqlite');
+        if ($dbType === 'sqlite3') {
+            $dbType = 'sqlite';
+        }
 
-		return $dbType;
-	}
+        return $dbType;
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getOS() {
-		return php_uname('s');
-	}
+    /**
+     * @return string
+     */
+    public function getOS() {
+        return php_uname('s');
+    }
 
-	/**
-	 * @param $command
-	 * @return bool
-	 */
-	public function isCommandKnown($command) {
-		$path = \OC_Helper::findBinaryPath($command);
-		return ($path !== null);
-	}
+    /**
+     * @param $command
+     * @return bool
+     */
+    public function isCommandKnown($command) {
+        $path = \OC_Helper::findBinaryPath($command);
+        return ($path !== null);
+    }
 
-	public function getLibraryVersion($name) {
-		$repo = new PlatformRepository();
-		$lib = $repo->findLibrary($name);
-		return $lib;
-	}
+    public function getLibraryVersion($name) {
+        $repo = new PlatformRepository();
+        $lib = $repo->findLibrary($name);
+        return $lib;
+    }
 }

lib/private/AppFramework/Http.php

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
 
 	/**
 	 * Gets the correct header
-	 * @param Http::CONSTANT $status the constant from the Http class
+	 * @param integer $status the constant from the Http class
 	 * @param \DateTime $lastModified formatted last modified date
 	 * @param string $ETag the etag
 	 * @return string

Indentation +115 added lines, -115 removed lines

@@ -33,121 +33,121 @@
 
 class Http extends BaseHttp {
 
-	private $server;
-	private $protocolVersion;
-	protected $headers;
-
-	/**
-	 * @param array $server $_SERVER
-	 * @param string $protocolVersion the http version to use defaults to HTTP/1.1
-	 */
-	public function __construct($server, $protocolVersion='HTTP/1.1') {
-		$this->server = $server;
-		$this->protocolVersion = $protocolVersion;
-
-		$this->headers = array(
-			self::STATUS_CONTINUE => 'Continue',
-			self::STATUS_SWITCHING_PROTOCOLS => 'Switching Protocols',
-			self::STATUS_PROCESSING => 'Processing',
-			self::STATUS_OK => 'OK',
-			self::STATUS_CREATED => 'Created',
-			self::STATUS_ACCEPTED => 'Accepted',
-			self::STATUS_NON_AUTHORATIVE_INFORMATION => 'Non-Authorative Information',
-			self::STATUS_NO_CONTENT => 'No Content',
-			self::STATUS_RESET_CONTENT => 'Reset Content',
-			self::STATUS_PARTIAL_CONTENT => 'Partial Content',
-			self::STATUS_MULTI_STATUS => 'Multi-Status', // RFC 4918
-			self::STATUS_ALREADY_REPORTED => 'Already Reported', // RFC 5842
-			self::STATUS_IM_USED => 'IM Used', // RFC 3229
-			self::STATUS_MULTIPLE_CHOICES => 'Multiple Choices',
-			self::STATUS_MOVED_PERMANENTLY => 'Moved Permanently',
-			self::STATUS_FOUND => 'Found',
-			self::STATUS_SEE_OTHER => 'See Other',
-			self::STATUS_NOT_MODIFIED => 'Not Modified',
-			self::STATUS_USE_PROXY => 'Use Proxy',
-			self::STATUS_RESERVED => 'Reserved',
-			self::STATUS_TEMPORARY_REDIRECT => 'Temporary Redirect',
-			self::STATUS_BAD_REQUEST => 'Bad request',
-			self::STATUS_UNAUTHORIZED => 'Unauthorized',
-			self::STATUS_PAYMENT_REQUIRED => 'Payment Required',
-			self::STATUS_FORBIDDEN => 'Forbidden',
-			self::STATUS_NOT_FOUND => 'Not Found',
-			self::STATUS_METHOD_NOT_ALLOWED => 'Method Not Allowed',
-			self::STATUS_NOT_ACCEPTABLE => 'Not Acceptable',
-			self::STATUS_PROXY_AUTHENTICATION_REQUIRED => 'Proxy Authentication Required',
-			self::STATUS_REQUEST_TIMEOUT => 'Request Timeout',
-			self::STATUS_CONFLICT => 'Conflict',
-			self::STATUS_GONE => 'Gone',
-			self::STATUS_LENGTH_REQUIRED => 'Length Required',
-			self::STATUS_PRECONDITION_FAILED => 'Precondition failed',
-			self::STATUS_REQUEST_ENTITY_TOO_LARGE => 'Request Entity Too Large',
-			self::STATUS_REQUEST_URI_TOO_LONG => 'Request-URI Too Long',
-			self::STATUS_UNSUPPORTED_MEDIA_TYPE => 'Unsupported Media Type',
-			self::STATUS_REQUEST_RANGE_NOT_SATISFIABLE => 'Requested Range Not Satisfiable',
-			self::STATUS_EXPECTATION_FAILED => 'Expectation Failed',
-			self::STATUS_IM_A_TEAPOT => 'I\'m a teapot', // RFC 2324
-			self::STATUS_UNPROCESSABLE_ENTITY => 'Unprocessable Entity', // RFC 4918
-			self::STATUS_LOCKED => 'Locked', // RFC 4918
-			self::STATUS_FAILED_DEPENDENCY => 'Failed Dependency', // RFC 4918
-			self::STATUS_UPGRADE_REQUIRED => 'Upgrade required',
-			self::STATUS_PRECONDITION_REQUIRED => 'Precondition required', // draft-nottingham-http-new-status
-			self::STATUS_TOO_MANY_REQUESTS => 'Too Many Requests', // draft-nottingham-http-new-status
-			self::STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE => 'Request Header Fields Too Large', // draft-nottingham-http-new-status
-			self::STATUS_INTERNAL_SERVER_ERROR => 'Internal Server Error',
-			self::STATUS_NOT_IMPLEMENTED => 'Not Implemented',
-			self::STATUS_BAD_GATEWAY => 'Bad Gateway',
-			self::STATUS_SERVICE_UNAVAILABLE => 'Service Unavailable',
-			self::STATUS_GATEWAY_TIMEOUT => 'Gateway Timeout',
-			self::STATUS_HTTP_VERSION_NOT_SUPPORTED => 'HTTP Version not supported',
-			self::STATUS_VARIANT_ALSO_NEGOTIATES => 'Variant Also Negotiates',
-			self::STATUS_INSUFFICIENT_STORAGE => 'Insufficient Storage', // RFC 4918
-			self::STATUS_LOOP_DETECTED => 'Loop Detected', // RFC 5842
-			self::STATUS_BANDWIDTH_LIMIT_EXCEEDED => 'Bandwidth Limit Exceeded', // non-standard
-			self::STATUS_NOT_EXTENDED => 'Not extended',
-			self::STATUS_NETWORK_AUTHENTICATION_REQUIRED => 'Network Authentication Required', // draft-nottingham-http-new-status
-		);
-	}
-
-
-	/**
-	 * Gets the correct header
-	 * @param Http::CONSTANT $status the constant from the Http class
-	 * @param \DateTime $lastModified formatted last modified date
-	 * @param string $ETag the etag
-	 * @return string
-	 */
-	public function getStatusHeader($status, \DateTime $lastModified=null, 
-	                                $ETag=null) {
-
-		if(!is_null($lastModified)) {
-			$lastModified = $lastModified->format(\DateTime::RFC2822);
-		}
-
-		// if etag or lastmodified have not changed, return a not modified
-		if ((isset($this->server['HTTP_IF_NONE_MATCH'])
-			&& trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string)$ETag)
-
-			||
-
-			(isset($this->server['HTTP_IF_MODIFIED_SINCE'])
-			&& trim($this->server['HTTP_IF_MODIFIED_SINCE']) === 
-				$lastModified)) {
-
-			$status = self::STATUS_NOT_MODIFIED;
-		}
-
-		// we have one change currently for the http 1.0 header that differs
-		// from 1.1: STATUS_TEMPORARY_REDIRECT should be STATUS_FOUND
-		// if this differs any more, we want to create childclasses for this
-		if($status === self::STATUS_TEMPORARY_REDIRECT 
-			&& $this->protocolVersion === 'HTTP/1.0') {
-
-			$status = self::STATUS_FOUND;
-		}
-
-		return $this->protocolVersion . ' ' . $status . ' ' . 
-			$this->headers[$status];
-	}
+    private $server;
+    private $protocolVersion;
+    protected $headers;
+
+    /**
+     * @param array $server $_SERVER
+     * @param string $protocolVersion the http version to use defaults to HTTP/1.1
+     */
+    public function __construct($server, $protocolVersion='HTTP/1.1') {
+        $this->server = $server;
+        $this->protocolVersion = $protocolVersion;
+
+        $this->headers = array(
+            self::STATUS_CONTINUE => 'Continue',
+            self::STATUS_SWITCHING_PROTOCOLS => 'Switching Protocols',
+            self::STATUS_PROCESSING => 'Processing',
+            self::STATUS_OK => 'OK',
+            self::STATUS_CREATED => 'Created',
+            self::STATUS_ACCEPTED => 'Accepted',
+            self::STATUS_NON_AUTHORATIVE_INFORMATION => 'Non-Authorative Information',
+            self::STATUS_NO_CONTENT => 'No Content',
+            self::STATUS_RESET_CONTENT => 'Reset Content',
+            self::STATUS_PARTIAL_CONTENT => 'Partial Content',
+            self::STATUS_MULTI_STATUS => 'Multi-Status', // RFC 4918
+            self::STATUS_ALREADY_REPORTED => 'Already Reported', // RFC 5842
+            self::STATUS_IM_USED => 'IM Used', // RFC 3229
+            self::STATUS_MULTIPLE_CHOICES => 'Multiple Choices',
+            self::STATUS_MOVED_PERMANENTLY => 'Moved Permanently',
+            self::STATUS_FOUND => 'Found',
+            self::STATUS_SEE_OTHER => 'See Other',
+            self::STATUS_NOT_MODIFIED => 'Not Modified',
+            self::STATUS_USE_PROXY => 'Use Proxy',
+            self::STATUS_RESERVED => 'Reserved',
+            self::STATUS_TEMPORARY_REDIRECT => 'Temporary Redirect',
+            self::STATUS_BAD_REQUEST => 'Bad request',
+            self::STATUS_UNAUTHORIZED => 'Unauthorized',
+            self::STATUS_PAYMENT_REQUIRED => 'Payment Required',
+            self::STATUS_FORBIDDEN => 'Forbidden',
+            self::STATUS_NOT_FOUND => 'Not Found',
+            self::STATUS_METHOD_NOT_ALLOWED => 'Method Not Allowed',
+            self::STATUS_NOT_ACCEPTABLE => 'Not Acceptable',
+            self::STATUS_PROXY_AUTHENTICATION_REQUIRED => 'Proxy Authentication Required',
+            self::STATUS_REQUEST_TIMEOUT => 'Request Timeout',
+            self::STATUS_CONFLICT => 'Conflict',
+            self::STATUS_GONE => 'Gone',
+            self::STATUS_LENGTH_REQUIRED => 'Length Required',
+            self::STATUS_PRECONDITION_FAILED => 'Precondition failed',
+            self::STATUS_REQUEST_ENTITY_TOO_LARGE => 'Request Entity Too Large',
+            self::STATUS_REQUEST_URI_TOO_LONG => 'Request-URI Too Long',
+            self::STATUS_UNSUPPORTED_MEDIA_TYPE => 'Unsupported Media Type',
+            self::STATUS_REQUEST_RANGE_NOT_SATISFIABLE => 'Requested Range Not Satisfiable',
+            self::STATUS_EXPECTATION_FAILED => 'Expectation Failed',
+            self::STATUS_IM_A_TEAPOT => 'I\'m a teapot', // RFC 2324
+            self::STATUS_UNPROCESSABLE_ENTITY => 'Unprocessable Entity', // RFC 4918
+            self::STATUS_LOCKED => 'Locked', // RFC 4918
+            self::STATUS_FAILED_DEPENDENCY => 'Failed Dependency', // RFC 4918
+            self::STATUS_UPGRADE_REQUIRED => 'Upgrade required',
+            self::STATUS_PRECONDITION_REQUIRED => 'Precondition required', // draft-nottingham-http-new-status
+            self::STATUS_TOO_MANY_REQUESTS => 'Too Many Requests', // draft-nottingham-http-new-status
+            self::STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE => 'Request Header Fields Too Large', // draft-nottingham-http-new-status
+            self::STATUS_INTERNAL_SERVER_ERROR => 'Internal Server Error',
+            self::STATUS_NOT_IMPLEMENTED => 'Not Implemented',
+            self::STATUS_BAD_GATEWAY => 'Bad Gateway',
+            self::STATUS_SERVICE_UNAVAILABLE => 'Service Unavailable',
+            self::STATUS_GATEWAY_TIMEOUT => 'Gateway Timeout',
+            self::STATUS_HTTP_VERSION_NOT_SUPPORTED => 'HTTP Version not supported',
+            self::STATUS_VARIANT_ALSO_NEGOTIATES => 'Variant Also Negotiates',
+            self::STATUS_INSUFFICIENT_STORAGE => 'Insufficient Storage', // RFC 4918
+            self::STATUS_LOOP_DETECTED => 'Loop Detected', // RFC 5842
+            self::STATUS_BANDWIDTH_LIMIT_EXCEEDED => 'Bandwidth Limit Exceeded', // non-standard
+            self::STATUS_NOT_EXTENDED => 'Not extended',
+            self::STATUS_NETWORK_AUTHENTICATION_REQUIRED => 'Network Authentication Required', // draft-nottingham-http-new-status
+        );
+    }
+
+
+    /**
+     * Gets the correct header
+     * @param Http::CONSTANT $status the constant from the Http class
+     * @param \DateTime $lastModified formatted last modified date
+     * @param string $ETag the etag
+     * @return string
+     */
+    public function getStatusHeader($status, \DateTime $lastModified=null, 
+                                    $ETag=null) {
+
+        if(!is_null($lastModified)) {
+            $lastModified = $lastModified->format(\DateTime::RFC2822);
+        }
+
+        // if etag or lastmodified have not changed, return a not modified
+        if ((isset($this->server['HTTP_IF_NONE_MATCH'])
+            && trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string)$ETag)
+
+            ||
+
+            (isset($this->server['HTTP_IF_MODIFIED_SINCE'])
+            && trim($this->server['HTTP_IF_MODIFIED_SINCE']) === 
+                $lastModified)) {
+
+            $status = self::STATUS_NOT_MODIFIED;
+        }
+
+        // we have one change currently for the http 1.0 header that differs
+        // from 1.1: STATUS_TEMPORARY_REDIRECT should be STATUS_FOUND
+        // if this differs any more, we want to create childclasses for this
+        if($status === self::STATUS_TEMPORARY_REDIRECT 
+            && $this->protocolVersion === 'HTTP/1.0') {
+
+            $status = self::STATUS_FOUND;
+        }
+
+        return $this->protocolVersion . ' ' . $status . ' ' . 
+            $this->headers[$status];
+    }
 
 
 }

Spacing +7 added lines, -7 removed lines

@@ -41,7 +41,7 @@ 
 	 * @param array $server $_SERVER
 	 * @param string $protocolVersion the http version to use defaults to HTTP/1.1
 	 */
-	public function __construct($server, $protocolVersion='HTTP/1.1') {
+	public function __construct($server, $protocolVersion = 'HTTP/1.1') {
 		$this->server = $server;
 		$this->protocolVersion = $protocolVersion;
 
@@ -116,16 +116,16 @@ 
 	 * @param string $ETag the etag
 	 * @return string
 	 */
-	public function getStatusHeader($status, \DateTime $lastModified=null, 
-	                                $ETag=null) {
+	public function getStatusHeader($status, \DateTime $lastModified = null, 
+	                                $ETag = null) {
 
-		if(!is_null($lastModified)) {
+		if (!is_null($lastModified)) {
 			$lastModified = $lastModified->format(\DateTime::RFC2822);
 		}
 
 		// if etag or lastmodified have not changed, return a not modified
 		if ((isset($this->server['HTTP_IF_NONE_MATCH'])
-			&& trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string)$ETag)
+			&& trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string) $ETag)
 
 			||
 
@@ -139,13 +139,13 @@ 
 		// we have one change currently for the http 1.0 header that differs
 		// from 1.1: STATUS_TEMPORARY_REDIRECT should be STATUS_FOUND
 		// if this differs any more, we want to create childclasses for this
-		if($status === self::STATUS_TEMPORARY_REDIRECT 
+		if ($status === self::STATUS_TEMPORARY_REDIRECT 
 			&& $this->protocolVersion === 'HTTP/1.0') {
 
 			$status = self::STATUS_FOUND;
 		}
 
-		return $this->protocolVersion . ' ' . $status . ' ' . 
+		return $this->protocolVersion.' '.$status.' '. 
 			$this->headers[$status];
 	}
 

lib/private/AppFramework/Utility/ControllerMethodReflector.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 
 
 	/**
-	 * @param object $object an object or classname
+	 * @param \OCP\AppFramework\Controller $object an object or classname
 	 * @param string $method the method which we want to inspect
 	 */
 	public function reflect($object, $method){

Indentation +79 added lines, -79 removed lines

@@ -35,85 +35,85 @@
  */
 class ControllerMethodReflector implements IControllerMethodReflector{
 
-	private $annotations;
-	private $types;
-	private $parameters;
-
-	public function __construct() {
-		$this->types = array();
-		$this->parameters = array();
-		$this->annotations = array();
-	}
-
-
-	/**
-	 * @param object $object an object or classname
-	 * @param string $method the method which we want to inspect
-	 */
-	public function reflect($object, $method){
-		$reflection = new \ReflectionMethod($object, $method);
-		$docs = $reflection->getDocComment();
-
-		// extract everything prefixed by @ and first letter uppercase
-		preg_match_all('/@([A-Z]\w+)/', $docs, $matches);
-		$this->annotations = $matches[1];
-
-		// extract type parameter information
-		preg_match_all('/@param\h+(?P<type>\w+)\h+\$(?P<var>\w+)/', $docs, $matches);
-		$this->types = array_combine($matches['var'], $matches['type']);
-
-		foreach ($reflection->getParameters() as $param) {
-			// extract type information from PHP 7 scalar types and prefer them
-			// over phpdoc annotations
-			if (method_exists($param, 'getType')) {
-				$type = $param->getType();
-				if ($type !== null) {
-					$this->types[$param->getName()] = (string) $type;
-				}
-			}
-
-			if($param->isOptional()) {
-				$default = $param->getDefaultValue();
-			} else {
-				$default = null;
-			}
-			$this->parameters[$param->name] = $default;
-		}
-	}
-
-
-	/**
-	 * Inspects the PHPDoc parameters for types
-	 * @param string $parameter the parameter whose type comments should be
-	 * parsed
-	 * @return string|null type in the type parameters (@param int $something)
-	 * would return int or null if not existing
-	 */
-	public function getType($parameter) {
-		if(array_key_exists($parameter, $this->types)) {
-			return $this->types[$parameter];
-		} else {
-			return null;
-		}
-	}
-
-
-	/**
-	 * @return array the arguments of the method with key => default value
-	 */
-	public function getParameters() {
-		return $this->parameters;
-	}
-
-
-	/**
-	 * Check if a method contains an annotation
-	 * @param string $name the name of the annotation
-	 * @return bool true if the annotation is found
-	 */
-	public function hasAnnotation($name){
-		return in_array($name, $this->annotations);
-	}
+    private $annotations;
+    private $types;
+    private $parameters;
+
+    public function __construct() {
+        $this->types = array();
+        $this->parameters = array();
+        $this->annotations = array();
+    }
+
+
+    /**
+     * @param object $object an object or classname
+     * @param string $method the method which we want to inspect
+     */
+    public function reflect($object, $method){
+        $reflection = new \ReflectionMethod($object, $method);
+        $docs = $reflection->getDocComment();
+
+        // extract everything prefixed by @ and first letter uppercase
+        preg_match_all('/@([A-Z]\w+)/', $docs, $matches);
+        $this->annotations = $matches[1];
+
+        // extract type parameter information
+        preg_match_all('/@param\h+(?P<type>\w+)\h+\$(?P<var>\w+)/', $docs, $matches);
+        $this->types = array_combine($matches['var'], $matches['type']);
+
+        foreach ($reflection->getParameters() as $param) {
+            // extract type information from PHP 7 scalar types and prefer them
+            // over phpdoc annotations
+            if (method_exists($param, 'getType')) {
+                $type = $param->getType();
+                if ($type !== null) {
+                    $this->types[$param->getName()] = (string) $type;
+                }
+            }
+
+            if($param->isOptional()) {
+                $default = $param->getDefaultValue();
+            } else {
+                $default = null;
+            }
+            $this->parameters[$param->name] = $default;
+        }
+    }
+
+
+    /**
+     * Inspects the PHPDoc parameters for types
+     * @param string $parameter the parameter whose type comments should be
+     * parsed
+     * @return string|null type in the type parameters (@param int $something)
+     * would return int or null if not existing
+     */
+    public function getType($parameter) {
+        if(array_key_exists($parameter, $this->types)) {
+            return $this->types[$parameter];
+        } else {
+            return null;
+        }
+    }
+
+
+    /**
+     * @return array the arguments of the method with key => default value
+     */
+    public function getParameters() {
+        return $this->parameters;
+    }
+
+
+    /**
+     * Check if a method contains an annotation
+     * @param string $name the name of the annotation
+     * @return bool true if the annotation is found
+     */
+    public function hasAnnotation($name){
+        return in_array($name, $this->annotations);
+    }
 
 
 }

Spacing +5 added lines, -5 removed lines

@@ -33,7 +33,7 @@ 
 /**
  * Reads and parses annotations from doc comments
  */
-class ControllerMethodReflector implements IControllerMethodReflector{
+class ControllerMethodReflector implements IControllerMethodReflector {
 
 	private $annotations;
 	private $types;
@@ -50,7 +50,7 @@ 
 	 * @param object $object an object or classname
 	 * @param string $method the method which we want to inspect
 	 */
-	public function reflect($object, $method){
+	public function reflect($object, $method) {
 		$reflection = new \ReflectionMethod($object, $method);
 		$docs = $reflection->getDocComment();
 
@@ -72,7 +72,7 @@ 
 				}
 			}
 
-			if($param->isOptional()) {
+			if ($param->isOptional()) {
 				$default = $param->getDefaultValue();
 			} else {
 				$default = null;
@@ -90,7 +90,7 @@ 
 	 * would return int or null if not existing
 	 */
 	public function getType($parameter) {
-		if(array_key_exists($parameter, $this->types)) {
+		if (array_key_exists($parameter, $this->types)) {
 			return $this->types[$parameter];
 		} else {
 			return null;
@@ -111,7 +111,7 @@ 
 	 * @param string $name the name of the annotation
 	 * @return bool true if the annotation is found
 	 */
-	public function hasAnnotation($name){
+	public function hasAnnotation($name) {
 		return in_array($name, $this->annotations);
 	}
 

lib/private/Cache/File.php

Doc Comments +2 added lines, -2 removed lines

@@ -92,9 +92,9 @@
 
 	/**
 	 * @param string $key
-	 * @param mixed $value
+	 * @param string|null $value
 	 * @param int $ttl
-	 * @return bool|mixed
+	 * @return boolean
 	 * @throws \OC\ForbiddenException
 	 */
 	public function set($key, $value, $ttl = 0) {

Indentation +157 added lines, -157 removed lines

@@ -33,170 +33,170 @@
 
 class File implements ICache {
 
-	/** @var View */
-	protected $storage;
+    /** @var View */
+    protected $storage;
 
-	/**
-	 * Returns the cache storage for the logged in user
-	 *
-	 * @return \OC\Files\View cache storage
-	 * @throws \OC\ForbiddenException
-	 * @throws \OC\User\NoUserException
-	 */
-	protected function getStorage() {
-		if (isset($this->storage)) {
-			return $this->storage;
-		}
-		if (\OC_User::isLoggedIn()) {
-			$rootView = new View();
-			$user = \OC::$server->getUserSession()->getUser();
-			Filesystem::initMountPoints($user->getUID());
-			if (!$rootView->file_exists('/' . $user->getUID() . '/cache')) {
-				$rootView->mkdir('/' . $user->getUID() . '/cache');
-			}
-			$this->storage = new View('/' . $user->getUID() . '/cache');
-			return $this->storage;
-		} else {
-			\OCP\Util::writeLog('core', 'Can\'t get cache storage, user not logged in', \OCP\Util::ERROR);
-			throw new \OC\ForbiddenException('Can\t get cache storage, user not logged in');
-		}
-	}
+    /**
+     * Returns the cache storage for the logged in user
+     *
+     * @return \OC\Files\View cache storage
+     * @throws \OC\ForbiddenException
+     * @throws \OC\User\NoUserException
+     */
+    protected function getStorage() {
+        if (isset($this->storage)) {
+            return $this->storage;
+        }
+        if (\OC_User::isLoggedIn()) {
+            $rootView = new View();
+            $user = \OC::$server->getUserSession()->getUser();
+            Filesystem::initMountPoints($user->getUID());
+            if (!$rootView->file_exists('/' . $user->getUID() . '/cache')) {
+                $rootView->mkdir('/' . $user->getUID() . '/cache');
+            }
+            $this->storage = new View('/' . $user->getUID() . '/cache');
+            return $this->storage;
+        } else {
+            \OCP\Util::writeLog('core', 'Can\'t get cache storage, user not logged in', \OCP\Util::ERROR);
+            throw new \OC\ForbiddenException('Can\t get cache storage, user not logged in');
+        }
+    }
 
-	/**
-	 * @param string $key
-	 * @return mixed|null
-	 * @throws \OC\ForbiddenException
-	 */
-	public function get($key) {
-		$result = null;
-		if ($this->hasKey($key)) {
-			$storage = $this->getStorage();
-			$result = $storage->file_get_contents($key);
-		}
-		return $result;
-	}
+    /**
+     * @param string $key
+     * @return mixed|null
+     * @throws \OC\ForbiddenException
+     */
+    public function get($key) {
+        $result = null;
+        if ($this->hasKey($key)) {
+            $storage = $this->getStorage();
+            $result = $storage->file_get_contents($key);
+        }
+        return $result;
+    }
 
-	/**
-	 * Returns the size of the stored/cached data
-	 *
-	 * @param string $key
-	 * @return int
-	 */
-	public function size($key) {
-		$result = 0;
-		if ($this->hasKey($key)) {
-			$storage = $this->getStorage();
-			$result = $storage->filesize($key);
-		}
-		return $result;
-	}
+    /**
+     * Returns the size of the stored/cached data
+     *
+     * @param string $key
+     * @return int
+     */
+    public function size($key) {
+        $result = 0;
+        if ($this->hasKey($key)) {
+            $storage = $this->getStorage();
+            $result = $storage->filesize($key);
+        }
+        return $result;
+    }
 
-	/**
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl
-	 * @return bool|mixed
-	 * @throws \OC\ForbiddenException
-	 */
-	public function set($key, $value, $ttl = 0) {
-		$storage = $this->getStorage();
-		$result = false;
-		// unique id to avoid chunk collision, just in case
-		$uniqueId = \OC::$server->getSecureRandom()->generate(
-			16,
-			ISecureRandom::CHAR_DIGITS . ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER
-		);
+    /**
+     * @param string $key
+     * @param mixed $value
+     * @param int $ttl
+     * @return bool|mixed
+     * @throws \OC\ForbiddenException
+     */
+    public function set($key, $value, $ttl = 0) {
+        $storage = $this->getStorage();
+        $result = false;
+        // unique id to avoid chunk collision, just in case
+        $uniqueId = \OC::$server->getSecureRandom()->generate(
+            16,
+            ISecureRandom::CHAR_DIGITS . ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER
+        );
 
-		// use part file to prevent hasKey() to find the key
-		// while it is being written
-		$keyPart = $key . '.' . $uniqueId . '.part';
-		if ($storage and $storage->file_put_contents($keyPart, $value)) {
-			if ($ttl === 0) {
-				$ttl = 86400; // 60*60*24
-			}
-			$result = $storage->touch($keyPart, time() + $ttl);
-			$result &= $storage->rename($keyPart, $key);
-		}
-		return $result;
-	}
+        // use part file to prevent hasKey() to find the key
+        // while it is being written
+        $keyPart = $key . '.' . $uniqueId . '.part';
+        if ($storage and $storage->file_put_contents($keyPart, $value)) {
+            if ($ttl === 0) {
+                $ttl = 86400; // 60*60*24
+            }
+            $result = $storage->touch($keyPart, time() + $ttl);
+            $result &= $storage->rename($keyPart, $key);
+        }
+        return $result;
+    }
 
-	/**
-	 * @param string $key
-	 * @return bool
-	 * @throws \OC\ForbiddenException
-	 */
-	public function hasKey($key) {
-		$storage = $this->getStorage();
-		if ($storage && $storage->is_file($key) && $storage->isReadable($key)) {
-			return true;
-		}
-		return false;
-	}
+    /**
+     * @param string $key
+     * @return bool
+     * @throws \OC\ForbiddenException
+     */
+    public function hasKey($key) {
+        $storage = $this->getStorage();
+        if ($storage && $storage->is_file($key) && $storage->isReadable($key)) {
+            return true;
+        }
+        return false;
+    }
 
-	/**
-	 * @param string $key
-	 * @return bool|mixed
-	 * @throws \OC\ForbiddenException
-	 */
-	public function remove($key) {
-		$storage = $this->getStorage();
-		if (!$storage) {
-			return false;
-		}
-		return $storage->unlink($key);
-	}
+    /**
+     * @param string $key
+     * @return bool|mixed
+     * @throws \OC\ForbiddenException
+     */
+    public function remove($key) {
+        $storage = $this->getStorage();
+        if (!$storage) {
+            return false;
+        }
+        return $storage->unlink($key);
+    }
 
-	/**
-	 * @param string $prefix
-	 * @return bool
-	 * @throws \OC\ForbiddenException
-	 */
-	public function clear($prefix = '') {
-		$storage = $this->getStorage();
-		if ($storage and $storage->is_dir('/')) {
-			$dh = $storage->opendir('/');
-			if (is_resource($dh)) {
-				while (($file = readdir($dh)) !== false) {
-					if ($file != '.' and $file != '..' and ($prefix === '' || strpos($file, $prefix) === 0)) {
-						$storage->unlink('/' . $file);
-					}
-				}
-			}
-		}
-		return true;
-	}
+    /**
+     * @param string $prefix
+     * @return bool
+     * @throws \OC\ForbiddenException
+     */
+    public function clear($prefix = '') {
+        $storage = $this->getStorage();
+        if ($storage and $storage->is_dir('/')) {
+            $dh = $storage->opendir('/');
+            if (is_resource($dh)) {
+                while (($file = readdir($dh)) !== false) {
+                    if ($file != '.' and $file != '..' and ($prefix === '' || strpos($file, $prefix) === 0)) {
+                        $storage->unlink('/' . $file);
+                    }
+                }
+            }
+        }
+        return true;
+    }
 
-	/**
-	 * Runs GC
-	 * @throws \OC\ForbiddenException
-	 */
-	public function gc() {
-		$storage = $this->getStorage();
-		if ($storage and $storage->is_dir('/')) {
-			// extra hour safety, in case of stray part chunks that take longer to write,
-			// because touch() is only called after the chunk was finished
-			$now = time() - 3600;
-			$dh = $storage->opendir('/');
-			if (!is_resource($dh)) {
-				return null;
-			}
-			while (($file = readdir($dh)) !== false) {
-				if ($file != '.' and $file != '..') {
-					try {
-						$mtime = $storage->filemtime('/' . $file);
-						if ($mtime < $now) {
-							$storage->unlink('/' . $file);
-						}
-					} catch (\OCP\Lock\LockedException $e) {
-						// ignore locked chunks
-						\OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', array('app' => 'core'));
-					} catch (\OCP\Files\ForbiddenException $e) {
-						\OC::$server->getLogger()->debug('Could not cleanup forbidden chunk "' . $file . '"', array('app' => 'core'));
-					} catch (\OCP\Files\LockNotAcquiredException $e) {
-						\OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', array('app' => 'core'));
-					}
-				}
-			}
-		}
-	}
+    /**
+     * Runs GC
+     * @throws \OC\ForbiddenException
+     */
+    public function gc() {
+        $storage = $this->getStorage();
+        if ($storage and $storage->is_dir('/')) {
+            // extra hour safety, in case of stray part chunks that take longer to write,
+            // because touch() is only called after the chunk was finished
+            $now = time() - 3600;
+            $dh = $storage->opendir('/');
+            if (!is_resource($dh)) {
+                return null;
+            }
+            while (($file = readdir($dh)) !== false) {
+                if ($file != '.' and $file != '..') {
+                    try {
+                        $mtime = $storage->filemtime('/' . $file);
+                        if ($mtime < $now) {
+                            $storage->unlink('/' . $file);
+                        }
+                    } catch (\OCP\Lock\LockedException $e) {
+                        // ignore locked chunks
+                        \OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', array('app' => 'core'));
+                    } catch (\OCP\Files\ForbiddenException $e) {
+                        \OC::$server->getLogger()->debug('Could not cleanup forbidden chunk "' . $file . '"', array('app' => 'core'));
+                    } catch (\OCP\Files\LockNotAcquiredException $e) {
+                        \OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', array('app' => 'core'));
+                    }
+                }
+            }
+        }
+    }
 }

Spacing +11 added lines, -11 removed lines

@@ -51,10 +51,10 @@ 
 			$rootView = new View();
 			$user = \OC::$server->getUserSession()->getUser();
 			Filesystem::initMountPoints($user->getUID());
-			if (!$rootView->file_exists('/' . $user->getUID() . '/cache')) {
-				$rootView->mkdir('/' . $user->getUID() . '/cache');
+			if (!$rootView->file_exists('/'.$user->getUID().'/cache')) {
+				$rootView->mkdir('/'.$user->getUID().'/cache');
 			}
-			$this->storage = new View('/' . $user->getUID() . '/cache');
+			$this->storage = new View('/'.$user->getUID().'/cache');
 			return $this->storage;
 		} else {
 			\OCP\Util::writeLog('core', 'Can\'t get cache storage, user not logged in', \OCP\Util::ERROR);
@@ -104,12 +104,12 @@ 
 		// unique id to avoid chunk collision, just in case
 		$uniqueId = \OC::$server->getSecureRandom()->generate(
 			16,
-			ISecureRandom::CHAR_DIGITS . ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER
+			ISecureRandom::CHAR_DIGITS.ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_UPPER
 		);
 
 		// use part file to prevent hasKey() to find the key
 		// while it is being written
-		$keyPart = $key . '.' . $uniqueId . '.part';
+		$keyPart = $key.'.'.$uniqueId.'.part';
 		if ($storage and $storage->file_put_contents($keyPart, $value)) {
 			if ($ttl === 0) {
 				$ttl = 86400; // 60*60*24
@@ -158,7 +158,7 @@ 
 			if (is_resource($dh)) {
 				while (($file = readdir($dh)) !== false) {
 					if ($file != '.' and $file != '..' and ($prefix === '' || strpos($file, $prefix) === 0)) {
-						$storage->unlink('/' . $file);
+						$storage->unlink('/'.$file);
 					}
 				}
 			}
@@ -183,17 +183,17 @@ 
 			while (($file = readdir($dh)) !== false) {
 				if ($file != '.' and $file != '..') {
 					try {
-						$mtime = $storage->filemtime('/' . $file);
+						$mtime = $storage->filemtime('/'.$file);
 						if ($mtime < $now) {
-							$storage->unlink('/' . $file);
+							$storage->unlink('/'.$file);
 						}
 					} catch (\OCP\Lock\LockedException $e) {
 						// ignore locked chunks
-						\OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', array('app' => 'core'));
+						\OC::$server->getLogger()->debug('Could not cleanup locked chunk "'.$file.'"', array('app' => 'core'));
 					} catch (\OCP\Files\ForbiddenException $e) {
-						\OC::$server->getLogger()->debug('Could not cleanup forbidden chunk "' . $file . '"', array('app' => 'core'));
+						\OC::$server->getLogger()->debug('Could not cleanup forbidden chunk "'.$file.'"', array('app' => 'core'));
 					} catch (\OCP\Files\LockNotAcquiredException $e) {
-						\OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', array('app' => 'core'));
+						\OC::$server->getLogger()->debug('Could not cleanup locked chunk "'.$file.'"', array('app' => 'core'));
 					}
 				}
 			}

lib/private/Comments/Manager.php

Doc Comments +1 added lines, -1 removed lines

@@ -205,7 +205,7 @@
 	/**
 	 * removes an entry from the comments run time cache
 	 *
-	 * @param mixed $id the comment's id
+	 * @param string $id the comment's id
 	 */
 	protected function uncache($id) {
 		$id = strval($id);

Indentation +714 added lines, -714 removed lines

@@ -37,718 +37,718 @@
 
 class Manager implements ICommentsManager {
 
-	/** @var  IDBConnection */
-	protected $dbConn;
-
-	/** @var  ILogger */
-	protected $logger;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var EventDispatcherInterface */
-	protected $dispatcher;
-
-	/** @var IComment[]  */
-	protected $commentsCache = [];
-
-	/**
-	 * Manager constructor.
-	 *
-	 * @param IDBConnection $dbConn
-	 * @param ILogger $logger
-	 * @param IConfig $config
-	 * @param EventDispatcherInterface $dispatcher
-	 */
-	public function __construct(
-		IDBConnection $dbConn,
-		ILogger $logger,
-		IConfig $config,
-		EventDispatcherInterface $dispatcher
-	) {
-		$this->dbConn = $dbConn;
-		$this->logger = $logger;
-		$this->config = $config;
-		$this->dispatcher = $dispatcher;
-	}
-
-	/**
-	 * converts data base data into PHP native, proper types as defined by
-	 * IComment interface.
-	 *
-	 * @param array $data
-	 * @return array
-	 */
-	protected function normalizeDatabaseData(array $data) {
-		$data['id'] = strval($data['id']);
-		$data['parent_id'] = strval($data['parent_id']);
-		$data['topmost_parent_id'] = strval($data['topmost_parent_id']);
-		$data['creation_timestamp'] = new \DateTime($data['creation_timestamp']);
-		if (!is_null($data['latest_child_timestamp'])) {
-			$data['latest_child_timestamp'] = new \DateTime($data['latest_child_timestamp']);
-		}
-		$data['children_count'] = intval($data['children_count']);
-		return $data;
-	}
-
-	/**
-	 * prepares a comment for an insert or update operation after making sure
-	 * all necessary fields have a value assigned.
-	 *
-	 * @param IComment $comment
-	 * @return IComment returns the same updated IComment instance as provided
-	 *                  by parameter for convenience
-	 * @throws \UnexpectedValueException
-	 */
-	protected function prepareCommentForDatabaseWrite(IComment $comment) {
-		if(    !$comment->getActorType()
-			|| !$comment->getActorId()
-			|| !$comment->getObjectType()
-			|| !$comment->getObjectId()
-			|| !$comment->getVerb()
-		) {
-			throw new \UnexpectedValueException('Actor, Object and Verb information must be provided for saving');
-		}
-
-		if($comment->getId() === '') {
-			$comment->setChildrenCount(0);
-			$comment->setLatestChildDateTime(new \DateTime('0000-00-00 00:00:00', new \DateTimeZone('UTC')));
-			$comment->setLatestChildDateTime(null);
-		}
-
-		if(is_null($comment->getCreationDateTime())) {
-			$comment->setCreationDateTime(new \DateTime());
-		}
-
-		if($comment->getParentId() !== '0') {
-			$comment->setTopmostParentId($this->determineTopmostParentId($comment->getParentId()));
-		} else {
-			$comment->setTopmostParentId('0');
-		}
-
-		$this->cache($comment);
-
-		return $comment;
-	}
-
-	/**
-	 * returns the topmost parent id of a given comment identified by ID
-	 *
-	 * @param string $id
-	 * @return string
-	 * @throws NotFoundException
-	 */
-	protected function determineTopmostParentId($id) {
-		$comment = $this->get($id);
-		if($comment->getParentId() === '0') {
-			return $comment->getId();
-		} else {
-			return $this->determineTopmostParentId($comment->getId());
-		}
-	}
-
-	/**
-	 * updates child information of a comment
-	 *
-	 * @param string	$id
-	 * @param \DateTime	$cDateTime	the date time of the most recent child
-	 * @throws NotFoundException
-	 */
-	protected function updateChildrenInformation($id, \DateTime $cDateTime) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select($qb->createFunction('COUNT(`id`)'))
-				->from('comments')
-				->where($qb->expr()->eq('parent_id', $qb->createParameter('id')))
-				->setParameter('id', $id);
-
-		$resultStatement = $query->execute();
-		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
-		$resultStatement->closeCursor();
-		$children = intval($data[0]);
-
-		$comment = $this->get($id);
-		$comment->setChildrenCount($children);
-		$comment->setLatestChildDateTime($cDateTime);
-		$this->save($comment);
-	}
-
-	/**
-	 * Tests whether actor or object type and id parameters are acceptable.
-	 * Throws exception if not.
-	 *
-	 * @param string $role
-	 * @param string $type
-	 * @param string $id
-	 * @throws \InvalidArgumentException
-	 */
-	protected function checkRoleParameters($role, $type, $id) {
-		if(
-			   !is_string($type) || empty($type)
-			|| !is_string($id) || empty($id)
-		) {
-			throw new \InvalidArgumentException($role . ' parameters must be string and not empty');
-		}
-	}
-
-	/**
-	 * run-time caches a comment
-	 *
-	 * @param IComment $comment
-	 */
-	protected function cache(IComment $comment) {
-		$id = $comment->getId();
-		if(empty($id)) {
-			return;
-		}
-		$this->commentsCache[strval($id)] = $comment;
-	}
-
-	/**
-	 * removes an entry from the comments run time cache
-	 *
-	 * @param mixed $id the comment's id
-	 */
-	protected function uncache($id) {
-		$id = strval($id);
-		if (isset($this->commentsCache[$id])) {
-			unset($this->commentsCache[$id]);
-		}
-	}
-
-	/**
-	 * returns a comment instance
-	 *
-	 * @param string $id the ID of the comment
-	 * @return IComment
-	 * @throws NotFoundException
-	 * @throws \InvalidArgumentException
-	 * @since 9.0.0
-	 */
-	public function get($id) {
-		if(intval($id) === 0) {
-			throw new \InvalidArgumentException('IDs must be translatable to a number in this implementation.');
-		}
-
-		if(isset($this->commentsCache[$id])) {
-			return $this->commentsCache[$id];
-		}
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$resultStatement = $qb->select('*')
-			->from('comments')
-			->where($qb->expr()->eq('id', $qb->createParameter('id')))
-			->setParameter('id', $id, IQueryBuilder::PARAM_INT)
-			->execute();
-
-		$data = $resultStatement->fetch();
-		$resultStatement->closeCursor();
-		if(!$data) {
-			throw new NotFoundException();
-		}
-
-		$comment = new Comment($this->normalizeDatabaseData($data));
-		$this->cache($comment);
-		return $comment;
-	}
-
-	/**
-	 * returns the comment specified by the id and all it's child comments.
-	 * At this point of time, we do only support one level depth.
-	 *
-	 * @param string $id
-	 * @param int $limit max number of entries to return, 0 returns all
-	 * @param int $offset the start entry
-	 * @return array
-	 * @since 9.0.0
-	 *
-	 * The return array looks like this
-	 * [
-	 *   'comment' => IComment, // root comment
-	 *   'replies' =>
-	 *   [
-	 *     0 =>
-	 *     [
-	 *       'comment' => IComment,
-	 *       'replies' => []
-	 *     ]
-	 *     1 =>
-	 *     [
-	 *       'comment' => IComment,
-	 *       'replies'=> []
-	 *     ],
-	 *     …
-	 *   ]
-	 * ]
-	 */
-	public function getTree($id, $limit = 0, $offset = 0) {
-		$tree = [];
-		$tree['comment'] = $this->get($id);
-		$tree['replies'] = [];
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select('*')
-				->from('comments')
-				->where($qb->expr()->eq('topmost_parent_id', $qb->createParameter('id')))
-				->orderBy('creation_timestamp', 'DESC')
-				->setParameter('id', $id);
-
-		if($limit > 0) {
-			$query->setMaxResults($limit);
-		}
-		if($offset > 0) {
-			$query->setFirstResult($offset);
-		}
-
-		$resultStatement = $query->execute();
-		while($data = $resultStatement->fetch()) {
-			$comment = new Comment($this->normalizeDatabaseData($data));
-			$this->cache($comment);
-			$tree['replies'][] = [
-				'comment' => $comment,
-				'replies' => []
-			];
-		}
-		$resultStatement->closeCursor();
-
-		return $tree;
-	}
-
-	/**
-	 * returns comments for a specific object (e.g. a file).
-	 *
-	 * The sort order is always newest to oldest.
-	 *
-	 * @param string $objectType the object type, e.g. 'files'
-	 * @param string $objectId the id of the object
-	 * @param int $limit optional, number of maximum comments to be returned. if
-	 * not specified, all comments are returned.
-	 * @param int $offset optional, starting point
-	 * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
-	 * that may be returned
-	 * @return IComment[]
-	 * @since 9.0.0
-	 */
-	public function getForObject(
-			$objectType,
-			$objectId,
-			$limit = 0,
-			$offset = 0,
-			\DateTime $notOlderThan = null
-	) {
-		$comments = [];
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select('*')
-				->from('comments')
-				->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
-				->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
-				->orderBy('creation_timestamp', 'DESC')
-				->setParameter('type', $objectType)
-				->setParameter('id', $objectId);
-
-		if($limit > 0) {
-			$query->setMaxResults($limit);
-		}
-		if($offset > 0) {
-			$query->setFirstResult($offset);
-		}
-		if(!is_null($notOlderThan)) {
-			$query
-				->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
-				->setParameter('notOlderThan', $notOlderThan, 'datetime');
-		}
-
-		$resultStatement = $query->execute();
-		while($data = $resultStatement->fetch()) {
-			$comment = new Comment($this->normalizeDatabaseData($data));
-			$this->cache($comment);
-			$comments[] = $comment;
-		}
-		$resultStatement->closeCursor();
-
-		return $comments;
-	}
-
-	/**
-	 * @param $objectType string the object type, e.g. 'files'
-	 * @param $objectId string the id of the object
-	 * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
-	 * that may be returned
-	 * @return Int
-	 * @since 9.0.0
-	 */
-	public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select($qb->createFunction('COUNT(`id`)'))
-				->from('comments')
-				->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
-				->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
-				->setParameter('type', $objectType)
-				->setParameter('id', $objectId);
-
-		if(!is_null($notOlderThan)) {
-			$query
-				->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
-				->setParameter('notOlderThan', $notOlderThan, 'datetime');
-		}
-
-		$resultStatement = $query->execute();
-		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
-		$resultStatement->closeCursor();
-		return intval($data[0]);
-	}
-
-	/**
-	 * creates a new comment and returns it. At this point of time, it is not
-	 * saved in the used data storage. Use save() after setting other fields
-	 * of the comment (e.g. message or verb).
-	 *
-	 * @param string $actorType the actor type (e.g. 'users')
-	 * @param string $actorId a user id
-	 * @param string $objectType the object type the comment is attached to
-	 * @param string $objectId the object id the comment is attached to
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function create($actorType, $actorId, $objectType, $objectId) {
-		$comment = new Comment();
-		$comment
-			->setActor($actorType, $actorId)
-			->setObject($objectType, $objectId);
-		return $comment;
-	}
-
-	/**
-	 * permanently deletes the comment specified by the ID
-	 *
-	 * When the comment has child comments, their parent ID will be changed to
-	 * the parent ID of the item that is to be deleted.
-	 *
-	 * @param string $id
-	 * @return bool
-	 * @throws \InvalidArgumentException
-	 * @since 9.0.0
-	 */
-	public function delete($id) {
-		if(!is_string($id)) {
-			throw new \InvalidArgumentException('Parameter must be string');
-		}
-
-		try {
-			$comment = $this->get($id);
-		} catch (\Exception $e) {
-			// Ignore exceptions, we just don't fire a hook then
-			$comment = null;
-		}
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->delete('comments')
-			->where($qb->expr()->eq('id', $qb->createParameter('id')))
-			->setParameter('id', $id);
-
-		try {
-			$affectedRows = $query->execute();
-			$this->uncache($id);
-		} catch (DriverException $e) {
-			$this->logger->logException($e, ['app' => 'core_comments']);
-			return false;
-		}
-
-		if ($affectedRows > 0 && $comment instanceof IComment) {
-			$this->dispatcher->dispatch(CommentsEvent::EVENT_DELETE, new CommentsEvent(
-				CommentsEvent::EVENT_DELETE,
-				$comment
-			));
-		}
-
-		return ($affectedRows > 0);
-	}
-
-	/**
-	 * saves the comment permanently
-	 *
-	 * if the supplied comment has an empty ID, a new entry comment will be
-	 * saved and the instance updated with the new ID.
-	 *
-	 * Otherwise, an existing comment will be updated.
-	 *
-	 * Throws NotFoundException when a comment that is to be updated does not
-	 * exist anymore at this point of time.
-	 *
-	 * @param IComment $comment
-	 * @return bool
-	 * @throws NotFoundException
-	 * @since 9.0.0
-	 */
-	public function save(IComment $comment) {
-		if($this->prepareCommentForDatabaseWrite($comment)->getId() === '') {
-			$result = $this->insert($comment);
-		} else {
-			$result = $this->update($comment);
-		}
-
-		if($result && !!$comment->getParentId()) {
-			$this->updateChildrenInformation(
-					$comment->getParentId(),
-					$comment->getCreationDateTime()
-			);
-			$this->cache($comment);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * inserts the provided comment in the database
-	 *
-	 * @param IComment $comment
-	 * @return bool
-	 */
-	protected function insert(IComment &$comment) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->insert('comments')
-			->values([
-				'parent_id'					=> $qb->createNamedParameter($comment->getParentId()),
-				'topmost_parent_id' 		=> $qb->createNamedParameter($comment->getTopmostParentId()),
-				'children_count' 			=> $qb->createNamedParameter($comment->getChildrenCount()),
-				'actor_type' 				=> $qb->createNamedParameter($comment->getActorType()),
-				'actor_id' 					=> $qb->createNamedParameter($comment->getActorId()),
-				'message' 					=> $qb->createNamedParameter($comment->getMessage()),
-				'verb' 						=> $qb->createNamedParameter($comment->getVerb()),
-				'creation_timestamp' 		=> $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'),
-				'latest_child_timestamp'	=> $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'),
-				'object_type' 				=> $qb->createNamedParameter($comment->getObjectType()),
-				'object_id' 				=> $qb->createNamedParameter($comment->getObjectId()),
-			])
-			->execute();
-
-		if ($affectedRows > 0) {
-			$comment->setId(strval($qb->getLastInsertId()));
-		}
-
-		$this->dispatcher->dispatch(CommentsEvent::EVENT_ADD, new CommentsEvent(
-			CommentsEvent::EVENT_ADD,
-			$comment
-		));
-
-		return $affectedRows > 0;
-	}
-
-	/**
-	 * updates a Comment data row
-	 *
-	 * @param IComment $comment
-	 * @return bool
-	 * @throws NotFoundException
-	 */
-	protected function update(IComment $comment) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->update('comments')
-				->set('parent_id',				$qb->createNamedParameter($comment->getParentId()))
-				->set('topmost_parent_id', 		$qb->createNamedParameter($comment->getTopmostParentId()))
-				->set('children_count',			$qb->createNamedParameter($comment->getChildrenCount()))
-				->set('actor_type', 			$qb->createNamedParameter($comment->getActorType()))
-				->set('actor_id', 				$qb->createNamedParameter($comment->getActorId()))
-				->set('message',				$qb->createNamedParameter($comment->getMessage()))
-				->set('verb',					$qb->createNamedParameter($comment->getVerb()))
-				->set('creation_timestamp',		$qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'))
-				->set('latest_child_timestamp',	$qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'))
-				->set('object_type',			$qb->createNamedParameter($comment->getObjectType()))
-				->set('object_id',				$qb->createNamedParameter($comment->getObjectId()))
-			->where($qb->expr()->eq('id', $qb->createParameter('id')))
-			->setParameter('id', $comment->getId())
-			->execute();
-
-		if($affectedRows === 0) {
-			throw new NotFoundException('Comment to update does ceased to exist');
-		}
-
-		$this->dispatcher->dispatch(CommentsEvent::EVENT_UPDATE, new CommentsEvent(
-			CommentsEvent::EVENT_UPDATE,
-			$comment
-		));
-
-		return $affectedRows > 0;
-	}
-
-	/**
-	 * removes references to specific actor (e.g. on user delete) of a comment.
-	 * The comment itself must not get lost/deleted.
-	 *
-	 * @param string $actorType the actor type (e.g. 'users')
-	 * @param string $actorId a user id
-	 * @return boolean
-	 * @since 9.0.0
-	 */
-	public function deleteReferencesOfActor($actorType, $actorId) {
-		$this->checkRoleParameters('Actor', $actorType, $actorId);
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->update('comments')
-			->set('actor_type',	$qb->createNamedParameter(ICommentsManager::DELETED_USER))
-			->set('actor_id',	$qb->createNamedParameter(ICommentsManager::DELETED_USER))
-			->where($qb->expr()->eq('actor_type', $qb->createParameter('type')))
-			->andWhere($qb->expr()->eq('actor_id', $qb->createParameter('id')))
-			->setParameter('type', $actorType)
-			->setParameter('id', $actorId)
-			->execute();
-
-		$this->commentsCache = [];
-
-		return is_int($affectedRows);
-	}
-
-	/**
-	 * deletes all comments made of a specific object (e.g. on file delete)
-	 *
-	 * @param string $objectType the object type (e.g. 'files')
-	 * @param string $objectId e.g. the file id
-	 * @return boolean
-	 * @since 9.0.0
-	 */
-	public function deleteCommentsAtObject($objectType, $objectId) {
-		$this->checkRoleParameters('Object', $objectType, $objectId);
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->delete('comments')
-			->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
-			->setParameter('type', $objectType)
-			->setParameter('id', $objectId)
-			->execute();
-
-		$this->commentsCache = [];
-
-		return is_int($affectedRows);
-	}
-
-	/**
-	 * deletes the read markers for the specified user
-	 *
-	 * @param \OCP\IUser $user
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function deleteReadMarksFromUser(IUser $user) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->delete('comments_read_markers')
-			->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
-			->setParameter('user_id', $user->getUID());
-
-		try {
-			$affectedRows = $query->execute();
-		} catch (DriverException $e) {
-			$this->logger->logException($e, ['app' => 'core_comments']);
-			return false;
-		}
-		return ($affectedRows > 0);
-	}
-
-	/**
-	 * sets the read marker for a given file to the specified date for the
-	 * provided user
-	 *
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @param \DateTime $dateTime
-	 * @param IUser $user
-	 * @since 9.0.0
-	 */
-	public function setReadMark($objectType, $objectId, \DateTime $dateTime, IUser $user) {
-		$this->checkRoleParameters('Object', $objectType, $objectId);
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$values = [
-			'user_id'         => $qb->createNamedParameter($user->getUID()),
-			'marker_datetime' => $qb->createNamedParameter($dateTime, 'datetime'),
-			'object_type'     => $qb->createNamedParameter($objectType),
-			'object_id'       => $qb->createNamedParameter($objectId),
-		];
-
-		// Strategy: try to update, if this does not return affected rows, do an insert.
-		$affectedRows = $qb
-			->update('comments_read_markers')
-			->set('user_id',         $values['user_id'])
-			->set('marker_datetime', $values['marker_datetime'])
-			->set('object_type',     $values['object_type'])
-			->set('object_id',       $values['object_id'])
-			->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
-			->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
-			->setParameter('user_id', $user->getUID(), IQueryBuilder::PARAM_STR)
-			->setParameter('object_type', $objectType, IQueryBuilder::PARAM_STR)
-			->setParameter('object_id', $objectId, IQueryBuilder::PARAM_STR)
-			->execute();
-
-		if ($affectedRows > 0) {
-			return;
-		}
-
-		$qb->insert('comments_read_markers')
-			->values($values)
-			->execute();
-	}
-
-	/**
-	 * returns the read marker for a given file to the specified date for the
-	 * provided user. It returns null, when the marker is not present, i.e.
-	 * no comments were marked as read.
-	 *
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @param IUser $user
-	 * @return \DateTime|null
-	 * @since 9.0.0
-	 */
-	public function getReadMark($objectType, $objectId, IUser $user) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$resultStatement = $qb->select('marker_datetime')
-			->from('comments_read_markers')
-			->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
-			->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
-			->setParameter('user_id', $user->getUID(), IQueryBuilder::PARAM_STR)
-			->setParameter('object_type', $objectType, IQueryBuilder::PARAM_STR)
-			->setParameter('object_id', $objectId, IQueryBuilder::PARAM_STR)
-			->execute();
-
-		$data = $resultStatement->fetch();
-		$resultStatement->closeCursor();
-		if(!$data || is_null($data['marker_datetime'])) {
-			return null;
-		}
-
-		return new \DateTime($data['marker_datetime']);
-	}
-
-	/**
-	 * deletes the read markers on the specified object
-	 *
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function deleteReadMarksOnObject($objectType, $objectId) {
-		$this->checkRoleParameters('Object', $objectType, $objectId);
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->delete('comments_read_markers')
-			->where($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
-			->setParameter('object_type', $objectType)
-			->setParameter('object_id', $objectId);
-
-		try {
-			$affectedRows = $query->execute();
-		} catch (DriverException $e) {
-			$this->logger->logException($e, ['app' => 'core_comments']);
-			return false;
-		}
-		return ($affectedRows > 0);
-	}
+    /** @var  IDBConnection */
+    protected $dbConn;
+
+    /** @var  ILogger */
+    protected $logger;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var EventDispatcherInterface */
+    protected $dispatcher;
+
+    /** @var IComment[]  */
+    protected $commentsCache = [];
+
+    /**
+     * Manager constructor.
+     *
+     * @param IDBConnection $dbConn
+     * @param ILogger $logger
+     * @param IConfig $config
+     * @param EventDispatcherInterface $dispatcher
+     */
+    public function __construct(
+        IDBConnection $dbConn,
+        ILogger $logger,
+        IConfig $config,
+        EventDispatcherInterface $dispatcher
+    ) {
+        $this->dbConn = $dbConn;
+        $this->logger = $logger;
+        $this->config = $config;
+        $this->dispatcher = $dispatcher;
+    }
+
+    /**
+     * converts data base data into PHP native, proper types as defined by
+     * IComment interface.
+     *
+     * @param array $data
+     * @return array
+     */
+    protected function normalizeDatabaseData(array $data) {
+        $data['id'] = strval($data['id']);
+        $data['parent_id'] = strval($data['parent_id']);
+        $data['topmost_parent_id'] = strval($data['topmost_parent_id']);
+        $data['creation_timestamp'] = new \DateTime($data['creation_timestamp']);
+        if (!is_null($data['latest_child_timestamp'])) {
+            $data['latest_child_timestamp'] = new \DateTime($data['latest_child_timestamp']);
+        }
+        $data['children_count'] = intval($data['children_count']);
+        return $data;
+    }
+
+    /**
+     * prepares a comment for an insert or update operation after making sure
+     * all necessary fields have a value assigned.
+     *
+     * @param IComment $comment
+     * @return IComment returns the same updated IComment instance as provided
+     *                  by parameter for convenience
+     * @throws \UnexpectedValueException
+     */
+    protected function prepareCommentForDatabaseWrite(IComment $comment) {
+        if(    !$comment->getActorType()
+            || !$comment->getActorId()
+            || !$comment->getObjectType()
+            || !$comment->getObjectId()
+            || !$comment->getVerb()
+        ) {
+            throw new \UnexpectedValueException('Actor, Object and Verb information must be provided for saving');
+        }
+
+        if($comment->getId() === '') {
+            $comment->setChildrenCount(0);
+            $comment->setLatestChildDateTime(new \DateTime('0000-00-00 00:00:00', new \DateTimeZone('UTC')));
+            $comment->setLatestChildDateTime(null);
+        }
+
+        if(is_null($comment->getCreationDateTime())) {
+            $comment->setCreationDateTime(new \DateTime());
+        }
+
+        if($comment->getParentId() !== '0') {
+            $comment->setTopmostParentId($this->determineTopmostParentId($comment->getParentId()));
+        } else {
+            $comment->setTopmostParentId('0');
+        }
+
+        $this->cache($comment);
+
+        return $comment;
+    }
+
+    /**
+     * returns the topmost parent id of a given comment identified by ID
+     *
+     * @param string $id
+     * @return string
+     * @throws NotFoundException
+     */
+    protected function determineTopmostParentId($id) {
+        $comment = $this->get($id);
+        if($comment->getParentId() === '0') {
+            return $comment->getId();
+        } else {
+            return $this->determineTopmostParentId($comment->getId());
+        }
+    }
+
+    /**
+     * updates child information of a comment
+     *
+     * @param string	$id
+     * @param \DateTime	$cDateTime	the date time of the most recent child
+     * @throws NotFoundException
+     */
+    protected function updateChildrenInformation($id, \DateTime $cDateTime) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select($qb->createFunction('COUNT(`id`)'))
+                ->from('comments')
+                ->where($qb->expr()->eq('parent_id', $qb->createParameter('id')))
+                ->setParameter('id', $id);
+
+        $resultStatement = $query->execute();
+        $data = $resultStatement->fetch(\PDO::FETCH_NUM);
+        $resultStatement->closeCursor();
+        $children = intval($data[0]);
+
+        $comment = $this->get($id);
+        $comment->setChildrenCount($children);
+        $comment->setLatestChildDateTime($cDateTime);
+        $this->save($comment);
+    }
+
+    /**
+     * Tests whether actor or object type and id parameters are acceptable.
+     * Throws exception if not.
+     *
+     * @param string $role
+     * @param string $type
+     * @param string $id
+     * @throws \InvalidArgumentException
+     */
+    protected function checkRoleParameters($role, $type, $id) {
+        if(
+                !is_string($type) || empty($type)
+            || !is_string($id) || empty($id)
+        ) {
+            throw new \InvalidArgumentException($role . ' parameters must be string and not empty');
+        }
+    }
+
+    /**
+     * run-time caches a comment
+     *
+     * @param IComment $comment
+     */
+    protected function cache(IComment $comment) {
+        $id = $comment->getId();
+        if(empty($id)) {
+            return;
+        }
+        $this->commentsCache[strval($id)] = $comment;
+    }
+
+    /**
+     * removes an entry from the comments run time cache
+     *
+     * @param mixed $id the comment's id
+     */
+    protected function uncache($id) {
+        $id = strval($id);
+        if (isset($this->commentsCache[$id])) {
+            unset($this->commentsCache[$id]);
+        }
+    }
+
+    /**
+     * returns a comment instance
+     *
+     * @param string $id the ID of the comment
+     * @return IComment
+     * @throws NotFoundException
+     * @throws \InvalidArgumentException
+     * @since 9.0.0
+     */
+    public function get($id) {
+        if(intval($id) === 0) {
+            throw new \InvalidArgumentException('IDs must be translatable to a number in this implementation.');
+        }
+
+        if(isset($this->commentsCache[$id])) {
+            return $this->commentsCache[$id];
+        }
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $resultStatement = $qb->select('*')
+            ->from('comments')
+            ->where($qb->expr()->eq('id', $qb->createParameter('id')))
+            ->setParameter('id', $id, IQueryBuilder::PARAM_INT)
+            ->execute();
+
+        $data = $resultStatement->fetch();
+        $resultStatement->closeCursor();
+        if(!$data) {
+            throw new NotFoundException();
+        }
+
+        $comment = new Comment($this->normalizeDatabaseData($data));
+        $this->cache($comment);
+        return $comment;
+    }
+
+    /**
+     * returns the comment specified by the id and all it's child comments.
+     * At this point of time, we do only support one level depth.
+     *
+     * @param string $id
+     * @param int $limit max number of entries to return, 0 returns all
+     * @param int $offset the start entry
+     * @return array
+     * @since 9.0.0
+     *
+     * The return array looks like this
+     * [
+     *   'comment' => IComment, // root comment
+     *   'replies' =>
+     *   [
+     *     0 =>
+     *     [
+     *       'comment' => IComment,
+     *       'replies' => []
+     *     ]
+     *     1 =>
+     *     [
+     *       'comment' => IComment,
+     *       'replies'=> []
+     *     ],
+     *     …
+     *   ]
+     * ]
+     */
+    public function getTree($id, $limit = 0, $offset = 0) {
+        $tree = [];
+        $tree['comment'] = $this->get($id);
+        $tree['replies'] = [];
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select('*')
+                ->from('comments')
+                ->where($qb->expr()->eq('topmost_parent_id', $qb->createParameter('id')))
+                ->orderBy('creation_timestamp', 'DESC')
+                ->setParameter('id', $id);
+
+        if($limit > 0) {
+            $query->setMaxResults($limit);
+        }
+        if($offset > 0) {
+            $query->setFirstResult($offset);
+        }
+
+        $resultStatement = $query->execute();
+        while($data = $resultStatement->fetch()) {
+            $comment = new Comment($this->normalizeDatabaseData($data));
+            $this->cache($comment);
+            $tree['replies'][] = [
+                'comment' => $comment,
+                'replies' => []
+            ];
+        }
+        $resultStatement->closeCursor();
+
+        return $tree;
+    }
+
+    /**
+     * returns comments for a specific object (e.g. a file).
+     *
+     * The sort order is always newest to oldest.
+     *
+     * @param string $objectType the object type, e.g. 'files'
+     * @param string $objectId the id of the object
+     * @param int $limit optional, number of maximum comments to be returned. if
+     * not specified, all comments are returned.
+     * @param int $offset optional, starting point
+     * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
+     * that may be returned
+     * @return IComment[]
+     * @since 9.0.0
+     */
+    public function getForObject(
+            $objectType,
+            $objectId,
+            $limit = 0,
+            $offset = 0,
+            \DateTime $notOlderThan = null
+    ) {
+        $comments = [];
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select('*')
+                ->from('comments')
+                ->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
+                ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
+                ->orderBy('creation_timestamp', 'DESC')
+                ->setParameter('type', $objectType)
+                ->setParameter('id', $objectId);
+
+        if($limit > 0) {
+            $query->setMaxResults($limit);
+        }
+        if($offset > 0) {
+            $query->setFirstResult($offset);
+        }
+        if(!is_null($notOlderThan)) {
+            $query
+                ->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
+                ->setParameter('notOlderThan', $notOlderThan, 'datetime');
+        }
+
+        $resultStatement = $query->execute();
+        while($data = $resultStatement->fetch()) {
+            $comment = new Comment($this->normalizeDatabaseData($data));
+            $this->cache($comment);
+            $comments[] = $comment;
+        }
+        $resultStatement->closeCursor();
+
+        return $comments;
+    }
+
+    /**
+     * @param $objectType string the object type, e.g. 'files'
+     * @param $objectId string the id of the object
+     * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
+     * that may be returned
+     * @return Int
+     * @since 9.0.0
+     */
+    public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select($qb->createFunction('COUNT(`id`)'))
+                ->from('comments')
+                ->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
+                ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
+                ->setParameter('type', $objectType)
+                ->setParameter('id', $objectId);
+
+        if(!is_null($notOlderThan)) {
+            $query
+                ->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
+                ->setParameter('notOlderThan', $notOlderThan, 'datetime');
+        }
+
+        $resultStatement = $query->execute();
+        $data = $resultStatement->fetch(\PDO::FETCH_NUM);
+        $resultStatement->closeCursor();
+        return intval($data[0]);
+    }
+
+    /**
+     * creates a new comment and returns it. At this point of time, it is not
+     * saved in the used data storage. Use save() after setting other fields
+     * of the comment (e.g. message or verb).
+     *
+     * @param string $actorType the actor type (e.g. 'users')
+     * @param string $actorId a user id
+     * @param string $objectType the object type the comment is attached to
+     * @param string $objectId the object id the comment is attached to
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function create($actorType, $actorId, $objectType, $objectId) {
+        $comment = new Comment();
+        $comment
+            ->setActor($actorType, $actorId)
+            ->setObject($objectType, $objectId);
+        return $comment;
+    }
+
+    /**
+     * permanently deletes the comment specified by the ID
+     *
+     * When the comment has child comments, their parent ID will be changed to
+     * the parent ID of the item that is to be deleted.
+     *
+     * @param string $id
+     * @return bool
+     * @throws \InvalidArgumentException
+     * @since 9.0.0
+     */
+    public function delete($id) {
+        if(!is_string($id)) {
+            throw new \InvalidArgumentException('Parameter must be string');
+        }
+
+        try {
+            $comment = $this->get($id);
+        } catch (\Exception $e) {
+            // Ignore exceptions, we just don't fire a hook then
+            $comment = null;
+        }
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->delete('comments')
+            ->where($qb->expr()->eq('id', $qb->createParameter('id')))
+            ->setParameter('id', $id);
+
+        try {
+            $affectedRows = $query->execute();
+            $this->uncache($id);
+        } catch (DriverException $e) {
+            $this->logger->logException($e, ['app' => 'core_comments']);
+            return false;
+        }
+
+        if ($affectedRows > 0 && $comment instanceof IComment) {
+            $this->dispatcher->dispatch(CommentsEvent::EVENT_DELETE, new CommentsEvent(
+                CommentsEvent::EVENT_DELETE,
+                $comment
+            ));
+        }
+
+        return ($affectedRows > 0);
+    }
+
+    /**
+     * saves the comment permanently
+     *
+     * if the supplied comment has an empty ID, a new entry comment will be
+     * saved and the instance updated with the new ID.
+     *
+     * Otherwise, an existing comment will be updated.
+     *
+     * Throws NotFoundException when a comment that is to be updated does not
+     * exist anymore at this point of time.
+     *
+     * @param IComment $comment
+     * @return bool
+     * @throws NotFoundException
+     * @since 9.0.0
+     */
+    public function save(IComment $comment) {
+        if($this->prepareCommentForDatabaseWrite($comment)->getId() === '') {
+            $result = $this->insert($comment);
+        } else {
+            $result = $this->update($comment);
+        }
+
+        if($result && !!$comment->getParentId()) {
+            $this->updateChildrenInformation(
+                    $comment->getParentId(),
+                    $comment->getCreationDateTime()
+            );
+            $this->cache($comment);
+        }
+
+        return $result;
+    }
+
+    /**
+     * inserts the provided comment in the database
+     *
+     * @param IComment $comment
+     * @return bool
+     */
+    protected function insert(IComment &$comment) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->insert('comments')
+            ->values([
+                'parent_id'					=> $qb->createNamedParameter($comment->getParentId()),
+                'topmost_parent_id' 		=> $qb->createNamedParameter($comment->getTopmostParentId()),
+                'children_count' 			=> $qb->createNamedParameter($comment->getChildrenCount()),
+                'actor_type' 				=> $qb->createNamedParameter($comment->getActorType()),
+                'actor_id' 					=> $qb->createNamedParameter($comment->getActorId()),
+                'message' 					=> $qb->createNamedParameter($comment->getMessage()),
+                'verb' 						=> $qb->createNamedParameter($comment->getVerb()),
+                'creation_timestamp' 		=> $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'),
+                'latest_child_timestamp'	=> $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'),
+                'object_type' 				=> $qb->createNamedParameter($comment->getObjectType()),
+                'object_id' 				=> $qb->createNamedParameter($comment->getObjectId()),
+            ])
+            ->execute();
+
+        if ($affectedRows > 0) {
+            $comment->setId(strval($qb->getLastInsertId()));
+        }
+
+        $this->dispatcher->dispatch(CommentsEvent::EVENT_ADD, new CommentsEvent(
+            CommentsEvent::EVENT_ADD,
+            $comment
+        ));
+
+        return $affectedRows > 0;
+    }
+
+    /**
+     * updates a Comment data row
+     *
+     * @param IComment $comment
+     * @return bool
+     * @throws NotFoundException
+     */
+    protected function update(IComment $comment) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->update('comments')
+                ->set('parent_id',				$qb->createNamedParameter($comment->getParentId()))
+                ->set('topmost_parent_id', 		$qb->createNamedParameter($comment->getTopmostParentId()))
+                ->set('children_count',			$qb->createNamedParameter($comment->getChildrenCount()))
+                ->set('actor_type', 			$qb->createNamedParameter($comment->getActorType()))
+                ->set('actor_id', 				$qb->createNamedParameter($comment->getActorId()))
+                ->set('message',				$qb->createNamedParameter($comment->getMessage()))
+                ->set('verb',					$qb->createNamedParameter($comment->getVerb()))
+                ->set('creation_timestamp',		$qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'))
+                ->set('latest_child_timestamp',	$qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'))
+                ->set('object_type',			$qb->createNamedParameter($comment->getObjectType()))
+                ->set('object_id',				$qb->createNamedParameter($comment->getObjectId()))
+            ->where($qb->expr()->eq('id', $qb->createParameter('id')))
+            ->setParameter('id', $comment->getId())
+            ->execute();
+
+        if($affectedRows === 0) {
+            throw new NotFoundException('Comment to update does ceased to exist');
+        }
+
+        $this->dispatcher->dispatch(CommentsEvent::EVENT_UPDATE, new CommentsEvent(
+            CommentsEvent::EVENT_UPDATE,
+            $comment
+        ));
+
+        return $affectedRows > 0;
+    }
+
+    /**
+     * removes references to specific actor (e.g. on user delete) of a comment.
+     * The comment itself must not get lost/deleted.
+     *
+     * @param string $actorType the actor type (e.g. 'users')
+     * @param string $actorId a user id
+     * @return boolean
+     * @since 9.0.0
+     */
+    public function deleteReferencesOfActor($actorType, $actorId) {
+        $this->checkRoleParameters('Actor', $actorType, $actorId);
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->update('comments')
+            ->set('actor_type',	$qb->createNamedParameter(ICommentsManager::DELETED_USER))
+            ->set('actor_id',	$qb->createNamedParameter(ICommentsManager::DELETED_USER))
+            ->where($qb->expr()->eq('actor_type', $qb->createParameter('type')))
+            ->andWhere($qb->expr()->eq('actor_id', $qb->createParameter('id')))
+            ->setParameter('type', $actorType)
+            ->setParameter('id', $actorId)
+            ->execute();
+
+        $this->commentsCache = [];
+
+        return is_int($affectedRows);
+    }
+
+    /**
+     * deletes all comments made of a specific object (e.g. on file delete)
+     *
+     * @param string $objectType the object type (e.g. 'files')
+     * @param string $objectId e.g. the file id
+     * @return boolean
+     * @since 9.0.0
+     */
+    public function deleteCommentsAtObject($objectType, $objectId) {
+        $this->checkRoleParameters('Object', $objectType, $objectId);
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->delete('comments')
+            ->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
+            ->setParameter('type', $objectType)
+            ->setParameter('id', $objectId)
+            ->execute();
+
+        $this->commentsCache = [];
+
+        return is_int($affectedRows);
+    }
+
+    /**
+     * deletes the read markers for the specified user
+     *
+     * @param \OCP\IUser $user
+     * @return bool
+     * @since 9.0.0
+     */
+    public function deleteReadMarksFromUser(IUser $user) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->delete('comments_read_markers')
+            ->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
+            ->setParameter('user_id', $user->getUID());
+
+        try {
+            $affectedRows = $query->execute();
+        } catch (DriverException $e) {
+            $this->logger->logException($e, ['app' => 'core_comments']);
+            return false;
+        }
+        return ($affectedRows > 0);
+    }
+
+    /**
+     * sets the read marker for a given file to the specified date for the
+     * provided user
+     *
+     * @param string $objectType
+     * @param string $objectId
+     * @param \DateTime $dateTime
+     * @param IUser $user
+     * @since 9.0.0
+     */
+    public function setReadMark($objectType, $objectId, \DateTime $dateTime, IUser $user) {
+        $this->checkRoleParameters('Object', $objectType, $objectId);
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $values = [
+            'user_id'         => $qb->createNamedParameter($user->getUID()),
+            'marker_datetime' => $qb->createNamedParameter($dateTime, 'datetime'),
+            'object_type'     => $qb->createNamedParameter($objectType),
+            'object_id'       => $qb->createNamedParameter($objectId),
+        ];
+
+        // Strategy: try to update, if this does not return affected rows, do an insert.
+        $affectedRows = $qb
+            ->update('comments_read_markers')
+            ->set('user_id',         $values['user_id'])
+            ->set('marker_datetime', $values['marker_datetime'])
+            ->set('object_type',     $values['object_type'])
+            ->set('object_id',       $values['object_id'])
+            ->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
+            ->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
+            ->setParameter('user_id', $user->getUID(), IQueryBuilder::PARAM_STR)
+            ->setParameter('object_type', $objectType, IQueryBuilder::PARAM_STR)
+            ->setParameter('object_id', $objectId, IQueryBuilder::PARAM_STR)
+            ->execute();
+
+        if ($affectedRows > 0) {
+            return;
+        }
+
+        $qb->insert('comments_read_markers')
+            ->values($values)
+            ->execute();
+    }
+
+    /**
+     * returns the read marker for a given file to the specified date for the
+     * provided user. It returns null, when the marker is not present, i.e.
+     * no comments were marked as read.
+     *
+     * @param string $objectType
+     * @param string $objectId
+     * @param IUser $user
+     * @return \DateTime|null
+     * @since 9.0.0
+     */
+    public function getReadMark($objectType, $objectId, IUser $user) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $resultStatement = $qb->select('marker_datetime')
+            ->from('comments_read_markers')
+            ->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
+            ->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
+            ->setParameter('user_id', $user->getUID(), IQueryBuilder::PARAM_STR)
+            ->setParameter('object_type', $objectType, IQueryBuilder::PARAM_STR)
+            ->setParameter('object_id', $objectId, IQueryBuilder::PARAM_STR)
+            ->execute();
+
+        $data = $resultStatement->fetch();
+        $resultStatement->closeCursor();
+        if(!$data || is_null($data['marker_datetime'])) {
+            return null;
+        }
+
+        return new \DateTime($data['marker_datetime']);
+    }
+
+    /**
+     * deletes the read markers on the specified object
+     *
+     * @param string $objectType
+     * @param string $objectId
+     * @return bool
+     * @since 9.0.0
+     */
+    public function deleteReadMarksOnObject($objectType, $objectId) {
+        $this->checkRoleParameters('Object', $objectType, $objectId);
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->delete('comments_read_markers')
+            ->where($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
+            ->setParameter('object_type', $objectType)
+            ->setParameter('object_id', $objectId);
+
+        try {
+            $affectedRows = $query->execute();
+        } catch (DriverException $e) {
+            $this->logger->logException($e, ['app' => 'core_comments']);
+            return false;
+        }
+        return ($affectedRows > 0);
+    }
 }

Spacing +41 added lines, -41 removed lines

@@ -101,7 +101,7 @@ 
 	 * @throws \UnexpectedValueException
 	 */
 	protected function prepareCommentForDatabaseWrite(IComment $comment) {
-		if(    !$comment->getActorType()
+		if (!$comment->getActorType()
 			|| !$comment->getActorId()
 			|| !$comment->getObjectType()
 			|| !$comment->getObjectId()
@@ -110,17 +110,17 @@ 
 			throw new \UnexpectedValueException('Actor, Object and Verb information must be provided for saving');
 		}
 
-		if($comment->getId() === '') {
+		if ($comment->getId() === '') {
 			$comment->setChildrenCount(0);
 			$comment->setLatestChildDateTime(new \DateTime('0000-00-00 00:00:00', new \DateTimeZone('UTC')));
 			$comment->setLatestChildDateTime(null);
 		}
 
-		if(is_null($comment->getCreationDateTime())) {
+		if (is_null($comment->getCreationDateTime())) {
 			$comment->setCreationDateTime(new \DateTime());
 		}
 
-		if($comment->getParentId() !== '0') {
+		if ($comment->getParentId() !== '0') {
 			$comment->setTopmostParentId($this->determineTopmostParentId($comment->getParentId()));
 		} else {
 			$comment->setTopmostParentId('0');
@@ -140,7 +140,7 @@ 
 	 */
 	protected function determineTopmostParentId($id) {
 		$comment = $this->get($id);
-		if($comment->getParentId() === '0') {
+		if ($comment->getParentId() === '0') {
 			return $comment->getId();
 		} else {
 			return $this->determineTopmostParentId($comment->getId());
@@ -182,11 +182,11 @@ 
 	 * @throws \InvalidArgumentException
 	 */
 	protected function checkRoleParameters($role, $type, $id) {
-		if(
+		if (
 			   !is_string($type) || empty($type)
 			|| !is_string($id) || empty($id)
 		) {
-			throw new \InvalidArgumentException($role . ' parameters must be string and not empty');
+			throw new \InvalidArgumentException($role.' parameters must be string and not empty');
 		}
 	}
 
@@ -197,7 +197,7 @@ 
 	 */
 	protected function cache(IComment $comment) {
 		$id = $comment->getId();
-		if(empty($id)) {
+		if (empty($id)) {
 			return;
 		}
 		$this->commentsCache[strval($id)] = $comment;
@@ -225,11 +225,11 @@ 
 	 * @since 9.0.0
 	 */
 	public function get($id) {
-		if(intval($id) === 0) {
+		if (intval($id) === 0) {
 			throw new \InvalidArgumentException('IDs must be translatable to a number in this implementation.');
 		}
 
-		if(isset($this->commentsCache[$id])) {
+		if (isset($this->commentsCache[$id])) {
 			return $this->commentsCache[$id];
 		}
 
@@ -242,7 +242,7 @@ 
 
 		$data = $resultStatement->fetch();
 		$resultStatement->closeCursor();
-		if(!$data) {
+		if (!$data) {
 			throw new NotFoundException();
 		}
 
@@ -292,15 +292,15 @@ 
 				->orderBy('creation_timestamp', 'DESC')
 				->setParameter('id', $id);
 
-		if($limit > 0) {
+		if ($limit > 0) {
 			$query->setMaxResults($limit);
 		}
-		if($offset > 0) {
+		if ($offset > 0) {
 			$query->setFirstResult($offset);
 		}
 
 		$resultStatement = $query->execute();
-		while($data = $resultStatement->fetch()) {
+		while ($data = $resultStatement->fetch()) {
 			$comment = new Comment($this->normalizeDatabaseData($data));
 			$this->cache($comment);
 			$tree['replies'][] = [
@@ -346,20 +346,20 @@ 
 				->setParameter('type', $objectType)
 				->setParameter('id', $objectId);
 
-		if($limit > 0) {
+		if ($limit > 0) {
 			$query->setMaxResults($limit);
 		}
-		if($offset > 0) {
+		if ($offset > 0) {
 			$query->setFirstResult($offset);
 		}
-		if(!is_null($notOlderThan)) {
+		if (!is_null($notOlderThan)) {
 			$query
 				->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
 				->setParameter('notOlderThan', $notOlderThan, 'datetime');
 		}
 
 		$resultStatement = $query->execute();
-		while($data = $resultStatement->fetch()) {
+		while ($data = $resultStatement->fetch()) {
 			$comment = new Comment($this->normalizeDatabaseData($data));
 			$this->cache($comment);
 			$comments[] = $comment;
@@ -386,7 +386,7 @@ 
 				->setParameter('type', $objectType)
 				->setParameter('id', $objectId);
 
-		if(!is_null($notOlderThan)) {
+		if (!is_null($notOlderThan)) {
 			$query
 				->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
 				->setParameter('notOlderThan', $notOlderThan, 'datetime');
@@ -430,7 +430,7 @@ 
 	 * @since 9.0.0
 	 */
 	public function delete($id) {
-		if(!is_string($id)) {
+		if (!is_string($id)) {
 			throw new \InvalidArgumentException('Parameter must be string');
 		}
 
@@ -481,13 +481,13 @@ 
 	 * @since 9.0.0
 	 */
 	public function save(IComment $comment) {
-		if($this->prepareCommentForDatabaseWrite($comment)->getId() === '') {
+		if ($this->prepareCommentForDatabaseWrite($comment)->getId() === '') {
 			$result = $this->insert($comment);
 		} else {
 			$result = $this->update($comment);
 		}
 
-		if($result && !!$comment->getParentId()) {
+		if ($result && !!$comment->getParentId()) {
 			$this->updateChildrenInformation(
 					$comment->getParentId(),
 					$comment->getCreationDateTime()
@@ -504,7 +504,7 @@ 
 	 * @param IComment $comment
 	 * @return bool
 	 */
-	protected function insert(IComment &$comment) {
+	protected function insert(IComment & $comment) {
 		$qb = $this->dbConn->getQueryBuilder();
 		$affectedRows = $qb
 			->insert('comments')
@@ -546,22 +546,22 @@ 
 		$qb = $this->dbConn->getQueryBuilder();
 		$affectedRows = $qb
 			->update('comments')
-				->set('parent_id',				$qb->createNamedParameter($comment->getParentId()))
-				->set('topmost_parent_id', 		$qb->createNamedParameter($comment->getTopmostParentId()))
-				->set('children_count',			$qb->createNamedParameter($comment->getChildrenCount()))
-				->set('actor_type', 			$qb->createNamedParameter($comment->getActorType()))
-				->set('actor_id', 				$qb->createNamedParameter($comment->getActorId()))
-				->set('message',				$qb->createNamedParameter($comment->getMessage()))
-				->set('verb',					$qb->createNamedParameter($comment->getVerb()))
-				->set('creation_timestamp',		$qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'))
-				->set('latest_child_timestamp',	$qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'))
-				->set('object_type',			$qb->createNamedParameter($comment->getObjectType()))
-				->set('object_id',				$qb->createNamedParameter($comment->getObjectId()))
+				->set('parent_id', $qb->createNamedParameter($comment->getParentId()))
+				->set('topmost_parent_id', $qb->createNamedParameter($comment->getTopmostParentId()))
+				->set('children_count', $qb->createNamedParameter($comment->getChildrenCount()))
+				->set('actor_type', $qb->createNamedParameter($comment->getActorType()))
+				->set('actor_id', $qb->createNamedParameter($comment->getActorId()))
+				->set('message', $qb->createNamedParameter($comment->getMessage()))
+				->set('verb', $qb->createNamedParameter($comment->getVerb()))
+				->set('creation_timestamp', $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'))
+				->set('latest_child_timestamp', $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'))
+				->set('object_type', $qb->createNamedParameter($comment->getObjectType()))
+				->set('object_id', $qb->createNamedParameter($comment->getObjectId()))
 			->where($qb->expr()->eq('id', $qb->createParameter('id')))
 			->setParameter('id', $comment->getId())
 			->execute();
 
-		if($affectedRows === 0) {
+		if ($affectedRows === 0) {
 			throw new NotFoundException('Comment to update does ceased to exist');
 		}
 
@@ -588,8 +588,8 @@ 
 		$qb = $this->dbConn->getQueryBuilder();
 		$affectedRows = $qb
 			->update('comments')
-			->set('actor_type',	$qb->createNamedParameter(ICommentsManager::DELETED_USER))
-			->set('actor_id',	$qb->createNamedParameter(ICommentsManager::DELETED_USER))
+			->set('actor_type', $qb->createNamedParameter(ICommentsManager::DELETED_USER))
+			->set('actor_id', $qb->createNamedParameter(ICommentsManager::DELETED_USER))
 			->where($qb->expr()->eq('actor_type', $qb->createParameter('type')))
 			->andWhere($qb->expr()->eq('actor_id', $qb->createParameter('id')))
 			->setParameter('type', $actorType)
@@ -672,10 +672,10 @@ 
 		// Strategy: try to update, if this does not return affected rows, do an insert.
 		$affectedRows = $qb
 			->update('comments_read_markers')
-			->set('user_id',         $values['user_id'])
+			->set('user_id', $values['user_id'])
 			->set('marker_datetime', $values['marker_datetime'])
-			->set('object_type',     $values['object_type'])
-			->set('object_id',       $values['object_id'])
+			->set('object_type', $values['object_type'])
+			->set('object_id', $values['object_id'])
 			->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
 			->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type')))
 			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id')))
@@ -718,7 +718,7 @@ 
 
 		$data = $resultStatement->fetch();
 		$resultStatement->closeCursor();
-		if(!$data || is_null($data['marker_datetime'])) {
+		if (!$data || is_null($data['marker_datetime'])) {
 			return null;
 		}
 

lib/private/DateTimeFormatter.php

Doc Comments +3 added lines, -3 removed lines

@@ -93,7 +93,7 @@ 
 	/**
 	 * Formats the date of the given timestamp
 	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+	 * @param integer	$timestamp	Either a Unix timestamp or DateTime object
 	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
 	 * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
 	 * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
@@ -192,7 +192,7 @@ 
 	/**
 	 * Gives the relative past time of the timestamp
 	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+	 * @param integer	$timestamp	Either a Unix timestamp or DateTime object
 	 * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
 	 * @return string	Dates returned are:
 	 * 				< 60 sec	=> seconds ago
@@ -228,7 +228,7 @@ 
 	/**
 	 * Formats the date and time of the given timestamp
 	 *
-	 * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
+	 * @param integer $timestamp	Either a Unix timestamp or DateTime object
 	 * @param string		$formatDate		See formatDate() for description
 	 * @param string		$formatTime		See formatTime() for description
 	 * @param \DateTimeZone	$timeZone	The timezone to use

Indentation +232 added lines, -232 removed lines

@@ -25,257 +25,257 @@
 namespace OC;
 
 class DateTimeFormatter implements \OCP\IDateTimeFormatter {
-	/** @var \DateTimeZone */
-	protected $defaultTimeZone;
+    /** @var \DateTimeZone */
+    protected $defaultTimeZone;
 
-	/** @var \OCP\IL10N */
-	protected $defaultL10N;
+    /** @var \OCP\IL10N */
+    protected $defaultL10N;
 
-	/**
-	 * Constructor
-	 *
-	 * @param \DateTimeZone $defaultTimeZone Set the timezone for the format
-	 * @param \OCP\IL10N $defaultL10N Set the language for the format
-	 */
-	public function __construct(\DateTimeZone $defaultTimeZone, \OCP\IL10N $defaultL10N) {
-		$this->defaultTimeZone = $defaultTimeZone;
-		$this->defaultL10N = $defaultL10N;
-	}
+    /**
+     * Constructor
+     *
+     * @param \DateTimeZone $defaultTimeZone Set the timezone for the format
+     * @param \OCP\IL10N $defaultL10N Set the language for the format
+     */
+    public function __construct(\DateTimeZone $defaultTimeZone, \OCP\IL10N $defaultL10N) {
+        $this->defaultTimeZone = $defaultTimeZone;
+        $this->defaultL10N = $defaultL10N;
+    }
 
-	/**
-	 * Get TimeZone to use
-	 *
-	 * @param \DateTimeZone $timeZone	The timezone to use
-	 * @return \DateTimeZone		The timezone to use, falling back to the current user's timezone
-	 */
-	protected function getTimeZone($timeZone = null) {
-		if ($timeZone === null) {
-			$timeZone = $this->defaultTimeZone;
-		}
+    /**
+     * Get TimeZone to use
+     *
+     * @param \DateTimeZone $timeZone	The timezone to use
+     * @return \DateTimeZone		The timezone to use, falling back to the current user's timezone
+     */
+    protected function getTimeZone($timeZone = null) {
+        if ($timeZone === null) {
+            $timeZone = $this->defaultTimeZone;
+        }
 
-		return $timeZone;
-	}
+        return $timeZone;
+    }
 
-	/**
-	 * Get \OCP\IL10N to use
-	 *
-	 * @param \OCP\IL10N $l	The locale to use
-	 * @return \OCP\IL10N		The locale to use, falling back to the current user's locale
-	 */
-	protected function getLocale($l = null) {
-		if ($l === null) {
-			$l = $this->defaultL10N;
-		}
+    /**
+     * Get \OCP\IL10N to use
+     *
+     * @param \OCP\IL10N $l	The locale to use
+     * @return \OCP\IL10N		The locale to use, falling back to the current user's locale
+     */
+    protected function getLocale($l = null) {
+        if ($l === null) {
+            $l = $this->defaultL10N;
+        }
 
-		return $l;
-	}
+        return $l;
+    }
 
-	/**
-	 * Generates a DateTime object with the given timestamp and TimeZone
-	 *
-	 * @param mixed $timestamp
-	 * @param \DateTimeZone $timeZone	The timezone to use
-	 * @return \DateTime
-	 */
-	protected function getDateTime($timestamp, \DateTimeZone $timeZone = null) {
-		if ($timestamp === null) {
-			return new \DateTime('now', $timeZone);
-		} else if (!$timestamp instanceof \DateTime) {
-			$dateTime = new \DateTime('now', $timeZone);
-			$dateTime->setTimestamp($timestamp);
-			return $dateTime;
-		}
-		if ($timeZone) {
-			$timestamp->setTimezone($timeZone);
-		}
-		return $timestamp;
-	}
+    /**
+     * Generates a DateTime object with the given timestamp and TimeZone
+     *
+     * @param mixed $timestamp
+     * @param \DateTimeZone $timeZone	The timezone to use
+     * @return \DateTime
+     */
+    protected function getDateTime($timestamp, \DateTimeZone $timeZone = null) {
+        if ($timestamp === null) {
+            return new \DateTime('now', $timeZone);
+        } else if (!$timestamp instanceof \DateTime) {
+            $dateTime = new \DateTime('now', $timeZone);
+            $dateTime->setTimestamp($timestamp);
+            return $dateTime;
+        }
+        if ($timeZone) {
+            $timestamp->setTimezone($timeZone);
+        }
+        return $timestamp;
+    }
 
-	/**
-	 * Formats the date of the given timestamp
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
-	 * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
-	 * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
-	 * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
-	 * 				The exact format is dependent on the language
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted date string
-	 */
-	public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		return $this->format($timestamp, 'date', $format, $timeZone, $l);
-	}
+    /**
+     * Formats the date of the given timestamp
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
+     * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
+     * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
+     * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
+     * 				The exact format is dependent on the language
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted date string
+     */
+    public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        return $this->format($timestamp, 'date', $format, $timeZone, $l);
+    }
 
-	/**
-	 * Formats the date of the given timestamp
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
-	 * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
-	 * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
-	 * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
-	 * 				The exact format is dependent on the language
-	 * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted relative date string
-	 */
-	public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		if (substr($format, -1) !== '*' && substr($format, -1) !== '*') {
-			$format .= '^';
-		}
+    /**
+     * Formats the date of the given timestamp
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
+     * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
+     * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
+     * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
+     * 				The exact format is dependent on the language
+     * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted relative date string
+     */
+    public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        if (substr($format, -1) !== '*' && substr($format, -1) !== '*') {
+            $format .= '^';
+        }
 
-		return $this->format($timestamp, 'date', $format, $timeZone, $l);
-	}
+        return $this->format($timestamp, 'date', $format, $timeZone, $l);
+    }
 
-	/**
-	 * Gives the relative date of the timestamp
-	 * Only works for past dates
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
-	 * @return string	Dates returned are:
-	 * 				<  1 month	=> Today, Yesterday, n days ago
-	 * 				< 13 month	=> last month, n months ago
-	 * 				>= 13 month	=> last year, n years ago
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted date span
-	 */
-	public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) {
-		$l = $this->getLocale($l);
-		$timestamp = $this->getDateTime($timestamp);
-		$timestamp->setTime(0, 0, 0);
-		if ($baseTimestamp === null) {
-			$baseTimestamp = time();
-		}
-		$baseTimestamp = $this->getDateTime($baseTimestamp);
-		$baseTimestamp->setTime(0, 0, 0);
-		$dateInterval = $timestamp->diff($baseTimestamp);
+    /**
+     * Gives the relative date of the timestamp
+     * Only works for past dates
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
+     * @return string	Dates returned are:
+     * 				<  1 month	=> Today, Yesterday, n days ago
+     * 				< 13 month	=> last month, n months ago
+     * 				>= 13 month	=> last year, n years ago
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted date span
+     */
+    public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) {
+        $l = $this->getLocale($l);
+        $timestamp = $this->getDateTime($timestamp);
+        $timestamp->setTime(0, 0, 0);
+        if ($baseTimestamp === null) {
+            $baseTimestamp = time();
+        }
+        $baseTimestamp = $this->getDateTime($baseTimestamp);
+        $baseTimestamp->setTime(0, 0, 0);
+        $dateInterval = $timestamp->diff($baseTimestamp);
 
-		if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 0) {
-			return (string) $l->t('today');
-		} else if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 1) {
-			return (string) $l->t('yesterday');
-		} else if ($dateInterval->y == 0 && $dateInterval->m == 0) {
-			return (string) $l->n('%n day ago', '%n days ago', $dateInterval->d);
-		} else if ($dateInterval->y == 0 && $dateInterval->m == 1) {
-			return (string) $l->t('last month');
-		} else if ($dateInterval->y == 0) {
-			return (string) $l->n('%n month ago', '%n months ago', $dateInterval->m);
-		} else if ($dateInterval->y == 1) {
-			return (string) $l->t('last year');
-		}
-		return (string) $l->n('%n year ago', '%n years ago', $dateInterval->y);
-	}
+        if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 0) {
+            return (string) $l->t('today');
+        } else if ($dateInterval->y == 0 && $dateInterval->m == 0 && $dateInterval->d == 1) {
+            return (string) $l->t('yesterday');
+        } else if ($dateInterval->y == 0 && $dateInterval->m == 0) {
+            return (string) $l->n('%n day ago', '%n days ago', $dateInterval->d);
+        } else if ($dateInterval->y == 0 && $dateInterval->m == 1) {
+            return (string) $l->t('last month');
+        } else if ($dateInterval->y == 0) {
+            return (string) $l->n('%n month ago', '%n months ago', $dateInterval->m);
+        } else if ($dateInterval->y == 1) {
+            return (string) $l->t('last year');
+        }
+        return (string) $l->n('%n year ago', '%n years ago', $dateInterval->y);
+    }
 
-	/**
-	 * Formats the time of the given timestamp
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'h:mm:ss a zzzz'	=> '11:42:13 AM GMT+0:00'
-	 * 				long:	e.g. 'h:mm:ss a z'		=> '11:42:13 AM GMT'
-	 * 				medium:	e.g. 'h:mm:ss a'		=> '11:42:13 AM'
-	 * 				short:	e.g. 'h:mm a'			=> '11:42 AM'
-	 * 				The exact format is dependent on the language
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted time string
-	 */
-	public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		return $this->format($timestamp, 'time', $format, $timeZone, $l);
-	}
+    /**
+     * Formats the time of the given timestamp
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'h:mm:ss a zzzz'	=> '11:42:13 AM GMT+0:00'
+     * 				long:	e.g. 'h:mm:ss a z'		=> '11:42:13 AM GMT'
+     * 				medium:	e.g. 'h:mm:ss a'		=> '11:42:13 AM'
+     * 				short:	e.g. 'h:mm a'			=> '11:42 AM'
+     * 				The exact format is dependent on the language
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted time string
+     */
+    public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        return $this->format($timestamp, 'time', $format, $timeZone, $l);
+    }
 
-	/**
-	 * Gives the relative past time of the timestamp
-	 *
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
-	 * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
-	 * @return string	Dates returned are:
-	 * 				< 60 sec	=> seconds ago
-	 * 				<  1 hour	=> n minutes ago
-	 * 				<  1 day	=> n hours ago
-	 * 				<  1 month	=> Yesterday, n days ago
-	 * 				< 13 month	=> last month, n months ago
-	 * 				>= 13 month	=> last year, n years ago
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted time span
-	 */
-	public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) {
-		$l = $this->getLocale($l);
-		$timestamp = $this->getDateTime($timestamp);
-		if ($baseTimestamp === null) {
-			$baseTimestamp = time();
-		}
-		$baseTimestamp = $this->getDateTime($baseTimestamp);
+    /**
+     * Gives the relative past time of the timestamp
+     *
+     * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
+     * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
+     * @return string	Dates returned are:
+     * 				< 60 sec	=> seconds ago
+     * 				<  1 hour	=> n minutes ago
+     * 				<  1 day	=> n hours ago
+     * 				<  1 month	=> Yesterday, n days ago
+     * 				< 13 month	=> last month, n months ago
+     * 				>= 13 month	=> last year, n years ago
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted time span
+     */
+    public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null) {
+        $l = $this->getLocale($l);
+        $timestamp = $this->getDateTime($timestamp);
+        if ($baseTimestamp === null) {
+            $baseTimestamp = time();
+        }
+        $baseTimestamp = $this->getDateTime($baseTimestamp);
 
-		$diff = $timestamp->diff($baseTimestamp);
-		if ($diff->y > 0 || $diff->m > 0 || $diff->d > 0) {
-			return (string) $this->formatDateSpan($timestamp, $baseTimestamp, $l);
-		}
+        $diff = $timestamp->diff($baseTimestamp);
+        if ($diff->y > 0 || $diff->m > 0 || $diff->d > 0) {
+            return (string) $this->formatDateSpan($timestamp, $baseTimestamp, $l);
+        }
 
-		if ($diff->h > 0) {
-			return (string) $l->n('%n hour ago', '%n hours ago', $diff->h);
-		} else if ($diff->i > 0) {
-			return (string) $l->n('%n minute ago', '%n minutes ago', $diff->i);
-		}
-		return (string) $l->t('seconds ago');
-	}
+        if ($diff->h > 0) {
+            return (string) $l->n('%n hour ago', '%n hours ago', $diff->h);
+        } else if ($diff->i > 0) {
+            return (string) $l->n('%n minute ago', '%n minutes ago', $diff->i);
+        }
+        return (string) $l->t('seconds ago');
+    }
 
-	/**
-	 * Formats the date and time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
-	 * @param string		$formatDate		See formatDate() for description
-	 * @param string		$formatTime		See formatTime() for description
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted date and time string
-	 */
-	public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
-	}
+    /**
+     * Formats the date and time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
+     * @param string		$formatDate		See formatDate() for description
+     * @param string		$formatTime		See formatTime() for description
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted date and time string
+     */
+    public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
+    }
 
-	/**
-	 * Formats the date and time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
-	 * @param string	$formatDate		See formatDate() for description
-	 * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
-	 * @param string	$formatTime		See formatTime() for description
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted relative date and time string
-	 */
-	public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		if (substr($formatDate, -1) !== '^' && substr($formatDate, -1) !== '*') {
-			$formatDate .= '^';
-		}
+    /**
+     * Formats the date and time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
+     * @param string	$formatDate		See formatDate() for description
+     * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
+     * @param string	$formatTime		See formatTime() for description
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted relative date and time string
+     */
+    public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        if (substr($formatDate, -1) !== '^' && substr($formatDate, -1) !== '*') {
+            $formatDate .= '^';
+        }
 
-		return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
-	}
+        return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
+    }
 
-	/**
-	 * Formats the date and time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
-	 * @param string		$type		One of 'date', 'datetime' or 'time'
-	 * @param string		$format		Format string
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted date and time string
-	 */
-	protected function format($timestamp, $type, $format, \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		$l = $this->getLocale($l);
-		$timeZone = $this->getTimeZone($timeZone);
-		$timestamp = $this->getDateTime($timestamp, $timeZone);
+    /**
+     * Formats the date and time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
+     * @param string		$type		One of 'date', 'datetime' or 'time'
+     * @param string		$format		Format string
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted date and time string
+     */
+    protected function format($timestamp, $type, $format, \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
+        $l = $this->getLocale($l);
+        $timeZone = $this->getTimeZone($timeZone);
+        $timestamp = $this->getDateTime($timestamp, $timeZone);
 
-		return (string) $l->l($type, $timestamp, array(
-			'width' => $format,
-		));
-	}
+        return (string) $l->l($type, $timestamp, array(
+            'width' => $format,
+        ));
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -237,7 +237,7 @@ 
 	 * @return string Formatted date and time string
 	 */
 	public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null) {
-		return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
+		return $this->format($timestamp, 'datetime', $formatDate.'|'.$formatTime, $timeZone, $l);
 	}
 
 	/**
@@ -256,7 +256,7 @@ 
 			$formatDate .= '^';
 		}
 
-		return $this->format($timestamp, 'datetime', $formatDate . '|' . $formatTime, $timeZone, $l);
+		return $this->format($timestamp, 'datetime', $formatDate.'|'.$formatTime, $timeZone, $l);
 	}
 
 	/**

lib/private/DB/Connection.php

Doc Comments +2 added lines, -2 removed lines

@@ -173,7 +173,7 @@ 
 	 * If an SQLLogger is configured, the execution is logged.
 	 *
 	 * @param string                                      $query  The SQL query to execute.
-	 * @param array                                       $params The parameters to bind to the query, if any.
+	 * @param string[]                                       $params The parameters to bind to the query, if any.
 	 * @param array                                       $types  The types the previous parameters are in.
 	 * @param \Doctrine\DBAL\Cache\QueryCacheProfile|null $qcp    The query cache profile, optional.
 	 *
@@ -218,7 +218,7 @@ 
 	 * columns or sequences.
 	 *
 	 * @param string $seqName Name of the sequence object from which the ID should be returned.
-	 * @return string A string representation of the last inserted ID.
+	 * @return integer A string representation of the last inserted ID.
 	 */
 	public function lastInsertId($seqName = null) {
 		if ($seqName) {

Indentation +363 added lines, -363 removed lines

@@ -39,367 +39,367 @@
 use OCP\PreConditionNotMetException;
 
 class Connection extends \Doctrine\DBAL\Connection implements IDBConnection {
-	/**
-	 * @var string $tablePrefix
-	 */
-	protected $tablePrefix;
-
-	/**
-	 * @var \OC\DB\Adapter $adapter
-	 */
-	protected $adapter;
-
-	protected $lockedTable = null;
-
-	public function connect() {
-		try {
-			return parent::connect();
-		} catch (DBALException $e) {
-			// throw a new exception to prevent leaking info from the stacktrace
-			throw new DBALException('Failed to connect to the database: ' . $e->getMessage(), $e->getCode());
-		}
-	}
-
-	/**
-	 * Returns a QueryBuilder for the connection.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder
-	 */
-	public function getQueryBuilder() {
-		return new QueryBuilder($this);
-	}
-
-	/**
-	 * Gets the QueryBuilder for the connection.
-	 *
-	 * @return \Doctrine\DBAL\Query\QueryBuilder
-	 * @deprecated please use $this->getQueryBuilder() instead
-	 */
-	public function createQueryBuilder() {
-		$backtrace = $this->getCallerBacktrace();
-		\OC::$server->getLogger()->debug('Doctrine QueryBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
-		return parent::createQueryBuilder();
-	}
-
-	/**
-	 * Gets the ExpressionBuilder for the connection.
-	 *
-	 * @return \Doctrine\DBAL\Query\Expression\ExpressionBuilder
-	 * @deprecated please use $this->getQueryBuilder()->expr() instead
-	 */
-	public function getExpressionBuilder() {
-		$backtrace = $this->getCallerBacktrace();
-		\OC::$server->getLogger()->debug('Doctrine ExpressionBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
-		return parent::getExpressionBuilder();
-	}
-
-	/**
-	 * Get the file and line that called the method where `getCallerBacktrace()` was used
-	 *
-	 * @return string
-	 */
-	protected function getCallerBacktrace() {
-		$traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
-
-		// 0 is the method where we use `getCallerBacktrace`
-		// 1 is the target method which uses the method we want to log
-		if (isset($traces[1])) {
-			return $traces[1]['file'] . ':' . $traces[1]['line'];
-		}
-
-		return '';
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getPrefix() {
-		return $this->tablePrefix;
-	}
-
-	/**
-	 * Initializes a new instance of the Connection class.
-	 *
-	 * @param array $params  The connection parameters.
-	 * @param \Doctrine\DBAL\Driver $driver
-	 * @param \Doctrine\DBAL\Configuration $config
-	 * @param \Doctrine\Common\EventManager $eventManager
-	 * @throws \Exception
-	 */
-	public function __construct(array $params, Driver $driver, Configuration $config = null,
-		EventManager $eventManager = null)
-	{
-		if (!isset($params['adapter'])) {
-			throw new \Exception('adapter not set');
-		}
-		if (!isset($params['tablePrefix'])) {
-			throw new \Exception('tablePrefix not set');
-		}
-		parent::__construct($params, $driver, $config, $eventManager);
-		$this->adapter = new $params['adapter']($this);
-		$this->tablePrefix = $params['tablePrefix'];
-
-		parent::setTransactionIsolation(parent::TRANSACTION_READ_COMMITTED);
-	}
-
-	/**
-	 * Prepares an SQL statement.
-	 *
-	 * @param string $statement The SQL statement to prepare.
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
-	 */
-	public function prepare( $statement, $limit=null, $offset=null ) {
-		if ($limit === -1) {
-			$limit = null;
-		}
-		if (!is_null($limit)) {
-			$platform = $this->getDatabasePlatform();
-			$statement = $platform->modifyLimitQuery($statement, $limit, $offset);
-		}
-		$statement = $this->replaceTablePrefix($statement);
-		$statement = $this->adapter->fixupStatement($statement);
-
-		if(\OC::$server->getSystemConfig()->getValue( 'log_query', false)) {
-			\OCP\Util::writeLog('core', 'DB prepare : '.$statement, \OCP\Util::DEBUG);
-		}
-		return parent::prepare($statement);
-	}
-
-	/**
-	 * Executes an, optionally parametrized, SQL query.
-	 *
-	 * If the query is parametrized, a prepared statement is used.
-	 * If an SQLLogger is configured, the execution is logged.
-	 *
-	 * @param string                                      $query  The SQL query to execute.
-	 * @param array                                       $params The parameters to bind to the query, if any.
-	 * @param array                                       $types  The types the previous parameters are in.
-	 * @param \Doctrine\DBAL\Cache\QueryCacheProfile|null $qcp    The query cache profile, optional.
-	 *
-	 * @return \Doctrine\DBAL\Driver\Statement The executed statement.
-	 *
-	 * @throws \Doctrine\DBAL\DBALException
-	 */
-	public function executeQuery($query, array $params = array(), $types = array(), QueryCacheProfile $qcp = null)
-	{
-		$query = $this->replaceTablePrefix($query);
-		$query = $this->adapter->fixupStatement($query);
-		return parent::executeQuery($query, $params, $types, $qcp);
-	}
-
-	/**
-	 * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
-	 * and returns the number of affected rows.
-	 *
-	 * This method supports PDO binding types as well as DBAL mapping types.
-	 *
-	 * @param string $query  The SQL query.
-	 * @param array  $params The query parameters.
-	 * @param array  $types  The parameter types.
-	 *
-	 * @return integer The number of affected rows.
-	 *
-	 * @throws \Doctrine\DBAL\DBALException
-	 */
-	public function executeUpdate($query, array $params = array(), array $types = array())
-	{
-		$query = $this->replaceTablePrefix($query);
-		$query = $this->adapter->fixupStatement($query);
-		return parent::executeUpdate($query, $params, $types);
-	}
-
-	/**
-	 * Returns the ID of the last inserted row, or the last value from a sequence object,
-	 * depending on the underlying driver.
-	 *
-	 * Note: This method may not return a meaningful or consistent result across different drivers,
-	 * because the underlying database may not even support the notion of AUTO_INCREMENT/IDENTITY
-	 * columns or sequences.
-	 *
-	 * @param string $seqName Name of the sequence object from which the ID should be returned.
-	 * @return string A string representation of the last inserted ID.
-	 */
-	public function lastInsertId($seqName = null) {
-		if ($seqName) {
-			$seqName = $this->replaceTablePrefix($seqName);
-		}
-		return $this->adapter->lastInsertId($seqName);
-	}
-
-	// internal use
-	public function realLastInsertId($seqName = null) {
-		return parent::lastInsertId($seqName);
-	}
-
-	/**
-	 * Insert a row if the matching row does not exists.
-	 *
-	 * @param string $table The table name (will replace *PREFIX* with the actual prefix)
-	 * @param array $input data that should be inserted into the table  (column name => value)
-	 * @param array|null $compare List of values that should be checked for "if not exists"
-	 *				If this is null or an empty array, all keys of $input will be compared
-	 *				Please note: text fields (clob) must not be used in the compare array
-	 * @return int number of inserted rows
-	 * @throws \Doctrine\DBAL\DBALException
-	 */
-	public function insertIfNotExist($table, $input, array $compare = null) {
-		return $this->adapter->insertIfNotExist($table, $input, $compare);
-	}
-
-	private function getType($value) {
-		if (is_bool($value)) {
-			return IQueryBuilder::PARAM_BOOL;
-		} else if (is_int($value)) {
-			return IQueryBuilder::PARAM_INT;
-		} else {
-			return IQueryBuilder::PARAM_STR;
-		}
-	}
-
-	/**
-	 * Insert or update a row value
-	 *
-	 * @param string $table
-	 * @param array $keys (column name => value)
-	 * @param array $values (column name => value)
-	 * @param array $updatePreconditionValues ensure values match preconditions (column name => value)
-	 * @return int number of new rows
-	 * @throws \Doctrine\DBAL\DBALException
-	 * @throws PreConditionNotMetException
-	 */
-	public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []) {
-		try {
-			$insertQb = $this->getQueryBuilder();
-			$insertQb->insert($table)
-				->values(
-					array_map(function($value) use ($insertQb) {
-						return $insertQb->createNamedParameter($value, $this->getType($value));
-					}, array_merge($keys, $values))
-				);
-			return $insertQb->execute();
-		} catch (\Doctrine\DBAL\Exception\ConstraintViolationException $e) {
-			// value already exists, try update
-			$updateQb = $this->getQueryBuilder();
-			$updateQb->update($table);
-			foreach ($values as $name => $value) {
-				$updateQb->set($name, $updateQb->createNamedParameter($value, $this->getType($value)));
-			}
-			$where = $updateQb->expr()->andX();
-			$whereValues = array_merge($keys, $updatePreconditionValues);
-			foreach ($whereValues as $name => $value) {
-				$where->add($updateQb->expr()->eq(
-					$name,
-					$updateQb->createNamedParameter($value, $this->getType($value)),
-					$this->getType($value)
-				));
-			}
-			$updateQb->where($where);
-			$affected = $updateQb->execute();
-
-			if ($affected === 0 && !empty($updatePreconditionValues)) {
-				throw new PreConditionNotMetException();
-			}
-
-			return 0;
-		}
-	}
-
-	/**
-	 * Create an exclusive read+write lock on a table
-	 *
-	 * @param string $tableName
-	 * @throws \BadMethodCallException When trying to acquire a second lock
-	 * @since 9.1.0
-	 */
-	public function lockTable($tableName) {
-		if ($this->lockedTable !== null) {
-			throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
-		}
-
-		$tableName = $this->tablePrefix . $tableName;
-		$this->lockedTable = $tableName;
-		$this->adapter->lockTable($tableName);
-	}
-
-	/**
-	 * Release a previous acquired lock again
-	 *
-	 * @since 9.1.0
-	 */
-	public function unlockTable() {
-		$this->adapter->unlockTable();
-		$this->lockedTable = null;
-	}
-
-	/**
-	 * returns the error code and message as a string for logging
-	 * works with DoctrineException
-	 * @return string
-	 */
-	public function getError() {
-		$msg = $this->errorCode() . ': ';
-		$errorInfo = $this->errorInfo();
-		if (is_array($errorInfo)) {
-			$msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
-			$msg .= 'Driver Code = '.$errorInfo[1] . ', ';
-			$msg .= 'Driver Message = '.$errorInfo[2];
-		}
-		return $msg;
-	}
-
-	/**
-	 * Drop a table from the database if it exists
-	 *
-	 * @param string $table table name without the prefix
-	 */
-	public function dropTable($table) {
-		$table = $this->tablePrefix . trim($table);
-		$schema = $this->getSchemaManager();
-		if($schema->tablesExist(array($table))) {
-			$schema->dropTable($table);
-		}
-	}
-
-	/**
-	 * Check if a table exists
-	 *
-	 * @param string $table table name without the prefix
-	 * @return bool
-	 */
-	public function tableExists($table){
-		$table = $this->tablePrefix . trim($table);
-		$schema = $this->getSchemaManager();
-		return $schema->tablesExist(array($table));
-	}
-
-	// internal use
-	/**
-	 * @param string $statement
-	 * @return string
-	 */
-	protected function replaceTablePrefix($statement) {
-		return str_replace( '*PREFIX*', $this->tablePrefix, $statement );
-	}
-
-	/**
-	 * Check if a transaction is active
-	 *
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function inTransaction() {
-		return $this->getTransactionNestingLevel() > 0;
-	}
-
-	/**
-	 * Espace a parameter to be used in a LIKE query
-	 *
-	 * @param string $param
-	 * @return string
-	 */
-	public function escapeLikeParameter($param) {
-		return addcslashes($param, '\\_%');
-	}
+    /**
+     * @var string $tablePrefix
+     */
+    protected $tablePrefix;
+
+    /**
+     * @var \OC\DB\Adapter $adapter
+     */
+    protected $adapter;
+
+    protected $lockedTable = null;
+
+    public function connect() {
+        try {
+            return parent::connect();
+        } catch (DBALException $e) {
+            // throw a new exception to prevent leaking info from the stacktrace
+            throw new DBALException('Failed to connect to the database: ' . $e->getMessage(), $e->getCode());
+        }
+    }
+
+    /**
+     * Returns a QueryBuilder for the connection.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder
+     */
+    public function getQueryBuilder() {
+        return new QueryBuilder($this);
+    }
+
+    /**
+     * Gets the QueryBuilder for the connection.
+     *
+     * @return \Doctrine\DBAL\Query\QueryBuilder
+     * @deprecated please use $this->getQueryBuilder() instead
+     */
+    public function createQueryBuilder() {
+        $backtrace = $this->getCallerBacktrace();
+        \OC::$server->getLogger()->debug('Doctrine QueryBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
+        return parent::createQueryBuilder();
+    }
+
+    /**
+     * Gets the ExpressionBuilder for the connection.
+     *
+     * @return \Doctrine\DBAL\Query\Expression\ExpressionBuilder
+     * @deprecated please use $this->getQueryBuilder()->expr() instead
+     */
+    public function getExpressionBuilder() {
+        $backtrace = $this->getCallerBacktrace();
+        \OC::$server->getLogger()->debug('Doctrine ExpressionBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
+        return parent::getExpressionBuilder();
+    }
+
+    /**
+     * Get the file and line that called the method where `getCallerBacktrace()` was used
+     *
+     * @return string
+     */
+    protected function getCallerBacktrace() {
+        $traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
+
+        // 0 is the method where we use `getCallerBacktrace`
+        // 1 is the target method which uses the method we want to log
+        if (isset($traces[1])) {
+            return $traces[1]['file'] . ':' . $traces[1]['line'];
+        }
+
+        return '';
+    }
+
+    /**
+     * @return string
+     */
+    public function getPrefix() {
+        return $this->tablePrefix;
+    }
+
+    /**
+     * Initializes a new instance of the Connection class.
+     *
+     * @param array $params  The connection parameters.
+     * @param \Doctrine\DBAL\Driver $driver
+     * @param \Doctrine\DBAL\Configuration $config
+     * @param \Doctrine\Common\EventManager $eventManager
+     * @throws \Exception
+     */
+    public function __construct(array $params, Driver $driver, Configuration $config = null,
+        EventManager $eventManager = null)
+    {
+        if (!isset($params['adapter'])) {
+            throw new \Exception('adapter not set');
+        }
+        if (!isset($params['tablePrefix'])) {
+            throw new \Exception('tablePrefix not set');
+        }
+        parent::__construct($params, $driver, $config, $eventManager);
+        $this->adapter = new $params['adapter']($this);
+        $this->tablePrefix = $params['tablePrefix'];
+
+        parent::setTransactionIsolation(parent::TRANSACTION_READ_COMMITTED);
+    }
+
+    /**
+     * Prepares an SQL statement.
+     *
+     * @param string $statement The SQL statement to prepare.
+     * @param int $limit
+     * @param int $offset
+     * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
+     */
+    public function prepare( $statement, $limit=null, $offset=null ) {
+        if ($limit === -1) {
+            $limit = null;
+        }
+        if (!is_null($limit)) {
+            $platform = $this->getDatabasePlatform();
+            $statement = $platform->modifyLimitQuery($statement, $limit, $offset);
+        }
+        $statement = $this->replaceTablePrefix($statement);
+        $statement = $this->adapter->fixupStatement($statement);
+
+        if(\OC::$server->getSystemConfig()->getValue( 'log_query', false)) {
+            \OCP\Util::writeLog('core', 'DB prepare : '.$statement, \OCP\Util::DEBUG);
+        }
+        return parent::prepare($statement);
+    }
+
+    /**
+     * Executes an, optionally parametrized, SQL query.
+     *
+     * If the query is parametrized, a prepared statement is used.
+     * If an SQLLogger is configured, the execution is logged.
+     *
+     * @param string                                      $query  The SQL query to execute.
+     * @param array                                       $params The parameters to bind to the query, if any.
+     * @param array                                       $types  The types the previous parameters are in.
+     * @param \Doctrine\DBAL\Cache\QueryCacheProfile|null $qcp    The query cache profile, optional.
+     *
+     * @return \Doctrine\DBAL\Driver\Statement The executed statement.
+     *
+     * @throws \Doctrine\DBAL\DBALException
+     */
+    public function executeQuery($query, array $params = array(), $types = array(), QueryCacheProfile $qcp = null)
+    {
+        $query = $this->replaceTablePrefix($query);
+        $query = $this->adapter->fixupStatement($query);
+        return parent::executeQuery($query, $params, $types, $qcp);
+    }
+
+    /**
+     * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
+     * and returns the number of affected rows.
+     *
+     * This method supports PDO binding types as well as DBAL mapping types.
+     *
+     * @param string $query  The SQL query.
+     * @param array  $params The query parameters.
+     * @param array  $types  The parameter types.
+     *
+     * @return integer The number of affected rows.
+     *
+     * @throws \Doctrine\DBAL\DBALException
+     */
+    public function executeUpdate($query, array $params = array(), array $types = array())
+    {
+        $query = $this->replaceTablePrefix($query);
+        $query = $this->adapter->fixupStatement($query);
+        return parent::executeUpdate($query, $params, $types);
+    }
+
+    /**
+     * Returns the ID of the last inserted row, or the last value from a sequence object,
+     * depending on the underlying driver.
+     *
+     * Note: This method may not return a meaningful or consistent result across different drivers,
+     * because the underlying database may not even support the notion of AUTO_INCREMENT/IDENTITY
+     * columns or sequences.
+     *
+     * @param string $seqName Name of the sequence object from which the ID should be returned.
+     * @return string A string representation of the last inserted ID.
+     */
+    public function lastInsertId($seqName = null) {
+        if ($seqName) {
+            $seqName = $this->replaceTablePrefix($seqName);
+        }
+        return $this->adapter->lastInsertId($seqName);
+    }
+
+    // internal use
+    public function realLastInsertId($seqName = null) {
+        return parent::lastInsertId($seqName);
+    }
+
+    /**
+     * Insert a row if the matching row does not exists.
+     *
+     * @param string $table The table name (will replace *PREFIX* with the actual prefix)
+     * @param array $input data that should be inserted into the table  (column name => value)
+     * @param array|null $compare List of values that should be checked for "if not exists"
+     *				If this is null or an empty array, all keys of $input will be compared
+     *				Please note: text fields (clob) must not be used in the compare array
+     * @return int number of inserted rows
+     * @throws \Doctrine\DBAL\DBALException
+     */
+    public function insertIfNotExist($table, $input, array $compare = null) {
+        return $this->adapter->insertIfNotExist($table, $input, $compare);
+    }
+
+    private function getType($value) {
+        if (is_bool($value)) {
+            return IQueryBuilder::PARAM_BOOL;
+        } else if (is_int($value)) {
+            return IQueryBuilder::PARAM_INT;
+        } else {
+            return IQueryBuilder::PARAM_STR;
+        }
+    }
+
+    /**
+     * Insert or update a row value
+     *
+     * @param string $table
+     * @param array $keys (column name => value)
+     * @param array $values (column name => value)
+     * @param array $updatePreconditionValues ensure values match preconditions (column name => value)
+     * @return int number of new rows
+     * @throws \Doctrine\DBAL\DBALException
+     * @throws PreConditionNotMetException
+     */
+    public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []) {
+        try {
+            $insertQb = $this->getQueryBuilder();
+            $insertQb->insert($table)
+                ->values(
+                    array_map(function($value) use ($insertQb) {
+                        return $insertQb->createNamedParameter($value, $this->getType($value));
+                    }, array_merge($keys, $values))
+                );
+            return $insertQb->execute();
+        } catch (\Doctrine\DBAL\Exception\ConstraintViolationException $e) {
+            // value already exists, try update
+            $updateQb = $this->getQueryBuilder();
+            $updateQb->update($table);
+            foreach ($values as $name => $value) {
+                $updateQb->set($name, $updateQb->createNamedParameter($value, $this->getType($value)));
+            }
+            $where = $updateQb->expr()->andX();
+            $whereValues = array_merge($keys, $updatePreconditionValues);
+            foreach ($whereValues as $name => $value) {
+                $where->add($updateQb->expr()->eq(
+                    $name,
+                    $updateQb->createNamedParameter($value, $this->getType($value)),
+                    $this->getType($value)
+                ));
+            }
+            $updateQb->where($where);
+            $affected = $updateQb->execute();
+
+            if ($affected === 0 && !empty($updatePreconditionValues)) {
+                throw new PreConditionNotMetException();
+            }
+
+            return 0;
+        }
+    }
+
+    /**
+     * Create an exclusive read+write lock on a table
+     *
+     * @param string $tableName
+     * @throws \BadMethodCallException When trying to acquire a second lock
+     * @since 9.1.0
+     */
+    public function lockTable($tableName) {
+        if ($this->lockedTable !== null) {
+            throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
+        }
+
+        $tableName = $this->tablePrefix . $tableName;
+        $this->lockedTable = $tableName;
+        $this->adapter->lockTable($tableName);
+    }
+
+    /**
+     * Release a previous acquired lock again
+     *
+     * @since 9.1.0
+     */
+    public function unlockTable() {
+        $this->adapter->unlockTable();
+        $this->lockedTable = null;
+    }
+
+    /**
+     * returns the error code and message as a string for logging
+     * works with DoctrineException
+     * @return string
+     */
+    public function getError() {
+        $msg = $this->errorCode() . ': ';
+        $errorInfo = $this->errorInfo();
+        if (is_array($errorInfo)) {
+            $msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
+            $msg .= 'Driver Code = '.$errorInfo[1] . ', ';
+            $msg .= 'Driver Message = '.$errorInfo[2];
+        }
+        return $msg;
+    }
+
+    /**
+     * Drop a table from the database if it exists
+     *
+     * @param string $table table name without the prefix
+     */
+    public function dropTable($table) {
+        $table = $this->tablePrefix . trim($table);
+        $schema = $this->getSchemaManager();
+        if($schema->tablesExist(array($table))) {
+            $schema->dropTable($table);
+        }
+    }
+
+    /**
+     * Check if a table exists
+     *
+     * @param string $table table name without the prefix
+     * @return bool
+     */
+    public function tableExists($table){
+        $table = $this->tablePrefix . trim($table);
+        $schema = $this->getSchemaManager();
+        return $schema->tablesExist(array($table));
+    }
+
+    // internal use
+    /**
+     * @param string $statement
+     * @return string
+     */
+    protected function replaceTablePrefix($statement) {
+        return str_replace( '*PREFIX*', $this->tablePrefix, $statement );
+    }
+
+    /**
+     * Check if a transaction is active
+     *
+     * @return bool
+     * @since 8.2.0
+     */
+    public function inTransaction() {
+        return $this->getTransactionNestingLevel() > 0;
+    }
+
+    /**
+     * Espace a parameter to be used in a LIKE query
+     *
+     * @param string $param
+     * @return string
+     */
+    public function escapeLikeParameter($param) {
+        return addcslashes($param, '\\_%');
+    }
 }

Spacing +13 added lines, -13 removed lines

@@ -56,7 +56,7 @@ 
 			return parent::connect();
 		} catch (DBALException $e) {
 			// throw a new exception to prevent leaking info from the stacktrace
-			throw new DBALException('Failed to connect to the database: ' . $e->getMessage(), $e->getCode());
+			throw new DBALException('Failed to connect to the database: '.$e->getMessage(), $e->getCode());
 		}
 	}
 
@@ -104,7 +104,7 @@ 
 		// 0 is the method where we use `getCallerBacktrace`
 		// 1 is the target method which uses the method we want to log
 		if (isset($traces[1])) {
-			return $traces[1]['file'] . ':' . $traces[1]['line'];
+			return $traces[1]['file'].':'.$traces[1]['line'];
 		}
 
 		return '';
@@ -150,7 +150,7 @@ 
 	 * @param int $offset
 	 * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
 	 */
-	public function prepare( $statement, $limit=null, $offset=null ) {
+	public function prepare($statement, $limit = null, $offset = null) {
 		if ($limit === -1) {
 			$limit = null;
 		}
@@ -161,7 +161,7 @@ 
 		$statement = $this->replaceTablePrefix($statement);
 		$statement = $this->adapter->fixupStatement($statement);
 
-		if(\OC::$server->getSystemConfig()->getValue( 'log_query', false)) {
+		if (\OC::$server->getSystemConfig()->getValue('log_query', false)) {
 			\OCP\Util::writeLog('core', 'DB prepare : '.$statement, \OCP\Util::DEBUG);
 		}
 		return parent::prepare($statement);
@@ -318,7 +318,7 @@ 
 			throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
 		}
 
-		$tableName = $this->tablePrefix . $tableName;
+		$tableName = $this->tablePrefix.$tableName;
 		$this->lockedTable = $tableName;
 		$this->adapter->lockTable($tableName);
 	}
@@ -339,11 +339,11 @@ 
 	 * @return string
 	 */
 	public function getError() {
-		$msg = $this->errorCode() . ': ';
+		$msg = $this->errorCode().': ';
 		$errorInfo = $this->errorInfo();
 		if (is_array($errorInfo)) {
-			$msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
-			$msg .= 'Driver Code = '.$errorInfo[1] . ', ';
+			$msg .= 'SQLSTATE = '.$errorInfo[0].', ';
+			$msg .= 'Driver Code = '.$errorInfo[1].', ';
 			$msg .= 'Driver Message = '.$errorInfo[2];
 		}
 		return $msg;
@@ -355,9 +355,9 @@ 
 	 * @param string $table table name without the prefix
 	 */
 	public function dropTable($table) {
-		$table = $this->tablePrefix . trim($table);
+		$table = $this->tablePrefix.trim($table);
 		$schema = $this->getSchemaManager();
-		if($schema->tablesExist(array($table))) {
+		if ($schema->tablesExist(array($table))) {
 			$schema->dropTable($table);
 		}
 	}
@@ -368,8 +368,8 @@ 
 	 * @param string $table table name without the prefix
 	 * @return bool
 	 */
-	public function tableExists($table){
-		$table = $this->tablePrefix . trim($table);
+	public function tableExists($table) {
+		$table = $this->tablePrefix.trim($table);
 		$schema = $this->getSchemaManager();
 		return $schema->tablesExist(array($table));
 	}
@@ -380,7 +380,7 @@ 
 	 * @return string
 	 */
 	protected function replaceTablePrefix($statement) {
-		return str_replace( '*PREFIX*', $this->tablePrefix, $statement );
+		return str_replace('*PREFIX*', $this->tablePrefix, $statement);
 	}
 
 	/**

lib/private/Encryption/Util.php

Unused Use Statements -1 removed lines

@@ -30,7 +30,6 @@
 use OC\Files\Filesystem;
 use OC\Files\View;
 use OCP\Encryption\IEncryptionModule;
-use OCP\Files\Storage;
 use OCP\IConfig;
 
 class Util {

Indentation +354 added lines, -354 removed lines

@@ -36,359 +36,359 @@
 
 class Util {
 
-	const HEADER_START = 'HBEGIN';
-	const HEADER_END = 'HEND';
-	const HEADER_PADDING_CHAR = '-';
-
-	const HEADER_ENCRYPTION_MODULE_KEY = 'oc_encryption_module';
-
-	/**
-	 * block size will always be 8192 for a PHP stream
-	 * @see https://bugs.php.net/bug.php?id=21641
-	 * @var integer
-	 */
-	protected $headerSize = 8192;
-
-	/**
-	 * block size will always be 8192 for a PHP stream
-	 * @see https://bugs.php.net/bug.php?id=21641
-	 * @var integer
-	 */
-	protected $blockSize = 8192;
-
-	/** @var View */
-	protected $rootView;
-
-	/** @var array */
-	protected $ocHeaderKeys;
-
-	/** @var \OC\User\Manager */
-	protected $userManager;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var array paths excluded from encryption */
-	protected $excludedPaths;
-
-	/** @var \OC\Group\Manager $manager */
-	protected $groupManager;
-
-	/**
-	 *
-	 * @param View $rootView
-	 * @param \OC\User\Manager $userManager
-	 * @param \OC\Group\Manager $groupManager
-	 * @param IConfig $config
-	 */
-	public function __construct(
-		View $rootView,
-		\OC\User\Manager $userManager,
-		\OC\Group\Manager $groupManager,
-		IConfig $config) {
-
-		$this->ocHeaderKeys = [
-			self::HEADER_ENCRYPTION_MODULE_KEY
-		];
-
-		$this->rootView = $rootView;
-		$this->userManager = $userManager;
-		$this->groupManager = $groupManager;
-		$this->config = $config;
-
-		$this->excludedPaths[] = 'files_encryption';
-	}
-
-	/**
-	 * read encryption module ID from header
-	 *
-	 * @param array $header
-	 * @return string
-	 * @throws ModuleDoesNotExistsException
-	 */
-	public function getEncryptionModuleId(array $header = null) {
-		$id = '';
-		$encryptionModuleKey = self::HEADER_ENCRYPTION_MODULE_KEY;
-
-		if (isset($header[$encryptionModuleKey])) {
-			$id = $header[$encryptionModuleKey];
-		} elseif (isset($header['cipher'])) {
-			if (class_exists('\OCA\Encryption\Crypto\Encryption')) {
-				// fall back to default encryption if the user migrated from
-				// ownCloud <= 8.0 with the old encryption
-				$id = \OCA\Encryption\Crypto\Encryption::ID;
-			} else {
-				throw new ModuleDoesNotExistsException('Default encryption module missing');
-			}
-		}
-
-		return $id;
-	}
-
-	/**
-	 * create header for encrypted file
-	 *
-	 * @param array $headerData
-	 * @param IEncryptionModule $encryptionModule
-	 * @return string
-	 * @throws EncryptionHeaderToLargeException if header has to many arguments
-	 * @throws EncryptionHeaderKeyExistsException if header key is already in use
-	 */
-	public function createHeader(array $headerData, IEncryptionModule $encryptionModule) {
-		$header = self::HEADER_START . ':' . self::HEADER_ENCRYPTION_MODULE_KEY . ':' . $encryptionModule->getId() . ':';
-		foreach ($headerData as $key => $value) {
-			if (in_array($key, $this->ocHeaderKeys)) {
-				throw new EncryptionHeaderKeyExistsException($key);
-			}
-			$header .= $key . ':' . $value . ':';
-		}
-		$header .= self::HEADER_END;
-
-		if (strlen($header) > $this->getHeaderSize()) {
-			throw new EncryptionHeaderToLargeException();
-		}
-
-		$paddedHeader = str_pad($header, $this->headerSize, self::HEADER_PADDING_CHAR, STR_PAD_RIGHT);
-
-		return $paddedHeader;
-	}
-
-	/**
-	 * go recursively through a dir and collect all files and sub files.
-	 *
-	 * @param string $dir relative to the users files folder
-	 * @return array with list of files relative to the users files folder
-	 */
-	public function getAllFiles($dir) {
-		$result = array();
-		$dirList = array($dir);
-
-		while ($dirList) {
-			$dir = array_pop($dirList);
-			$content = $this->rootView->getDirectoryContent($dir);
-
-			foreach ($content as $c) {
-				if ($c->getType() === 'dir') {
-					$dirList[] = $c->getPath();
-				} else {
-					$result[] =  $c->getPath();
-				}
-			}
-
-		}
-
-		return $result;
-	}
-
-	/**
-	 * check if it is a file uploaded by the user stored in data/user/files
-	 * or a metadata file
-	 *
-	 * @param string $path relative to the data/ folder
-	 * @return boolean
-	 */
-	public function isFile($path) {
-		$parts = explode('/', Filesystem::normalizePath($path), 4);
-		if (isset($parts[2]) && $parts[2] === 'files') {
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * return size of encryption header
-	 *
-	 * @return integer
-	 */
-	public function getHeaderSize() {
-		return $this->headerSize;
-	}
-
-	/**
-	 * return size of block read by a PHP stream
-	 *
-	 * @return integer
-	 */
-	public function getBlockSize() {
-		return $this->blockSize;
-	}
-
-	/**
-	 * get the owner and the path for the file relative to the owners files folder
-	 *
-	 * @param string $path
-	 * @return array
-	 * @throws \BadMethodCallException
-	 */
-	public function getUidAndFilename($path) {
-
-		$parts = explode('/', $path);
-		$uid = '';
-		if (count($parts) > 2) {
-			$uid = $parts[1];
-		}
-		if (!$this->userManager->userExists($uid)) {
-			throw new \BadMethodCallException(
-				'path needs to be relative to the system wide data folder and point to a user specific file'
-			);
-		}
-
-		$ownerPath = implode('/', array_slice($parts, 2));
-
-		return array($uid, Filesystem::normalizePath($ownerPath));
-
-	}
-
-	/**
-	 * Remove .path extension from a file path
-	 * @param string $path Path that may identify a .part file
-	 * @return string File path without .part extension
-	 * @note this is needed for reusing keys
-	 */
-	public function stripPartialFileExtension($path) {
-		$extension = pathinfo($path, PATHINFO_EXTENSION);
-
-		if ( $extension === 'part') {
-
-			$newLength = strlen($path) - 5; // 5 = strlen(".part")
-			$fPath = substr($path, 0, $newLength);
-
-			// if path also contains a transaction id, we remove it too
-			$extension = pathinfo($fPath, PATHINFO_EXTENSION);
-			if(substr($extension, 0, 12) === 'ocTransferId') { // 12 = strlen("ocTransferId")
-				$newLength = strlen($fPath) - strlen($extension) -1;
-				$fPath = substr($fPath, 0, $newLength);
-			}
-			return $fPath;
-
-		} else {
-			return $path;
-		}
-	}
-
-	public function getUserWithAccessToMountPoint($users, $groups) {
-		$result = array();
-		if (in_array('all', $users)) {
-			$result = \OCP\User::getUsers();
-		} else {
-			$result = array_merge($result, $users);
-			foreach ($groups as $group) {
-				$result = array_merge($result, \OC_Group::usersInGroup($group));
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * check if the file is stored on a system wide mount point
-	 * @param string $path relative to /data/user with leading '/'
-	 * @param string $uid
-	 * @return boolean
-	 */
-	public function isSystemWideMountPoint($path, $uid) {
-		if (\OCP\App::isEnabled("files_external")) {
-			$mounts = \OC_Mount_Config::getSystemMountPoints();
-			foreach ($mounts as $mount) {
-				if (strpos($path, '/files/' . $mount['mountpoint']) === 0) {
-					if ($this->isMountPointApplicableToUser($mount, $uid)) {
-						return true;
-					}
-				}
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * check if mount point is applicable to user
-	 *
-	 * @param array $mount contains $mount['applicable']['users'], $mount['applicable']['groups']
-	 * @param string $uid
-	 * @return boolean
-	 */
-	private function isMountPointApplicableToUser($mount, $uid) {
-		$acceptedUids = array('all', $uid);
-		// check if mount point is applicable for the user
-		$intersection = array_intersect($acceptedUids, $mount['applicable']['users']);
-		if (!empty($intersection)) {
-			return true;
-		}
-		// check if mount point is applicable for group where the user is a member
-		foreach ($mount['applicable']['groups'] as $gid) {
-			if ($this->groupManager->isInGroup($uid, $gid)) {
-				return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * check if it is a path which is excluded by ownCloud from encryption
-	 *
-	 * @param string $path
-	 * @return boolean
-	 */
-	public function isExcluded($path) {
-		$normalizedPath = Filesystem::normalizePath($path);
-		$root = explode('/', $normalizedPath, 4);
-		if (count($root) > 1) {
-
-			// detect alternative key storage root
-			$rootDir = $this->getKeyStorageRoot();
-			if ($rootDir !== '' &&
-				0 === strpos(
-					Filesystem::normalizePath($path),
-					Filesystem::normalizePath($rootDir)
-				)
-			) {
-				return true;
-			}
-
-
-			//detect system wide folders
-			if (in_array($root[1], $this->excludedPaths)) {
-				return true;
-			}
-
-			// detect user specific folders
-			if ($this->userManager->userExists($root[1])
-				&& in_array($root[2], $this->excludedPaths)) {
-
-				return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * check if recovery key is enabled for user
-	 *
-	 * @param string $uid
-	 * @return boolean
-	 */
-	public function recoveryEnabled($uid) {
-		$enabled = $this->config->getUserValue($uid, 'encryption', 'recovery_enabled', '0');
-
-		return ($enabled === '1') ? true : false;
-	}
-
-	/**
-	 * set new key storage root
-	 *
-	 * @param string $root new key store root relative to the data folder
-	 */
-	public function setKeyStorageRoot($root) {
-		$this->config->setAppValue('core', 'encryption_key_storage_root', $root);
-	}
-
-	/**
-	 * get key storage root
-	 *
-	 * @return string key storage root
-	 */
-	public function getKeyStorageRoot() {
-		return $this->config->getAppValue('core', 'encryption_key_storage_root', '');
-	}
+    const HEADER_START = 'HBEGIN';
+    const HEADER_END = 'HEND';
+    const HEADER_PADDING_CHAR = '-';
+
+    const HEADER_ENCRYPTION_MODULE_KEY = 'oc_encryption_module';
+
+    /**
+     * block size will always be 8192 for a PHP stream
+     * @see https://bugs.php.net/bug.php?id=21641
+     * @var integer
+     */
+    protected $headerSize = 8192;
+
+    /**
+     * block size will always be 8192 for a PHP stream
+     * @see https://bugs.php.net/bug.php?id=21641
+     * @var integer
+     */
+    protected $blockSize = 8192;
+
+    /** @var View */
+    protected $rootView;
+
+    /** @var array */
+    protected $ocHeaderKeys;
+
+    /** @var \OC\User\Manager */
+    protected $userManager;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var array paths excluded from encryption */
+    protected $excludedPaths;
+
+    /** @var \OC\Group\Manager $manager */
+    protected $groupManager;
+
+    /**
+     *
+     * @param View $rootView
+     * @param \OC\User\Manager $userManager
+     * @param \OC\Group\Manager $groupManager
+     * @param IConfig $config
+     */
+    public function __construct(
+        View $rootView,
+        \OC\User\Manager $userManager,
+        \OC\Group\Manager $groupManager,
+        IConfig $config) {
+
+        $this->ocHeaderKeys = [
+            self::HEADER_ENCRYPTION_MODULE_KEY
+        ];
+
+        $this->rootView = $rootView;
+        $this->userManager = $userManager;
+        $this->groupManager = $groupManager;
+        $this->config = $config;
+
+        $this->excludedPaths[] = 'files_encryption';
+    }
+
+    /**
+     * read encryption module ID from header
+     *
+     * @param array $header
+     * @return string
+     * @throws ModuleDoesNotExistsException
+     */
+    public function getEncryptionModuleId(array $header = null) {
+        $id = '';
+        $encryptionModuleKey = self::HEADER_ENCRYPTION_MODULE_KEY;
+
+        if (isset($header[$encryptionModuleKey])) {
+            $id = $header[$encryptionModuleKey];
+        } elseif (isset($header['cipher'])) {
+            if (class_exists('\OCA\Encryption\Crypto\Encryption')) {
+                // fall back to default encryption if the user migrated from
+                // ownCloud <= 8.0 with the old encryption
+                $id = \OCA\Encryption\Crypto\Encryption::ID;
+            } else {
+                throw new ModuleDoesNotExistsException('Default encryption module missing');
+            }
+        }
+
+        return $id;
+    }
+
+    /**
+     * create header for encrypted file
+     *
+     * @param array $headerData
+     * @param IEncryptionModule $encryptionModule
+     * @return string
+     * @throws EncryptionHeaderToLargeException if header has to many arguments
+     * @throws EncryptionHeaderKeyExistsException if header key is already in use
+     */
+    public function createHeader(array $headerData, IEncryptionModule $encryptionModule) {
+        $header = self::HEADER_START . ':' . self::HEADER_ENCRYPTION_MODULE_KEY . ':' . $encryptionModule->getId() . ':';
+        foreach ($headerData as $key => $value) {
+            if (in_array($key, $this->ocHeaderKeys)) {
+                throw new EncryptionHeaderKeyExistsException($key);
+            }
+            $header .= $key . ':' . $value . ':';
+        }
+        $header .= self::HEADER_END;
+
+        if (strlen($header) > $this->getHeaderSize()) {
+            throw new EncryptionHeaderToLargeException();
+        }
+
+        $paddedHeader = str_pad($header, $this->headerSize, self::HEADER_PADDING_CHAR, STR_PAD_RIGHT);
+
+        return $paddedHeader;
+    }
+
+    /**
+     * go recursively through a dir and collect all files and sub files.
+     *
+     * @param string $dir relative to the users files folder
+     * @return array with list of files relative to the users files folder
+     */
+    public function getAllFiles($dir) {
+        $result = array();
+        $dirList = array($dir);
+
+        while ($dirList) {
+            $dir = array_pop($dirList);
+            $content = $this->rootView->getDirectoryContent($dir);
+
+            foreach ($content as $c) {
+                if ($c->getType() === 'dir') {
+                    $dirList[] = $c->getPath();
+                } else {
+                    $result[] =  $c->getPath();
+                }
+            }
+
+        }
+
+        return $result;
+    }
+
+    /**
+     * check if it is a file uploaded by the user stored in data/user/files
+     * or a metadata file
+     *
+     * @param string $path relative to the data/ folder
+     * @return boolean
+     */
+    public function isFile($path) {
+        $parts = explode('/', Filesystem::normalizePath($path), 4);
+        if (isset($parts[2]) && $parts[2] === 'files') {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * return size of encryption header
+     *
+     * @return integer
+     */
+    public function getHeaderSize() {
+        return $this->headerSize;
+    }
+
+    /**
+     * return size of block read by a PHP stream
+     *
+     * @return integer
+     */
+    public function getBlockSize() {
+        return $this->blockSize;
+    }
+
+    /**
+     * get the owner and the path for the file relative to the owners files folder
+     *
+     * @param string $path
+     * @return array
+     * @throws \BadMethodCallException
+     */
+    public function getUidAndFilename($path) {
+
+        $parts = explode('/', $path);
+        $uid = '';
+        if (count($parts) > 2) {
+            $uid = $parts[1];
+        }
+        if (!$this->userManager->userExists($uid)) {
+            throw new \BadMethodCallException(
+                'path needs to be relative to the system wide data folder and point to a user specific file'
+            );
+        }
+
+        $ownerPath = implode('/', array_slice($parts, 2));
+
+        return array($uid, Filesystem::normalizePath($ownerPath));
+
+    }
+
+    /**
+     * Remove .path extension from a file path
+     * @param string $path Path that may identify a .part file
+     * @return string File path without .part extension
+     * @note this is needed for reusing keys
+     */
+    public function stripPartialFileExtension($path) {
+        $extension = pathinfo($path, PATHINFO_EXTENSION);
+
+        if ( $extension === 'part') {
+
+            $newLength = strlen($path) - 5; // 5 = strlen(".part")
+            $fPath = substr($path, 0, $newLength);
+
+            // if path also contains a transaction id, we remove it too
+            $extension = pathinfo($fPath, PATHINFO_EXTENSION);
+            if(substr($extension, 0, 12) === 'ocTransferId') { // 12 = strlen("ocTransferId")
+                $newLength = strlen($fPath) - strlen($extension) -1;
+                $fPath = substr($fPath, 0, $newLength);
+            }
+            return $fPath;
+
+        } else {
+            return $path;
+        }
+    }
+
+    public function getUserWithAccessToMountPoint($users, $groups) {
+        $result = array();
+        if (in_array('all', $users)) {
+            $result = \OCP\User::getUsers();
+        } else {
+            $result = array_merge($result, $users);
+            foreach ($groups as $group) {
+                $result = array_merge($result, \OC_Group::usersInGroup($group));
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * check if the file is stored on a system wide mount point
+     * @param string $path relative to /data/user with leading '/'
+     * @param string $uid
+     * @return boolean
+     */
+    public function isSystemWideMountPoint($path, $uid) {
+        if (\OCP\App::isEnabled("files_external")) {
+            $mounts = \OC_Mount_Config::getSystemMountPoints();
+            foreach ($mounts as $mount) {
+                if (strpos($path, '/files/' . $mount['mountpoint']) === 0) {
+                    if ($this->isMountPointApplicableToUser($mount, $uid)) {
+                        return true;
+                    }
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * check if mount point is applicable to user
+     *
+     * @param array $mount contains $mount['applicable']['users'], $mount['applicable']['groups']
+     * @param string $uid
+     * @return boolean
+     */
+    private function isMountPointApplicableToUser($mount, $uid) {
+        $acceptedUids = array('all', $uid);
+        // check if mount point is applicable for the user
+        $intersection = array_intersect($acceptedUids, $mount['applicable']['users']);
+        if (!empty($intersection)) {
+            return true;
+        }
+        // check if mount point is applicable for group where the user is a member
+        foreach ($mount['applicable']['groups'] as $gid) {
+            if ($this->groupManager->isInGroup($uid, $gid)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * check if it is a path which is excluded by ownCloud from encryption
+     *
+     * @param string $path
+     * @return boolean
+     */
+    public function isExcluded($path) {
+        $normalizedPath = Filesystem::normalizePath($path);
+        $root = explode('/', $normalizedPath, 4);
+        if (count($root) > 1) {
+
+            // detect alternative key storage root
+            $rootDir = $this->getKeyStorageRoot();
+            if ($rootDir !== '' &&
+                0 === strpos(
+                    Filesystem::normalizePath($path),
+                    Filesystem::normalizePath($rootDir)
+                )
+            ) {
+                return true;
+            }
+
+
+            //detect system wide folders
+            if (in_array($root[1], $this->excludedPaths)) {
+                return true;
+            }
+
+            // detect user specific folders
+            if ($this->userManager->userExists($root[1])
+                && in_array($root[2], $this->excludedPaths)) {
+
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * check if recovery key is enabled for user
+     *
+     * @param string $uid
+     * @return boolean
+     */
+    public function recoveryEnabled($uid) {
+        $enabled = $this->config->getUserValue($uid, 'encryption', 'recovery_enabled', '0');
+
+        return ($enabled === '1') ? true : false;
+    }
+
+    /**
+     * set new key storage root
+     *
+     * @param string $root new key store root relative to the data folder
+     */
+    public function setKeyStorageRoot($root) {
+        $this->config->setAppValue('core', 'encryption_key_storage_root', $root);
+    }
+
+    /**
+     * get key storage root
+     *
+     * @return string key storage root
+     */
+    public function getKeyStorageRoot() {
+        return $this->config->getAppValue('core', 'encryption_key_storage_root', '');
+    }
 
 }

Spacing +7 added lines, -7 removed lines

@@ -135,12 +135,12 @@ 
 	 * @throws EncryptionHeaderKeyExistsException if header key is already in use
 	 */
 	public function createHeader(array $headerData, IEncryptionModule $encryptionModule) {
-		$header = self::HEADER_START . ':' . self::HEADER_ENCRYPTION_MODULE_KEY . ':' . $encryptionModule->getId() . ':';
+		$header = self::HEADER_START.':'.self::HEADER_ENCRYPTION_MODULE_KEY.':'.$encryptionModule->getId().':';
 		foreach ($headerData as $key => $value) {
 			if (in_array($key, $this->ocHeaderKeys)) {
 				throw new EncryptionHeaderKeyExistsException($key);
 			}
-			$header .= $key . ':' . $value . ':';
+			$header .= $key.':'.$value.':';
 		}
 		$header .= self::HEADER_END;
 
@@ -171,7 +171,7 @@ 
 				if ($c->getType() === 'dir') {
 					$dirList[] = $c->getPath();
 				} else {
-					$result[] =  $c->getPath();
+					$result[] = $c->getPath();
 				}
 			}
 
@@ -248,15 +248,15 @@ 
 	public function stripPartialFileExtension($path) {
 		$extension = pathinfo($path, PATHINFO_EXTENSION);
 
-		if ( $extension === 'part') {
+		if ($extension === 'part') {
 
 			$newLength = strlen($path) - 5; // 5 = strlen(".part")
 			$fPath = substr($path, 0, $newLength);
 
 			// if path also contains a transaction id, we remove it too
 			$extension = pathinfo($fPath, PATHINFO_EXTENSION);
-			if(substr($extension, 0, 12) === 'ocTransferId') { // 12 = strlen("ocTransferId")
-				$newLength = strlen($fPath) - strlen($extension) -1;
+			if (substr($extension, 0, 12) === 'ocTransferId') { // 12 = strlen("ocTransferId")
+				$newLength = strlen($fPath) - strlen($extension) - 1;
 				$fPath = substr($fPath, 0, $newLength);
 			}
 			return $fPath;
@@ -290,7 +290,7 @@ 
 		if (\OCP\App::isEnabled("files_external")) {
 			$mounts = \OC_Mount_Config::getSystemMountPoints();
 			foreach ($mounts as $mount) {
-				if (strpos($path, '/files/' . $mount['mountpoint']) === 0) {
+				if (strpos($path, '/files/'.$mount['mountpoint']) === 0) {
 					if ($this->isMountPointApplicableToUser($mount, $uid)) {
 						return true;
 					}

lib/private/Files/Cache/Cache.php

Doc Comments +3 added lines

@@ -402,6 +402,9 @@
 		}
 	}
 
+	/**
+	 * @param string $path
+	 */
 	private function getParentPath($path) {
 		$parent = dirname($path);
 		if ($parent === '.') {

Indentation +773 added lines, -773 removed lines

@@ -52,787 +52,787 @@
  * - ChangePropagator: updates the mtime and etags of parent folders whenever a change to the cache is made to the cache by the updater
  */
 class Cache implements ICache {
-	use MoveFromCacheTrait {
-		MoveFromCacheTrait::moveFromCache as moveFromCacheFallback;
-	}
-
-	/**
-	 * @var array partial data for the cache
-	 */
-	protected $partial = array();
-
-	/**
-	 * @var string
-	 */
-	protected $storageId;
-
-	/**
-	 * @var Storage $storageCache
-	 */
-	protected $storageCache;
-
-	/** @var IMimeTypeLoader */
-	protected $mimetypeLoader;
-
-	/**
-	 * @var IDBConnection
-	 */
-	protected $connection;
-
-	/**
-	 * @param \OC\Files\Storage\Storage|string $storage
-	 */
-	public function __construct($storage) {
-		if ($storage instanceof \OC\Files\Storage\Storage) {
-			$this->storageId = $storage->getId();
-		} else {
-			$this->storageId = $storage;
-		}
-		if (strlen($this->storageId) > 64) {
-			$this->storageId = md5($this->storageId);
-		}
-
-		$this->storageCache = new Storage($storage);
-		$this->mimetypeLoader = \OC::$server->getMimeTypeLoader();
-		$this->connection = \OC::$server->getDatabaseConnection();
-	}
-
-	/**
-	 * Get the numeric storage id for this cache's storage
-	 *
-	 * @return int
-	 */
-	public function getNumericStorageId() {
-		return $this->storageCache->getNumericId();
-	}
-
-	/**
-	 * get the stored metadata of a file or folder
-	 *
-	 * @param string | int $file either the path of a file or folder or the file id for a file or folder
-	 * @return ICacheEntry|false the cache entry as array of false if the file is not found in the cache
-	 */
-	public function get($file) {
-		if (is_string($file) or $file == '') {
-			// normalize file
-			$file = $this->normalize($file);
-
-			$where = 'WHERE `storage` = ? AND `path_hash` = ?';
-			$params = array($this->getNumericStorageId(), md5($file));
-		} else { //file id
-			$where = 'WHERE `fileid` = ?';
-			$params = array($file);
-		}
-		$sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`,
+    use MoveFromCacheTrait {
+        MoveFromCacheTrait::moveFromCache as moveFromCacheFallback;
+    }
+
+    /**
+     * @var array partial data for the cache
+     */
+    protected $partial = array();
+
+    /**
+     * @var string
+     */
+    protected $storageId;
+
+    /**
+     * @var Storage $storageCache
+     */
+    protected $storageCache;
+
+    /** @var IMimeTypeLoader */
+    protected $mimetypeLoader;
+
+    /**
+     * @var IDBConnection
+     */
+    protected $connection;
+
+    /**
+     * @param \OC\Files\Storage\Storage|string $storage
+     */
+    public function __construct($storage) {
+        if ($storage instanceof \OC\Files\Storage\Storage) {
+            $this->storageId = $storage->getId();
+        } else {
+            $this->storageId = $storage;
+        }
+        if (strlen($this->storageId) > 64) {
+            $this->storageId = md5($this->storageId);
+        }
+
+        $this->storageCache = new Storage($storage);
+        $this->mimetypeLoader = \OC::$server->getMimeTypeLoader();
+        $this->connection = \OC::$server->getDatabaseConnection();
+    }
+
+    /**
+     * Get the numeric storage id for this cache's storage
+     *
+     * @return int
+     */
+    public function getNumericStorageId() {
+        return $this->storageCache->getNumericId();
+    }
+
+    /**
+     * get the stored metadata of a file or folder
+     *
+     * @param string | int $file either the path of a file or folder or the file id for a file or folder
+     * @return ICacheEntry|false the cache entry as array of false if the file is not found in the cache
+     */
+    public function get($file) {
+        if (is_string($file) or $file == '') {
+            // normalize file
+            $file = $this->normalize($file);
+
+            $where = 'WHERE `storage` = ? AND `path_hash` = ?';
+            $params = array($this->getNumericStorageId(), md5($file));
+        } else { //file id
+            $where = 'WHERE `fileid` = ?';
+            $params = array($file);
+        }
+        $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`,
 					   `storage_mtime`, `encrypted`, `etag`, `permissions`, `checksum`
 				FROM `*PREFIX*filecache` ' . $where;
-		$result = $this->connection->executeQuery($sql, $params);
-		$data = $result->fetch();
-
-		//FIXME hide this HACK in the next database layer, or just use doctrine and get rid of MDB2 and PDO
-		//PDO returns false, MDB2 returns null, oracle always uses MDB2, so convert null to false
-		if ($data === null) {
-			$data = false;
-		}
-
-		//merge partial data
-		if (!$data and is_string($file)) {
-			if (isset($this->partial[$file])) {
-				$data = $this->partial[$file];
-			}
-			return $data;
-		} else {
-			//fix types
-			$data['fileid'] = (int)$data['fileid'];
-			$data['parent'] = (int)$data['parent'];
-			$data['size'] = 0 + $data['size'];
-			$data['mtime'] = (int)$data['mtime'];
-			$data['storage_mtime'] = (int)$data['storage_mtime'];
-			$data['encryptedVersion'] = (int)$data['encrypted'];
-			$data['encrypted'] = (bool)$data['encrypted'];
-			$data['storage'] = $this->storageId;
-			$data['mimetype'] = $this->mimetypeLoader->getMimetypeById($data['mimetype']);
-			$data['mimepart'] = $this->mimetypeLoader->getMimetypeById($data['mimepart']);
-			if ($data['storage_mtime'] == 0) {
-				$data['storage_mtime'] = $data['mtime'];
-			}
-			$data['permissions'] = (int)$data['permissions'];
-			return new CacheEntry($data);
-		}
-	}
-
-	/**
-	 * get the metadata of all files stored in $folder
-	 *
-	 * @param string $folder
-	 * @return ICacheEntry[]
-	 */
-	public function getFolderContents($folder) {
-		$fileId = $this->getId($folder);
-		return $this->getFolderContentsById($fileId);
-	}
-
-	/**
-	 * get the metadata of all files stored in $folder
-	 *
-	 * @param int $fileId the file id of the folder
-	 * @return ICacheEntry[]
-	 */
-	public function getFolderContentsById($fileId) {
-		if ($fileId > -1) {
-			$sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`,
+        $result = $this->connection->executeQuery($sql, $params);
+        $data = $result->fetch();
+
+        //FIXME hide this HACK in the next database layer, or just use doctrine and get rid of MDB2 and PDO
+        //PDO returns false, MDB2 returns null, oracle always uses MDB2, so convert null to false
+        if ($data === null) {
+            $data = false;
+        }
+
+        //merge partial data
+        if (!$data and is_string($file)) {
+            if (isset($this->partial[$file])) {
+                $data = $this->partial[$file];
+            }
+            return $data;
+        } else {
+            //fix types
+            $data['fileid'] = (int)$data['fileid'];
+            $data['parent'] = (int)$data['parent'];
+            $data['size'] = 0 + $data['size'];
+            $data['mtime'] = (int)$data['mtime'];
+            $data['storage_mtime'] = (int)$data['storage_mtime'];
+            $data['encryptedVersion'] = (int)$data['encrypted'];
+            $data['encrypted'] = (bool)$data['encrypted'];
+            $data['storage'] = $this->storageId;
+            $data['mimetype'] = $this->mimetypeLoader->getMimetypeById($data['mimetype']);
+            $data['mimepart'] = $this->mimetypeLoader->getMimetypeById($data['mimepart']);
+            if ($data['storage_mtime'] == 0) {
+                $data['storage_mtime'] = $data['mtime'];
+            }
+            $data['permissions'] = (int)$data['permissions'];
+            return new CacheEntry($data);
+        }
+    }
+
+    /**
+     * get the metadata of all files stored in $folder
+     *
+     * @param string $folder
+     * @return ICacheEntry[]
+     */
+    public function getFolderContents($folder) {
+        $fileId = $this->getId($folder);
+        return $this->getFolderContentsById($fileId);
+    }
+
+    /**
+     * get the metadata of all files stored in $folder
+     *
+     * @param int $fileId the file id of the folder
+     * @return ICacheEntry[]
+     */
+    public function getFolderContentsById($fileId) {
+        if ($fileId > -1) {
+            $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`,
 						   `storage_mtime`, `encrypted`, `etag`, `permissions`, `checksum`
 					FROM `*PREFIX*filecache` WHERE `parent` = ? ORDER BY `name` ASC';
-			$result = $this->connection->executeQuery($sql, [$fileId]);
-			$files = $result->fetchAll();
-			foreach ($files as &$file) {
-				$file['mimetype'] = $this->mimetypeLoader->getMimetypeById($file['mimetype']);
-				$file['mimepart'] = $this->mimetypeLoader->getMimetypeById($file['mimepart']);
-				if ($file['storage_mtime'] == 0) {
-					$file['storage_mtime'] = $file['mtime'];
-				}
-				$file['permissions'] = (int)$file['permissions'];
-				$file['mtime'] = (int)$file['mtime'];
-				$file['storage_mtime'] = (int)$file['storage_mtime'];
-				$file['size'] = 0 + $file['size'];
-			}
-			return array_map(function (array $data) {
-				return new CacheEntry($data);
-			}, $files);
-		} else {
-			return array();
-		}
-	}
-
-	/**
-	 * insert or update meta data for a file or folder
-	 *
-	 * @param string $file
-	 * @param array $data
-	 *
-	 * @return int file id
-	 * @throws \RuntimeException
-	 */
-	public function put($file, array $data) {
-		if (($id = $this->getId($file)) > -1) {
-			$this->update($id, $data);
-			return $id;
-		} else {
-			return $this->insert($file, $data);
-		}
-	}
-
-	/**
-	 * insert meta data for a new file or folder
-	 *
-	 * @param string $file
-	 * @param array $data
-	 *
-	 * @return int file id
-	 * @throws \RuntimeException
-	 */
-	public function insert($file, array $data) {
-		// normalize file
-		$file = $this->normalize($file);
-
-		if (isset($this->partial[$file])) { //add any saved partial data
-			$data = array_merge($this->partial[$file], $data);
-			unset($this->partial[$file]);
-		}
-
-		$requiredFields = array('size', 'mtime', 'mimetype');
-		foreach ($requiredFields as $field) {
-			if (!isset($data[$field])) { //data not complete save as partial and return
-				$this->partial[$file] = $data;
-				return -1;
-			}
-		}
-
-		$data['path'] = $file;
-		$data['parent'] = $this->getParentId($file);
-		$data['name'] = \OC_Util::basename($file);
-
-		list($queryParts, $params) = $this->buildParts($data);
-		$queryParts[] = '`storage`';
-		$params[] = $this->getNumericStorageId();
-
-		$queryParts = array_map(function ($item) {
-			return trim($item, "`");
-		}, $queryParts);
-		$values = array_combine($queryParts, $params);
-		if (\OC::$server->getDatabaseConnection()->insertIfNotExist('*PREFIX*filecache', $values, [
-			'storage',
-			'path_hash',
-		])
-		) {
-			return (int)$this->connection->lastInsertId('*PREFIX*filecache');
-		}
-
-		// The file was created in the mean time
-		if (($id = $this->getId($file)) > -1) {
-			$this->update($id, $data);
-			return $id;
-		} else {
-			throw new \RuntimeException('File entry could not be inserted with insertIfNotExist() but could also not be selected with getId() in order to perform an update. Please try again.');
-		}
-	}
-
-	/**
-	 * update the metadata of an existing file or folder in the cache
-	 *
-	 * @param int $id the fileid of the existing file or folder
-	 * @param array $data [$key => $value] the metadata to update, only the fields provided in the array will be updated, non-provided values will remain unchanged
-	 */
-	public function update($id, array $data) {
-
-		if (isset($data['path'])) {
-			// normalize path
-			$data['path'] = $this->normalize($data['path']);
-		}
-
-		if (isset($data['name'])) {
-			// normalize path
-			$data['name'] = $this->normalize($data['name']);
-		}
-
-		list($queryParts, $params) = $this->buildParts($data);
-		// duplicate $params because we need the parts twice in the SQL statement
-		// once for the SET part, once in the WHERE clause
-		$params = array_merge($params, $params);
-		$params[] = $id;
-
-		// don't update if the data we try to set is the same as the one in the record
-		// some databases (Postgres) don't like superfluous updates
-		$sql = 'UPDATE `*PREFIX*filecache` SET ' . implode(' = ?, ', $queryParts) . '=? ' .
-			'WHERE (' .
-			implode(' <> ? OR ', $queryParts) . ' <> ? OR ' .
-			implode(' IS NULL OR ', $queryParts) . ' IS NULL' .
-			') AND `fileid` = ? ';
-		$this->connection->executeQuery($sql, $params);
-
-	}
-
-	/**
-	 * extract query parts and params array from data array
-	 *
-	 * @param array $data
-	 * @return array [$queryParts, $params]
-	 *        $queryParts: string[], the (escaped) column names to be set in the query
-	 *        $params: mixed[], the new values for the columns, to be passed as params to the query
-	 */
-	protected function buildParts(array $data) {
-		$fields = array(
-			'path', 'parent', 'name', 'mimetype', 'size', 'mtime', 'storage_mtime', 'encrypted',
-			'etag', 'permissions', 'checksum');
-
-		$doNotCopyStorageMTime = false;
-		if (array_key_exists('mtime', $data) && $data['mtime'] === null) {
-			// this horrific magic tells it to not copy storage_mtime to mtime
-			unset($data['mtime']);
-			$doNotCopyStorageMTime = true;
-		}
-
-		$params = array();
-		$queryParts = array();
-		foreach ($data as $name => $value) {
-			if (array_search($name, $fields) !== false) {
-				if ($name === 'path') {
-					$params[] = md5($value);
-					$queryParts[] = '`path_hash`';
-				} elseif ($name === 'mimetype') {
-					$params[] = $this->mimetypeLoader->getId(substr($value, 0, strpos($value, '/')));
-					$queryParts[] = '`mimepart`';
-					$value = $this->mimetypeLoader->getId($value);
-				} elseif ($name === 'storage_mtime') {
-					if (!$doNotCopyStorageMTime && !isset($data['mtime'])) {
-						$params[] = $value;
-						$queryParts[] = '`mtime`';
-					}
-				} elseif ($name === 'encrypted') {
-					if(isset($data['encryptedVersion'])) {
-						$value = $data['encryptedVersion'];
-					} else {
-						// Boolean to integer conversion
-						$value = $value ? 1 : 0;
-					}
-				}
-				$params[] = $value;
-				$queryParts[] = '`' . $name . '`';
-			}
-		}
-		return array($queryParts, $params);
-	}
-
-	/**
-	 * get the file id for a file
-	 *
-	 * A file id is a numeric id for a file or folder that's unique within an owncloud instance which stays the same for the lifetime of a file
-	 *
-	 * File ids are easiest way for apps to store references to a file since unlike paths they are not affected by renames or sharing
-	 *
-	 * @param string $file
-	 * @return int
-	 */
-	public function getId($file) {
-		// normalize file
-		$file = $this->normalize($file);
-
-		$pathHash = md5($file);
-
-		$sql = 'SELECT `fileid` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path_hash` = ?';
-		$result = $this->connection->executeQuery($sql, array($this->getNumericStorageId(), $pathHash));
-		if ($row = $result->fetch()) {
-			return $row['fileid'];
-		} else {
-			return -1;
-		}
-	}
-
-	/**
-	 * get the id of the parent folder of a file
-	 *
-	 * @param string $file
-	 * @return int
-	 */
-	public function getParentId($file) {
-		if ($file === '') {
-			return -1;
-		} else {
-			$parent = $this->getParentPath($file);
-			return (int)$this->getId($parent);
-		}
-	}
-
-	private function getParentPath($path) {
-		$parent = dirname($path);
-		if ($parent === '.') {
-			$parent = '';
-		}
-		return $parent;
-	}
-
-	/**
-	 * check if a file is available in the cache
-	 *
-	 * @param string $file
-	 * @return bool
-	 */
-	public function inCache($file) {
-		return $this->getId($file) != -1;
-	}
-
-	/**
-	 * remove a file or folder from the cache
-	 *
-	 * when removing a folder from the cache all files and folders inside the folder will be removed as well
-	 *
-	 * @param string $file
-	 */
-	public function remove($file) {
-		$entry = $this->get($file);
-		$sql = 'DELETE FROM `*PREFIX*filecache` WHERE `fileid` = ?';
-		$this->connection->executeQuery($sql, array($entry['fileid']));
-		if ($entry['mimetype'] === 'httpd/unix-directory') {
-			$this->removeChildren($entry);
-		}
-	}
-
-	/**
-	 * Get all sub folders of a folder
-	 *
-	 * @param array $entry the cache entry of the folder to get the subfolders for
-	 * @return array[] the cache entries for the subfolders
-	 */
-	private function getSubFolders($entry) {
-		$children = $this->getFolderContentsById($entry['fileid']);
-		return array_filter($children, function ($child) {
-			return $child['mimetype'] === 'httpd/unix-directory';
-		});
-	}
-
-	/**
-	 * Recursively remove all children of a folder
-	 *
-	 * @param array $entry the cache entry of the folder to remove the children of
-	 * @throws \OC\DatabaseException
-	 */
-	private function removeChildren($entry) {
-		$subFolders = $this->getSubFolders($entry);
-		foreach ($subFolders as $folder) {
-			$this->removeChildren($folder);
-		}
-		$sql = 'DELETE FROM `*PREFIX*filecache` WHERE `parent` = ?';
-		$this->connection->executeQuery($sql, array($entry['fileid']));
-	}
-
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * @param string $source
-	 * @param string $target
-	 */
-	public function move($source, $target) {
-		$this->moveFromCache($this, $source, $target);
-	}
-
-	/**
-	 * Get the storage id and path needed for a move
-	 *
-	 * @param string $path
-	 * @return array [$storageId, $internalPath]
-	 */
-	protected function getMoveInfo($path) {
-		return [$this->getNumericStorageId(), $path];
-	}
-
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * @param \OCP\Files\Cache\ICache $sourceCache
-	 * @param string $sourcePath
-	 * @param string $targetPath
-	 * @throws \OC\DatabaseException
-	 */
-	public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath) {
-		if ($sourceCache instanceof Cache) {
-			// normalize source and target
-			$sourcePath = $this->normalize($sourcePath);
-			$targetPath = $this->normalize($targetPath);
-
-			$sourceData = $sourceCache->get($sourcePath);
-			$sourceId = $sourceData['fileid'];
-			$newParentId = $this->getParentId($targetPath);
-
-			list($sourceStorageId, $sourcePath) = $sourceCache->getMoveInfo($sourcePath);
-			list($targetStorageId, $targetPath) = $this->getMoveInfo($targetPath);
-
-			// sql for final update
-			$moveSql = 'UPDATE `*PREFIX*filecache` SET `storage` =  ?, `path` = ?, `path_hash` = ?, `name` = ?, `parent` =? WHERE `fileid` = ?';
-
-			if ($sourceData['mimetype'] === 'httpd/unix-directory') {
-				//find all child entries
-				$sql = 'SELECT `path`, `fileid` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path` LIKE ?';
-				$result = $this->connection->executeQuery($sql, [$sourceStorageId, $this->connection->escapeLikeParameter($sourcePath) . '/%']);
-				$childEntries = $result->fetchAll();
-				$sourceLength = strlen($sourcePath);
-				$this->connection->beginTransaction();
-				$query = $this->connection->prepare('UPDATE `*PREFIX*filecache` SET `storage` = ?, `path` = ?, `path_hash` = ? WHERE `fileid` = ?');
-
-				foreach ($childEntries as $child) {
-					$newTargetPath = $targetPath . substr($child['path'], $sourceLength);
-					$query->execute([$targetStorageId, $newTargetPath, md5($newTargetPath), $child['fileid']]);
-				}
-				$this->connection->executeQuery($moveSql, [$targetStorageId, $targetPath, md5($targetPath), basename($targetPath), $newParentId, $sourceId]);
-				$this->connection->commit();
-			} else {
-				$this->connection->executeQuery($moveSql, [$targetStorageId, $targetPath, md5($targetPath), basename($targetPath), $newParentId, $sourceId]);
-			}
-		} else {
-			$this->moveFromCacheFallback($sourceCache, $sourcePath, $targetPath);
-		}
-	}
-
-	/**
-	 * remove all entries for files that are stored on the storage from the cache
-	 */
-	public function clear() {
-		$sql = 'DELETE FROM `*PREFIX*filecache` WHERE `storage` = ?';
-		$this->connection->executeQuery($sql, array($this->getNumericStorageId()));
-
-		$sql = 'DELETE FROM `*PREFIX*storages` WHERE `id` = ?';
-		$this->connection->executeQuery($sql, array($this->storageId));
-	}
-
-	/**
-	 * Get the scan status of a file
-	 *
-	 * - Cache::NOT_FOUND: File is not in the cache
-	 * - Cache::PARTIAL: File is not stored in the cache but some incomplete data is known
-	 * - Cache::SHALLOW: The folder and it's direct children are in the cache but not all sub folders are fully scanned
-	 * - Cache::COMPLETE: The file or folder, with all it's children) are fully scanned
-	 *
-	 * @param string $file
-	 *
-	 * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
-	 */
-	public function getStatus($file) {
-		// normalize file
-		$file = $this->normalize($file);
-
-		$pathHash = md5($file);
-		$sql = 'SELECT `size` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path_hash` = ?';
-		$result = $this->connection->executeQuery($sql, array($this->getNumericStorageId(), $pathHash));
-		if ($row = $result->fetch()) {
-			if ((int)$row['size'] === -1) {
-				return self::SHALLOW;
-			} else {
-				return self::COMPLETE;
-			}
-		} else {
-			if (isset($this->partial[$file])) {
-				return self::PARTIAL;
-			} else {
-				return self::NOT_FOUND;
-			}
-		}
-	}
-
-	/**
-	 * search for files matching $pattern
-	 *
-	 * @param string $pattern the search pattern using SQL search syntax (e.g. '%searchstring%')
-	 * @return ICacheEntry[] an array of cache entries where the name matches the search pattern
-	 */
-	public function search($pattern) {
-		// normalize pattern
-		$pattern = $this->normalize($pattern);
-
-
-		$sql = '
+            $result = $this->connection->executeQuery($sql, [$fileId]);
+            $files = $result->fetchAll();
+            foreach ($files as &$file) {
+                $file['mimetype'] = $this->mimetypeLoader->getMimetypeById($file['mimetype']);
+                $file['mimepart'] = $this->mimetypeLoader->getMimetypeById($file['mimepart']);
+                if ($file['storage_mtime'] == 0) {
+                    $file['storage_mtime'] = $file['mtime'];
+                }
+                $file['permissions'] = (int)$file['permissions'];
+                $file['mtime'] = (int)$file['mtime'];
+                $file['storage_mtime'] = (int)$file['storage_mtime'];
+                $file['size'] = 0 + $file['size'];
+            }
+            return array_map(function (array $data) {
+                return new CacheEntry($data);
+            }, $files);
+        } else {
+            return array();
+        }
+    }
+
+    /**
+     * insert or update meta data for a file or folder
+     *
+     * @param string $file
+     * @param array $data
+     *
+     * @return int file id
+     * @throws \RuntimeException
+     */
+    public function put($file, array $data) {
+        if (($id = $this->getId($file)) > -1) {
+            $this->update($id, $data);
+            return $id;
+        } else {
+            return $this->insert($file, $data);
+        }
+    }
+
+    /**
+     * insert meta data for a new file or folder
+     *
+     * @param string $file
+     * @param array $data
+     *
+     * @return int file id
+     * @throws \RuntimeException
+     */
+    public function insert($file, array $data) {
+        // normalize file
+        $file = $this->normalize($file);
+
+        if (isset($this->partial[$file])) { //add any saved partial data
+            $data = array_merge($this->partial[$file], $data);
+            unset($this->partial[$file]);
+        }
+
+        $requiredFields = array('size', 'mtime', 'mimetype');
+        foreach ($requiredFields as $field) {
+            if (!isset($data[$field])) { //data not complete save as partial and return
+                $this->partial[$file] = $data;
+                return -1;
+            }
+        }
+
+        $data['path'] = $file;
+        $data['parent'] = $this->getParentId($file);
+        $data['name'] = \OC_Util::basename($file);
+
+        list($queryParts, $params) = $this->buildParts($data);
+        $queryParts[] = '`storage`';
+        $params[] = $this->getNumericStorageId();
+
+        $queryParts = array_map(function ($item) {
+            return trim($item, "`");
+        }, $queryParts);
+        $values = array_combine($queryParts, $params);
+        if (\OC::$server->getDatabaseConnection()->insertIfNotExist('*PREFIX*filecache', $values, [
+            'storage',
+            'path_hash',
+        ])
+        ) {
+            return (int)$this->connection->lastInsertId('*PREFIX*filecache');
+        }
+
+        // The file was created in the mean time
+        if (($id = $this->getId($file)) > -1) {
+            $this->update($id, $data);
+            return $id;
+        } else {
+            throw new \RuntimeException('File entry could not be inserted with insertIfNotExist() but could also not be selected with getId() in order to perform an update. Please try again.');
+        }
+    }
+
+    /**
+     * update the metadata of an existing file or folder in the cache
+     *
+     * @param int $id the fileid of the existing file or folder
+     * @param array $data [$key => $value] the metadata to update, only the fields provided in the array will be updated, non-provided values will remain unchanged
+     */
+    public function update($id, array $data) {
+
+        if (isset($data['path'])) {
+            // normalize path
+            $data['path'] = $this->normalize($data['path']);
+        }
+
+        if (isset($data['name'])) {
+            // normalize path
+            $data['name'] = $this->normalize($data['name']);
+        }
+
+        list($queryParts, $params) = $this->buildParts($data);
+        // duplicate $params because we need the parts twice in the SQL statement
+        // once for the SET part, once in the WHERE clause
+        $params = array_merge($params, $params);
+        $params[] = $id;
+
+        // don't update if the data we try to set is the same as the one in the record
+        // some databases (Postgres) don't like superfluous updates
+        $sql = 'UPDATE `*PREFIX*filecache` SET ' . implode(' = ?, ', $queryParts) . '=? ' .
+            'WHERE (' .
+            implode(' <> ? OR ', $queryParts) . ' <> ? OR ' .
+            implode(' IS NULL OR ', $queryParts) . ' IS NULL' .
+            ') AND `fileid` = ? ';
+        $this->connection->executeQuery($sql, $params);
+
+    }
+
+    /**
+     * extract query parts and params array from data array
+     *
+     * @param array $data
+     * @return array [$queryParts, $params]
+     *        $queryParts: string[], the (escaped) column names to be set in the query
+     *        $params: mixed[], the new values for the columns, to be passed as params to the query
+     */
+    protected function buildParts(array $data) {
+        $fields = array(
+            'path', 'parent', 'name', 'mimetype', 'size', 'mtime', 'storage_mtime', 'encrypted',
+            'etag', 'permissions', 'checksum');
+
+        $doNotCopyStorageMTime = false;
+        if (array_key_exists('mtime', $data) && $data['mtime'] === null) {
+            // this horrific magic tells it to not copy storage_mtime to mtime
+            unset($data['mtime']);
+            $doNotCopyStorageMTime = true;
+        }
+
+        $params = array();
+        $queryParts = array();
+        foreach ($data as $name => $value) {
+            if (array_search($name, $fields) !== false) {
+                if ($name === 'path') {
+                    $params[] = md5($value);
+                    $queryParts[] = '`path_hash`';
+                } elseif ($name === 'mimetype') {
+                    $params[] = $this->mimetypeLoader->getId(substr($value, 0, strpos($value, '/')));
+                    $queryParts[] = '`mimepart`';
+                    $value = $this->mimetypeLoader->getId($value);
+                } elseif ($name === 'storage_mtime') {
+                    if (!$doNotCopyStorageMTime && !isset($data['mtime'])) {
+                        $params[] = $value;
+                        $queryParts[] = '`mtime`';
+                    }
+                } elseif ($name === 'encrypted') {
+                    if(isset($data['encryptedVersion'])) {
+                        $value = $data['encryptedVersion'];
+                    } else {
+                        // Boolean to integer conversion
+                        $value = $value ? 1 : 0;
+                    }
+                }
+                $params[] = $value;
+                $queryParts[] = '`' . $name . '`';
+            }
+        }
+        return array($queryParts, $params);
+    }
+
+    /**
+     * get the file id for a file
+     *
+     * A file id is a numeric id for a file or folder that's unique within an owncloud instance which stays the same for the lifetime of a file
+     *
+     * File ids are easiest way for apps to store references to a file since unlike paths they are not affected by renames or sharing
+     *
+     * @param string $file
+     * @return int
+     */
+    public function getId($file) {
+        // normalize file
+        $file = $this->normalize($file);
+
+        $pathHash = md5($file);
+
+        $sql = 'SELECT `fileid` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path_hash` = ?';
+        $result = $this->connection->executeQuery($sql, array($this->getNumericStorageId(), $pathHash));
+        if ($row = $result->fetch()) {
+            return $row['fileid'];
+        } else {
+            return -1;
+        }
+    }
+
+    /**
+     * get the id of the parent folder of a file
+     *
+     * @param string $file
+     * @return int
+     */
+    public function getParentId($file) {
+        if ($file === '') {
+            return -1;
+        } else {
+            $parent = $this->getParentPath($file);
+            return (int)$this->getId($parent);
+        }
+    }
+
+    private function getParentPath($path) {
+        $parent = dirname($path);
+        if ($parent === '.') {
+            $parent = '';
+        }
+        return $parent;
+    }
+
+    /**
+     * check if a file is available in the cache
+     *
+     * @param string $file
+     * @return bool
+     */
+    public function inCache($file) {
+        return $this->getId($file) != -1;
+    }
+
+    /**
+     * remove a file or folder from the cache
+     *
+     * when removing a folder from the cache all files and folders inside the folder will be removed as well
+     *
+     * @param string $file
+     */
+    public function remove($file) {
+        $entry = $this->get($file);
+        $sql = 'DELETE FROM `*PREFIX*filecache` WHERE `fileid` = ?';
+        $this->connection->executeQuery($sql, array($entry['fileid']));
+        if ($entry['mimetype'] === 'httpd/unix-directory') {
+            $this->removeChildren($entry);
+        }
+    }
+
+    /**
+     * Get all sub folders of a folder
+     *
+     * @param array $entry the cache entry of the folder to get the subfolders for
+     * @return array[] the cache entries for the subfolders
+     */
+    private function getSubFolders($entry) {
+        $children = $this->getFolderContentsById($entry['fileid']);
+        return array_filter($children, function ($child) {
+            return $child['mimetype'] === 'httpd/unix-directory';
+        });
+    }
+
+    /**
+     * Recursively remove all children of a folder
+     *
+     * @param array $entry the cache entry of the folder to remove the children of
+     * @throws \OC\DatabaseException
+     */
+    private function removeChildren($entry) {
+        $subFolders = $this->getSubFolders($entry);
+        foreach ($subFolders as $folder) {
+            $this->removeChildren($folder);
+        }
+        $sql = 'DELETE FROM `*PREFIX*filecache` WHERE `parent` = ?';
+        $this->connection->executeQuery($sql, array($entry['fileid']));
+    }
+
+    /**
+     * Move a file or folder in the cache
+     *
+     * @param string $source
+     * @param string $target
+     */
+    public function move($source, $target) {
+        $this->moveFromCache($this, $source, $target);
+    }
+
+    /**
+     * Get the storage id and path needed for a move
+     *
+     * @param string $path
+     * @return array [$storageId, $internalPath]
+     */
+    protected function getMoveInfo($path) {
+        return [$this->getNumericStorageId(), $path];
+    }
+
+    /**
+     * Move a file or folder in the cache
+     *
+     * @param \OCP\Files\Cache\ICache $sourceCache
+     * @param string $sourcePath
+     * @param string $targetPath
+     * @throws \OC\DatabaseException
+     */
+    public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath) {
+        if ($sourceCache instanceof Cache) {
+            // normalize source and target
+            $sourcePath = $this->normalize($sourcePath);
+            $targetPath = $this->normalize($targetPath);
+
+            $sourceData = $sourceCache->get($sourcePath);
+            $sourceId = $sourceData['fileid'];
+            $newParentId = $this->getParentId($targetPath);
+
+            list($sourceStorageId, $sourcePath) = $sourceCache->getMoveInfo($sourcePath);
+            list($targetStorageId, $targetPath) = $this->getMoveInfo($targetPath);
+
+            // sql for final update
+            $moveSql = 'UPDATE `*PREFIX*filecache` SET `storage` =  ?, `path` = ?, `path_hash` = ?, `name` = ?, `parent` =? WHERE `fileid` = ?';
+
+            if ($sourceData['mimetype'] === 'httpd/unix-directory') {
+                //find all child entries
+                $sql = 'SELECT `path`, `fileid` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path` LIKE ?';
+                $result = $this->connection->executeQuery($sql, [$sourceStorageId, $this->connection->escapeLikeParameter($sourcePath) . '/%']);
+                $childEntries = $result->fetchAll();
+                $sourceLength = strlen($sourcePath);
+                $this->connection->beginTransaction();
+                $query = $this->connection->prepare('UPDATE `*PREFIX*filecache` SET `storage` = ?, `path` = ?, `path_hash` = ? WHERE `fileid` = ?');
+
+                foreach ($childEntries as $child) {
+                    $newTargetPath = $targetPath . substr($child['path'], $sourceLength);
+                    $query->execute([$targetStorageId, $newTargetPath, md5($newTargetPath), $child['fileid']]);
+                }
+                $this->connection->executeQuery($moveSql, [$targetStorageId, $targetPath, md5($targetPath), basename($targetPath), $newParentId, $sourceId]);
+                $this->connection->commit();
+            } else {
+                $this->connection->executeQuery($moveSql, [$targetStorageId, $targetPath, md5($targetPath), basename($targetPath), $newParentId, $sourceId]);
+            }
+        } else {
+            $this->moveFromCacheFallback($sourceCache, $sourcePath, $targetPath);
+        }
+    }
+
+    /**
+     * remove all entries for files that are stored on the storage from the cache
+     */
+    public function clear() {
+        $sql = 'DELETE FROM `*PREFIX*filecache` WHERE `storage` = ?';
+        $this->connection->executeQuery($sql, array($this->getNumericStorageId()));
+
+        $sql = 'DELETE FROM `*PREFIX*storages` WHERE `id` = ?';
+        $this->connection->executeQuery($sql, array($this->storageId));
+    }
+
+    /**
+     * Get the scan status of a file
+     *
+     * - Cache::NOT_FOUND: File is not in the cache
+     * - Cache::PARTIAL: File is not stored in the cache but some incomplete data is known
+     * - Cache::SHALLOW: The folder and it's direct children are in the cache but not all sub folders are fully scanned
+     * - Cache::COMPLETE: The file or folder, with all it's children) are fully scanned
+     *
+     * @param string $file
+     *
+     * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
+     */
+    public function getStatus($file) {
+        // normalize file
+        $file = $this->normalize($file);
+
+        $pathHash = md5($file);
+        $sql = 'SELECT `size` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path_hash` = ?';
+        $result = $this->connection->executeQuery($sql, array($this->getNumericStorageId(), $pathHash));
+        if ($row = $result->fetch()) {
+            if ((int)$row['size'] === -1) {
+                return self::SHALLOW;
+            } else {
+                return self::COMPLETE;
+            }
+        } else {
+            if (isset($this->partial[$file])) {
+                return self::PARTIAL;
+            } else {
+                return self::NOT_FOUND;
+            }
+        }
+    }
+
+    /**
+     * search for files matching $pattern
+     *
+     * @param string $pattern the search pattern using SQL search syntax (e.g. '%searchstring%')
+     * @return ICacheEntry[] an array of cache entries where the name matches the search pattern
+     */
+    public function search($pattern) {
+        // normalize pattern
+        $pattern = $this->normalize($pattern);
+
+
+        $sql = '
 			SELECT `fileid`, `storage`, `path`, `parent`, `name`,
 				`mimetype`, `mimepart`, `size`, `mtime`, `encrypted`,
 				`etag`, `permissions`, `checksum`
 			FROM `*PREFIX*filecache`
 			WHERE `storage` = ? AND `name` ILIKE ?';
-		$result = $this->connection->executeQuery($sql,
-			[$this->getNumericStorageId(), $pattern]
-		);
-
-		$files = [];
-		while ($row = $result->fetch()) {
-			$row['mimetype'] = $this->mimetypeLoader->getMimetypeById($row['mimetype']);
-			$row['mimepart'] = $this->mimetypeLoader->getMimetypeById($row['mimepart']);
-			$files[] = $row;
-		}
-		return array_map(function(array $data) {
-			return new CacheEntry($data);
-		}, $files);
-	}
-
-	/**
-	 * search for files by mimetype
-	 *
-	 * @param string $mimetype either a full mimetype to search ('text/plain') or only the first part of a mimetype ('image')
-	 *        where it will search for all mimetypes in the group ('image/*')
-	 * @return ICacheEntry[] an array of cache entries where the mimetype matches the search
-	 */
-	public function searchByMime($mimetype) {
-		if (strpos($mimetype, '/')) {
-			$where = '`mimetype` = ?';
-		} else {
-			$where = '`mimepart` = ?';
-		}
-		$sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`, `encrypted`, `etag`, `permissions`, `checksum`
+        $result = $this->connection->executeQuery($sql,
+            [$this->getNumericStorageId(), $pattern]
+        );
+
+        $files = [];
+        while ($row = $result->fetch()) {
+            $row['mimetype'] = $this->mimetypeLoader->getMimetypeById($row['mimetype']);
+            $row['mimepart'] = $this->mimetypeLoader->getMimetypeById($row['mimepart']);
+            $files[] = $row;
+        }
+        return array_map(function(array $data) {
+            return new CacheEntry($data);
+        }, $files);
+    }
+
+    /**
+     * search for files by mimetype
+     *
+     * @param string $mimetype either a full mimetype to search ('text/plain') or only the first part of a mimetype ('image')
+     *        where it will search for all mimetypes in the group ('image/*')
+     * @return ICacheEntry[] an array of cache entries where the mimetype matches the search
+     */
+    public function searchByMime($mimetype) {
+        if (strpos($mimetype, '/')) {
+            $where = '`mimetype` = ?';
+        } else {
+            $where = '`mimepart` = ?';
+        }
+        $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`, `encrypted`, `etag`, `permissions`, `checksum`
 				FROM `*PREFIX*filecache` WHERE ' . $where . ' AND `storage` = ?';
-		$mimetype = $this->mimetypeLoader->getId($mimetype);
-		$result = $this->connection->executeQuery($sql, array($mimetype, $this->getNumericStorageId()));
-		$files = array();
-		while ($row = $result->fetch()) {
-			$row['mimetype'] = $this->mimetypeLoader->getMimetypeById($row['mimetype']);
-			$row['mimepart'] = $this->mimetypeLoader->getMimetypeById($row['mimepart']);
-			$files[] = $row;
-		}
-		return array_map(function (array $data) {
-			return new CacheEntry($data);
-		}, $files);
-	}
-
-	/**
-	 * Search for files by tag of a given users.
-	 *
-	 * Note that every user can tag files differently.
-	 *
-	 * @param string|int $tag name or tag id
-	 * @param string $userId owner of the tags
-	 * @return ICacheEntry[] file data
-	 */
-	public function searchByTag($tag, $userId) {
-		$sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, ' .
-			'`mimetype`, `mimepart`, `size`, `mtime`, ' .
-			'`encrypted`, `etag`, `permissions`, `checksum` ' .
-			'FROM `*PREFIX*filecache` `file`, ' .
-			'`*PREFIX*vcategory_to_object` `tagmap`, ' .
-			'`*PREFIX*vcategory` `tag` ' .
-			// JOIN filecache to vcategory_to_object
-			'WHERE `file`.`fileid` = `tagmap`.`objid` ' .
-			// JOIN vcategory_to_object to vcategory
-			'AND `tagmap`.`type` = `tag`.`type` ' .
-			'AND `tagmap`.`categoryid` = `tag`.`id` ' .
-			// conditions
-			'AND `file`.`storage` = ? ' .
-			'AND `tag`.`type` = \'files\' ' .
-			'AND `tag`.`uid` = ? ';
-		if (is_int($tag)) {
-			$sql .= 'AND `tag`.`id` = ? ';
-		} else {
-			$sql .= 'AND `tag`.`category` = ? ';
-		}
-		$result = $this->connection->executeQuery(
-			$sql,
-			[
-				$this->getNumericStorageId(),
-				$userId,
-				$tag
-			]
-		);
-		$files = array();
-		while ($row = $result->fetch()) {
-			$files[] = $row;
-		}
-		return array_map(function (array $data) {
-			return new CacheEntry($data);
-		}, $files);
-	}
-
-	/**
-	 * Re-calculate the folder size and the size of all parent folders
-	 *
-	 * @param string|boolean $path
-	 * @param array $data (optional) meta data of the folder
-	 */
-	public function correctFolderSize($path, $data = null) {
-		$this->calculateFolderSize($path, $data);
-		if ($path !== '') {
-			$parent = dirname($path);
-			if ($parent === '.' or $parent === '/') {
-				$parent = '';
-			}
-			$this->correctFolderSize($parent);
-		}
-	}
-
-	/**
-	 * calculate the size of a folder and set it in the cache
-	 *
-	 * @param string $path
-	 * @param array $entry (optional) meta data of the folder
-	 * @return int
-	 */
-	public function calculateFolderSize($path, $entry = null) {
-		$totalSize = 0;
-		if (is_null($entry) or !isset($entry['fileid'])) {
-			$entry = $this->get($path);
-		}
-		if (isset($entry['mimetype']) && $entry['mimetype'] === 'httpd/unix-directory') {
-			$id = $entry['fileid'];
-			$sql = 'SELECT SUM(`size`) AS f1, MIN(`size`) AS f2 ' .
-				'FROM `*PREFIX*filecache` ' .
-				'WHERE `parent` = ? AND `storage` = ?';
-			$result = $this->connection->executeQuery($sql, array($id, $this->getNumericStorageId()));
-			if ($row = $result->fetch()) {
-				$result->closeCursor();
-				list($sum, $min) = array_values($row);
-				$sum = 0 + $sum;
-				$min = 0 + $min;
-				if ($min === -1) {
-					$totalSize = $min;
-				} else {
-					$totalSize = $sum;
-				}
-				$update = array();
-				if ($entry['size'] !== $totalSize) {
-					$update['size'] = $totalSize;
-				}
-				if (count($update) > 0) {
-					$this->update($id, $update);
-				}
-			} else {
-				$result->closeCursor();
-			}
-		}
-		return $totalSize;
-	}
-
-	/**
-	 * get all file ids on the files on the storage
-	 *
-	 * @return int[]
-	 */
-	public function getAll() {
-		$sql = 'SELECT `fileid` FROM `*PREFIX*filecache` WHERE `storage` = ?';
-		$result = $this->connection->executeQuery($sql, array($this->getNumericStorageId()));
-		$ids = array();
-		while ($row = $result->fetch()) {
-			$ids[] = $row['fileid'];
-		}
-		return $ids;
-	}
-
-	/**
-	 * find a folder in the cache which has not been fully scanned
-	 *
-	 * If multiple incomplete folders are in the cache, the one with the highest id will be returned,
-	 * use the one with the highest id gives the best result with the background scanner, since that is most
-	 * likely the folder where we stopped scanning previously
-	 *
-	 * @return string|bool the path of the folder or false when no folder matched
-	 */
-	public function getIncomplete() {
-		$query = $this->connection->prepare('SELECT `path` FROM `*PREFIX*filecache`'
-			. ' WHERE `storage` = ? AND `size` = -1 ORDER BY `fileid` DESC', 1);
-		$query->execute([$this->getNumericStorageId()]);
-		if ($row = $query->fetch()) {
-			return $row['path'];
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * get the path of a file on this storage by it's file id
-	 *
-	 * @param int $id the file id of the file or folder to search
-	 * @return string|null the path of the file (relative to the storage) or null if a file with the given id does not exists within this cache
-	 */
-	public function getPathById($id) {
-		$sql = 'SELECT `path` FROM `*PREFIX*filecache` WHERE `fileid` = ? AND `storage` = ?';
-		$result = $this->connection->executeQuery($sql, array($id, $this->getNumericStorageId()));
-		if ($row = $result->fetch()) {
-			// Oracle stores empty strings as null...
-			if ($row['path'] === null) {
-				return '';
-			}
-			return $row['path'];
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * get the storage id of the storage for a file and the internal path of the file
-	 * unlike getPathById this does not limit the search to files on this storage and
-	 * instead does a global search in the cache table
-	 *
-	 * @param int $id
-	 * @deprecated use getPathById() instead
-	 * @return array first element holding the storage id, second the path
-	 */
-	static public function getById($id) {
-		$connection = \OC::$server->getDatabaseConnection();
-		$sql = 'SELECT `storage`, `path` FROM `*PREFIX*filecache` WHERE `fileid` = ?';
-		$result = $connection->executeQuery($sql, array($id));
-		if ($row = $result->fetch()) {
-			$numericId = $row['storage'];
-			$path = $row['path'];
-		} else {
-			return null;
-		}
-
-		if ($id = Storage::getStorageId($numericId)) {
-			return array($id, $path);
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * normalize the given path
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function normalize($path) {
-
-		return trim(\OC_Util::normalizeUnicode($path), '/');
-	}
+        $mimetype = $this->mimetypeLoader->getId($mimetype);
+        $result = $this->connection->executeQuery($sql, array($mimetype, $this->getNumericStorageId()));
+        $files = array();
+        while ($row = $result->fetch()) {
+            $row['mimetype'] = $this->mimetypeLoader->getMimetypeById($row['mimetype']);
+            $row['mimepart'] = $this->mimetypeLoader->getMimetypeById($row['mimepart']);
+            $files[] = $row;
+        }
+        return array_map(function (array $data) {
+            return new CacheEntry($data);
+        }, $files);
+    }
+
+    /**
+     * Search for files by tag of a given users.
+     *
+     * Note that every user can tag files differently.
+     *
+     * @param string|int $tag name or tag id
+     * @param string $userId owner of the tags
+     * @return ICacheEntry[] file data
+     */
+    public function searchByTag($tag, $userId) {
+        $sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, ' .
+            '`mimetype`, `mimepart`, `size`, `mtime`, ' .
+            '`encrypted`, `etag`, `permissions`, `checksum` ' .
+            'FROM `*PREFIX*filecache` `file`, ' .
+            '`*PREFIX*vcategory_to_object` `tagmap`, ' .
+            '`*PREFIX*vcategory` `tag` ' .
+            // JOIN filecache to vcategory_to_object
+            'WHERE `file`.`fileid` = `tagmap`.`objid` ' .
+            // JOIN vcategory_to_object to vcategory
+            'AND `tagmap`.`type` = `tag`.`type` ' .
+            'AND `tagmap`.`categoryid` = `tag`.`id` ' .
+            // conditions
+            'AND `file`.`storage` = ? ' .
+            'AND `tag`.`type` = \'files\' ' .
+            'AND `tag`.`uid` = ? ';
+        if (is_int($tag)) {
+            $sql .= 'AND `tag`.`id` = ? ';
+        } else {
+            $sql .= 'AND `tag`.`category` = ? ';
+        }
+        $result = $this->connection->executeQuery(
+            $sql,
+            [
+                $this->getNumericStorageId(),
+                $userId,
+                $tag
+            ]
+        );
+        $files = array();
+        while ($row = $result->fetch()) {
+            $files[] = $row;
+        }
+        return array_map(function (array $data) {
+            return new CacheEntry($data);
+        }, $files);
+    }
+
+    /**
+     * Re-calculate the folder size and the size of all parent folders
+     *
+     * @param string|boolean $path
+     * @param array $data (optional) meta data of the folder
+     */
+    public function correctFolderSize($path, $data = null) {
+        $this->calculateFolderSize($path, $data);
+        if ($path !== '') {
+            $parent = dirname($path);
+            if ($parent === '.' or $parent === '/') {
+                $parent = '';
+            }
+            $this->correctFolderSize($parent);
+        }
+    }
+
+    /**
+     * calculate the size of a folder and set it in the cache
+     *
+     * @param string $path
+     * @param array $entry (optional) meta data of the folder
+     * @return int
+     */
+    public function calculateFolderSize($path, $entry = null) {
+        $totalSize = 0;
+        if (is_null($entry) or !isset($entry['fileid'])) {
+            $entry = $this->get($path);
+        }
+        if (isset($entry['mimetype']) && $entry['mimetype'] === 'httpd/unix-directory') {
+            $id = $entry['fileid'];
+            $sql = 'SELECT SUM(`size`) AS f1, MIN(`size`) AS f2 ' .
+                'FROM `*PREFIX*filecache` ' .
+                'WHERE `parent` = ? AND `storage` = ?';
+            $result = $this->connection->executeQuery($sql, array($id, $this->getNumericStorageId()));
+            if ($row = $result->fetch()) {
+                $result->closeCursor();
+                list($sum, $min) = array_values($row);
+                $sum = 0 + $sum;
+                $min = 0 + $min;
+                if ($min === -1) {
+                    $totalSize = $min;
+                } else {
+                    $totalSize = $sum;
+                }
+                $update = array();
+                if ($entry['size'] !== $totalSize) {
+                    $update['size'] = $totalSize;
+                }
+                if (count($update) > 0) {
+                    $this->update($id, $update);
+                }
+            } else {
+                $result->closeCursor();
+            }
+        }
+        return $totalSize;
+    }
+
+    /**
+     * get all file ids on the files on the storage
+     *
+     * @return int[]
+     */
+    public function getAll() {
+        $sql = 'SELECT `fileid` FROM `*PREFIX*filecache` WHERE `storage` = ?';
+        $result = $this->connection->executeQuery($sql, array($this->getNumericStorageId()));
+        $ids = array();
+        while ($row = $result->fetch()) {
+            $ids[] = $row['fileid'];
+        }
+        return $ids;
+    }
+
+    /**
+     * find a folder in the cache which has not been fully scanned
+     *
+     * If multiple incomplete folders are in the cache, the one with the highest id will be returned,
+     * use the one with the highest id gives the best result with the background scanner, since that is most
+     * likely the folder where we stopped scanning previously
+     *
+     * @return string|bool the path of the folder or false when no folder matched
+     */
+    public function getIncomplete() {
+        $query = $this->connection->prepare('SELECT `path` FROM `*PREFIX*filecache`'
+            . ' WHERE `storage` = ? AND `size` = -1 ORDER BY `fileid` DESC', 1);
+        $query->execute([$this->getNumericStorageId()]);
+        if ($row = $query->fetch()) {
+            return $row['path'];
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * get the path of a file on this storage by it's file id
+     *
+     * @param int $id the file id of the file or folder to search
+     * @return string|null the path of the file (relative to the storage) or null if a file with the given id does not exists within this cache
+     */
+    public function getPathById($id) {
+        $sql = 'SELECT `path` FROM `*PREFIX*filecache` WHERE `fileid` = ? AND `storage` = ?';
+        $result = $this->connection->executeQuery($sql, array($id, $this->getNumericStorageId()));
+        if ($row = $result->fetch()) {
+            // Oracle stores empty strings as null...
+            if ($row['path'] === null) {
+                return '';
+            }
+            return $row['path'];
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * get the storage id of the storage for a file and the internal path of the file
+     * unlike getPathById this does not limit the search to files on this storage and
+     * instead does a global search in the cache table
+     *
+     * @param int $id
+     * @deprecated use getPathById() instead
+     * @return array first element holding the storage id, second the path
+     */
+    static public function getById($id) {
+        $connection = \OC::$server->getDatabaseConnection();
+        $sql = 'SELECT `storage`, `path` FROM `*PREFIX*filecache` WHERE `fileid` = ?';
+        $result = $connection->executeQuery($sql, array($id));
+        if ($row = $result->fetch()) {
+            $numericId = $row['storage'];
+            $path = $row['path'];
+        } else {
+            return null;
+        }
+
+        if ($id = Storage::getStorageId($numericId)) {
+            return array($id, $path);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * normalize the given path
+     *
+     * @param string $path
+     * @return string
+     */
+    public function normalize($path) {
+
+        return trim(\OC_Util::normalizeUnicode($path), '/');
+    }
 }

Spacing +40 added lines, -40 removed lines

@@ -143,20 +143,20 @@ 
 			return $data;
 		} else {
 			//fix types
-			$data['fileid'] = (int)$data['fileid'];
-			$data['parent'] = (int)$data['parent'];
+			$data['fileid'] = (int) $data['fileid'];
+			$data['parent'] = (int) $data['parent'];
 			$data['size'] = 0 + $data['size'];
-			$data['mtime'] = (int)$data['mtime'];
-			$data['storage_mtime'] = (int)$data['storage_mtime'];
-			$data['encryptedVersion'] = (int)$data['encrypted'];
-			$data['encrypted'] = (bool)$data['encrypted'];
+			$data['mtime'] = (int) $data['mtime'];
+			$data['storage_mtime'] = (int) $data['storage_mtime'];
+			$data['encryptedVersion'] = (int) $data['encrypted'];
+			$data['encrypted'] = (bool) $data['encrypted'];
 			$data['storage'] = $this->storageId;
 			$data['mimetype'] = $this->mimetypeLoader->getMimetypeById($data['mimetype']);
 			$data['mimepart'] = $this->mimetypeLoader->getMimetypeById($data['mimepart']);
 			if ($data['storage_mtime'] == 0) {
 				$data['storage_mtime'] = $data['mtime'];
 			}
-			$data['permissions'] = (int)$data['permissions'];
+			$data['permissions'] = (int) $data['permissions'];
 			return new CacheEntry($data);
 		}
 	}
@@ -191,12 +191,12 @@ 
 				if ($file['storage_mtime'] == 0) {
 					$file['storage_mtime'] = $file['mtime'];
 				}
-				$file['permissions'] = (int)$file['permissions'];
-				$file['mtime'] = (int)$file['mtime'];
-				$file['storage_mtime'] = (int)$file['storage_mtime'];
+				$file['permissions'] = (int) $file['permissions'];
+				$file['mtime'] = (int) $file['mtime'];
+				$file['storage_mtime'] = (int) $file['storage_mtime'];
 				$file['size'] = 0 + $file['size'];
 			}
-			return array_map(function (array $data) {
+			return array_map(function(array $data) {
 				return new CacheEntry($data);
 			}, $files);
 		} else {
@@ -256,7 +256,7 @@ 
 		$queryParts[] = '`storage`';
 		$params[] = $this->getNumericStorageId();
 
-		$queryParts = array_map(function ($item) {
+		$queryParts = array_map(function($item) {
 			return trim($item, "`");
 		}, $queryParts);
 		$values = array_combine($queryParts, $params);
@@ -265,7 +265,7 @@ 
 			'path_hash',
 		])
 		) {
-			return (int)$this->connection->lastInsertId('*PREFIX*filecache');
+			return (int) $this->connection->lastInsertId('*PREFIX*filecache');
 		}
 
 		// The file was created in the mean time
@@ -303,10 +303,10 @@ 
 
 		// don't update if the data we try to set is the same as the one in the record
 		// some databases (Postgres) don't like superfluous updates
-		$sql = 'UPDATE `*PREFIX*filecache` SET ' . implode(' = ?, ', $queryParts) . '=? ' .
-			'WHERE (' .
-			implode(' <> ? OR ', $queryParts) . ' <> ? OR ' .
-			implode(' IS NULL OR ', $queryParts) . ' IS NULL' .
+		$sql = 'UPDATE `*PREFIX*filecache` SET '.implode(' = ?, ', $queryParts).'=? '.
+			'WHERE ('.
+			implode(' <> ? OR ', $queryParts).' <> ? OR '.
+			implode(' IS NULL OR ', $queryParts).' IS NULL'.
 			') AND `fileid` = ? ';
 		$this->connection->executeQuery($sql, $params);
 
@@ -349,7 +349,7 @@ 
 						$queryParts[] = '`mtime`';
 					}
 				} elseif ($name === 'encrypted') {
-					if(isset($data['encryptedVersion'])) {
+					if (isset($data['encryptedVersion'])) {
 						$value = $data['encryptedVersion'];
 					} else {
 						// Boolean to integer conversion
@@ -357,7 +357,7 @@ 
 					}
 				}
 				$params[] = $value;
-				$queryParts[] = '`' . $name . '`';
+				$queryParts[] = '`'.$name.'`';
 			}
 		}
 		return array($queryParts, $params);
@@ -399,7 +399,7 @@ 
 			return -1;
 		} else {
 			$parent = $this->getParentPath($file);
-			return (int)$this->getId($parent);
+			return (int) $this->getId($parent);
 		}
 	}
 
@@ -445,7 +445,7 @@ 
 	 */
 	private function getSubFolders($entry) {
 		$children = $this->getFolderContentsById($entry['fileid']);
-		return array_filter($children, function ($child) {
+		return array_filter($children, function($child) {
 			return $child['mimetype'] === 'httpd/unix-directory';
 		});
 	}
@@ -512,14 +512,14 @@ 
 			if ($sourceData['mimetype'] === 'httpd/unix-directory') {
 				//find all child entries
 				$sql = 'SELECT `path`, `fileid` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path` LIKE ?';
-				$result = $this->connection->executeQuery($sql, [$sourceStorageId, $this->connection->escapeLikeParameter($sourcePath) . '/%']);
+				$result = $this->connection->executeQuery($sql, [$sourceStorageId, $this->connection->escapeLikeParameter($sourcePath).'/%']);
 				$childEntries = $result->fetchAll();
 				$sourceLength = strlen($sourcePath);
 				$this->connection->beginTransaction();
 				$query = $this->connection->prepare('UPDATE `*PREFIX*filecache` SET `storage` = ?, `path` = ?, `path_hash` = ? WHERE `fileid` = ?');
 
 				foreach ($childEntries as $child) {
-					$newTargetPath = $targetPath . substr($child['path'], $sourceLength);
+					$newTargetPath = $targetPath.substr($child['path'], $sourceLength);
 					$query->execute([$targetStorageId, $newTargetPath, md5($newTargetPath), $child['fileid']]);
 				}
 				$this->connection->executeQuery($moveSql, [$targetStorageId, $targetPath, md5($targetPath), basename($targetPath), $newParentId, $sourceId]);
@@ -563,7 +563,7 @@ 
 		$sql = 'SELECT `size` FROM `*PREFIX*filecache` WHERE `storage` = ? AND `path_hash` = ?';
 		$result = $this->connection->executeQuery($sql, array($this->getNumericStorageId(), $pathHash));
 		if ($row = $result->fetch()) {
-			if ((int)$row['size'] === -1) {
+			if ((int) $row['size'] === -1) {
 				return self::SHALLOW;
 			} else {
 				return self::COMPLETE;
@@ -623,7 +623,7 @@ 
 			$where = '`mimepart` = ?';
 		}
 		$sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, `mimetype`, `mimepart`, `size`, `mtime`, `encrypted`, `etag`, `permissions`, `checksum`
-				FROM `*PREFIX*filecache` WHERE ' . $where . ' AND `storage` = ?';
+				FROM `*PREFIX*filecache` WHERE ' . $where.' AND `storage` = ?';
 		$mimetype = $this->mimetypeLoader->getId($mimetype);
 		$result = $this->connection->executeQuery($sql, array($mimetype, $this->getNumericStorageId()));
 		$files = array();
@@ -632,7 +632,7 @@ 
 			$row['mimepart'] = $this->mimetypeLoader->getMimetypeById($row['mimepart']);
 			$files[] = $row;
 		}
-		return array_map(function (array $data) {
+		return array_map(function(array $data) {
 			return new CacheEntry($data);
 		}, $files);
 	}
@@ -647,20 +647,20 @@ 
 	 * @return ICacheEntry[] file data
 	 */
 	public function searchByTag($tag, $userId) {
-		$sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, ' .
-			'`mimetype`, `mimepart`, `size`, `mtime`, ' .
-			'`encrypted`, `etag`, `permissions`, `checksum` ' .
-			'FROM `*PREFIX*filecache` `file`, ' .
-			'`*PREFIX*vcategory_to_object` `tagmap`, ' .
-			'`*PREFIX*vcategory` `tag` ' .
+		$sql = 'SELECT `fileid`, `storage`, `path`, `parent`, `name`, '.
+			'`mimetype`, `mimepart`, `size`, `mtime`, '.
+			'`encrypted`, `etag`, `permissions`, `checksum` '.
+			'FROM `*PREFIX*filecache` `file`, '.
+			'`*PREFIX*vcategory_to_object` `tagmap`, '.
+			'`*PREFIX*vcategory` `tag` '.
 			// JOIN filecache to vcategory_to_object
-			'WHERE `file`.`fileid` = `tagmap`.`objid` ' .
+			'WHERE `file`.`fileid` = `tagmap`.`objid` '.
 			// JOIN vcategory_to_object to vcategory
-			'AND `tagmap`.`type` = `tag`.`type` ' .
-			'AND `tagmap`.`categoryid` = `tag`.`id` ' .
+			'AND `tagmap`.`type` = `tag`.`type` '.
+			'AND `tagmap`.`categoryid` = `tag`.`id` '.
 			// conditions
-			'AND `file`.`storage` = ? ' .
-			'AND `tag`.`type` = \'files\' ' .
+			'AND `file`.`storage` = ? '.
+			'AND `tag`.`type` = \'files\' '.
 			'AND `tag`.`uid` = ? ';
 		if (is_int($tag)) {
 			$sql .= 'AND `tag`.`id` = ? ';
@@ -679,7 +679,7 @@ 
 		while ($row = $result->fetch()) {
 			$files[] = $row;
 		}
-		return array_map(function (array $data) {
+		return array_map(function(array $data) {
 			return new CacheEntry($data);
 		}, $files);
 	}
@@ -715,8 +715,8 @@ 
 		}
 		if (isset($entry['mimetype']) && $entry['mimetype'] === 'httpd/unix-directory') {
 			$id = $entry['fileid'];
-			$sql = 'SELECT SUM(`size`) AS f1, MIN(`size`) AS f2 ' .
-				'FROM `*PREFIX*filecache` ' .
+			$sql = 'SELECT SUM(`size`) AS f1, MIN(`size`) AS f2 '.
+				'FROM `*PREFIX*filecache` '.
 				'WHERE `parent` = ? AND `storage` = ?';
 			$result = $this->connection->executeQuery($sql, array($id, $this->getNumericStorageId()));
 			if ($row = $result->fetch()) {