nextcloud / server

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/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 +306 added lines, -306 removed lines

@@ -37,338 +37,338 @@
 use OCP\PreconditionNotMetException;
 
 class Connection extends \Doctrine\DBAL\Connection implements IDBConnection {
-	/**
-	 * @var string $tablePrefix
-	 */
-	protected $tablePrefix;
+    /**
+     * @var string $tablePrefix
+     */
+    protected $tablePrefix;
 
-	/**
-	 * @var \OC\DB\Adapter $adapter
-	 */
-	protected $adapter;
+    /**
+     * @var \OC\DB\Adapter $adapter
+     */
+    protected $adapter;
 
-	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());
-		}
-	}
+    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);
-	}
+    /**
+     * 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 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();
-	}
+    /**
+     * 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);
+    /**
+     * 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'];
-		}
+        // 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 '';
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getPrefix() {
-		return $this->tablePrefix;
-	}
+    /**
+     * @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'];
+    /**
+     * 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);
-	}
+        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);
+    /**
+     * 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);
-	}
+        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, 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);
-	}
+    /**
+     * 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);
-	}
+    /**
+     * 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);
-	}
+    // 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);
-	}
+    /**
+     * 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;
-		}
-	}
+    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();
+    /**
+     * 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();
-			}
+            if ($affected === 0 && !empty($updatePreconditionValues)) {
+                throw new PreconditionNotMetException();
+            }
 
-			return 0;
-		}
-	}
+            return 0;
+        }
+    }
 
-	/**
-	 * 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;
-	}
+    /**
+     * 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);
-		}
-	}
+    /**
+     * 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));
-	}
+    /**
+     * 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 );
-	}
+    // 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;
-	}
+    /**
+     * 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, '\\_%');
-	}
+    /**
+     * Espace a parameter to be used in a LIKE query
+     *
+     * @param string $param
+     * @return string
+     */
+    public function escapeLikeParameter($param) {
+        return addcslashes($param, '\\_%');
+    }
 }

Spacing +12 added lines, -12 removed lines

@@ -52,7 +52,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());
 		}
 	}
 
@@ -100,7 +100,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 '';
@@ -146,7 +146,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;
 		}
@@ -157,7 +157,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);
@@ -308,11 +308,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;
@@ -324,9 +324,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);
 		}
 	}
@@ -337,8 +337,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));
 	}
@@ -349,7 +349,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/eventsource.php

Doc Comments +1 added lines, -1 removed lines

@@ -88,7 +88,7 @@
 	 * send a message to the client
 	 *
 	 * @param string $type
-	 * @param mixed $data
+	 * @param string $data
 	 *
 	 * @throws \BadMethodCallException
 	 * if only one parameter is given, a typeless message will be send with that parameter as data

Indentation +88 added lines, -88 removed lines

@@ -33,98 +33,98 @@
  * use server side events with caution, to many open requests can hang the server
  */
 class OC_EventSource implements \OCP\IEventSource {
-	/**
-	 * @var bool
-	 */
-	private $fallback;
+    /**
+     * @var bool
+     */
+    private $fallback;
 
-	/**
-	 * @var int
-	 */
-	private $fallBackId = 0;
+    /**
+     * @var int
+     */
+    private $fallBackId = 0;
 
-	/**
-	 * @var bool
-	 */
-	private $started = false;
+    /**
+     * @var bool
+     */
+    private $started = false;
 
-	protected function init() {
-		if ($this->started) {
-			return;
-		}
-		$this->started = true;
+    protected function init() {
+        if ($this->started) {
+            return;
+        }
+        $this->started = true;
 
-		// prevent php output buffering, caching and nginx buffering
-		OC_Util::obEnd();
-		header('Cache-Control: no-cache');
-		header('X-Accel-Buffering: no');
-		$this->fallback = isset($_GET['fallback']) and $_GET['fallback'] == 'true';
-		if ($this->fallback) {
-			$this->fallBackId = (int)$_GET['fallback_id'];
-			/**
-			 * FIXME: The default content-security-policy of ownCloud forbids inline
-			 * JavaScript for security reasons. IE starting on Windows 10 will
-			 * however also obey the CSP which will break the event source fallback.
-			 *
-			 * As a workaround thus we set a custom policy which allows the execution
-			 * of inline JavaScript.
-			 *
-			 * @link https://github.com/owncloud/core/issues/14286
-			 */
-			header("Content-Security-Policy: default-src 'none'; script-src 'unsafe-inline'");
-			header("Content-Type: text/html");
-			echo str_repeat('<span></span>' . PHP_EOL, 10); //dummy data to keep IE happy
-		} else {
-			header("Content-Type: text/event-stream");
-		}
-		if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
-			header('Location: '.\OC::$WEBROOT);
-			exit();
-		}
-		if (!(\OC::$server->getRequest()->passesCSRFCheck())) {
-			$this->send('error', 'Possible CSRF attack. Connection will be closed.');
-			$this->close();
-			exit();
-		}
-		flush();
-	}
+        // prevent php output buffering, caching and nginx buffering
+        OC_Util::obEnd();
+        header('Cache-Control: no-cache');
+        header('X-Accel-Buffering: no');
+        $this->fallback = isset($_GET['fallback']) and $_GET['fallback'] == 'true';
+        if ($this->fallback) {
+            $this->fallBackId = (int)$_GET['fallback_id'];
+            /**
+             * FIXME: The default content-security-policy of ownCloud forbids inline
+             * JavaScript for security reasons. IE starting on Windows 10 will
+             * however also obey the CSP which will break the event source fallback.
+             *
+             * As a workaround thus we set a custom policy which allows the execution
+             * of inline JavaScript.
+             *
+             * @link https://github.com/owncloud/core/issues/14286
+             */
+            header("Content-Security-Policy: default-src 'none'; script-src 'unsafe-inline'");
+            header("Content-Type: text/html");
+            echo str_repeat('<span></span>' . PHP_EOL, 10); //dummy data to keep IE happy
+        } else {
+            header("Content-Type: text/event-stream");
+        }
+        if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
+            header('Location: '.\OC::$WEBROOT);
+            exit();
+        }
+        if (!(\OC::$server->getRequest()->passesCSRFCheck())) {
+            $this->send('error', 'Possible CSRF attack. Connection will be closed.');
+            $this->close();
+            exit();
+        }
+        flush();
+    }
 
-	/**
-	 * send a message to the client
-	 *
-	 * @param string $type
-	 * @param mixed $data
-	 *
-	 * @throws \BadMethodCallException
-	 * if only one parameter is given, a typeless message will be send with that parameter as data
-	 */
-	public function send($type, $data = null) {
-		if ($data and !preg_match('/^[A-Za-z0-9_]+$/', $type)) {
-			throw new BadMethodCallException('Type needs to be alphanumeric ('. $type .')');
-		}
-		$this->init();
-		if (is_null($data)) {
-			$data = $type;
-			$type = null;
-		}
-		if ($this->fallback) {
-			$response = '<script type="text/javascript">window.parent.OC.EventSource.fallBackCallBack('
-				. $this->fallBackId . ',"' . $type . '",' . OCP\JSON::encode($data) . ')</script>' . PHP_EOL;
-			echo $response;
-		} else {
-			if ($type) {
-				echo 'event: ' . $type . PHP_EOL;
-			}
-			echo 'data: ' . OCP\JSON::encode($data) . PHP_EOL;
-		}
-		echo PHP_EOL;
-		flush();
-	}
+    /**
+     * send a message to the client
+     *
+     * @param string $type
+     * @param mixed $data
+     *
+     * @throws \BadMethodCallException
+     * if only one parameter is given, a typeless message will be send with that parameter as data
+     */
+    public function send($type, $data = null) {
+        if ($data and !preg_match('/^[A-Za-z0-9_]+$/', $type)) {
+            throw new BadMethodCallException('Type needs to be alphanumeric ('. $type .')');
+        }
+        $this->init();
+        if (is_null($data)) {
+            $data = $type;
+            $type = null;
+        }
+        if ($this->fallback) {
+            $response = '<script type="text/javascript">window.parent.OC.EventSource.fallBackCallBack('
+                . $this->fallBackId . ',"' . $type . '",' . OCP\JSON::encode($data) . ')</script>' . PHP_EOL;
+            echo $response;
+        } else {
+            if ($type) {
+                echo 'event: ' . $type . PHP_EOL;
+            }
+            echo 'data: ' . OCP\JSON::encode($data) . PHP_EOL;
+        }
+        echo PHP_EOL;
+        flush();
+    }
 
-	/**
-	 * close the connection of the event source
-	 */
-	public function close() {
-		$this->send('__internal__', 'close'); //server side closing can be an issue, let the client do it
-	}
+    /**
+     * close the connection of the event source
+     */
+    public function close() {
+        $this->send('__internal__', 'close'); //server side closing can be an issue, let the client do it
+    }
 }

Spacing +7 added lines, -7 removed lines

@@ -60,7 +60,7 @@ 
 		header('X-Accel-Buffering: no');
 		$this->fallback = isset($_GET['fallback']) and $_GET['fallback'] == 'true';
 		if ($this->fallback) {
-			$this->fallBackId = (int)$_GET['fallback_id'];
+			$this->fallBackId = (int) $_GET['fallback_id'];
 			/**
 			 * FIXME: The default content-security-policy of ownCloud forbids inline
 			 * JavaScript for security reasons. IE starting on Windows 10 will
@@ -73,11 +73,11 @@ 
 			 */
 			header("Content-Security-Policy: default-src 'none'; script-src 'unsafe-inline'");
 			header("Content-Type: text/html");
-			echo str_repeat('<span></span>' . PHP_EOL, 10); //dummy data to keep IE happy
+			echo str_repeat('<span></span>'.PHP_EOL, 10); //dummy data to keep IE happy
 		} else {
 			header("Content-Type: text/event-stream");
 		}
-		if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
+		if (!\OC::$server->getRequest()->passesStrictCookieCheck()) {
 			header('Location: '.\OC::$WEBROOT);
 			exit();
 		}
@@ -100,7 +100,7 @@ 
 	 */
 	public function send($type, $data = null) {
 		if ($data and !preg_match('/^[A-Za-z0-9_]+$/', $type)) {
-			throw new BadMethodCallException('Type needs to be alphanumeric ('. $type .')');
+			throw new BadMethodCallException('Type needs to be alphanumeric ('.$type.')');
 		}
 		$this->init();
 		if (is_null($data)) {
@@ -109,13 +109,13 @@ 
 		}
 		if ($this->fallback) {
 			$response = '<script type="text/javascript">window.parent.OC.EventSource.fallBackCallBack('
-				. $this->fallBackId . ',"' . $type . '",' . OCP\JSON::encode($data) . ')</script>' . PHP_EOL;
+				. $this->fallBackId.',"'.$type.'",'.OCP\JSON::encode($data).')</script>'.PHP_EOL;
 			echo $response;
 		} else {
 			if ($type) {
-				echo 'event: ' . $type . PHP_EOL;
+				echo 'event: '.$type.PHP_EOL;
 			}
-			echo 'data: ' . OCP\JSON::encode($data) . PHP_EOL;
+			echo 'data: '.OCP\JSON::encode($data).PHP_EOL;
 		}
 		echo PHP_EOL;
 		flush();

lib/private/files/cache/scanner.php

Doc Comments +3 added lines

@@ -476,6 +476,9 @@
 		}
 	}
 
+	/**
+	 * @param string|boolean $path
+	 */
 	private function runBackgroundScanJob(callable $callback, $path) {
 		try {
 			$callback();

Indentation +465 added lines, -465 removed lines

@@ -54,473 +54,473 @@
  * @package OC\Files\Cache
  */
 class Scanner extends BasicEmitter implements IScanner {
-	/**
-	 * @var \OC\Files\Storage\Storage $storage
-	 */
-	protected $storage;
-
-	/**
-	 * @var string $storageId
-	 */
-	protected $storageId;
-
-	/**
-	 * @var \OC\Files\Cache\Cache $cache
-	 */
-	protected $cache;
-
-	/**
-	 * @var boolean $cacheActive If true, perform cache operations, if false, do not affect cache
-	 */
-	protected $cacheActive;
-
-	/**
-	 * @var bool $useTransactions whether to use transactions
-	 */
-	protected $useTransactions = true;
-
-	/**
-	 * @var \OCP\Lock\ILockingProvider
-	 */
-	protected $lockingProvider;
-
-	public function __construct(\OC\Files\Storage\Storage $storage) {
-		$this->storage = $storage;
-		$this->storageId = $this->storage->getId();
-		$this->cache = $storage->getCache();
-		$this->cacheActive = !Config::getSystemValue('filesystem_cache_readonly', false);
-		$this->lockingProvider = \OC::$server->getLockingProvider();
-	}
-
-	/**
-	 * Whether to wrap the scanning of a folder in a database transaction
-	 * On default transactions are used
-	 *
-	 * @param bool $useTransactions
-	 */
-	public function setUseTransactions($useTransactions) {
-		$this->useTransactions = $useTransactions;
-	}
-
-	/**
-	 * get all the metadata of a file or folder
-	 * *
-	 *
-	 * @param string $path
-	 * @return array an array of metadata of the file
-	 */
-	protected function getData($path) {
-		$data = $this->storage->getMetaData($path);
-		if (is_null($data)) {
-			\OCP\Util::writeLog('OC\Files\Cache\Scanner', "!!! Path '$path' is not accessible or present !!!", \OCP\Util::DEBUG);
-		}
-		return $data;
-	}
-
-	/**
-	 * scan a single file and store it in the cache
-	 *
-	 * @param string $file
-	 * @param int $reuseExisting
-	 * @param int $parentId
-	 * @param array | null $cacheData existing data in the cache for the file to be scanned
-	 * @param bool $lock set to false to disable getting an additional read lock during scanning
-	 * @return array an array of metadata of the scanned file
-	 * @throws \OC\ServerNotAvailableException
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true) {
-
-		// verify database - e.g. mysql only 3-byte chars
-		if (preg_match('%(?:
+    /**
+     * @var \OC\Files\Storage\Storage $storage
+     */
+    protected $storage;
+
+    /**
+     * @var string $storageId
+     */
+    protected $storageId;
+
+    /**
+     * @var \OC\Files\Cache\Cache $cache
+     */
+    protected $cache;
+
+    /**
+     * @var boolean $cacheActive If true, perform cache operations, if false, do not affect cache
+     */
+    protected $cacheActive;
+
+    /**
+     * @var bool $useTransactions whether to use transactions
+     */
+    protected $useTransactions = true;
+
+    /**
+     * @var \OCP\Lock\ILockingProvider
+     */
+    protected $lockingProvider;
+
+    public function __construct(\OC\Files\Storage\Storage $storage) {
+        $this->storage = $storage;
+        $this->storageId = $this->storage->getId();
+        $this->cache = $storage->getCache();
+        $this->cacheActive = !Config::getSystemValue('filesystem_cache_readonly', false);
+        $this->lockingProvider = \OC::$server->getLockingProvider();
+    }
+
+    /**
+     * Whether to wrap the scanning of a folder in a database transaction
+     * On default transactions are used
+     *
+     * @param bool $useTransactions
+     */
+    public function setUseTransactions($useTransactions) {
+        $this->useTransactions = $useTransactions;
+    }
+
+    /**
+     * get all the metadata of a file or folder
+     * *
+     *
+     * @param string $path
+     * @return array an array of metadata of the file
+     */
+    protected function getData($path) {
+        $data = $this->storage->getMetaData($path);
+        if (is_null($data)) {
+            \OCP\Util::writeLog('OC\Files\Cache\Scanner', "!!! Path '$path' is not accessible or present !!!", \OCP\Util::DEBUG);
+        }
+        return $data;
+    }
+
+    /**
+     * scan a single file and store it in the cache
+     *
+     * @param string $file
+     * @param int $reuseExisting
+     * @param int $parentId
+     * @param array | null $cacheData existing data in the cache for the file to be scanned
+     * @param bool $lock set to false to disable getting an additional read lock during scanning
+     * @return array an array of metadata of the scanned file
+     * @throws \OC\ServerNotAvailableException
+     * @throws \OCP\Lock\LockedException
+     */
+    public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true) {
+
+        // verify database - e.g. mysql only 3-byte chars
+        if (preg_match('%(?:
       \xF0[\x90-\xBF][\x80-\xBF]{2}      # planes 1-3
     | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
     | \xF4[\x80-\x8F][\x80-\xBF]{2}      # plane 16
 )%xs', $file)) {
-			// 4-byte characters are not supported in file names
-			return null;
-		}
-
-		try {
-			$this->storage->verifyPath(dirname($file), basename($file));
-		} catch (\Exception $e) {
-			return null;
-		}
-
-		// only proceed if $file is not a partial file nor a blacklisted file
-		if (!self::isPartialFile($file) and !Filesystem::isFileBlacklisted($file)) {
-
-			//acquire a lock
-			if ($lock) {
-				if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-					$this->storage->acquireLock($file, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
-				}
-			}
-
-			$data = $this->getData($file);
-
-			if ($data) {
-
-				// pre-emit only if it was a file. By that we avoid counting/treating folders as files
-				if ($data['mimetype'] !== 'httpd/unix-directory') {
-					$this->emit('\OC\Files\Cache\Scanner', 'scanFile', array($file, $this->storageId));
-					\OC_Hook::emit('\OC\Files\Cache\Scanner', 'scan_file', array('path' => $file, 'storage' => $this->storageId));
-				}
-
-				$parent = dirname($file);
-				if ($parent === '.' or $parent === '/') {
-					$parent = '';
-				}
-				if ($parentId === -1) {
-					$parentId = $this->cache->getId($parent);
-				}
-
-				// scan the parent if it's not in the cache (id -1) and the current file is not the root folder
-				if ($file and $parentId === -1) {
-					$parentData = $this->scanFile($parent);
-					if (!$parentData) {
-						return null;
-					}
-					$parentId = $parentData['fileid'];
-				}
-				if ($parent) {
-					$data['parent'] = $parentId;
-				}
-				if (is_null($cacheData)) {
-					/** @var CacheEntry $cacheData */
-					$cacheData = $this->cache->get($file);
-				}
-				if ($cacheData and $reuseExisting and isset($cacheData['fileid'])) {
-					// prevent empty etag
-					if (empty($cacheData['etag'])) {
-						$etag = $data['etag'];
-					} else {
-						$etag = $cacheData['etag'];
-					}
-					$fileId = $cacheData['fileid'];
-					$data['fileid'] = $fileId;
-					// only reuse data if the file hasn't explicitly changed
-					if (isset($data['storage_mtime']) && isset($cacheData['storage_mtime']) && $data['storage_mtime'] === $cacheData['storage_mtime']) {
-						$data['mtime'] = $cacheData['mtime'];
-						if (($reuseExisting & self::REUSE_SIZE) && ($data['size'] === -1)) {
-							$data['size'] = $cacheData['size'];
-						}
-						if ($reuseExisting & self::REUSE_ETAG) {
-							$data['etag'] = $etag;
-						}
-					}
-					// Only update metadata that has changed
-					$newData = array_diff_assoc($data, $cacheData->getData());
-				} else {
-					$newData = $data;
-					$fileId = -1;
-				}
-				if (!empty($newData)) {
-					// Reset the checksum if the data has changed
-					$newData['checksum'] = '';
-					$data['fileid'] = $this->addToCache($file, $newData, $fileId);
-				}
-				if (isset($cacheData['size'])) {
-					$data['oldSize'] = $cacheData['size'];
-				} else {
-					$data['oldSize'] = 0;
-				}
-
-				if (isset($cacheData['encrypted'])) {
-					$data['encrypted'] = $cacheData['encrypted'];
-				}
-
-				// post-emit only if it was a file. By that we avoid counting/treating folders as files
-				if ($data['mimetype'] !== 'httpd/unix-directory') {
-					$this->emit('\OC\Files\Cache\Scanner', 'postScanFile', array($file, $this->storageId));
-					\OC_Hook::emit('\OC\Files\Cache\Scanner', 'post_scan_file', array('path' => $file, 'storage' => $this->storageId));
-				}
-
-			} else {
-				$this->removeFromCache($file);
-			}
-
-			//release the acquired lock
-			if ($lock) {
-				if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-					$this->storage->releaseLock($file, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
-				}
-			}
-
-			if ($data && !isset($data['encrypted'])) {
-				$data['encrypted'] = false;
-			}
-			return $data;
-		}
-
-		return null;
-	}
-
-	protected function removeFromCache($path) {
-		\OC_Hook::emit('Scanner', 'removeFromCache', array('file' => $path));
-		$this->emit('\OC\Files\Cache\Scanner', 'removeFromCache', array($path));
-		if ($this->cacheActive) {
-			$this->cache->remove($path);
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param array $data
-	 * @param int $fileId
-	 * @return int the id of the added file
-	 */
-	protected function addToCache($path, $data, $fileId = -1) {
-		\OC_Hook::emit('Scanner', 'addToCache', array('file' => $path, 'data' => $data));
-		$this->emit('\OC\Files\Cache\Scanner', 'addToCache', array($path, $this->storageId, $data));
-		if ($this->cacheActive) {
-			if ($fileId !== -1) {
-				$this->cache->update($fileId, $data);
-				return $fileId;
-			} else {
-				return $this->cache->put($path, $data);
-			}
-		} else {
-			return -1;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param array $data
-	 * @param int $fileId
-	 */
-	protected function updateCache($path, $data, $fileId = -1) {
-		\OC_Hook::emit('Scanner', 'addToCache', array('file' => $path, 'data' => $data));
-		$this->emit('\OC\Files\Cache\Scanner', 'updateCache', array($path, $this->storageId, $data));
-		if ($this->cacheActive) {
-			if ($fileId !== -1) {
-				$this->cache->update($fileId, $data);
-			} else {
-				$this->cache->put($path, $data);
-			}
-		}
-	}
-
-	/**
-	 * scan a folder and all it's children
-	 *
-	 * @param string $path
-	 * @param bool $recursive
-	 * @param int $reuse
-	 * @param bool $lock set to false to disable getting an additional read lock during scanning
-	 * @return array an array of the meta data of the scanned file or folder
-	 */
-	public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true) {
-		if ($reuse === -1) {
-			$reuse = ($recursive === self::SCAN_SHALLOW) ? self::REUSE_ETAG | self::REUSE_SIZE : self::REUSE_ETAG;
-		}
-		if ($lock) {
-			if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-				$this->storage->acquireLock('scanner::' . $path, ILockingProvider::LOCK_EXCLUSIVE, $this->lockingProvider);
-				$this->storage->acquireLock($path, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
-			}
-		}
-		$data = $this->scanFile($path, $reuse, -1, null, $lock);
-		if ($data and $data['mimetype'] === 'httpd/unix-directory') {
-			$size = $this->scanChildren($path, $recursive, $reuse, $data, $lock);
-			$data['size'] = $size;
-		}
-		if ($lock) {
-			if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-				$this->storage->releaseLock($path, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
-				$this->storage->releaseLock('scanner::' . $path, ILockingProvider::LOCK_EXCLUSIVE, $this->lockingProvider);
-			}
-		}
-		return $data;
-	}
-
-	/**
-	 * Get the children currently in the cache
-	 *
-	 * @param int $folderId
-	 * @return array[]
-	 */
-	protected function getExistingChildren($folderId) {
-		$existingChildren = array();
-		$children = $this->cache->getFolderContentsById($folderId);
-		foreach ($children as $child) {
-			$existingChildren[$child['name']] = $child;
-		}
-		return $existingChildren;
-	}
-
-	/**
-	 * Get the children from the storage
-	 *
-	 * @param string $folder
-	 * @return string[]
-	 */
-	protected function getNewChildren($folder) {
-		$children = array();
-		if ($dh = $this->storage->opendir($folder)) {
-			if (is_resource($dh)) {
-				while (($file = readdir($dh)) !== false) {
-					if (!Filesystem::isIgnoredDir($file)) {
-						$children[] = $file;
-					}
-				}
-			}
-		}
-		return $children;
-	}
-
-	/**
-	 * scan all the files and folders in a folder
-	 *
-	 * @param string $path
-	 * @param bool $recursive
-	 * @param int $reuse
-	 * @param array $folderData existing cache data for the folder to be scanned
-	 * @param bool $lock set to false to disable getting an additional read lock during scanning
-	 * @return int the size of the scanned folder or -1 if the size is unknown at this stage
-	 */
-	protected function scanChildren($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $folderData = null, $lock = true) {
-		if ($reuse === -1) {
-			$reuse = ($recursive === self::SCAN_SHALLOW) ? self::REUSE_ETAG | self::REUSE_SIZE : self::REUSE_ETAG;
-		}
-		$this->emit('\OC\Files\Cache\Scanner', 'scanFolder', array($path, $this->storageId));
-		$size = 0;
-		$childQueue = array();
-		if (is_array($folderData) and isset($folderData['fileid'])) {
-			$folderId = $folderData['fileid'];
-		} else {
-			$folderId = $this->cache->getId($path);
-		}
-		$existingChildren = $this->getExistingChildren($folderId);
-		$newChildren = $this->getNewChildren($path);
-
-		if ($this->useTransactions) {
-			\OC::$server->getDatabaseConnection()->beginTransaction();
-		}
-		$exceptionOccurred = false;
-		foreach ($newChildren as $file) {
-			$child = ($path) ? $path . '/' . $file : $file;
-			try {
-				$existingData = isset($existingChildren[$file]) ? $existingChildren[$file] : null;
-				$data = $this->scanFile($child, $reuse, $folderId, $existingData, $lock);
-				if ($data) {
-					if ($data['mimetype'] === 'httpd/unix-directory' and $recursive === self::SCAN_RECURSIVE) {
-						$childQueue[$child] = $data;
-					} else if ($data['size'] === -1) {
-						$size = -1;
-					} else if ($size !== -1) {
-						$size += $data['size'];
-					}
-				}
-			} catch (\Doctrine\DBAL\DBALException $ex) {
-				// might happen if inserting duplicate while a scanning
-				// process is running in parallel
-				// log and ignore
-				\OCP\Util::writeLog('core', 'Exception while scanning file "' . $child . '": ' . $ex->getMessage(), \OCP\Util::DEBUG);
-				$exceptionOccurred = true;
-			} catch (\OCP\Lock\LockedException $e) {
-				if ($this->useTransactions) {
-					\OC::$server->getDatabaseConnection()->rollback();
-				}
-				throw $e;
-			}
-		}
-		$removedChildren = \array_diff(array_keys($existingChildren), $newChildren);
-		foreach ($removedChildren as $childName) {
-			$child = ($path) ? $path . '/' . $childName : $childName;
-			$this->removeFromCache($child);
-		}
-		if ($this->useTransactions) {
-			\OC::$server->getDatabaseConnection()->commit();
-		}
-		if ($exceptionOccurred) {
-			// It might happen that the parallel scan process has already
-			// inserted mimetypes but those weren't available yet inside the transaction
-			// To make sure to have the updated mime types in such cases,
-			// we reload them here
-			\OC::$server->getMimeTypeLoader()->reset();
-		}
-
-		foreach ($childQueue as $child => $childData) {
-			$childSize = $this->scanChildren($child, self::SCAN_RECURSIVE, $reuse, $childData, $lock);
-			if ($childSize === -1) {
-				$size = -1;
-			} else if ($size !== -1) {
-				$size += $childSize;
-			}
-		}
-		if (!is_array($folderData) or !isset($folderData['size']) or $folderData['size'] !== $size) {
-			$this->updateCache($path, array('size' => $size), $folderId);
-		}
-		$this->emit('\OC\Files\Cache\Scanner', 'postScanFolder', array($path, $this->storageId));
-		return $size;
-	}
-
-	/**
-	 * check if the file should be ignored when scanning
-	 * NOTE: files with a '.part' extension are ignored as well!
-	 *       prevents unfinished put requests to be scanned
-	 *
-	 * @param string $file
-	 * @return boolean
-	 */
-	public static function isPartialFile($file) {
-		if (pathinfo($file, PATHINFO_EXTENSION) === 'part') {
-			return true;
-		}
-		if (strpos($file, '.part/') !== false) {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * walk over any folders that are not fully scanned yet and scan them
-	 */
-	public function backgroundScan() {
-		if (!$this->cache->inCache('')) {
-			$this->runBackgroundScanJob(function () {
-				$this->scan('', self::SCAN_RECURSIVE, self::REUSE_ETAG);
-			}, '');
-		} else {
-			$lastPath = null;
-			while (($path = $this->cache->getIncomplete()) !== false && $path !== $lastPath) {
-				$this->runBackgroundScanJob(function() use ($path) {
-					$this->scan($path, self::SCAN_RECURSIVE, self::REUSE_ETAG);
-				}, $path);
-				// FIXME: this won't proceed with the next item, needs revamping of getIncomplete()
-				// to make this possible
-				$lastPath = $path;
-			}
-		}
-	}
-
-	private function runBackgroundScanJob(callable $callback, $path) {
-		try {
-			$callback();
-			\OC_Hook::emit('Scanner', 'correctFolderSize', array('path' => $path));
-			if ($this->cacheActive && $this->cache instanceof Cache) {
-				$this->cache->correctFolderSize($path);
-			}
-		} catch (\OCP\Files\StorageInvalidException $e) {
-			// skip unavailable storages
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			// skip unavailable storages
-		} catch (\OCP\Files\ForbiddenException $e) {
-			// skip forbidden storages
-		} catch (\OCP\Lock\LockedException $e) {
-			// skip unavailable storages
-		}
-	}
-
-	/**
-	 * Set whether the cache is affected by scan operations
-	 *
-	 * @param boolean $active The active state of the cache
-	 */
-	public function setCacheActive($active) {
-		$this->cacheActive = $active;
-	}
+            // 4-byte characters are not supported in file names
+            return null;
+        }
+
+        try {
+            $this->storage->verifyPath(dirname($file), basename($file));
+        } catch (\Exception $e) {
+            return null;
+        }
+
+        // only proceed if $file is not a partial file nor a blacklisted file
+        if (!self::isPartialFile($file) and !Filesystem::isFileBlacklisted($file)) {
+
+            //acquire a lock
+            if ($lock) {
+                if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+                    $this->storage->acquireLock($file, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
+                }
+            }
+
+            $data = $this->getData($file);
+
+            if ($data) {
+
+                // pre-emit only if it was a file. By that we avoid counting/treating folders as files
+                if ($data['mimetype'] !== 'httpd/unix-directory') {
+                    $this->emit('\OC\Files\Cache\Scanner', 'scanFile', array($file, $this->storageId));
+                    \OC_Hook::emit('\OC\Files\Cache\Scanner', 'scan_file', array('path' => $file, 'storage' => $this->storageId));
+                }
+
+                $parent = dirname($file);
+                if ($parent === '.' or $parent === '/') {
+                    $parent = '';
+                }
+                if ($parentId === -1) {
+                    $parentId = $this->cache->getId($parent);
+                }
+
+                // scan the parent if it's not in the cache (id -1) and the current file is not the root folder
+                if ($file and $parentId === -1) {
+                    $parentData = $this->scanFile($parent);
+                    if (!$parentData) {
+                        return null;
+                    }
+                    $parentId = $parentData['fileid'];
+                }
+                if ($parent) {
+                    $data['parent'] = $parentId;
+                }
+                if (is_null($cacheData)) {
+                    /** @var CacheEntry $cacheData */
+                    $cacheData = $this->cache->get($file);
+                }
+                if ($cacheData and $reuseExisting and isset($cacheData['fileid'])) {
+                    // prevent empty etag
+                    if (empty($cacheData['etag'])) {
+                        $etag = $data['etag'];
+                    } else {
+                        $etag = $cacheData['etag'];
+                    }
+                    $fileId = $cacheData['fileid'];
+                    $data['fileid'] = $fileId;
+                    // only reuse data if the file hasn't explicitly changed
+                    if (isset($data['storage_mtime']) && isset($cacheData['storage_mtime']) && $data['storage_mtime'] === $cacheData['storage_mtime']) {
+                        $data['mtime'] = $cacheData['mtime'];
+                        if (($reuseExisting & self::REUSE_SIZE) && ($data['size'] === -1)) {
+                            $data['size'] = $cacheData['size'];
+                        }
+                        if ($reuseExisting & self::REUSE_ETAG) {
+                            $data['etag'] = $etag;
+                        }
+                    }
+                    // Only update metadata that has changed
+                    $newData = array_diff_assoc($data, $cacheData->getData());
+                } else {
+                    $newData = $data;
+                    $fileId = -1;
+                }
+                if (!empty($newData)) {
+                    // Reset the checksum if the data has changed
+                    $newData['checksum'] = '';
+                    $data['fileid'] = $this->addToCache($file, $newData, $fileId);
+                }
+                if (isset($cacheData['size'])) {
+                    $data['oldSize'] = $cacheData['size'];
+                } else {
+                    $data['oldSize'] = 0;
+                }
+
+                if (isset($cacheData['encrypted'])) {
+                    $data['encrypted'] = $cacheData['encrypted'];
+                }
+
+                // post-emit only if it was a file. By that we avoid counting/treating folders as files
+                if ($data['mimetype'] !== 'httpd/unix-directory') {
+                    $this->emit('\OC\Files\Cache\Scanner', 'postScanFile', array($file, $this->storageId));
+                    \OC_Hook::emit('\OC\Files\Cache\Scanner', 'post_scan_file', array('path' => $file, 'storage' => $this->storageId));
+                }
+
+            } else {
+                $this->removeFromCache($file);
+            }
+
+            //release the acquired lock
+            if ($lock) {
+                if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+                    $this->storage->releaseLock($file, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
+                }
+            }
+
+            if ($data && !isset($data['encrypted'])) {
+                $data['encrypted'] = false;
+            }
+            return $data;
+        }
+
+        return null;
+    }
+
+    protected function removeFromCache($path) {
+        \OC_Hook::emit('Scanner', 'removeFromCache', array('file' => $path));
+        $this->emit('\OC\Files\Cache\Scanner', 'removeFromCache', array($path));
+        if ($this->cacheActive) {
+            $this->cache->remove($path);
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param array $data
+     * @param int $fileId
+     * @return int the id of the added file
+     */
+    protected function addToCache($path, $data, $fileId = -1) {
+        \OC_Hook::emit('Scanner', 'addToCache', array('file' => $path, 'data' => $data));
+        $this->emit('\OC\Files\Cache\Scanner', 'addToCache', array($path, $this->storageId, $data));
+        if ($this->cacheActive) {
+            if ($fileId !== -1) {
+                $this->cache->update($fileId, $data);
+                return $fileId;
+            } else {
+                return $this->cache->put($path, $data);
+            }
+        } else {
+            return -1;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param array $data
+     * @param int $fileId
+     */
+    protected function updateCache($path, $data, $fileId = -1) {
+        \OC_Hook::emit('Scanner', 'addToCache', array('file' => $path, 'data' => $data));
+        $this->emit('\OC\Files\Cache\Scanner', 'updateCache', array($path, $this->storageId, $data));
+        if ($this->cacheActive) {
+            if ($fileId !== -1) {
+                $this->cache->update($fileId, $data);
+            } else {
+                $this->cache->put($path, $data);
+            }
+        }
+    }
+
+    /**
+     * scan a folder and all it's children
+     *
+     * @param string $path
+     * @param bool $recursive
+     * @param int $reuse
+     * @param bool $lock set to false to disable getting an additional read lock during scanning
+     * @return array an array of the meta data of the scanned file or folder
+     */
+    public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true) {
+        if ($reuse === -1) {
+            $reuse = ($recursive === self::SCAN_SHALLOW) ? self::REUSE_ETAG | self::REUSE_SIZE : self::REUSE_ETAG;
+        }
+        if ($lock) {
+            if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+                $this->storage->acquireLock('scanner::' . $path, ILockingProvider::LOCK_EXCLUSIVE, $this->lockingProvider);
+                $this->storage->acquireLock($path, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
+            }
+        }
+        $data = $this->scanFile($path, $reuse, -1, null, $lock);
+        if ($data and $data['mimetype'] === 'httpd/unix-directory') {
+            $size = $this->scanChildren($path, $recursive, $reuse, $data, $lock);
+            $data['size'] = $size;
+        }
+        if ($lock) {
+            if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+                $this->storage->releaseLock($path, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
+                $this->storage->releaseLock('scanner::' . $path, ILockingProvider::LOCK_EXCLUSIVE, $this->lockingProvider);
+            }
+        }
+        return $data;
+    }
+
+    /**
+     * Get the children currently in the cache
+     *
+     * @param int $folderId
+     * @return array[]
+     */
+    protected function getExistingChildren($folderId) {
+        $existingChildren = array();
+        $children = $this->cache->getFolderContentsById($folderId);
+        foreach ($children as $child) {
+            $existingChildren[$child['name']] = $child;
+        }
+        return $existingChildren;
+    }
+
+    /**
+     * Get the children from the storage
+     *
+     * @param string $folder
+     * @return string[]
+     */
+    protected function getNewChildren($folder) {
+        $children = array();
+        if ($dh = $this->storage->opendir($folder)) {
+            if (is_resource($dh)) {
+                while (($file = readdir($dh)) !== false) {
+                    if (!Filesystem::isIgnoredDir($file)) {
+                        $children[] = $file;
+                    }
+                }
+            }
+        }
+        return $children;
+    }
+
+    /**
+     * scan all the files and folders in a folder
+     *
+     * @param string $path
+     * @param bool $recursive
+     * @param int $reuse
+     * @param array $folderData existing cache data for the folder to be scanned
+     * @param bool $lock set to false to disable getting an additional read lock during scanning
+     * @return int the size of the scanned folder or -1 if the size is unknown at this stage
+     */
+    protected function scanChildren($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $folderData = null, $lock = true) {
+        if ($reuse === -1) {
+            $reuse = ($recursive === self::SCAN_SHALLOW) ? self::REUSE_ETAG | self::REUSE_SIZE : self::REUSE_ETAG;
+        }
+        $this->emit('\OC\Files\Cache\Scanner', 'scanFolder', array($path, $this->storageId));
+        $size = 0;
+        $childQueue = array();
+        if (is_array($folderData) and isset($folderData['fileid'])) {
+            $folderId = $folderData['fileid'];
+        } else {
+            $folderId = $this->cache->getId($path);
+        }
+        $existingChildren = $this->getExistingChildren($folderId);
+        $newChildren = $this->getNewChildren($path);
+
+        if ($this->useTransactions) {
+            \OC::$server->getDatabaseConnection()->beginTransaction();
+        }
+        $exceptionOccurred = false;
+        foreach ($newChildren as $file) {
+            $child = ($path) ? $path . '/' . $file : $file;
+            try {
+                $existingData = isset($existingChildren[$file]) ? $existingChildren[$file] : null;
+                $data = $this->scanFile($child, $reuse, $folderId, $existingData, $lock);
+                if ($data) {
+                    if ($data['mimetype'] === 'httpd/unix-directory' and $recursive === self::SCAN_RECURSIVE) {
+                        $childQueue[$child] = $data;
+                    } else if ($data['size'] === -1) {
+                        $size = -1;
+                    } else if ($size !== -1) {
+                        $size += $data['size'];
+                    }
+                }
+            } catch (\Doctrine\DBAL\DBALException $ex) {
+                // might happen if inserting duplicate while a scanning
+                // process is running in parallel
+                // log and ignore
+                \OCP\Util::writeLog('core', 'Exception while scanning file "' . $child . '": ' . $ex->getMessage(), \OCP\Util::DEBUG);
+                $exceptionOccurred = true;
+            } catch (\OCP\Lock\LockedException $e) {
+                if ($this->useTransactions) {
+                    \OC::$server->getDatabaseConnection()->rollback();
+                }
+                throw $e;
+            }
+        }
+        $removedChildren = \array_diff(array_keys($existingChildren), $newChildren);
+        foreach ($removedChildren as $childName) {
+            $child = ($path) ? $path . '/' . $childName : $childName;
+            $this->removeFromCache($child);
+        }
+        if ($this->useTransactions) {
+            \OC::$server->getDatabaseConnection()->commit();
+        }
+        if ($exceptionOccurred) {
+            // It might happen that the parallel scan process has already
+            // inserted mimetypes but those weren't available yet inside the transaction
+            // To make sure to have the updated mime types in such cases,
+            // we reload them here
+            \OC::$server->getMimeTypeLoader()->reset();
+        }
+
+        foreach ($childQueue as $child => $childData) {
+            $childSize = $this->scanChildren($child, self::SCAN_RECURSIVE, $reuse, $childData, $lock);
+            if ($childSize === -1) {
+                $size = -1;
+            } else if ($size !== -1) {
+                $size += $childSize;
+            }
+        }
+        if (!is_array($folderData) or !isset($folderData['size']) or $folderData['size'] !== $size) {
+            $this->updateCache($path, array('size' => $size), $folderId);
+        }
+        $this->emit('\OC\Files\Cache\Scanner', 'postScanFolder', array($path, $this->storageId));
+        return $size;
+    }
+
+    /**
+     * check if the file should be ignored when scanning
+     * NOTE: files with a '.part' extension are ignored as well!
+     *       prevents unfinished put requests to be scanned
+     *
+     * @param string $file
+     * @return boolean
+     */
+    public static function isPartialFile($file) {
+        if (pathinfo($file, PATHINFO_EXTENSION) === 'part') {
+            return true;
+        }
+        if (strpos($file, '.part/') !== false) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * walk over any folders that are not fully scanned yet and scan them
+     */
+    public function backgroundScan() {
+        if (!$this->cache->inCache('')) {
+            $this->runBackgroundScanJob(function () {
+                $this->scan('', self::SCAN_RECURSIVE, self::REUSE_ETAG);
+            }, '');
+        } else {
+            $lastPath = null;
+            while (($path = $this->cache->getIncomplete()) !== false && $path !== $lastPath) {
+                $this->runBackgroundScanJob(function() use ($path) {
+                    $this->scan($path, self::SCAN_RECURSIVE, self::REUSE_ETAG);
+                }, $path);
+                // FIXME: this won't proceed with the next item, needs revamping of getIncomplete()
+                // to make this possible
+                $lastPath = $path;
+            }
+        }
+    }
+
+    private function runBackgroundScanJob(callable $callback, $path) {
+        try {
+            $callback();
+            \OC_Hook::emit('Scanner', 'correctFolderSize', array('path' => $path));
+            if ($this->cacheActive && $this->cache instanceof Cache) {
+                $this->cache->correctFolderSize($path);
+            }
+        } catch (\OCP\Files\StorageInvalidException $e) {
+            // skip unavailable storages
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            // skip unavailable storages
+        } catch (\OCP\Files\ForbiddenException $e) {
+            // skip forbidden storages
+        } catch (\OCP\Lock\LockedException $e) {
+            // skip unavailable storages
+        }
+    }
+
+    /**
+     * Set whether the cache is affected by scan operations
+     *
+     * @param boolean $active The active state of the cache
+     */
+    public function setCacheActive($active) {
+        $this->cacheActive = $active;
+    }
 }

Spacing +6 added lines, -6 removed lines

@@ -317,7 +317,7 @@ 
 		}
 		if ($lock) {
 			if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-				$this->storage->acquireLock('scanner::' . $path, ILockingProvider::LOCK_EXCLUSIVE, $this->lockingProvider);
+				$this->storage->acquireLock('scanner::'.$path, ILockingProvider::LOCK_EXCLUSIVE, $this->lockingProvider);
 				$this->storage->acquireLock($path, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
 			}
 		}
@@ -329,7 +329,7 @@ 
 		if ($lock) {
 			if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
 				$this->storage->releaseLock($path, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
-				$this->storage->releaseLock('scanner::' . $path, ILockingProvider::LOCK_EXCLUSIVE, $this->lockingProvider);
+				$this->storage->releaseLock('scanner::'.$path, ILockingProvider::LOCK_EXCLUSIVE, $this->lockingProvider);
 			}
 		}
 		return $data;
@@ -400,7 +400,7 @@ 
 		}
 		$exceptionOccurred = false;
 		foreach ($newChildren as $file) {
-			$child = ($path) ? $path . '/' . $file : $file;
+			$child = ($path) ? $path.'/'.$file : $file;
 			try {
 				$existingData = isset($existingChildren[$file]) ? $existingChildren[$file] : null;
 				$data = $this->scanFile($child, $reuse, $folderId, $existingData, $lock);
@@ -417,7 +417,7 @@ 
 				// might happen if inserting duplicate while a scanning
 				// process is running in parallel
 				// log and ignore
-				\OCP\Util::writeLog('core', 'Exception while scanning file "' . $child . '": ' . $ex->getMessage(), \OCP\Util::DEBUG);
+				\OCP\Util::writeLog('core', 'Exception while scanning file "'.$child.'": '.$ex->getMessage(), \OCP\Util::DEBUG);
 				$exceptionOccurred = true;
 			} catch (\OCP\Lock\LockedException $e) {
 				if ($this->useTransactions) {
@@ -428,7 +428,7 @@ 
 		}
 		$removedChildren = \array_diff(array_keys($existingChildren), $newChildren);
 		foreach ($removedChildren as $childName) {
-			$child = ($path) ? $path . '/' . $childName : $childName;
+			$child = ($path) ? $path.'/'.$childName : $childName;
 			$this->removeFromCache($child);
 		}
 		if ($this->useTransactions) {
@@ -481,7 +481,7 @@ 
 	 */
 	public function backgroundScan() {
 		if (!$this->cache->inCache('')) {
-			$this->runBackgroundScanJob(function () {
+			$this->runBackgroundScanJob(function() {
 				$this->scan('', self::SCAN_RECURSIVE, self::REUSE_ETAG);
 			}, '');
 		} else {

lib/private/files/config/usermountcache.php

Doc Comments +1 added lines, -1 removed lines

@@ -206,7 +206,7 @@
 	}
 
 	/**
-	 * @param $fileId
+	 * @param integer $fileId
 	 * @return array
 	 * @throws \OCP\Files\NotFoundException
 	 */

Unused Use Statements -2 removed lines

@@ -22,8 +22,6 @@
 
 namespace OC\Files\Config;
 
-use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
-use OC\Files\Filesystem;
 use OCA\Files_Sharing\SharedMount;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\Files\Config\ICachedMountInfo;

Indentation +264 added lines, -264 removed lines

@@ -43,268 +43,268 @@
  * Cache mounts points per user in the cache so we can easilly look them up
  */
 class UserMountCache implements IUserMountCache {
-	/**
-	 * @var IDBConnection
-	 */
-	private $connection;
-
-	/**
-	 * @var IUserManager
-	 */
-	private $userManager;
-
-	/**
-	 * Cached mount info.
-	 * Map of $userId to ICachedMountInfo.
-	 *
-	 * @var ICache
-	 **/
-	private $mountsForUsers;
-
-	/**
-	 * @var ILogger
-	 */
-	private $logger;
-
-	/**
-	 * @var ICache
-	 */
-	private $cacheInfoCache;
-
-	/**
-	 * UserMountCache constructor.
-	 *
-	 * @param IDBConnection $connection
-	 * @param IUserManager $userManager
-	 * @param ILogger $logger
-	 */
-	public function __construct(IDBConnection $connection, IUserManager $userManager, ILogger $logger) {
-		$this->connection = $connection;
-		$this->userManager = $userManager;
-		$this->logger = $logger;
-		$this->cacheInfoCache = new CappedMemoryCache();
-		$this->mountsForUsers = new CappedMemoryCache();
-	}
-
-	public function registerMounts(IUser $user, array $mounts) {
-		// filter out non-proper storages coming from unit tests
-		$mounts = array_filter($mounts, function (IMountPoint $mount) {
-			return $mount instanceof SharedMount || $mount->getStorage() && $mount->getStorage()->getCache();
-		});
-		/** @var ICachedMountInfo[] $newMounts */
-		$newMounts = array_map(function (IMountPoint $mount) use ($user) {
-			$storage = $mount->getStorage();
-			if ($storage->instanceOfStorage('\OC\Files\Storage\Shared')) {
-				$rootId = (int)$storage->getShare()['file_source'];
-			} else {
-				$rootId = (int)$storage->getCache()->getId('');
-			}
-			$storageId = (int)$storage->getStorageCache()->getNumericId();
-			// filter out any storages which aren't scanned yet since we aren't interested in files from those storages (yet)
-			if ($rootId === -1) {
-				return null;
-			} else {
-				return new CachedMountInfo($user, $storageId, $rootId, $mount->getMountPoint());
-			}
-		}, $mounts);
-		$newMounts = array_values(array_filter($newMounts));
-
-		$cachedMounts = $this->getMountsForUser($user);
-		$mountDiff = function (ICachedMountInfo $mount1, ICachedMountInfo $mount2) {
-			// since we are only looking for mounts for a specific user comparing on root id is enough
-			return $mount1->getRootId() - $mount2->getRootId();
-		};
-
-		/** @var ICachedMountInfo[] $addedMounts */
-		$addedMounts = array_udiff($newMounts, $cachedMounts, $mountDiff);
-		/** @var ICachedMountInfo[] $removedMounts */
-		$removedMounts = array_udiff($cachedMounts, $newMounts, $mountDiff);
-
-		$changedMounts = array_uintersect($newMounts, $cachedMounts, function (ICachedMountInfo $mount1, ICachedMountInfo $mount2) {
-			// filter mounts with the same root id and different mountpoints
-			if ($mount1->getRootId() !== $mount2->getRootId()) {
-				return -1;
-			}
-			return ($mount1->getMountPoint() !== $mount2->getMountPoint()) ? 0 : 1;
-		});
-
-		foreach ($addedMounts as $mount) {
-			$this->addToCache($mount);
-			$this->mountsForUsers[$user->getUID()][] = $mount;
-		}
-		foreach ($removedMounts as $mount) {
-			$this->removeFromCache($mount);
-			$index = array_search($mount, $this->mountsForUsers[$user->getUID()]);
-			unset($this->mountsForUsers[$user->getUID()][$index]);
-		}
-		foreach ($changedMounts as $mount) {
-			$this->setMountPoint($mount);
-		}
-	}
-
-	private function addToCache(ICachedMountInfo $mount) {
-		$this->connection->insertIfNotExist('*PREFIX*mounts', [
-			'storage_id' => $mount->getStorageId(),
-			'root_id' => $mount->getRootId(),
-			'user_id' => $mount->getUser()->getUID(),
-			'mount_point' => $mount->getMountPoint()
-		], ['root_id', 'user_id']);
-	}
-
-	private function setMountPoint(ICachedMountInfo $mount) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$query = $builder->update('mounts')
-			->set('mount_point', $builder->createNamedParameter($mount->getMountPoint()))
-			->where($builder->expr()->eq('user_id', $builder->createNamedParameter($mount->getUser()->getUID())))
-			->andWhere($builder->expr()->eq('root_id', $builder->createNamedParameter($mount->getRootId(), IQueryBuilder::PARAM_INT)));
-
-		$query->execute();
-	}
-
-	private function removeFromCache(ICachedMountInfo $mount) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$query = $builder->delete('mounts')
-			->where($builder->expr()->eq('user_id', $builder->createNamedParameter($mount->getUser()->getUID())))
-			->andWhere($builder->expr()->eq('root_id', $builder->createNamedParameter($mount->getRootId(), IQueryBuilder::PARAM_INT)));
-		$query->execute();
-	}
-
-	private function dbRowToMountInfo(array $row) {
-		$user = $this->userManager->get($row['user_id']);
-		return new CachedMountInfo($user, (int)$row['storage_id'], (int)$row['root_id'], $row['mount_point']);
-	}
-
-	/**
-	 * @param IUser $user
-	 * @return ICachedMountInfo[]
-	 */
-	public function getMountsForUser(IUser $user) {
-		if (!isset($this->mountsForUsers[$user->getUID()])) {
-			$builder = $this->connection->getQueryBuilder();
-			$query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point')
-				->from('mounts')
-				->where($builder->expr()->eq('user_id', $builder->createPositionalParameter($user->getUID())));
-
-			$rows = $query->execute()->fetchAll();
-
-			$this->mountsForUsers[$user->getUID()] = array_map([$this, 'dbRowToMountInfo'], $rows);
-		}
-		return $this->mountsForUsers[$user->getUID()];
-	}
-
-	/**
-	 * @param int $numericStorageId
-	 * @return CachedMountInfo[]
-	 */
-	public function getMountsForStorageId($numericStorageId) {
-		$builder = $this->connection->getQueryBuilder();
-		$query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point')
-			->from('mounts')
-			->where($builder->expr()->eq('storage_id', $builder->createPositionalParameter($numericStorageId, IQueryBuilder::PARAM_INT)));
-
-		$rows = $query->execute()->fetchAll();
-
-		return array_map([$this, 'dbRowToMountInfo'], $rows);
-	}
-
-	/**
-	 * @param int $rootFileId
-	 * @return CachedMountInfo[]
-	 */
-	public function getMountsForRootId($rootFileId) {
-		$builder = $this->connection->getQueryBuilder();
-		$query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point')
-			->from('mounts')
-			->where($builder->expr()->eq('root_id', $builder->createPositionalParameter($rootFileId, IQueryBuilder::PARAM_INT)));
-
-		$rows = $query->execute()->fetchAll();
-
-		return array_map([$this, 'dbRowToMountInfo'], $rows);
-	}
-
-	/**
-	 * @param $fileId
-	 * @return array
-	 * @throws \OCP\Files\NotFoundException
-	 */
-	private function getCacheInfoFromFileId($fileId) {
-		if (!isset($this->cacheInfoCache[$fileId])) {
-			$builder = $this->connection->getQueryBuilder();
-			$query = $builder->select('storage', 'path')
-				->from('filecache')
-				->where($builder->expr()->eq('fileid', $builder->createNamedParameter($fileId, IQueryBuilder::PARAM_INT)));
-
-			$row = $query->execute()->fetch();
-			if (is_array($row)) {
-				$this->cacheInfoCache[$fileId] = [
-					(int)$row['storage'],
-					$row['path']
-				];
-			} else {
-				throw new NotFoundException('File with id "' . $fileId . '" not found');
-			}
-		}
-		return $this->cacheInfoCache[$fileId];
-	}
-
-	/**
-	 * @param int $fileId
-	 * @return ICachedMountInfo[]
-	 * @since 9.0.0
-	 */
-	public function getMountsForFileId($fileId) {
-		try {
-			list($storageId, $internalPath) = $this->getCacheInfoFromFileId($fileId);
-		} catch (NotFoundException $e) {
-			return [];
-		}
-		$mountsForStorage = $this->getMountsForStorageId($storageId);
-
-		// filter mounts that are from the same storage but a different directory
-		return array_filter($mountsForStorage, function (ICachedMountInfo $mount) use ($internalPath, $fileId) {
-			if ($fileId === $mount->getRootId()) {
-				return true;
-			}
-			try {
-				list(, $internalMountPath) = $this->getCacheInfoFromFileId($mount->getRootId());
-			} catch (NotFoundException $e) {
-				return false;
-			}
-
-			return $internalMountPath === '' || substr($internalPath, 0, strlen($internalMountPath) + 1) === $internalMountPath . '/';
-		});
-
-	}
-
-	/**
-	 * Remove all cached mounts for a user
-	 *
-	 * @param IUser $user
-	 */
-	public function removeUserMounts(IUser $user) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$query = $builder->delete('mounts')
-			->where($builder->expr()->eq('user_id', $builder->createNamedParameter($user->getUID())));
-		$query->execute();
-	}
-
-	public function removeUserStorageMount($storageId, $userId) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$query = $builder->delete('mounts')
-			->where($builder->expr()->eq('user_id', $builder->createNamedParameter($userId)))
-			->andWhere($builder->expr()->eq('storage_id', $builder->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)));
-		$query->execute();
-	}
-
-	public function remoteStorageMounts($storageId) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$query = $builder->delete('mounts')
-			->where($builder->expr()->eq('storage_id', $builder->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)));
-		$query->execute();
-	}
+    /**
+     * @var IDBConnection
+     */
+    private $connection;
+
+    /**
+     * @var IUserManager
+     */
+    private $userManager;
+
+    /**
+     * Cached mount info.
+     * Map of $userId to ICachedMountInfo.
+     *
+     * @var ICache
+     **/
+    private $mountsForUsers;
+
+    /**
+     * @var ILogger
+     */
+    private $logger;
+
+    /**
+     * @var ICache
+     */
+    private $cacheInfoCache;
+
+    /**
+     * UserMountCache constructor.
+     *
+     * @param IDBConnection $connection
+     * @param IUserManager $userManager
+     * @param ILogger $logger
+     */
+    public function __construct(IDBConnection $connection, IUserManager $userManager, ILogger $logger) {
+        $this->connection = $connection;
+        $this->userManager = $userManager;
+        $this->logger = $logger;
+        $this->cacheInfoCache = new CappedMemoryCache();
+        $this->mountsForUsers = new CappedMemoryCache();
+    }
+
+    public function registerMounts(IUser $user, array $mounts) {
+        // filter out non-proper storages coming from unit tests
+        $mounts = array_filter($mounts, function (IMountPoint $mount) {
+            return $mount instanceof SharedMount || $mount->getStorage() && $mount->getStorage()->getCache();
+        });
+        /** @var ICachedMountInfo[] $newMounts */
+        $newMounts = array_map(function (IMountPoint $mount) use ($user) {
+            $storage = $mount->getStorage();
+            if ($storage->instanceOfStorage('\OC\Files\Storage\Shared')) {
+                $rootId = (int)$storage->getShare()['file_source'];
+            } else {
+                $rootId = (int)$storage->getCache()->getId('');
+            }
+            $storageId = (int)$storage->getStorageCache()->getNumericId();
+            // filter out any storages which aren't scanned yet since we aren't interested in files from those storages (yet)
+            if ($rootId === -1) {
+                return null;
+            } else {
+                return new CachedMountInfo($user, $storageId, $rootId, $mount->getMountPoint());
+            }
+        }, $mounts);
+        $newMounts = array_values(array_filter($newMounts));
+
+        $cachedMounts = $this->getMountsForUser($user);
+        $mountDiff = function (ICachedMountInfo $mount1, ICachedMountInfo $mount2) {
+            // since we are only looking for mounts for a specific user comparing on root id is enough
+            return $mount1->getRootId() - $mount2->getRootId();
+        };
+
+        /** @var ICachedMountInfo[] $addedMounts */
+        $addedMounts = array_udiff($newMounts, $cachedMounts, $mountDiff);
+        /** @var ICachedMountInfo[] $removedMounts */
+        $removedMounts = array_udiff($cachedMounts, $newMounts, $mountDiff);
+
+        $changedMounts = array_uintersect($newMounts, $cachedMounts, function (ICachedMountInfo $mount1, ICachedMountInfo $mount2) {
+            // filter mounts with the same root id and different mountpoints
+            if ($mount1->getRootId() !== $mount2->getRootId()) {
+                return -1;
+            }
+            return ($mount1->getMountPoint() !== $mount2->getMountPoint()) ? 0 : 1;
+        });
+
+        foreach ($addedMounts as $mount) {
+            $this->addToCache($mount);
+            $this->mountsForUsers[$user->getUID()][] = $mount;
+        }
+        foreach ($removedMounts as $mount) {
+            $this->removeFromCache($mount);
+            $index = array_search($mount, $this->mountsForUsers[$user->getUID()]);
+            unset($this->mountsForUsers[$user->getUID()][$index]);
+        }
+        foreach ($changedMounts as $mount) {
+            $this->setMountPoint($mount);
+        }
+    }
+
+    private function addToCache(ICachedMountInfo $mount) {
+        $this->connection->insertIfNotExist('*PREFIX*mounts', [
+            'storage_id' => $mount->getStorageId(),
+            'root_id' => $mount->getRootId(),
+            'user_id' => $mount->getUser()->getUID(),
+            'mount_point' => $mount->getMountPoint()
+        ], ['root_id', 'user_id']);
+    }
+
+    private function setMountPoint(ICachedMountInfo $mount) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $query = $builder->update('mounts')
+            ->set('mount_point', $builder->createNamedParameter($mount->getMountPoint()))
+            ->where($builder->expr()->eq('user_id', $builder->createNamedParameter($mount->getUser()->getUID())))
+            ->andWhere($builder->expr()->eq('root_id', $builder->createNamedParameter($mount->getRootId(), IQueryBuilder::PARAM_INT)));
+
+        $query->execute();
+    }
+
+    private function removeFromCache(ICachedMountInfo $mount) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $query = $builder->delete('mounts')
+            ->where($builder->expr()->eq('user_id', $builder->createNamedParameter($mount->getUser()->getUID())))
+            ->andWhere($builder->expr()->eq('root_id', $builder->createNamedParameter($mount->getRootId(), IQueryBuilder::PARAM_INT)));
+        $query->execute();
+    }
+
+    private function dbRowToMountInfo(array $row) {
+        $user = $this->userManager->get($row['user_id']);
+        return new CachedMountInfo($user, (int)$row['storage_id'], (int)$row['root_id'], $row['mount_point']);
+    }
+
+    /**
+     * @param IUser $user
+     * @return ICachedMountInfo[]
+     */
+    public function getMountsForUser(IUser $user) {
+        if (!isset($this->mountsForUsers[$user->getUID()])) {
+            $builder = $this->connection->getQueryBuilder();
+            $query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point')
+                ->from('mounts')
+                ->where($builder->expr()->eq('user_id', $builder->createPositionalParameter($user->getUID())));
+
+            $rows = $query->execute()->fetchAll();
+
+            $this->mountsForUsers[$user->getUID()] = array_map([$this, 'dbRowToMountInfo'], $rows);
+        }
+        return $this->mountsForUsers[$user->getUID()];
+    }
+
+    /**
+     * @param int $numericStorageId
+     * @return CachedMountInfo[]
+     */
+    public function getMountsForStorageId($numericStorageId) {
+        $builder = $this->connection->getQueryBuilder();
+        $query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point')
+            ->from('mounts')
+            ->where($builder->expr()->eq('storage_id', $builder->createPositionalParameter($numericStorageId, IQueryBuilder::PARAM_INT)));
+
+        $rows = $query->execute()->fetchAll();
+
+        return array_map([$this, 'dbRowToMountInfo'], $rows);
+    }
+
+    /**
+     * @param int $rootFileId
+     * @return CachedMountInfo[]
+     */
+    public function getMountsForRootId($rootFileId) {
+        $builder = $this->connection->getQueryBuilder();
+        $query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point')
+            ->from('mounts')
+            ->where($builder->expr()->eq('root_id', $builder->createPositionalParameter($rootFileId, IQueryBuilder::PARAM_INT)));
+
+        $rows = $query->execute()->fetchAll();
+
+        return array_map([$this, 'dbRowToMountInfo'], $rows);
+    }
+
+    /**
+     * @param $fileId
+     * @return array
+     * @throws \OCP\Files\NotFoundException
+     */
+    private function getCacheInfoFromFileId($fileId) {
+        if (!isset($this->cacheInfoCache[$fileId])) {
+            $builder = $this->connection->getQueryBuilder();
+            $query = $builder->select('storage', 'path')
+                ->from('filecache')
+                ->where($builder->expr()->eq('fileid', $builder->createNamedParameter($fileId, IQueryBuilder::PARAM_INT)));
+
+            $row = $query->execute()->fetch();
+            if (is_array($row)) {
+                $this->cacheInfoCache[$fileId] = [
+                    (int)$row['storage'],
+                    $row['path']
+                ];
+            } else {
+                throw new NotFoundException('File with id "' . $fileId . '" not found');
+            }
+        }
+        return $this->cacheInfoCache[$fileId];
+    }
+
+    /**
+     * @param int $fileId
+     * @return ICachedMountInfo[]
+     * @since 9.0.0
+     */
+    public function getMountsForFileId($fileId) {
+        try {
+            list($storageId, $internalPath) = $this->getCacheInfoFromFileId($fileId);
+        } catch (NotFoundException $e) {
+            return [];
+        }
+        $mountsForStorage = $this->getMountsForStorageId($storageId);
+
+        // filter mounts that are from the same storage but a different directory
+        return array_filter($mountsForStorage, function (ICachedMountInfo $mount) use ($internalPath, $fileId) {
+            if ($fileId === $mount->getRootId()) {
+                return true;
+            }
+            try {
+                list(, $internalMountPath) = $this->getCacheInfoFromFileId($mount->getRootId());
+            } catch (NotFoundException $e) {
+                return false;
+            }
+
+            return $internalMountPath === '' || substr($internalPath, 0, strlen($internalMountPath) + 1) === $internalMountPath . '/';
+        });
+
+    }
+
+    /**
+     * Remove all cached mounts for a user
+     *
+     * @param IUser $user
+     */
+    public function removeUserMounts(IUser $user) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $query = $builder->delete('mounts')
+            ->where($builder->expr()->eq('user_id', $builder->createNamedParameter($user->getUID())));
+        $query->execute();
+    }
+
+    public function removeUserStorageMount($storageId, $userId) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $query = $builder->delete('mounts')
+            ->where($builder->expr()->eq('user_id', $builder->createNamedParameter($userId)))
+            ->andWhere($builder->expr()->eq('storage_id', $builder->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)));
+        $query->execute();
+    }
+
+    public function remoteStorageMounts($storageId) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $query = $builder->delete('mounts')
+            ->where($builder->expr()->eq('storage_id', $builder->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)));
+        $query->execute();
+    }
 }

Spacing +12 added lines, -12 removed lines

@@ -88,18 +88,18 @@ 
 
 	public function registerMounts(IUser $user, array $mounts) {
 		// filter out non-proper storages coming from unit tests
-		$mounts = array_filter($mounts, function (IMountPoint $mount) {
+		$mounts = array_filter($mounts, function(IMountPoint $mount) {
 			return $mount instanceof SharedMount || $mount->getStorage() && $mount->getStorage()->getCache();
 		});
 		/** @var ICachedMountInfo[] $newMounts */
-		$newMounts = array_map(function (IMountPoint $mount) use ($user) {
+		$newMounts = array_map(function(IMountPoint $mount) use ($user) {
 			$storage = $mount->getStorage();
 			if ($storage->instanceOfStorage('\OC\Files\Storage\Shared')) {
-				$rootId = (int)$storage->getShare()['file_source'];
+				$rootId = (int) $storage->getShare()['file_source'];
 			} else {
-				$rootId = (int)$storage->getCache()->getId('');
+				$rootId = (int) $storage->getCache()->getId('');
 			}
-			$storageId = (int)$storage->getStorageCache()->getNumericId();
+			$storageId = (int) $storage->getStorageCache()->getNumericId();
 			// filter out any storages which aren't scanned yet since we aren't interested in files from those storages (yet)
 			if ($rootId === -1) {
 				return null;
@@ -110,7 +110,7 @@ 
 		$newMounts = array_values(array_filter($newMounts));
 
 		$cachedMounts = $this->getMountsForUser($user);
-		$mountDiff = function (ICachedMountInfo $mount1, ICachedMountInfo $mount2) {
+		$mountDiff = function(ICachedMountInfo $mount1, ICachedMountInfo $mount2) {
 			// since we are only looking for mounts for a specific user comparing on root id is enough
 			return $mount1->getRootId() - $mount2->getRootId();
 		};
@@ -120,7 +120,7 @@ 
 		/** @var ICachedMountInfo[] $removedMounts */
 		$removedMounts = array_udiff($cachedMounts, $newMounts, $mountDiff);
 
-		$changedMounts = array_uintersect($newMounts, $cachedMounts, function (ICachedMountInfo $mount1, ICachedMountInfo $mount2) {
+		$changedMounts = array_uintersect($newMounts, $cachedMounts, function(ICachedMountInfo $mount1, ICachedMountInfo $mount2) {
 			// filter mounts with the same root id and different mountpoints
 			if ($mount1->getRootId() !== $mount2->getRootId()) {
 				return -1;
@@ -173,7 +173,7 @@ 
 
 	private function dbRowToMountInfo(array $row) {
 		$user = $this->userManager->get($row['user_id']);
-		return new CachedMountInfo($user, (int)$row['storage_id'], (int)$row['root_id'], $row['mount_point']);
+		return new CachedMountInfo($user, (int) $row['storage_id'], (int) $row['root_id'], $row['mount_point']);
 	}
 
 	/**
@@ -239,11 +239,11 @@ 
 			$row = $query->execute()->fetch();
 			if (is_array($row)) {
 				$this->cacheInfoCache[$fileId] = [
-					(int)$row['storage'],
+					(int) $row['storage'],
 					$row['path']
 				];
 			} else {
-				throw new NotFoundException('File with id "' . $fileId . '" not found');
+				throw new NotFoundException('File with id "'.$fileId.'" not found');
 			}
 		}
 		return $this->cacheInfoCache[$fileId];
@@ -263,7 +263,7 @@ 
 		$mountsForStorage = $this->getMountsForStorageId($storageId);
 
 		// filter mounts that are from the same storage but a different directory
-		return array_filter($mountsForStorage, function (ICachedMountInfo $mount) use ($internalPath, $fileId) {
+		return array_filter($mountsForStorage, function(ICachedMountInfo $mount) use ($internalPath, $fileId) {
 			if ($fileId === $mount->getRootId()) {
 				return true;
 			}
@@ -273,7 +273,7 @@ 
 				return false;
 			}
 
-			return $internalMountPath === '' || substr($internalPath, 0, strlen($internalMountPath) + 1) === $internalMountPath . '/';
+			return $internalMountPath === '' || substr($internalPath, 0, strlen($internalMountPath) + 1) === $internalMountPath.'/';
 		});
 
 	}

lib/private/files/filesystem.php

Unused Use Statements -1 removed lines

@@ -62,7 +62,6 @@
 use OC\Files\Mount\MountPoint;
 use OC\Files\Storage\StorageFactory;
 use OCP\Files\Config\IMountProvider;
-use OCP\Files\Mount\IMountPoint;
 use OCP\Files\NotFoundException;
 use OCP\IUserManager;
 

Doc Comments +28 added lines, -2 removed lines

@@ -338,6 +338,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $root
+	 */
 	static public function init($user, $root) {
 		if (self::$defaultInstance) {
 			return false;
@@ -521,7 +524,7 @@ 
 	/**
 	 * mount an \OC\Files\Storage\Storage in our virtual filesystem
 	 *
-	 * @param \OC\Files\Storage\Storage|string $class
+	 * @param string $class
 	 * @param array $arguments
 	 * @param string $mountpoint
 	 */
@@ -653,6 +656,9 @@ 
 		return self::$defaultInstance->is_dir($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function is_file($path) {
 		return self::$defaultInstance->is_file($path);
 	}
@@ -665,6 +671,9 @@ 
 		return self::$defaultInstance->filetype($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function filesize($path) {
 		return self::$defaultInstance->filesize($path);
 	}
@@ -677,6 +686,9 @@ 
 		return self::$defaultInstance->isCreatable($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function isReadable($path) {
 		return self::$defaultInstance->isReadable($path);
 	}
@@ -689,6 +701,9 @@ 
 		return self::$defaultInstance->isDeletable($path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function isSharable($path) {
 		return self::$defaultInstance->isSharable($path);
 	}
@@ -706,6 +721,7 @@ 
 	}
 
 	/**
+	 * @param string $path
 	 * @return string
 	 */
 	static public function file_get_contents($path) {
@@ -728,6 +744,10 @@ 
 		return self::$defaultInstance->copy($path1, $path2);
 	}
 
+	/**
+	 * @param string $path
+	 * @param string $mode
+	 */
 	static public function fopen($path, $mode) {
 		return self::$defaultInstance->fopen($path, $mode);
 	}
@@ -743,6 +763,9 @@ 
 		return self::$defaultInstance->fromTmpFile($tmpFile, $path);
 	}
 
+	/**
+	 * @param string $path
+	 */
 	static public function getMimeType($path) {
 		return self::$defaultInstance->getMimeType($path);
 	}
@@ -755,6 +778,9 @@ 
 		return self::$defaultInstance->free_space($path);
 	}
 
+	/**
+	 * @param string $query
+	 */
 	static public function search($query) {
 		return self::$defaultInstance->search($query);
 	}
@@ -868,7 +894,7 @@ 
 	 * @param string $path
 	 * @param boolean $includeMountPoints whether to add mountpoint sizes,
 	 * defaults to true
-	 * @return \OC\Files\FileInfo|bool False if file does not exist
+	 * @return \OCP\Files\FileInfo|null False if file does not exist
 	 */
 	public static function getFileInfo($path, $includeMountPoints = true) {
 		return self::$defaultInstance->getFileInfo($path, $includeMountPoints);

Indentation +861 added lines, -861 removed lines

@@ -70,865 +70,865 @@
 
 class Filesystem {
 
-	/**
-	 * @var Mount\Manager $mounts
-	 */
-	private static $mounts;
-
-	public static $loaded = false;
-	/**
-	 * @var \OC\Files\View $defaultInstance
-	 */
-	static private $defaultInstance;
-
-	static private $usersSetup = array();
-
-	static private $normalizedPathCache = null;
-
-	static private $listeningForProviders = false;
-
-	/**
-	 * classname which used for hooks handling
-	 * used as signalclass in OC_Hooks::emit()
-	 */
-	const CLASSNAME = 'OC_Filesystem';
-
-	/**
-	 * signalname emitted before file renaming
-	 *
-	 * @param string $oldpath
-	 * @param string $newpath
-	 */
-	const signal_rename = 'rename';
-
-	/**
-	 * signal emitted after file renaming
-	 *
-	 * @param string $oldpath
-	 * @param string $newpath
-	 */
-	const signal_post_rename = 'post_rename';
-
-	/**
-	 * signal emitted before file/dir creation
-	 *
-	 * @param string $path
-	 * @param bool $run changing this flag to false in hook handler will cancel event
-	 */
-	const signal_create = 'create';
-
-	/**
-	 * signal emitted after file/dir creation
-	 *
-	 * @param string $path
-	 * @param bool $run changing this flag to false in hook handler will cancel event
-	 */
-	const signal_post_create = 'post_create';
-
-	/**
-	 * signal emits before file/dir copy
-	 *
-	 * @param string $oldpath
-	 * @param string $newpath
-	 * @param bool $run changing this flag to false in hook handler will cancel event
-	 */
-	const signal_copy = 'copy';
-
-	/**
-	 * signal emits after file/dir copy
-	 *
-	 * @param string $oldpath
-	 * @param string $newpath
-	 */
-	const signal_post_copy = 'post_copy';
-
-	/**
-	 * signal emits before file/dir save
-	 *
-	 * @param string $path
-	 * @param bool $run changing this flag to false in hook handler will cancel event
-	 */
-	const signal_write = 'write';
-
-	/**
-	 * signal emits after file/dir save
-	 *
-	 * @param string $path
-	 */
-	const signal_post_write = 'post_write';
-
-	/**
-	 * signal emitted before file/dir update
-	 *
-	 * @param string $path
-	 * @param bool $run changing this flag to false in hook handler will cancel event
-	 */
-	const signal_update = 'update';
-
-	/**
-	 * signal emitted after file/dir update
-	 *
-	 * @param string $path
-	 * @param bool $run changing this flag to false in hook handler will cancel event
-	 */
-	const signal_post_update = 'post_update';
-
-	/**
-	 * signal emits when reading file/dir
-	 *
-	 * @param string $path
-	 */
-	const signal_read = 'read';
-
-	/**
-	 * signal emits when removing file/dir
-	 *
-	 * @param string $path
-	 */
-	const signal_delete = 'delete';
-
-	/**
-	 * parameters definitions for signals
-	 */
-	const signal_param_path = 'path';
-	const signal_param_oldpath = 'oldpath';
-	const signal_param_newpath = 'newpath';
-
-	/**
-	 * run - changing this flag to false in hook handler will cancel event
-	 */
-	const signal_param_run = 'run';
-
-	const signal_create_mount = 'create_mount';
-	const signal_delete_mount = 'delete_mount';
-	const signal_param_mount_type = 'mounttype';
-	const signal_param_users = 'users';
-
-	/**
-	 * @var \OC\Files\Storage\StorageFactory $loader
-	 */
-	private static $loader;
-
-	/**
-	 * @param string $wrapperName
-	 * @param callable $wrapper
-	 * @param int $priority
-	 */
-	public static function addStorageWrapper($wrapperName, $wrapper, $priority = 50) {
-		$mounts = self::getMountManager()->getAll();
-		if (!self::getLoader()->addStorageWrapper($wrapperName, $wrapper, $priority, $mounts)) {
-			// do not re-wrap if storage with this name already existed
-			return;
-		}
-	}
-
-	/**
-	 * Returns the storage factory
-	 *
-	 * @return \OCP\Files\Storage\IStorageFactory
-	 */
-	public static function getLoader() {
-		if (!self::$loader) {
-			self::$loader = new StorageFactory();
-		}
-		return self::$loader;
-	}
-
-	/**
-	 * Returns the mount manager
-	 *
-	 * @return \OC\Files\Mount\Manager
-	 */
-	public static function getMountManager($user = '') {
-		if (!self::$mounts) {
-			\OC_Util::setupFS($user);
-		}
-		return self::$mounts;
-	}
-
-	/**
-	 * get the mountpoint of the storage object for a path
-	 * ( note: because a storage is not always mounted inside the fakeroot, the
-	 * returned mountpoint is relative to the absolute root of the filesystem
-	 * and doesn't take the chroot into account )
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	static public function getMountPoint($path) {
-		if (!self::$mounts) {
-			\OC_Util::setupFS();
-		}
-		$mount = self::$mounts->find($path);
-		if ($mount) {
-			return $mount->getMountPoint();
-		} else {
-			return '';
-		}
-	}
-
-	/**
-	 * get a list of all mount points in a directory
-	 *
-	 * @param string $path
-	 * @return string[]
-	 */
-	static public function getMountPoints($path) {
-		if (!self::$mounts) {
-			\OC_Util::setupFS();
-		}
-		$result = array();
-		$mounts = self::$mounts->findIn($path);
-		foreach ($mounts as $mount) {
-			$result[] = $mount->getMountPoint();
-		}
-		return $result;
-	}
-
-	/**
-	 * get the storage mounted at $mountPoint
-	 *
-	 * @param string $mountPoint
-	 * @return \OC\Files\Storage\Storage
-	 */
-	public static function getStorage($mountPoint) {
-		if (!self::$mounts) {
-			\OC_Util::setupFS();
-		}
-		$mount = self::$mounts->find($mountPoint);
-		return $mount->getStorage();
-	}
-
-	/**
-	 * @param string $id
-	 * @return Mount\MountPoint[]
-	 */
-	public static function getMountByStorageId($id) {
-		if (!self::$mounts) {
-			\OC_Util::setupFS();
-		}
-		return self::$mounts->findByStorageId($id);
-	}
-
-	/**
-	 * @param int $id
-	 * @return Mount\MountPoint[]
-	 */
-	public static function getMountByNumericId($id) {
-		if (!self::$mounts) {
-			\OC_Util::setupFS();
-		}
-		return self::$mounts->findByNumericId($id);
-	}
-
-	/**
-	 * resolve a path to a storage and internal path
-	 *
-	 * @param string $path
-	 * @return array an array consisting of the storage and the internal path
-	 */
-	static public function resolvePath($path) {
-		if (!self::$mounts) {
-			\OC_Util::setupFS();
-		}
-		$mount = self::$mounts->find($path);
-		if ($mount) {
-			return array($mount->getStorage(), rtrim($mount->getInternalPath($path), '/'));
-		} else {
-			return array(null, null);
-		}
-	}
-
-	static public function init($user, $root) {
-		if (self::$defaultInstance) {
-			return false;
-		}
-		self::getLoader();
-		self::$defaultInstance = new View($root);
-
-		if (!self::$mounts) {
-			self::$mounts = \OC::$server->getMountManager();
-		}
-
-		//load custom mount config
-		self::initMountPoints($user);
-
-		self::$loaded = true;
-
-		return true;
-	}
-
-	static public function initMountManager() {
-		if (!self::$mounts) {
-			self::$mounts = \OC::$server->getMountManager();
-		}
-	}
-
-	/**
-	 * Initialize system and personal mount points for a user
-	 *
-	 * @param string $user
-	 * @throws \OC\User\NoUserException if the user is not available
-	 */
-	public static function initMountPoints($user = '') {
-		if ($user == '') {
-			$user = \OC_User::getUser();
-		}
-		if ($user === null || $user === false || $user === '') {
-			throw new \OC\User\NoUserException('Attempted to initialize mount points for null user and no user in session');
-		}
-		if (isset(self::$usersSetup[$user])) {
-			return;
-		}
-		self::$usersSetup[$user] = true;
-
-		$root = \OC_User::getHome($user);
-
-		$userManager = \OC::$server->getUserManager();
-		$userObject = $userManager->get($user);
-
-		if (is_null($userObject)) {
-			\OCP\Util::writeLog('files', ' Backends provided no user object for ' . $user, \OCP\Util::ERROR);
-			throw new \OC\User\NoUserException('Backends provided no user object for ' . $user);
-		}
-
-		$homeStorage = \OC::$server->getConfig()->getSystemValue('objectstore');
-		if (!empty($homeStorage)) {
-			// sanity checks
-			if (empty($homeStorage['class'])) {
-				\OCP\Util::writeLog('files', 'No class given for objectstore', \OCP\Util::ERROR);
-			}
-			if (!isset($homeStorage['arguments'])) {
-				$homeStorage['arguments'] = array();
-			}
-			// instantiate object store implementation
-			$homeStorage['arguments']['objectstore'] = new $homeStorage['class']($homeStorage['arguments']);
-			// mount with home object store implementation
-			$homeStorage['class'] = '\OC\Files\ObjectStore\HomeObjectStoreStorage';
-		} else {
-			$homeStorage = array(
-				//default home storage configuration:
-				'class' => '\OC\Files\Storage\Home',
-				'arguments' => array()
-			);
-		}
-		$homeStorage['arguments']['user'] = $userObject;
-
-		// check for legacy home id (<= 5.0.12)
-		if (\OC\Files\Cache\Storage::exists('local::' . $root . '/')) {
-			$homeStorage['arguments']['legacy'] = true;
-		}
-
-		$mount = new MountPoint($homeStorage['class'], '/' . $user, $homeStorage['arguments'], self::getLoader());
-		self::getMountManager()->addMount($mount);
-
-		$home = \OC\Files\Filesystem::getStorage($user);
-
-		self::mountCacheDir($user);
-
-		// Chance to mount for other storages
-		/** @var \OC\Files\Config\MountProviderCollection $mountConfigManager */
-		$mountConfigManager = \OC::$server->getMountProviderCollection();
-		if ($userObject) {
-			$mounts = $mountConfigManager->getMountsForUser($userObject);
-			array_walk($mounts, array(self::$mounts, 'addMount'));
-			$mounts[] = $mount;
-			$mountConfigManager->registerMounts($userObject, $mounts);
-		}
-
-		self::listenForNewMountProviders($mountConfigManager, $userManager);
-		\OC_Hook::emit('OC_Filesystem', 'post_initMountPoints', array('user' => $user, 'user_dir' => $root));
-	}
-
-	/**
-	 * Get mounts from mount providers that are registered after setup
-	 *
-	 * @param MountProviderCollection $mountConfigManager
-	 * @param IUserManager $userManager
-	 */
-	private static function listenForNewMountProviders(MountProviderCollection $mountConfigManager, IUserManager $userManager) {
-		if (!self::$listeningForProviders) {
-			self::$listeningForProviders = true;
-			$mountConfigManager->listen('\OC\Files\Config', 'registerMountProvider', function (IMountProvider $provider) use ($userManager) {
-				foreach (Filesystem::$usersSetup as $user => $setup) {
-					$userObject = $userManager->get($user);
-					if ($userObject) {
-						$mounts = $provider->getMountsForUser($userObject, Filesystem::getLoader());
-						array_walk($mounts, array(self::$mounts, 'addMount'));
-					}
-				}
-			});
-		}
-	}
-
-	/**
-	 * Mounts the cache directory
-	 *
-	 * @param string $user user name
-	 */
-	private static function mountCacheDir($user) {
-		$cacheBaseDir = \OC::$server->getConfig()->getSystemValue('cache_path', '');
-		if ($cacheBaseDir !== '') {
-			$cacheDir = rtrim($cacheBaseDir, '/') . '/' . $user;
-			if (!file_exists($cacheDir)) {
-				mkdir($cacheDir, 0770, true);
-			}
-			// mount external cache dir to "/$user/cache" mount point
-			self::mount('\OC\Files\Storage\Local', array('datadir' => $cacheDir), '/' . $user . '/cache');
-		}
-	}
-
-	/**
-	 * get the default filesystem view
-	 *
-	 * @return View
-	 */
-	static public function getView() {
-		return self::$defaultInstance;
-	}
-
-	/**
-	 * tear down the filesystem, removing all storage providers
-	 */
-	static public function tearDown() {
-		self::clearMounts();
-		self::$defaultInstance = null;
-	}
-
-	/**
-	 * get the relative path of the root data directory for the current user
-	 *
-	 * @return string
-	 *
-	 * Returns path like /admin/files
-	 */
-	static public function getRoot() {
-		if (!self::$defaultInstance) {
-			return null;
-		}
-		return self::$defaultInstance->getRoot();
-	}
-
-	/**
-	 * clear all mounts and storage backends
-	 */
-	public static function clearMounts() {
-		if (self::$mounts) {
-			self::$usersSetup = array();
-			self::$mounts->clear();
-		}
-	}
-
-	/**
-	 * mount an \OC\Files\Storage\Storage in our virtual filesystem
-	 *
-	 * @param \OC\Files\Storage\Storage|string $class
-	 * @param array $arguments
-	 * @param string $mountpoint
-	 */
-	static public function mount($class, $arguments, $mountpoint) {
-		if (!self::$mounts) {
-			\OC_Util::setupFS();
-		}
-		$mount = new Mount\MountPoint($class, $mountpoint, $arguments, self::getLoader());
-		self::$mounts->addMount($mount);
-	}
-
-	/**
-	 * return the path to a local version of the file
-	 * we need this because we can't know if a file is stored local or not from
-	 * outside the filestorage and for some purposes a local file is needed
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	static public function getLocalFile($path) {
-		return self::$defaultInstance->getLocalFile($path);
-	}
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	static public function getLocalFolder($path) {
-		return self::$defaultInstance->getLocalFolder($path);
-	}
-
-	/**
-	 * return path to file which reflects one visible in browser
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	static public function getLocalPath($path) {
-		$datadir = \OC_User::getHome(\OC_User::getUser()) . '/files';
-		$newpath = $path;
-		if (strncmp($newpath, $datadir, strlen($datadir)) == 0) {
-			$newpath = substr($path, strlen($datadir));
-		}
-		return $newpath;
-	}
-
-	/**
-	 * check if the requested path is valid
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	static public function isValidPath($path) {
-		$path = self::normalizePath($path);
-		if (!$path || $path[0] !== '/') {
-			$path = '/' . $path;
-		}
-		if (strpos($path, '/../') !== false || strrchr($path, '/') === '/..') {
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * checks if a file is blacklisted for storage in the filesystem
-	 * Listens to write and rename hooks
-	 *
-	 * @param array $data from hook
-	 */
-	static public function isBlacklisted($data) {
-		if (isset($data['path'])) {
-			$path = $data['path'];
-		} else if (isset($data['newpath'])) {
-			$path = $data['newpath'];
-		}
-		if (isset($path)) {
-			if (self::isFileBlacklisted($path)) {
-				$data['run'] = false;
-			}
-		}
-	}
-
-	/**
-	 * @param string $filename
-	 * @return bool
-	 */
-	static public function isFileBlacklisted($filename) {
-		$filename = self::normalizePath($filename);
-
-		$blacklist = \OC::$server->getConfig()->getSystemValue('blacklisted_files', array('.htaccess'));
-		$filename = strtolower(basename($filename));
-		return in_array($filename, $blacklist);
-	}
-
-	/**
-	 * check if the directory should be ignored when scanning
-	 * NOTE: the special directories . and .. would cause never ending recursion
-	 *
-	 * @param String $dir
-	 * @return boolean
-	 */
-	static public function isIgnoredDir($dir) {
-		if ($dir === '.' || $dir === '..') {
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * following functions are equivalent to their php builtin equivalents for arguments/return values.
-	 */
-	static public function mkdir($path) {
-		return self::$defaultInstance->mkdir($path);
-	}
-
-	static public function rmdir($path) {
-		return self::$defaultInstance->rmdir($path);
-	}
-
-	static public function opendir($path) {
-		return self::$defaultInstance->opendir($path);
-	}
-
-	static public function readdir($path) {
-		return self::$defaultInstance->readdir($path);
-	}
-
-	static public function is_dir($path) {
-		return self::$defaultInstance->is_dir($path);
-	}
-
-	static public function is_file($path) {
-		return self::$defaultInstance->is_file($path);
-	}
-
-	static public function stat($path) {
-		return self::$defaultInstance->stat($path);
-	}
-
-	static public function filetype($path) {
-		return self::$defaultInstance->filetype($path);
-	}
-
-	static public function filesize($path) {
-		return self::$defaultInstance->filesize($path);
-	}
-
-	static public function readfile($path) {
-		return self::$defaultInstance->readfile($path);
-	}
-
-	static public function isCreatable($path) {
-		return self::$defaultInstance->isCreatable($path);
-	}
-
-	static public function isReadable($path) {
-		return self::$defaultInstance->isReadable($path);
-	}
-
-	static public function isUpdatable($path) {
-		return self::$defaultInstance->isUpdatable($path);
-	}
-
-	static public function isDeletable($path) {
-		return self::$defaultInstance->isDeletable($path);
-	}
-
-	static public function isSharable($path) {
-		return self::$defaultInstance->isSharable($path);
-	}
-
-	static public function file_exists($path) {
-		return self::$defaultInstance->file_exists($path);
-	}
-
-	static public function filemtime($path) {
-		return self::$defaultInstance->filemtime($path);
-	}
-
-	static public function touch($path, $mtime = null) {
-		return self::$defaultInstance->touch($path, $mtime);
-	}
-
-	/**
-	 * @return string
-	 */
-	static public function file_get_contents($path) {
-		return self::$defaultInstance->file_get_contents($path);
-	}
-
-	static public function file_put_contents($path, $data) {
-		return self::$defaultInstance->file_put_contents($path, $data);
-	}
-
-	static public function unlink($path) {
-		return self::$defaultInstance->unlink($path);
-	}
-
-	static public function rename($path1, $path2) {
-		return self::$defaultInstance->rename($path1, $path2);
-	}
-
-	static public function copy($path1, $path2) {
-		return self::$defaultInstance->copy($path1, $path2);
-	}
-
-	static public function fopen($path, $mode) {
-		return self::$defaultInstance->fopen($path, $mode);
-	}
-
-	/**
-	 * @return string
-	 */
-	static public function toTmpFile($path) {
-		return self::$defaultInstance->toTmpFile($path);
-	}
-
-	static public function fromTmpFile($tmpFile, $path) {
-		return self::$defaultInstance->fromTmpFile($tmpFile, $path);
-	}
-
-	static public function getMimeType($path) {
-		return self::$defaultInstance->getMimeType($path);
-	}
-
-	static public function hash($type, $path, $raw = false) {
-		return self::$defaultInstance->hash($type, $path, $raw);
-	}
-
-	static public function free_space($path = '/') {
-		return self::$defaultInstance->free_space($path);
-	}
-
-	static public function search($query) {
-		return self::$defaultInstance->search($query);
-	}
-
-	/**
-	 * @param string $query
-	 */
-	static public function searchByMime($query) {
-		return self::$defaultInstance->searchByMime($query);
-	}
-
-	/**
-	 * @param string|int $tag name or tag id
-	 * @param string $userId owner of the tags
-	 * @return FileInfo[] array or file info
-	 */
-	static public function searchByTag($tag, $userId) {
-		return self::$defaultInstance->searchByTag($tag, $userId);
-	}
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @return bool
-	 */
-	static public function hasUpdated($path, $time) {
-		return self::$defaultInstance->hasUpdated($path, $time);
-	}
-
-	/**
-	 * Fix common problems with a file path
-	 *
-	 * @param string $path
-	 * @param bool $stripTrailingSlash
-	 * @param bool $isAbsolutePath
-	 * @return string
-	 */
-	public static function normalizePath($path, $stripTrailingSlash = true, $isAbsolutePath = false) {
-		if (is_null(self::$normalizedPathCache)) {
-			self::$normalizedPathCache = new CappedMemoryCache();
-		}
-
-		/**
-		 * FIXME: This is a workaround for existing classes and files which call
-		 *        this function with another type than a valid string. This
-		 *        conversion should get removed as soon as all existing
-		 *        function calls have been fixed.
-		 */
-		$path = (string)$path;
-
-		$cacheKey = json_encode([$path, $stripTrailingSlash, $isAbsolutePath]);
-
-		if (isset(self::$normalizedPathCache[$cacheKey])) {
-			return self::$normalizedPathCache[$cacheKey];
-		}
-
-		if ($path == '') {
-			return '/';
-		}
-
-		//normalize unicode if possible
-		$path = \OC_Util::normalizeUnicode($path);
-
-		//no windows style slashes
-		$path = str_replace('\\', '/', $path);
-
-		// When normalizing an absolute path, we need to ensure that the drive-letter
-		// is still at the beginning on windows
-		$windows_drive_letter = '';
-		if ($isAbsolutePath && \OC_Util::runningOnWindows() && preg_match('#^([a-zA-Z])$#', $path[0]) && $path[1] == ':' && $path[2] == '/') {
-			$windows_drive_letter = substr($path, 0, 2);
-			$path = substr($path, 2);
-		}
-
-		//add leading slash
-		if ($path[0] !== '/') {
-			$path = '/' . $path;
-		}
-
-		// remove '/./'
-		// ugly, but str_replace() can't replace them all in one go
-		// as the replacement itself is part of the search string
-		// which will only be found during the next iteration
-		while (strpos($path, '/./') !== false) {
-			$path = str_replace('/./', '/', $path);
-		}
-		// remove sequences of slashes
-		$path = preg_replace('#/{2,}#', '/', $path);
-
-		//remove trailing slash
-		if ($stripTrailingSlash and strlen($path) > 1 and substr($path, -1, 1) === '/') {
-			$path = substr($path, 0, -1);
-		}
-
-		// remove trailing '/.'
-		if (substr($path, -2) == '/.') {
-			$path = substr($path, 0, -2);
-		}
-
-		$normalizedPath = $windows_drive_letter . $path;
-		self::$normalizedPathCache[$cacheKey] = $normalizedPath;
-
-		return $normalizedPath;
-	}
-
-	/**
-	 * get the filesystem info
-	 *
-	 * @param string $path
-	 * @param boolean $includeMountPoints whether to add mountpoint sizes,
-	 * defaults to true
-	 * @return \OC\Files\FileInfo|bool False if file does not exist
-	 */
-	public static function getFileInfo($path, $includeMountPoints = true) {
-		return self::$defaultInstance->getFileInfo($path, $includeMountPoints);
-	}
-
-	/**
-	 * change file metadata
-	 *
-	 * @param string $path
-	 * @param array $data
-	 * @return int
-	 *
-	 * returns the fileid of the updated file
-	 */
-	public static function putFileInfo($path, $data) {
-		return self::$defaultInstance->putFileInfo($path, $data);
-	}
-
-	/**
-	 * get the content of a directory
-	 *
-	 * @param string $directory path under datadirectory
-	 * @param string $mimetype_filter limit returned content to this mimetype or mimepart
-	 * @return \OC\Files\FileInfo[]
-	 */
-	public static function getDirectoryContent($directory, $mimetype_filter = '') {
-		return self::$defaultInstance->getDirectoryContent($directory, $mimetype_filter);
-	}
-
-	/**
-	 * Get the path of a file by id
-	 *
-	 * Note that the resulting path is not guaranteed to be unique for the id, multiple paths can point to the same file
-	 *
-	 * @param int $id
-	 * @throws NotFoundException
-	 * @return string
-	 */
-	public static function getPath($id) {
-		return self::$defaultInstance->getPath($id);
-	}
-
-	/**
-	 * Get the owner for a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public static function getOwner($path) {
-		return self::$defaultInstance->getOwner($path);
-	}
-
-	/**
-	 * get the ETag for a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	static public function getETag($path) {
-		return self::$defaultInstance->getETag($path);
-	}
+    /**
+     * @var Mount\Manager $mounts
+     */
+    private static $mounts;
+
+    public static $loaded = false;
+    /**
+     * @var \OC\Files\View $defaultInstance
+     */
+    static private $defaultInstance;
+
+    static private $usersSetup = array();
+
+    static private $normalizedPathCache = null;
+
+    static private $listeningForProviders = false;
+
+    /**
+     * classname which used for hooks handling
+     * used as signalclass in OC_Hooks::emit()
+     */
+    const CLASSNAME = 'OC_Filesystem';
+
+    /**
+     * signalname emitted before file renaming
+     *
+     * @param string $oldpath
+     * @param string $newpath
+     */
+    const signal_rename = 'rename';
+
+    /**
+     * signal emitted after file renaming
+     *
+     * @param string $oldpath
+     * @param string $newpath
+     */
+    const signal_post_rename = 'post_rename';
+
+    /**
+     * signal emitted before file/dir creation
+     *
+     * @param string $path
+     * @param bool $run changing this flag to false in hook handler will cancel event
+     */
+    const signal_create = 'create';
+
+    /**
+     * signal emitted after file/dir creation
+     *
+     * @param string $path
+     * @param bool $run changing this flag to false in hook handler will cancel event
+     */
+    const signal_post_create = 'post_create';
+
+    /**
+     * signal emits before file/dir copy
+     *
+     * @param string $oldpath
+     * @param string $newpath
+     * @param bool $run changing this flag to false in hook handler will cancel event
+     */
+    const signal_copy = 'copy';
+
+    /**
+     * signal emits after file/dir copy
+     *
+     * @param string $oldpath
+     * @param string $newpath
+     */
+    const signal_post_copy = 'post_copy';
+
+    /**
+     * signal emits before file/dir save
+     *
+     * @param string $path
+     * @param bool $run changing this flag to false in hook handler will cancel event
+     */
+    const signal_write = 'write';
+
+    /**
+     * signal emits after file/dir save
+     *
+     * @param string $path
+     */
+    const signal_post_write = 'post_write';
+
+    /**
+     * signal emitted before file/dir update
+     *
+     * @param string $path
+     * @param bool $run changing this flag to false in hook handler will cancel event
+     */
+    const signal_update = 'update';
+
+    /**
+     * signal emitted after file/dir update
+     *
+     * @param string $path
+     * @param bool $run changing this flag to false in hook handler will cancel event
+     */
+    const signal_post_update = 'post_update';
+
+    /**
+     * signal emits when reading file/dir
+     *
+     * @param string $path
+     */
+    const signal_read = 'read';
+
+    /**
+     * signal emits when removing file/dir
+     *
+     * @param string $path
+     */
+    const signal_delete = 'delete';
+
+    /**
+     * parameters definitions for signals
+     */
+    const signal_param_path = 'path';
+    const signal_param_oldpath = 'oldpath';
+    const signal_param_newpath = 'newpath';
+
+    /**
+     * run - changing this flag to false in hook handler will cancel event
+     */
+    const signal_param_run = 'run';
+
+    const signal_create_mount = 'create_mount';
+    const signal_delete_mount = 'delete_mount';
+    const signal_param_mount_type = 'mounttype';
+    const signal_param_users = 'users';
+
+    /**
+     * @var \OC\Files\Storage\StorageFactory $loader
+     */
+    private static $loader;
+
+    /**
+     * @param string $wrapperName
+     * @param callable $wrapper
+     * @param int $priority
+     */
+    public static function addStorageWrapper($wrapperName, $wrapper, $priority = 50) {
+        $mounts = self::getMountManager()->getAll();
+        if (!self::getLoader()->addStorageWrapper($wrapperName, $wrapper, $priority, $mounts)) {
+            // do not re-wrap if storage with this name already existed
+            return;
+        }
+    }
+
+    /**
+     * Returns the storage factory
+     *
+     * @return \OCP\Files\Storage\IStorageFactory
+     */
+    public static function getLoader() {
+        if (!self::$loader) {
+            self::$loader = new StorageFactory();
+        }
+        return self::$loader;
+    }
+
+    /**
+     * Returns the mount manager
+     *
+     * @return \OC\Files\Mount\Manager
+     */
+    public static function getMountManager($user = '') {
+        if (!self::$mounts) {
+            \OC_Util::setupFS($user);
+        }
+        return self::$mounts;
+    }
+
+    /**
+     * get the mountpoint of the storage object for a path
+     * ( note: because a storage is not always mounted inside the fakeroot, the
+     * returned mountpoint is relative to the absolute root of the filesystem
+     * and doesn't take the chroot into account )
+     *
+     * @param string $path
+     * @return string
+     */
+    static public function getMountPoint($path) {
+        if (!self::$mounts) {
+            \OC_Util::setupFS();
+        }
+        $mount = self::$mounts->find($path);
+        if ($mount) {
+            return $mount->getMountPoint();
+        } else {
+            return '';
+        }
+    }
+
+    /**
+     * get a list of all mount points in a directory
+     *
+     * @param string $path
+     * @return string[]
+     */
+    static public function getMountPoints($path) {
+        if (!self::$mounts) {
+            \OC_Util::setupFS();
+        }
+        $result = array();
+        $mounts = self::$mounts->findIn($path);
+        foreach ($mounts as $mount) {
+            $result[] = $mount->getMountPoint();
+        }
+        return $result;
+    }
+
+    /**
+     * get the storage mounted at $mountPoint
+     *
+     * @param string $mountPoint
+     * @return \OC\Files\Storage\Storage
+     */
+    public static function getStorage($mountPoint) {
+        if (!self::$mounts) {
+            \OC_Util::setupFS();
+        }
+        $mount = self::$mounts->find($mountPoint);
+        return $mount->getStorage();
+    }
+
+    /**
+     * @param string $id
+     * @return Mount\MountPoint[]
+     */
+    public static function getMountByStorageId($id) {
+        if (!self::$mounts) {
+            \OC_Util::setupFS();
+        }
+        return self::$mounts->findByStorageId($id);
+    }
+
+    /**
+     * @param int $id
+     * @return Mount\MountPoint[]
+     */
+    public static function getMountByNumericId($id) {
+        if (!self::$mounts) {
+            \OC_Util::setupFS();
+        }
+        return self::$mounts->findByNumericId($id);
+    }
+
+    /**
+     * resolve a path to a storage and internal path
+     *
+     * @param string $path
+     * @return array an array consisting of the storage and the internal path
+     */
+    static public function resolvePath($path) {
+        if (!self::$mounts) {
+            \OC_Util::setupFS();
+        }
+        $mount = self::$mounts->find($path);
+        if ($mount) {
+            return array($mount->getStorage(), rtrim($mount->getInternalPath($path), '/'));
+        } else {
+            return array(null, null);
+        }
+    }
+
+    static public function init($user, $root) {
+        if (self::$defaultInstance) {
+            return false;
+        }
+        self::getLoader();
+        self::$defaultInstance = new View($root);
+
+        if (!self::$mounts) {
+            self::$mounts = \OC::$server->getMountManager();
+        }
+
+        //load custom mount config
+        self::initMountPoints($user);
+
+        self::$loaded = true;
+
+        return true;
+    }
+
+    static public function initMountManager() {
+        if (!self::$mounts) {
+            self::$mounts = \OC::$server->getMountManager();
+        }
+    }
+
+    /**
+     * Initialize system and personal mount points for a user
+     *
+     * @param string $user
+     * @throws \OC\User\NoUserException if the user is not available
+     */
+    public static function initMountPoints($user = '') {
+        if ($user == '') {
+            $user = \OC_User::getUser();
+        }
+        if ($user === null || $user === false || $user === '') {
+            throw new \OC\User\NoUserException('Attempted to initialize mount points for null user and no user in session');
+        }
+        if (isset(self::$usersSetup[$user])) {
+            return;
+        }
+        self::$usersSetup[$user] = true;
+
+        $root = \OC_User::getHome($user);
+
+        $userManager = \OC::$server->getUserManager();
+        $userObject = $userManager->get($user);
+
+        if (is_null($userObject)) {
+            \OCP\Util::writeLog('files', ' Backends provided no user object for ' . $user, \OCP\Util::ERROR);
+            throw new \OC\User\NoUserException('Backends provided no user object for ' . $user);
+        }
+
+        $homeStorage = \OC::$server->getConfig()->getSystemValue('objectstore');
+        if (!empty($homeStorage)) {
+            // sanity checks
+            if (empty($homeStorage['class'])) {
+                \OCP\Util::writeLog('files', 'No class given for objectstore', \OCP\Util::ERROR);
+            }
+            if (!isset($homeStorage['arguments'])) {
+                $homeStorage['arguments'] = array();
+            }
+            // instantiate object store implementation
+            $homeStorage['arguments']['objectstore'] = new $homeStorage['class']($homeStorage['arguments']);
+            // mount with home object store implementation
+            $homeStorage['class'] = '\OC\Files\ObjectStore\HomeObjectStoreStorage';
+        } else {
+            $homeStorage = array(
+                //default home storage configuration:
+                'class' => '\OC\Files\Storage\Home',
+                'arguments' => array()
+            );
+        }
+        $homeStorage['arguments']['user'] = $userObject;
+
+        // check for legacy home id (<= 5.0.12)
+        if (\OC\Files\Cache\Storage::exists('local::' . $root . '/')) {
+            $homeStorage['arguments']['legacy'] = true;
+        }
+
+        $mount = new MountPoint($homeStorage['class'], '/' . $user, $homeStorage['arguments'], self::getLoader());
+        self::getMountManager()->addMount($mount);
+
+        $home = \OC\Files\Filesystem::getStorage($user);
+
+        self::mountCacheDir($user);
+
+        // Chance to mount for other storages
+        /** @var \OC\Files\Config\MountProviderCollection $mountConfigManager */
+        $mountConfigManager = \OC::$server->getMountProviderCollection();
+        if ($userObject) {
+            $mounts = $mountConfigManager->getMountsForUser($userObject);
+            array_walk($mounts, array(self::$mounts, 'addMount'));
+            $mounts[] = $mount;
+            $mountConfigManager->registerMounts($userObject, $mounts);
+        }
+
+        self::listenForNewMountProviders($mountConfigManager, $userManager);
+        \OC_Hook::emit('OC_Filesystem', 'post_initMountPoints', array('user' => $user, 'user_dir' => $root));
+    }
+
+    /**
+     * Get mounts from mount providers that are registered after setup
+     *
+     * @param MountProviderCollection $mountConfigManager
+     * @param IUserManager $userManager
+     */
+    private static function listenForNewMountProviders(MountProviderCollection $mountConfigManager, IUserManager $userManager) {
+        if (!self::$listeningForProviders) {
+            self::$listeningForProviders = true;
+            $mountConfigManager->listen('\OC\Files\Config', 'registerMountProvider', function (IMountProvider $provider) use ($userManager) {
+                foreach (Filesystem::$usersSetup as $user => $setup) {
+                    $userObject = $userManager->get($user);
+                    if ($userObject) {
+                        $mounts = $provider->getMountsForUser($userObject, Filesystem::getLoader());
+                        array_walk($mounts, array(self::$mounts, 'addMount'));
+                    }
+                }
+            });
+        }
+    }
+
+    /**
+     * Mounts the cache directory
+     *
+     * @param string $user user name
+     */
+    private static function mountCacheDir($user) {
+        $cacheBaseDir = \OC::$server->getConfig()->getSystemValue('cache_path', '');
+        if ($cacheBaseDir !== '') {
+            $cacheDir = rtrim($cacheBaseDir, '/') . '/' . $user;
+            if (!file_exists($cacheDir)) {
+                mkdir($cacheDir, 0770, true);
+            }
+            // mount external cache dir to "/$user/cache" mount point
+            self::mount('\OC\Files\Storage\Local', array('datadir' => $cacheDir), '/' . $user . '/cache');
+        }
+    }
+
+    /**
+     * get the default filesystem view
+     *
+     * @return View
+     */
+    static public function getView() {
+        return self::$defaultInstance;
+    }
+
+    /**
+     * tear down the filesystem, removing all storage providers
+     */
+    static public function tearDown() {
+        self::clearMounts();
+        self::$defaultInstance = null;
+    }
+
+    /**
+     * get the relative path of the root data directory for the current user
+     *
+     * @return string
+     *
+     * Returns path like /admin/files
+     */
+    static public function getRoot() {
+        if (!self::$defaultInstance) {
+            return null;
+        }
+        return self::$defaultInstance->getRoot();
+    }
+
+    /**
+     * clear all mounts and storage backends
+     */
+    public static function clearMounts() {
+        if (self::$mounts) {
+            self::$usersSetup = array();
+            self::$mounts->clear();
+        }
+    }
+
+    /**
+     * mount an \OC\Files\Storage\Storage in our virtual filesystem
+     *
+     * @param \OC\Files\Storage\Storage|string $class
+     * @param array $arguments
+     * @param string $mountpoint
+     */
+    static public function mount($class, $arguments, $mountpoint) {
+        if (!self::$mounts) {
+            \OC_Util::setupFS();
+        }
+        $mount = new Mount\MountPoint($class, $mountpoint, $arguments, self::getLoader());
+        self::$mounts->addMount($mount);
+    }
+
+    /**
+     * return the path to a local version of the file
+     * we need this because we can't know if a file is stored local or not from
+     * outside the filestorage and for some purposes a local file is needed
+     *
+     * @param string $path
+     * @return string
+     */
+    static public function getLocalFile($path) {
+        return self::$defaultInstance->getLocalFile($path);
+    }
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    static public function getLocalFolder($path) {
+        return self::$defaultInstance->getLocalFolder($path);
+    }
+
+    /**
+     * return path to file which reflects one visible in browser
+     *
+     * @param string $path
+     * @return string
+     */
+    static public function getLocalPath($path) {
+        $datadir = \OC_User::getHome(\OC_User::getUser()) . '/files';
+        $newpath = $path;
+        if (strncmp($newpath, $datadir, strlen($datadir)) == 0) {
+            $newpath = substr($path, strlen($datadir));
+        }
+        return $newpath;
+    }
+
+    /**
+     * check if the requested path is valid
+     *
+     * @param string $path
+     * @return bool
+     */
+    static public function isValidPath($path) {
+        $path = self::normalizePath($path);
+        if (!$path || $path[0] !== '/') {
+            $path = '/' . $path;
+        }
+        if (strpos($path, '/../') !== false || strrchr($path, '/') === '/..') {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * checks if a file is blacklisted for storage in the filesystem
+     * Listens to write and rename hooks
+     *
+     * @param array $data from hook
+     */
+    static public function isBlacklisted($data) {
+        if (isset($data['path'])) {
+            $path = $data['path'];
+        } else if (isset($data['newpath'])) {
+            $path = $data['newpath'];
+        }
+        if (isset($path)) {
+            if (self::isFileBlacklisted($path)) {
+                $data['run'] = false;
+            }
+        }
+    }
+
+    /**
+     * @param string $filename
+     * @return bool
+     */
+    static public function isFileBlacklisted($filename) {
+        $filename = self::normalizePath($filename);
+
+        $blacklist = \OC::$server->getConfig()->getSystemValue('blacklisted_files', array('.htaccess'));
+        $filename = strtolower(basename($filename));
+        return in_array($filename, $blacklist);
+    }
+
+    /**
+     * check if the directory should be ignored when scanning
+     * NOTE: the special directories . and .. would cause never ending recursion
+     *
+     * @param String $dir
+     * @return boolean
+     */
+    static public function isIgnoredDir($dir) {
+        if ($dir === '.' || $dir === '..') {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * following functions are equivalent to their php builtin equivalents for arguments/return values.
+     */
+    static public function mkdir($path) {
+        return self::$defaultInstance->mkdir($path);
+    }
+
+    static public function rmdir($path) {
+        return self::$defaultInstance->rmdir($path);
+    }
+
+    static public function opendir($path) {
+        return self::$defaultInstance->opendir($path);
+    }
+
+    static public function readdir($path) {
+        return self::$defaultInstance->readdir($path);
+    }
+
+    static public function is_dir($path) {
+        return self::$defaultInstance->is_dir($path);
+    }
+
+    static public function is_file($path) {
+        return self::$defaultInstance->is_file($path);
+    }
+
+    static public function stat($path) {
+        return self::$defaultInstance->stat($path);
+    }
+
+    static public function filetype($path) {
+        return self::$defaultInstance->filetype($path);
+    }
+
+    static public function filesize($path) {
+        return self::$defaultInstance->filesize($path);
+    }
+
+    static public function readfile($path) {
+        return self::$defaultInstance->readfile($path);
+    }
+
+    static public function isCreatable($path) {
+        return self::$defaultInstance->isCreatable($path);
+    }
+
+    static public function isReadable($path) {
+        return self::$defaultInstance->isReadable($path);
+    }
+
+    static public function isUpdatable($path) {
+        return self::$defaultInstance->isUpdatable($path);
+    }
+
+    static public function isDeletable($path) {
+        return self::$defaultInstance->isDeletable($path);
+    }
+
+    static public function isSharable($path) {
+        return self::$defaultInstance->isSharable($path);
+    }
+
+    static public function file_exists($path) {
+        return self::$defaultInstance->file_exists($path);
+    }
+
+    static public function filemtime($path) {
+        return self::$defaultInstance->filemtime($path);
+    }
+
+    static public function touch($path, $mtime = null) {
+        return self::$defaultInstance->touch($path, $mtime);
+    }
+
+    /**
+     * @return string
+     */
+    static public function file_get_contents($path) {
+        return self::$defaultInstance->file_get_contents($path);
+    }
+
+    static public function file_put_contents($path, $data) {
+        return self::$defaultInstance->file_put_contents($path, $data);
+    }
+
+    static public function unlink($path) {
+        return self::$defaultInstance->unlink($path);
+    }
+
+    static public function rename($path1, $path2) {
+        return self::$defaultInstance->rename($path1, $path2);
+    }
+
+    static public function copy($path1, $path2) {
+        return self::$defaultInstance->copy($path1, $path2);
+    }
+
+    static public function fopen($path, $mode) {
+        return self::$defaultInstance->fopen($path, $mode);
+    }
+
+    /**
+     * @return string
+     */
+    static public function toTmpFile($path) {
+        return self::$defaultInstance->toTmpFile($path);
+    }
+
+    static public function fromTmpFile($tmpFile, $path) {
+        return self::$defaultInstance->fromTmpFile($tmpFile, $path);
+    }
+
+    static public function getMimeType($path) {
+        return self::$defaultInstance->getMimeType($path);
+    }
+
+    static public function hash($type, $path, $raw = false) {
+        return self::$defaultInstance->hash($type, $path, $raw);
+    }
+
+    static public function free_space($path = '/') {
+        return self::$defaultInstance->free_space($path);
+    }
+
+    static public function search($query) {
+        return self::$defaultInstance->search($query);
+    }
+
+    /**
+     * @param string $query
+     */
+    static public function searchByMime($query) {
+        return self::$defaultInstance->searchByMime($query);
+    }
+
+    /**
+     * @param string|int $tag name or tag id
+     * @param string $userId owner of the tags
+     * @return FileInfo[] array or file info
+     */
+    static public function searchByTag($tag, $userId) {
+        return self::$defaultInstance->searchByTag($tag, $userId);
+    }
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * @param string $path
+     * @param int $time
+     * @return bool
+     */
+    static public function hasUpdated($path, $time) {
+        return self::$defaultInstance->hasUpdated($path, $time);
+    }
+
+    /**
+     * Fix common problems with a file path
+     *
+     * @param string $path
+     * @param bool $stripTrailingSlash
+     * @param bool $isAbsolutePath
+     * @return string
+     */
+    public static function normalizePath($path, $stripTrailingSlash = true, $isAbsolutePath = false) {
+        if (is_null(self::$normalizedPathCache)) {
+            self::$normalizedPathCache = new CappedMemoryCache();
+        }
+
+        /**
+         * FIXME: This is a workaround for existing classes and files which call
+         *        this function with another type than a valid string. This
+         *        conversion should get removed as soon as all existing
+         *        function calls have been fixed.
+         */
+        $path = (string)$path;
+
+        $cacheKey = json_encode([$path, $stripTrailingSlash, $isAbsolutePath]);
+
+        if (isset(self::$normalizedPathCache[$cacheKey])) {
+            return self::$normalizedPathCache[$cacheKey];
+        }
+
+        if ($path == '') {
+            return '/';
+        }
+
+        //normalize unicode if possible
+        $path = \OC_Util::normalizeUnicode($path);
+
+        //no windows style slashes
+        $path = str_replace('\\', '/', $path);
+
+        // When normalizing an absolute path, we need to ensure that the drive-letter
+        // is still at the beginning on windows
+        $windows_drive_letter = '';
+        if ($isAbsolutePath && \OC_Util::runningOnWindows() && preg_match('#^([a-zA-Z])$#', $path[0]) && $path[1] == ':' && $path[2] == '/') {
+            $windows_drive_letter = substr($path, 0, 2);
+            $path = substr($path, 2);
+        }
+
+        //add leading slash
+        if ($path[0] !== '/') {
+            $path = '/' . $path;
+        }
+
+        // remove '/./'
+        // ugly, but str_replace() can't replace them all in one go
+        // as the replacement itself is part of the search string
+        // which will only be found during the next iteration
+        while (strpos($path, '/./') !== false) {
+            $path = str_replace('/./', '/', $path);
+        }
+        // remove sequences of slashes
+        $path = preg_replace('#/{2,}#', '/', $path);
+
+        //remove trailing slash
+        if ($stripTrailingSlash and strlen($path) > 1 and substr($path, -1, 1) === '/') {
+            $path = substr($path, 0, -1);
+        }
+
+        // remove trailing '/.'
+        if (substr($path, -2) == '/.') {
+            $path = substr($path, 0, -2);
+        }
+
+        $normalizedPath = $windows_drive_letter . $path;
+        self::$normalizedPathCache[$cacheKey] = $normalizedPath;
+
+        return $normalizedPath;
+    }
+
+    /**
+     * get the filesystem info
+     *
+     * @param string $path
+     * @param boolean $includeMountPoints whether to add mountpoint sizes,
+     * defaults to true
+     * @return \OC\Files\FileInfo|bool False if file does not exist
+     */
+    public static function getFileInfo($path, $includeMountPoints = true) {
+        return self::$defaultInstance->getFileInfo($path, $includeMountPoints);
+    }
+
+    /**
+     * change file metadata
+     *
+     * @param string $path
+     * @param array $data
+     * @return int
+     *
+     * returns the fileid of the updated file
+     */
+    public static function putFileInfo($path, $data) {
+        return self::$defaultInstance->putFileInfo($path, $data);
+    }
+
+    /**
+     * get the content of a directory
+     *
+     * @param string $directory path under datadirectory
+     * @param string $mimetype_filter limit returned content to this mimetype or mimepart
+     * @return \OC\Files\FileInfo[]
+     */
+    public static function getDirectoryContent($directory, $mimetype_filter = '') {
+        return self::$defaultInstance->getDirectoryContent($directory, $mimetype_filter);
+    }
+
+    /**
+     * Get the path of a file by id
+     *
+     * Note that the resulting path is not guaranteed to be unique for the id, multiple paths can point to the same file
+     *
+     * @param int $id
+     * @throws NotFoundException
+     * @return string
+     */
+    public static function getPath($id) {
+        return self::$defaultInstance->getPath($id);
+    }
+
+    /**
+     * Get the owner for a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    public static function getOwner($path) {
+        return self::$defaultInstance->getOwner($path);
+    }
+
+    /**
+     * get the ETag for a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    static public function getETag($path) {
+        return self::$defaultInstance->getETag($path);
+    }
 }

Spacing +12 added lines, -12 removed lines

@@ -388,8 +388,8 @@ 
 		$userObject = $userManager->get($user);
 
 		if (is_null($userObject)) {
-			\OCP\Util::writeLog('files', ' Backends provided no user object for ' . $user, \OCP\Util::ERROR);
-			throw new \OC\User\NoUserException('Backends provided no user object for ' . $user);
+			\OCP\Util::writeLog('files', ' Backends provided no user object for '.$user, \OCP\Util::ERROR);
+			throw new \OC\User\NoUserException('Backends provided no user object for '.$user);
 		}
 
 		$homeStorage = \OC::$server->getConfig()->getSystemValue('objectstore');
@@ -415,11 +415,11 @@ 
 		$homeStorage['arguments']['user'] = $userObject;
 
 		// check for legacy home id (<= 5.0.12)
-		if (\OC\Files\Cache\Storage::exists('local::' . $root . '/')) {
+		if (\OC\Files\Cache\Storage::exists('local::'.$root.'/')) {
 			$homeStorage['arguments']['legacy'] = true;
 		}
 
-		$mount = new MountPoint($homeStorage['class'], '/' . $user, $homeStorage['arguments'], self::getLoader());
+		$mount = new MountPoint($homeStorage['class'], '/'.$user, $homeStorage['arguments'], self::getLoader());
 		self::getMountManager()->addMount($mount);
 
 		$home = \OC\Files\Filesystem::getStorage($user);
@@ -449,7 +449,7 @@ 
 	private static function listenForNewMountProviders(MountProviderCollection $mountConfigManager, IUserManager $userManager) {
 		if (!self::$listeningForProviders) {
 			self::$listeningForProviders = true;
-			$mountConfigManager->listen('\OC\Files\Config', 'registerMountProvider', function (IMountProvider $provider) use ($userManager) {
+			$mountConfigManager->listen('\OC\Files\Config', 'registerMountProvider', function(IMountProvider $provider) use ($userManager) {
 				foreach (Filesystem::$usersSetup as $user => $setup) {
 					$userObject = $userManager->get($user);
 					if ($userObject) {
@@ -469,12 +469,12 @@ 
 	private static function mountCacheDir($user) {
 		$cacheBaseDir = \OC::$server->getConfig()->getSystemValue('cache_path', '');
 		if ($cacheBaseDir !== '') {
-			$cacheDir = rtrim($cacheBaseDir, '/') . '/' . $user;
+			$cacheDir = rtrim($cacheBaseDir, '/').'/'.$user;
 			if (!file_exists($cacheDir)) {
 				mkdir($cacheDir, 0770, true);
 			}
 			// mount external cache dir to "/$user/cache" mount point
-			self::mount('\OC\Files\Storage\Local', array('datadir' => $cacheDir), '/' . $user . '/cache');
+			self::mount('\OC\Files\Storage\Local', array('datadir' => $cacheDir), '/'.$user.'/cache');
 		}
 	}
 
@@ -561,7 +561,7 @@ 
 	 * @return string
 	 */
 	static public function getLocalPath($path) {
-		$datadir = \OC_User::getHome(\OC_User::getUser()) . '/files';
+		$datadir = \OC_User::getHome(\OC_User::getUser()).'/files';
 		$newpath = $path;
 		if (strncmp($newpath, $datadir, strlen($datadir)) == 0) {
 			$newpath = substr($path, strlen($datadir));
@@ -578,7 +578,7 @@ 
 	static public function isValidPath($path) {
 		$path = self::normalizePath($path);
 		if (!$path || $path[0] !== '/') {
-			$path = '/' . $path;
+			$path = '/'.$path;
 		}
 		if (strpos($path, '/../') !== false || strrchr($path, '/') === '/..') {
 			return false;
@@ -806,7 +806,7 @@ 
 		 *        conversion should get removed as soon as all existing
 		 *        function calls have been fixed.
 		 */
-		$path = (string)$path;
+		$path = (string) $path;
 
 		$cacheKey = json_encode([$path, $stripTrailingSlash, $isAbsolutePath]);
 
@@ -834,7 +834,7 @@ 
 
 		//add leading slash
 		if ($path[0] !== '/') {
-			$path = '/' . $path;
+			$path = '/'.$path;
 		}
 
 		// remove '/./'
@@ -857,7 +857,7 @@ 
 			$path = substr($path, 0, -2);
 		}
 
-		$normalizedPath = $windows_drive_letter . $path;
+		$normalizedPath = $windows_drive_letter.$path;
 		self::$normalizedPathCache[$cacheKey] = $normalizedPath;
 
 		return $normalizedPath;