nextcloud / server

lib/private/Setup/PostgreSQL.php

Indentation +131 added lines, -131 removed lines

@@ -34,135 +34,135 @@
 use OCP\IDBConnection;
 
 class PostgreSQL extends AbstractDatabase {
-	public $dbprettyname = 'PostgreSQL';
-
-	/**
-	 * @param string $username
-	 * @throws \OC\DatabaseSetupException
-	 */
-	public function setupDatabase($username) {
-		try {
-			$connection = $this->connect([
-				'dbname' => 'postgres'
-			]);
-			//check for roles creation rights in postgresql
-			$builder = $connection->getQueryBuilder();
-			$builder->automaticTablePrefix(false);
-			$query = $builder
-				->select('rolname')
-				->from('pg_roles')
-				->where($builder->expr()->eq('rolcreaterole', new Literal('TRUE')))
-				->andWhere($builder->expr()->eq('rolname', $builder->createNamedParameter($this->dbUser)));
-
-			try {
-				$result = $query->execute();
-				$canCreateRoles = $result->rowCount() > 0;
-			} catch (DatabaseException $e) {
-				$canCreateRoles = false;
-			}
-
-			if ($canCreateRoles) {
-				//use the admin login data for the new database user
-
-				//add prefix to the postgresql user name to prevent collisions
-				$this->dbUser = 'oc_' . strtolower($username);
-				//create a new password so we don't need to store the admin config in the config file
-				$this->dbPassword = \OC::$server->getSecureRandom()->generate(30, \OCP\Security\ISecureRandom::CHAR_LOWER . \OCP\Security\ISecureRandom::CHAR_DIGITS);
-
-				$this->createDBUser($connection);
-			}
-
-			$this->config->setValues([
-				'dbuser' => $this->dbUser,
-				'dbpassword' => $this->dbPassword,
-			]);
-
-			//create the database
-			$this->createDatabase($connection);
-			// the connection to dbname=postgres is not needed anymore
-			$connection->close();
-		} catch (\Exception $e) {
-			$this->logger->logException($e);
-			$this->logger->warning('Error trying to connect as "postgres", assuming database is setup and tables need to be created');
-			$this->config->setValues([
-				'dbuser' => $this->dbUser,
-				'dbpassword' => $this->dbPassword,
-			]);
-		}
-
-		// connect to the database (dbname=$this->dbname) and check if it needs to be filled
-		$this->dbUser = $this->config->getValue('dbuser');
-		$this->dbPassword = $this->config->getValue('dbpassword');
-		$connection = $this->connect();
-		try {
-			$connection->connect();
-		} catch (\Exception $e) {
-			$this->logger->logException($e);
-			throw new \OC\DatabaseSetupException($this->trans->t('PostgreSQL username and/or password not valid'),
-				$this->trans->t('You need to enter details of an existing account.'));
-		}
-	}
-
-	private function createDatabase(IDBConnection $connection) {
-		if (!$this->databaseExists($connection)) {
-			//The database does not exists... let's create it
-			$query = $connection->prepare("CREATE DATABASE " . addslashes($this->dbName) . " OWNER " . addslashes($this->dbUser));
-			try {
-				$query->execute();
-			} catch (DatabaseException $e) {
-				$this->logger->error('Error while trying to create database');
-				$this->logger->logException($e);
-			}
-		} else {
-			$query = $connection->prepare("REVOKE ALL PRIVILEGES ON DATABASE " . addslashes($this->dbName) . " FROM PUBLIC");
-			try {
-				$query->execute();
-			} catch (DatabaseException $e) {
-				$this->logger->error('Error while trying to restrict database permissions');
-				$this->logger->logException($e);
-			}
-		}
-	}
-
-	private function userExists(IDBConnection $connection) {
-		$builder = $connection->getQueryBuilder();
-		$builder->automaticTablePrefix(false);
-		$query = $builder->select('*')
-			->from('pg_roles')
-			->where($builder->expr()->eq('rolname', $builder->createNamedParameter($this->dbUser)));
-		$result = $query->execute();
-		return $result->rowCount() > 0;
-	}
-
-	private function databaseExists(IDBConnection $connection) {
-		$builder = $connection->getQueryBuilder();
-		$builder->automaticTablePrefix(false);
-		$query = $builder->select('datname')
-			->from('pg_database')
-			->where($builder->expr()->eq('datname', $builder->createNamedParameter($this->dbName)));
-		$result = $query->execute();
-		return $result->rowCount() > 0;
-	}
-
-	private function createDBUser(IDBConnection $connection) {
-		$dbUser = $this->dbUser;
-		try {
-			$i = 1;
-			while ($this->userExists($connection)) {
-				$i++;
-				$this->dbUser = $dbUser . $i;
-			}
-
-			// create the user
-			$query = $connection->prepare("CREATE USER " . addslashes($this->dbUser) . " CREATEDB PASSWORD '" . addslashes($this->dbPassword) . "'");
-			$query->execute();
-			if ($this->databaseExists($connection)) {
-				$query = $connection->prepare('GRANT CONNECT ON DATABASE ' . addslashes($this->dbName) . ' TO '.addslashes($this->dbUser));
-				$query->execute();
-			}
-		} catch (DatabaseException $e) {
-			$this->logger->error('Error while trying to create database user');
-			$this->logger->logException($e);
-		}
-	}
+    public $dbprettyname = 'PostgreSQL';
+
+    /**
+     * @param string $username
+     * @throws \OC\DatabaseSetupException
+     */
+    public function setupDatabase($username) {
+        try {
+            $connection = $this->connect([
+                'dbname' => 'postgres'
+            ]);
+            //check for roles creation rights in postgresql
+            $builder = $connection->getQueryBuilder();
+            $builder->automaticTablePrefix(false);
+            $query = $builder
+                ->select('rolname')
+                ->from('pg_roles')
+                ->where($builder->expr()->eq('rolcreaterole', new Literal('TRUE')))
+                ->andWhere($builder->expr()->eq('rolname', $builder->createNamedParameter($this->dbUser)));
+
+            try {
+                $result = $query->execute();
+                $canCreateRoles = $result->rowCount() > 0;
+            } catch (DatabaseException $e) {
+                $canCreateRoles = false;
+            }
+
+            if ($canCreateRoles) {
+                //use the admin login data for the new database user
+
+                //add prefix to the postgresql user name to prevent collisions
+                $this->dbUser = 'oc_' . strtolower($username);
+                //create a new password so we don't need to store the admin config in the config file
+                $this->dbPassword = \OC::$server->getSecureRandom()->generate(30, \OCP\Security\ISecureRandom::CHAR_LOWER . \OCP\Security\ISecureRandom::CHAR_DIGITS);
+
+                $this->createDBUser($connection);
+            }
+
+            $this->config->setValues([
+                'dbuser' => $this->dbUser,
+                'dbpassword' => $this->dbPassword,
+            ]);
+
+            //create the database
+            $this->createDatabase($connection);
+            // the connection to dbname=postgres is not needed anymore
+            $connection->close();
+        } catch (\Exception $e) {
+            $this->logger->logException($e);
+            $this->logger->warning('Error trying to connect as "postgres", assuming database is setup and tables need to be created');
+            $this->config->setValues([
+                'dbuser' => $this->dbUser,
+                'dbpassword' => $this->dbPassword,
+            ]);
+        }
+
+        // connect to the database (dbname=$this->dbname) and check if it needs to be filled
+        $this->dbUser = $this->config->getValue('dbuser');
+        $this->dbPassword = $this->config->getValue('dbpassword');
+        $connection = $this->connect();
+        try {
+            $connection->connect();
+        } catch (\Exception $e) {
+            $this->logger->logException($e);
+            throw new \OC\DatabaseSetupException($this->trans->t('PostgreSQL username and/or password not valid'),
+                $this->trans->t('You need to enter details of an existing account.'));
+        }
+    }
+
+    private function createDatabase(IDBConnection $connection) {
+        if (!$this->databaseExists($connection)) {
+            //The database does not exists... let's create it
+            $query = $connection->prepare("CREATE DATABASE " . addslashes($this->dbName) . " OWNER " . addslashes($this->dbUser));
+            try {
+                $query->execute();
+            } catch (DatabaseException $e) {
+                $this->logger->error('Error while trying to create database');
+                $this->logger->logException($e);
+            }
+        } else {
+            $query = $connection->prepare("REVOKE ALL PRIVILEGES ON DATABASE " . addslashes($this->dbName) . " FROM PUBLIC");
+            try {
+                $query->execute();
+            } catch (DatabaseException $e) {
+                $this->logger->error('Error while trying to restrict database permissions');
+                $this->logger->logException($e);
+            }
+        }
+    }
+
+    private function userExists(IDBConnection $connection) {
+        $builder = $connection->getQueryBuilder();
+        $builder->automaticTablePrefix(false);
+        $query = $builder->select('*')
+            ->from('pg_roles')
+            ->where($builder->expr()->eq('rolname', $builder->createNamedParameter($this->dbUser)));
+        $result = $query->execute();
+        return $result->rowCount() > 0;
+    }
+
+    private function databaseExists(IDBConnection $connection) {
+        $builder = $connection->getQueryBuilder();
+        $builder->automaticTablePrefix(false);
+        $query = $builder->select('datname')
+            ->from('pg_database')
+            ->where($builder->expr()->eq('datname', $builder->createNamedParameter($this->dbName)));
+        $result = $query->execute();
+        return $result->rowCount() > 0;
+    }
+
+    private function createDBUser(IDBConnection $connection) {
+        $dbUser = $this->dbUser;
+        try {
+            $i = 1;
+            while ($this->userExists($connection)) {
+                $i++;
+                $this->dbUser = $dbUser . $i;
+            }
+
+            // create the user
+            $query = $connection->prepare("CREATE USER " . addslashes($this->dbUser) . " CREATEDB PASSWORD '" . addslashes($this->dbPassword) . "'");
+            $query->execute();
+            if ($this->databaseExists($connection)) {
+                $query = $connection->prepare('GRANT CONNECT ON DATABASE ' . addslashes($this->dbName) . ' TO '.addslashes($this->dbUser));
+                $query->execute();
+            }
+        } catch (DatabaseException $e) {
+            $this->logger->error('Error while trying to create database user');
+            $this->logger->logException($e);
+        }
+    }
 }

lib/private/Comments/Manager.php

Indentation +1075 added lines, -1075 removed lines

@@ -43,1079 +43,1079 @@
 
 class Manager implements ICommentsManager {
 
-	/** @var  IDBConnection */
-	protected $dbConn;
-
-	/** @var  ILogger */
-	protected $logger;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var IComment[] */
-	protected $commentsCache = [];
-
-	/** @var  \Closure[] */
-	protected $eventHandlerClosures = [];
-
-	/** @var  ICommentsEventHandler[] */
-	protected $eventHandlers = [];
-
-	/** @var \Closure[] */
-	protected $displayNameResolvers = [];
-
-	/**
-	 * Manager constructor.
-	 *
-	 * @param IDBConnection $dbConn
-	 * @param ILogger $logger
-	 * @param IConfig $config
-	 */
-	public function __construct(
-		IDBConnection $dbConn,
-		ILogger $logger,
-		IConfig $config
-	) {
-		$this->dbConn = $dbConn;
-		$this->logger = $logger;
-		$this->config = $config;
-	}
-
-	/**
-	 * 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'] = (string)$data['id'];
-		$data['parent_id'] = (string)$data['parent_id'];
-		$data['topmost_parent_id'] = (string)$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'] = (int)$data['children_count'];
-		$data['reference_id'] = $data['reference_id'] ?? null;
-		return $data;
-	}
-
-
-	/**
-	 * @param array $data
-	 * @return IComment
-	 */
-	public function getCommentFromData(array $data): IComment {
-		return new Comment($this->normalizeDatabaseData($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();
-		}
-
-		return $this->determineTopmostParentId($comment->getParentId());
-	}
-
-	/**
-	 * 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->func()->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 = (int)$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[(string)$id] = $comment;
-	}
-
-	/**
-	 * removes an entry from the comments run time cache
-	 *
-	 * @param mixed $id the comment's id
-	 */
-	protected function uncache($id) {
-		$id = (string)$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 ((int)$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 = $this->getCommentFromData($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 = $this->getCommentFromData($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 = $this->getCommentFromData($data);
-			$this->cache($comment);
-			$comments[] = $comment;
-		}
-		$resultStatement->closeCursor();
-
-		return $comments;
-	}
-
-	/**
-	 * @param string $objectType the object type, e.g. 'files'
-	 * @param string $objectId the id of the object
-	 * @param int $lastKnownCommentId the last known comment (will be used as offset)
-	 * @param string $sortDirection direction of the comments (`asc` or `desc`)
-	 * @param int $limit optional, number of maximum comments to be returned. if
-	 * set to 0, all comments are returned.
-	 * @return IComment[]
-	 * @return array
-	 */
-	public function getForObjectSince(
-		string $objectType,
-		string $objectId,
-		int $lastKnownCommentId,
-		string $sortDirection = 'asc',
-		int $limit = 30
-	): array {
-		$comments = [];
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select('*')
-			->from('comments')
-			->where($query->expr()->eq('object_type', $query->createNamedParameter($objectType)))
-			->andWhere($query->expr()->eq('object_id', $query->createNamedParameter($objectId)))
-			->orderBy('creation_timestamp', $sortDirection === 'desc' ? 'DESC' : 'ASC')
-			->addOrderBy('id', $sortDirection === 'desc' ? 'DESC' : 'ASC');
-
-		if ($limit > 0) {
-			$query->setMaxResults($limit);
-		}
-
-		$lastKnownComment = $lastKnownCommentId > 0 ? $this->getLastKnownComment(
-			$objectType,
-			$objectId,
-			$lastKnownCommentId
-		) : null;
-		if ($lastKnownComment instanceof IComment) {
-			$lastKnownCommentDateTime = $lastKnownComment->getCreationDateTime();
-			if ($sortDirection === 'desc') {
-				$query->andWhere(
-					$query->expr()->orX(
-						$query->expr()->lt(
-							'creation_timestamp',
-							$query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATE),
-							IQueryBuilder::PARAM_DATE
-						),
-						$query->expr()->andX(
-							$query->expr()->eq(
-								'creation_timestamp',
-								$query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATE),
-								IQueryBuilder::PARAM_DATE
-							),
-							$query->expr()->lt('id', $query->createNamedParameter($lastKnownCommentId))
-						)
-					)
-				);
-			} else {
-				$query->andWhere(
-					$query->expr()->orX(
-						$query->expr()->gt(
-							'creation_timestamp',
-							$query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATE),
-							IQueryBuilder::PARAM_DATE
-						),
-						$query->expr()->andX(
-							$query->expr()->eq(
-								'creation_timestamp',
-								$query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATE),
-								IQueryBuilder::PARAM_DATE
-							),
-							$query->expr()->gt('id', $query->createNamedParameter($lastKnownCommentId))
-						)
-					)
-				);
-			}
-		}
-
-		$resultStatement = $query->execute();
-		while ($data = $resultStatement->fetch()) {
-			$comment = $this->getCommentFromData($data);
-			$this->cache($comment);
-			$comments[] = $comment;
-		}
-		$resultStatement->closeCursor();
-
-		return $comments;
-	}
-
-	/**
-	 * @param string $objectType the object type, e.g. 'files'
-	 * @param string $objectId the id of the object
-	 * @param int $id the comment to look for
-	 * @return Comment|null
-	 */
-	protected function getLastKnownComment(string $objectType,
-										   string $objectId,
-										   int $id) {
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select('*')
-			->from('comments')
-			->where($query->expr()->eq('object_type', $query->createNamedParameter($objectType)))
-			->andWhere($query->expr()->eq('object_id', $query->createNamedParameter($objectId)))
-			->andWhere($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
-
-		$result = $query->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		if ($row) {
-			$comment = $this->getCommentFromData($row);
-			$this->cache($comment);
-			return $comment;
-		}
-
-		return null;
-	}
-
-	/**
-	 * Search for comments with a given content
-	 *
-	 * @param string $search content to search for
-	 * @param string $objectType Limit the search by object type
-	 * @param string $objectId Limit the search by object id
-	 * @param string $verb Limit the verb of the comment
-	 * @param int $offset
-	 * @param int $limit
-	 * @return IComment[]
-	 */
-	public function search(string $search, string $objectType, string $objectId, string $verb, int $offset, int $limit = 50): array {
-		$query = $this->dbConn->getQueryBuilder();
-
-		$query->select('*')
-			->from('comments')
-			->where($query->expr()->iLike('message', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search). '%'
-			)))
-			->orderBy('creation_timestamp', 'DESC')
-			->addOrderBy('id', 'DESC')
-			->setMaxResults($limit);
-
-		if ($objectType !== '') {
-			$query->andWhere($query->expr()->eq('object_type', $query->createNamedParameter($objectType)));
-		}
-		if ($objectId !== '') {
-			$query->andWhere($query->expr()->eq('object_id', $query->createNamedParameter($objectId)));
-		}
-		if ($verb !== '') {
-			$query->andWhere($query->expr()->eq('verb', $query->createNamedParameter($verb)));
-		}
-		if ($offset !== 0) {
-			$query->setFirstResult($offset);
-		}
-
-		$comments = [];
-		$result = $query->execute();
-		while ($data = $result->fetch()) {
-			$comment = $this->getCommentFromData($data);
-			$this->cache($comment);
-			$comments[] = $comment;
-		}
-		$result->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
-	 * @param string $verb Limit the verb of the comment - Added in 14.0.0
-	 * @return Int
-	 * @since 9.0.0
-	 */
-	public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null, $verb = '') {
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select($qb->func()->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');
-		}
-
-		if ($verb !== '') {
-			$query->andWhere($qb->expr()->eq('verb', $qb->createNamedParameter($verb)));
-		}
-
-		$resultStatement = $query->execute();
-		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
-		$resultStatement->closeCursor();
-		return (int)$data[0];
-	}
-
-	/**
-	 * Get the number of unread comments for all files in a folder
-	 *
-	 * @param int $folderId
-	 * @param IUser $user
-	 * @return array [$fileId => $unreadCount]
-	 */
-	public function getNumberOfUnreadCommentsForFolder($folderId, IUser $user) {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$query = $qb->select('f.fileid')
-			->addSelect($qb->func()->count('c.id', 'num_ids'))
-			->from('filecache', 'f')
-			->leftJoin('f', 'comments', 'c', $qb->expr()->andX(
-				$qb->expr()->eq('f.fileid', $qb->expr()->castColumn('c.object_id', IQueryBuilder::PARAM_INT)),
-				$qb->expr()->eq('c.object_type', $qb->createNamedParameter('files'))
-			))
-			->leftJoin('c', 'comments_read_markers', 'm', $qb->expr()->andX(
-				$qb->expr()->eq('c.object_id', 'm.object_id'),
-				$qb->expr()->eq('m.object_type', $qb->createNamedParameter('files'))
-			))
-			->where(
-				$qb->expr()->andX(
-					$qb->expr()->eq('f.parent', $qb->createNamedParameter($folderId)),
-					$qb->expr()->orX(
-						$qb->expr()->eq('c.object_type', $qb->createNamedParameter('files')),
-						$qb->expr()->isNull('c.object_type')
-					),
-					$qb->expr()->orX(
-						$qb->expr()->eq('m.object_type', $qb->createNamedParameter('files')),
-						$qb->expr()->isNull('m.object_type')
-					),
-					$qb->expr()->orX(
-						$qb->expr()->eq('m.user_id', $qb->createNamedParameter($user->getUID())),
-						$qb->expr()->isNull('m.user_id')
-					),
-					$qb->expr()->orX(
-						$qb->expr()->gt('c.creation_timestamp', 'm.marker_datetime'),
-						$qb->expr()->isNull('m.marker_datetime')
-					)
-				)
-			)->groupBy('f.fileid');
-
-		$resultStatement = $query->execute();
-
-		$results = [];
-		while ($row = $resultStatement->fetch()) {
-			$results[$row['fileid']] = (int) $row['num_ids'];
-		}
-		$resultStatement->closeCursor();
-		return $results;
-	}
-
-	/**
-	 * 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->sendEvent(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): bool {
-		try {
-			$result = $this->insertQuery($comment, true);
-		} catch (InvalidFieldNameException $e) {
-			// The reference id field was only added in Nextcloud 19.
-			// In order to not cause too long waiting times on the update,
-			// it was decided to only add it lazy, as it is also not a critical
-			// feature, but only helps to have a better experience while commenting.
-			// So in case the reference_id field is missing,
-			// we simply save the comment without that field.
-			$result = $this->insertQuery($comment, false);
-		}
-
-		return $result;
-	}
-
-	protected function insertQuery(IComment $comment, bool $tryWritingReferenceId): bool {
-		$qb = $this->dbConn->getQueryBuilder();
-
-		$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()),
-		];
-
-		if ($tryWritingReferenceId) {
-			$values['reference_id'] = $qb->createNamedParameter($comment->getReferenceId());
-		}
-
-		$affectedRows = $qb->insert('comments')
-			->values($values)
-			->execute();
-
-		if ($affectedRows > 0) {
-			$comment->setId((string)$qb->getLastInsertId());
-			$this->sendEvent(CommentsEvent::EVENT_ADD, $comment);
-		}
-
-		return $affectedRows > 0;
-	}
-
-	/**
-	 * updates a Comment data row
-	 *
-	 * @param IComment $comment
-	 * @return bool
-	 * @throws NotFoundException
-	 */
-	protected function update(IComment $comment) {
-		// for properly working preUpdate Events we need the old comments as is
-		// in the DB and overcome caching. Also avoid that outdated information stays.
-		$this->uncache($comment->getId());
-		$this->sendEvent(CommentsEvent::EVENT_PRE_UPDATE, $this->get($comment->getId()));
-		$this->uncache($comment->getId());
-
-		try {
-			$result = $this->updateQuery($comment, true);
-		} catch (InvalidFieldNameException $e) {
-			// See function insert() for explanation
-			$result = $this->updateQuery($comment, false);
-		}
-
-		$this->sendEvent(CommentsEvent::EVENT_UPDATE, $comment);
-
-		return $result;
-	}
-
-	protected function updateQuery(IComment $comment, bool $tryWritingReferenceId): bool {
-		$qb = $this->dbConn->getQueryBuilder();
-		$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()));
-
-		if ($tryWritingReferenceId) {
-			$qb->set('reference_id', $qb->createNamedParameter($comment->getReferenceId()));
-		}
-
-		$affectedRows = $qb->where($qb->expr()->eq('id', $qb->createNamedParameter($comment->getId())))
-			->execute();
-
-		if ($affectedRows === 0) {
-			throw new NotFoundException('Comment to update does ceased to exist');
-		}
-
-		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);
-	}
-
-	/**
-	 * registers an Entity to the manager, so event notifications can be send
-	 * to consumers of the comments infrastructure
-	 *
-	 * @param \Closure $closure
-	 */
-	public function registerEventHandler(\Closure $closure) {
-		$this->eventHandlerClosures[] = $closure;
-		$this->eventHandlers = [];
-	}
-
-	/**
-	 * registers a method that resolves an ID to a display name for a given type
-	 *
-	 * @param string $type
-	 * @param \Closure $closure
-	 * @throws \OutOfBoundsException
-	 * @since 11.0.0
-	 *
-	 * Only one resolver shall be registered per type. Otherwise a
-	 * \OutOfBoundsException has to thrown.
-	 */
-	public function registerDisplayNameResolver($type, \Closure $closure) {
-		if (!is_string($type)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		if (isset($this->displayNameResolvers[$type])) {
-			throw new \OutOfBoundsException('Displayname resolver for this type already registered');
-		}
-		$this->displayNameResolvers[$type] = $closure;
-	}
-
-	/**
-	 * resolves a given ID of a given Type to a display name.
-	 *
-	 * @param string $type
-	 * @param string $id
-	 * @return string
-	 * @throws \OutOfBoundsException
-	 * @since 11.0.0
-	 *
-	 * If a provided type was not registered, an \OutOfBoundsException shall
-	 * be thrown. It is upon the resolver discretion what to return of the
-	 * provided ID is unknown. It must be ensured that a string is returned.
-	 */
-	public function resolveDisplayName($type, $id) {
-		if (!is_string($type)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		if (!isset($this->displayNameResolvers[$type])) {
-			throw new \OutOfBoundsException('No Displayname resolver for this type registered');
-		}
-		return (string)$this->displayNameResolvers[$type]($id);
-	}
-
-	/**
-	 * returns valid, registered entities
-	 *
-	 * @return \OCP\Comments\ICommentsEventHandler[]
-	 */
-	private function getEventHandlers() {
-		if (!empty($this->eventHandlers)) {
-			return $this->eventHandlers;
-		}
-
-		$this->eventHandlers = [];
-		foreach ($this->eventHandlerClosures as $name => $closure) {
-			$entity = $closure();
-			if (!($entity instanceof ICommentsEventHandler)) {
-				throw new \InvalidArgumentException('The given entity does not implement the ICommentsEntity interface');
-			}
-			$this->eventHandlers[$name] = $entity;
-		}
-
-		return $this->eventHandlers;
-	}
-
-	/**
-	 * sends notifications to the registered entities
-	 *
-	 * @param $eventType
-	 * @param IComment $comment
-	 */
-	private function sendEvent($eventType, IComment $comment) {
-		$entities = $this->getEventHandlers();
-		$event = new CommentsEvent($eventType, $comment);
-		foreach ($entities as $entity) {
-			$entity->handle($event);
-		}
-	}
+    /** @var  IDBConnection */
+    protected $dbConn;
+
+    /** @var  ILogger */
+    protected $logger;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var IComment[] */
+    protected $commentsCache = [];
+
+    /** @var  \Closure[] */
+    protected $eventHandlerClosures = [];
+
+    /** @var  ICommentsEventHandler[] */
+    protected $eventHandlers = [];
+
+    /** @var \Closure[] */
+    protected $displayNameResolvers = [];
+
+    /**
+     * Manager constructor.
+     *
+     * @param IDBConnection $dbConn
+     * @param ILogger $logger
+     * @param IConfig $config
+     */
+    public function __construct(
+        IDBConnection $dbConn,
+        ILogger $logger,
+        IConfig $config
+    ) {
+        $this->dbConn = $dbConn;
+        $this->logger = $logger;
+        $this->config = $config;
+    }
+
+    /**
+     * 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'] = (string)$data['id'];
+        $data['parent_id'] = (string)$data['parent_id'];
+        $data['topmost_parent_id'] = (string)$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'] = (int)$data['children_count'];
+        $data['reference_id'] = $data['reference_id'] ?? null;
+        return $data;
+    }
+
+
+    /**
+     * @param array $data
+     * @return IComment
+     */
+    public function getCommentFromData(array $data): IComment {
+        return new Comment($this->normalizeDatabaseData($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();
+        }
+
+        return $this->determineTopmostParentId($comment->getParentId());
+    }
+
+    /**
+     * 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->func()->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 = (int)$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[(string)$id] = $comment;
+    }
+
+    /**
+     * removes an entry from the comments run time cache
+     *
+     * @param mixed $id the comment's id
+     */
+    protected function uncache($id) {
+        $id = (string)$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 ((int)$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 = $this->getCommentFromData($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 = $this->getCommentFromData($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 = $this->getCommentFromData($data);
+            $this->cache($comment);
+            $comments[] = $comment;
+        }
+        $resultStatement->closeCursor();
+
+        return $comments;
+    }
+
+    /**
+     * @param string $objectType the object type, e.g. 'files'
+     * @param string $objectId the id of the object
+     * @param int $lastKnownCommentId the last known comment (will be used as offset)
+     * @param string $sortDirection direction of the comments (`asc` or `desc`)
+     * @param int $limit optional, number of maximum comments to be returned. if
+     * set to 0, all comments are returned.
+     * @return IComment[]
+     * @return array
+     */
+    public function getForObjectSince(
+        string $objectType,
+        string $objectId,
+        int $lastKnownCommentId,
+        string $sortDirection = 'asc',
+        int $limit = 30
+    ): array {
+        $comments = [];
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select('*')
+            ->from('comments')
+            ->where($query->expr()->eq('object_type', $query->createNamedParameter($objectType)))
+            ->andWhere($query->expr()->eq('object_id', $query->createNamedParameter($objectId)))
+            ->orderBy('creation_timestamp', $sortDirection === 'desc' ? 'DESC' : 'ASC')
+            ->addOrderBy('id', $sortDirection === 'desc' ? 'DESC' : 'ASC');
+
+        if ($limit > 0) {
+            $query->setMaxResults($limit);
+        }
+
+        $lastKnownComment = $lastKnownCommentId > 0 ? $this->getLastKnownComment(
+            $objectType,
+            $objectId,
+            $lastKnownCommentId
+        ) : null;
+        if ($lastKnownComment instanceof IComment) {
+            $lastKnownCommentDateTime = $lastKnownComment->getCreationDateTime();
+            if ($sortDirection === 'desc') {
+                $query->andWhere(
+                    $query->expr()->orX(
+                        $query->expr()->lt(
+                            'creation_timestamp',
+                            $query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATE),
+                            IQueryBuilder::PARAM_DATE
+                        ),
+                        $query->expr()->andX(
+                            $query->expr()->eq(
+                                'creation_timestamp',
+                                $query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATE),
+                                IQueryBuilder::PARAM_DATE
+                            ),
+                            $query->expr()->lt('id', $query->createNamedParameter($lastKnownCommentId))
+                        )
+                    )
+                );
+            } else {
+                $query->andWhere(
+                    $query->expr()->orX(
+                        $query->expr()->gt(
+                            'creation_timestamp',
+                            $query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATE),
+                            IQueryBuilder::PARAM_DATE
+                        ),
+                        $query->expr()->andX(
+                            $query->expr()->eq(
+                                'creation_timestamp',
+                                $query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATE),
+                                IQueryBuilder::PARAM_DATE
+                            ),
+                            $query->expr()->gt('id', $query->createNamedParameter($lastKnownCommentId))
+                        )
+                    )
+                );
+            }
+        }
+
+        $resultStatement = $query->execute();
+        while ($data = $resultStatement->fetch()) {
+            $comment = $this->getCommentFromData($data);
+            $this->cache($comment);
+            $comments[] = $comment;
+        }
+        $resultStatement->closeCursor();
+
+        return $comments;
+    }
+
+    /**
+     * @param string $objectType the object type, e.g. 'files'
+     * @param string $objectId the id of the object
+     * @param int $id the comment to look for
+     * @return Comment|null
+     */
+    protected function getLastKnownComment(string $objectType,
+                                            string $objectId,
+                                            int $id) {
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select('*')
+            ->from('comments')
+            ->where($query->expr()->eq('object_type', $query->createNamedParameter($objectType)))
+            ->andWhere($query->expr()->eq('object_id', $query->createNamedParameter($objectId)))
+            ->andWhere($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
+
+        $result = $query->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        if ($row) {
+            $comment = $this->getCommentFromData($row);
+            $this->cache($comment);
+            return $comment;
+        }
+
+        return null;
+    }
+
+    /**
+     * Search for comments with a given content
+     *
+     * @param string $search content to search for
+     * @param string $objectType Limit the search by object type
+     * @param string $objectId Limit the search by object id
+     * @param string $verb Limit the verb of the comment
+     * @param int $offset
+     * @param int $limit
+     * @return IComment[]
+     */
+    public function search(string $search, string $objectType, string $objectId, string $verb, int $offset, int $limit = 50): array {
+        $query = $this->dbConn->getQueryBuilder();
+
+        $query->select('*')
+            ->from('comments')
+            ->where($query->expr()->iLike('message', $query->createNamedParameter(
+                '%' . $this->dbConn->escapeLikeParameter($search). '%'
+            )))
+            ->orderBy('creation_timestamp', 'DESC')
+            ->addOrderBy('id', 'DESC')
+            ->setMaxResults($limit);
+
+        if ($objectType !== '') {
+            $query->andWhere($query->expr()->eq('object_type', $query->createNamedParameter($objectType)));
+        }
+        if ($objectId !== '') {
+            $query->andWhere($query->expr()->eq('object_id', $query->createNamedParameter($objectId)));
+        }
+        if ($verb !== '') {
+            $query->andWhere($query->expr()->eq('verb', $query->createNamedParameter($verb)));
+        }
+        if ($offset !== 0) {
+            $query->setFirstResult($offset);
+        }
+
+        $comments = [];
+        $result = $query->execute();
+        while ($data = $result->fetch()) {
+            $comment = $this->getCommentFromData($data);
+            $this->cache($comment);
+            $comments[] = $comment;
+        }
+        $result->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
+     * @param string $verb Limit the verb of the comment - Added in 14.0.0
+     * @return Int
+     * @since 9.0.0
+     */
+    public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null, $verb = '') {
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select($qb->func()->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');
+        }
+
+        if ($verb !== '') {
+            $query->andWhere($qb->expr()->eq('verb', $qb->createNamedParameter($verb)));
+        }
+
+        $resultStatement = $query->execute();
+        $data = $resultStatement->fetch(\PDO::FETCH_NUM);
+        $resultStatement->closeCursor();
+        return (int)$data[0];
+    }
+
+    /**
+     * Get the number of unread comments for all files in a folder
+     *
+     * @param int $folderId
+     * @param IUser $user
+     * @return array [$fileId => $unreadCount]
+     */
+    public function getNumberOfUnreadCommentsForFolder($folderId, IUser $user) {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $query = $qb->select('f.fileid')
+            ->addSelect($qb->func()->count('c.id', 'num_ids'))
+            ->from('filecache', 'f')
+            ->leftJoin('f', 'comments', 'c', $qb->expr()->andX(
+                $qb->expr()->eq('f.fileid', $qb->expr()->castColumn('c.object_id', IQueryBuilder::PARAM_INT)),
+                $qb->expr()->eq('c.object_type', $qb->createNamedParameter('files'))
+            ))
+            ->leftJoin('c', 'comments_read_markers', 'm', $qb->expr()->andX(
+                $qb->expr()->eq('c.object_id', 'm.object_id'),
+                $qb->expr()->eq('m.object_type', $qb->createNamedParameter('files'))
+            ))
+            ->where(
+                $qb->expr()->andX(
+                    $qb->expr()->eq('f.parent', $qb->createNamedParameter($folderId)),
+                    $qb->expr()->orX(
+                        $qb->expr()->eq('c.object_type', $qb->createNamedParameter('files')),
+                        $qb->expr()->isNull('c.object_type')
+                    ),
+                    $qb->expr()->orX(
+                        $qb->expr()->eq('m.object_type', $qb->createNamedParameter('files')),
+                        $qb->expr()->isNull('m.object_type')
+                    ),
+                    $qb->expr()->orX(
+                        $qb->expr()->eq('m.user_id', $qb->createNamedParameter($user->getUID())),
+                        $qb->expr()->isNull('m.user_id')
+                    ),
+                    $qb->expr()->orX(
+                        $qb->expr()->gt('c.creation_timestamp', 'm.marker_datetime'),
+                        $qb->expr()->isNull('m.marker_datetime')
+                    )
+                )
+            )->groupBy('f.fileid');
+
+        $resultStatement = $query->execute();
+
+        $results = [];
+        while ($row = $resultStatement->fetch()) {
+            $results[$row['fileid']] = (int) $row['num_ids'];
+        }
+        $resultStatement->closeCursor();
+        return $results;
+    }
+
+    /**
+     * 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->sendEvent(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): bool {
+        try {
+            $result = $this->insertQuery($comment, true);
+        } catch (InvalidFieldNameException $e) {
+            // The reference id field was only added in Nextcloud 19.
+            // In order to not cause too long waiting times on the update,
+            // it was decided to only add it lazy, as it is also not a critical
+            // feature, but only helps to have a better experience while commenting.
+            // So in case the reference_id field is missing,
+            // we simply save the comment without that field.
+            $result = $this->insertQuery($comment, false);
+        }
+
+        return $result;
+    }
+
+    protected function insertQuery(IComment $comment, bool $tryWritingReferenceId): bool {
+        $qb = $this->dbConn->getQueryBuilder();
+
+        $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()),
+        ];
+
+        if ($tryWritingReferenceId) {
+            $values['reference_id'] = $qb->createNamedParameter($comment->getReferenceId());
+        }
+
+        $affectedRows = $qb->insert('comments')
+            ->values($values)
+            ->execute();
+
+        if ($affectedRows > 0) {
+            $comment->setId((string)$qb->getLastInsertId());
+            $this->sendEvent(CommentsEvent::EVENT_ADD, $comment);
+        }
+
+        return $affectedRows > 0;
+    }
+
+    /**
+     * updates a Comment data row
+     *
+     * @param IComment $comment
+     * @return bool
+     * @throws NotFoundException
+     */
+    protected function update(IComment $comment) {
+        // for properly working preUpdate Events we need the old comments as is
+        // in the DB and overcome caching. Also avoid that outdated information stays.
+        $this->uncache($comment->getId());
+        $this->sendEvent(CommentsEvent::EVENT_PRE_UPDATE, $this->get($comment->getId()));
+        $this->uncache($comment->getId());
+
+        try {
+            $result = $this->updateQuery($comment, true);
+        } catch (InvalidFieldNameException $e) {
+            // See function insert() for explanation
+            $result = $this->updateQuery($comment, false);
+        }
+
+        $this->sendEvent(CommentsEvent::EVENT_UPDATE, $comment);
+
+        return $result;
+    }
+
+    protected function updateQuery(IComment $comment, bool $tryWritingReferenceId): bool {
+        $qb = $this->dbConn->getQueryBuilder();
+        $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()));
+
+        if ($tryWritingReferenceId) {
+            $qb->set('reference_id', $qb->createNamedParameter($comment->getReferenceId()));
+        }
+
+        $affectedRows = $qb->where($qb->expr()->eq('id', $qb->createNamedParameter($comment->getId())))
+            ->execute();
+
+        if ($affectedRows === 0) {
+            throw new NotFoundException('Comment to update does ceased to exist');
+        }
+
+        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);
+    }
+
+    /**
+     * registers an Entity to the manager, so event notifications can be send
+     * to consumers of the comments infrastructure
+     *
+     * @param \Closure $closure
+     */
+    public function registerEventHandler(\Closure $closure) {
+        $this->eventHandlerClosures[] = $closure;
+        $this->eventHandlers = [];
+    }
+
+    /**
+     * registers a method that resolves an ID to a display name for a given type
+     *
+     * @param string $type
+     * @param \Closure $closure
+     * @throws \OutOfBoundsException
+     * @since 11.0.0
+     *
+     * Only one resolver shall be registered per type. Otherwise a
+     * \OutOfBoundsException has to thrown.
+     */
+    public function registerDisplayNameResolver($type, \Closure $closure) {
+        if (!is_string($type)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        if (isset($this->displayNameResolvers[$type])) {
+            throw new \OutOfBoundsException('Displayname resolver for this type already registered');
+        }
+        $this->displayNameResolvers[$type] = $closure;
+    }
+
+    /**
+     * resolves a given ID of a given Type to a display name.
+     *
+     * @param string $type
+     * @param string $id
+     * @return string
+     * @throws \OutOfBoundsException
+     * @since 11.0.0
+     *
+     * If a provided type was not registered, an \OutOfBoundsException shall
+     * be thrown. It is upon the resolver discretion what to return of the
+     * provided ID is unknown. It must be ensured that a string is returned.
+     */
+    public function resolveDisplayName($type, $id) {
+        if (!is_string($type)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        if (!isset($this->displayNameResolvers[$type])) {
+            throw new \OutOfBoundsException('No Displayname resolver for this type registered');
+        }
+        return (string)$this->displayNameResolvers[$type]($id);
+    }
+
+    /**
+     * returns valid, registered entities
+     *
+     * @return \OCP\Comments\ICommentsEventHandler[]
+     */
+    private function getEventHandlers() {
+        if (!empty($this->eventHandlers)) {
+            return $this->eventHandlers;
+        }
+
+        $this->eventHandlers = [];
+        foreach ($this->eventHandlerClosures as $name => $closure) {
+            $entity = $closure();
+            if (!($entity instanceof ICommentsEventHandler)) {
+                throw new \InvalidArgumentException('The given entity does not implement the ICommentsEntity interface');
+            }
+            $this->eventHandlers[$name] = $entity;
+        }
+
+        return $this->eventHandlers;
+    }
+
+    /**
+     * sends notifications to the registered entities
+     *
+     * @param $eventType
+     * @param IComment $comment
+     */
+    private function sendEvent($eventType, IComment $comment) {
+        $entities = $this->getEventHandlers();
+        $event = new CommentsEvent($eventType, $comment);
+        foreach ($entities as $entity) {
+            $entity->handle($event);
+        }
+    }
 }

lib/private/Files/Config/UserMountCache.php

Indentation +367 added lines, -367 removed lines

@@ -47,371 +47,371 @@
  * 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) {
-			// filter out any storages which aren't scanned yet since we aren't interested in files from those storages (yet)
-			if ($mount->getStorageRootId() === -1) {
-				return null;
-			} else {
-				return new LazyStorageMountInfo($user, $mount);
-			}
-		}, $mounts);
-		$newMounts = array_values(array_filter($newMounts));
-		$newMountRootIds = array_map(function (ICachedMountInfo $mount) {
-			return $mount->getRootId();
-		}, $newMounts);
-		$newMounts = array_combine($newMountRootIds, $newMounts);
-
-		$cachedMounts = $this->getMountsForUser($user);
-		$cachedMountRootIds = array_map(function (ICachedMountInfo $mount) {
-			return $mount->getRootId();
-		}, $cachedMounts);
-		$cachedMounts = array_combine($cachedMountRootIds, $cachedMounts);
-
-		$addedMounts = [];
-		$removedMounts = [];
-
-		foreach ($newMounts as $rootId => $newMount) {
-			if (!isset($cachedMounts[$rootId])) {
-				$addedMounts[] = $newMount;
-			}
-		}
-
-		foreach ($cachedMounts as $rootId => $cachedMount) {
-			if (!isset($newMounts[$rootId])) {
-				$removedMounts[] = $cachedMount;
-			}
-		}
-
-		$changedMounts = $this->findChangedMounts($newMounts, $cachedMounts);
-
-		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->updateCachedMount($mount);
-		}
-	}
-
-	/**
-	 * @param ICachedMountInfo[] $newMounts
-	 * @param ICachedMountInfo[] $cachedMounts
-	 * @return ICachedMountInfo[]
-	 */
-	private function findChangedMounts(array $newMounts, array $cachedMounts) {
-		$new = [];
-		foreach ($newMounts as $mount) {
-			$new[$mount->getRootId()] = $mount;
-		}
-		$changed = [];
-		foreach ($cachedMounts as $cachedMount) {
-			$rootId = $cachedMount->getRootId();
-			if (isset($new[$rootId])) {
-				$newMount = $new[$rootId];
-				if (
-					$newMount->getMountPoint() !== $cachedMount->getMountPoint() ||
-					$newMount->getStorageId() !== $cachedMount->getStorageId() ||
-					$newMount->getMountId() !== $cachedMount->getMountId()
-				) {
-					$changed[] = $newMount;
-				}
-			}
-		}
-		return $changed;
-	}
-
-	private function addToCache(ICachedMountInfo $mount) {
-		if ($mount->getStorageId() !== -1) {
-			$this->connection->insertIfNotExist('*PREFIX*mounts', [
-				'storage_id' => $mount->getStorageId(),
-				'root_id' => $mount->getRootId(),
-				'user_id' => $mount->getUser()->getUID(),
-				'mount_point' => $mount->getMountPoint(),
-				'mount_id' => $mount->getMountId()
-			], ['root_id', 'user_id']);
-		} else {
-			// in some cases this is legitimate, like orphaned shares
-			$this->logger->debug('Could not get storage info for mount at ' . $mount->getMountPoint());
-		}
-	}
-
-	private function updateCachedMount(ICachedMountInfo $mount) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$query = $builder->update('mounts')
-			->set('storage_id', $builder->createNamedParameter($mount->getStorageId()))
-			->set('mount_point', $builder->createNamedParameter($mount->getMountPoint()))
-			->set('mount_id', $builder->createNamedParameter($mount->getMountId(), IQueryBuilder::PARAM_INT))
-			->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']);
-		if (is_null($user)) {
-			return null;
-		}
-		$mount_id = $row['mount_id'];
-		if (!is_null($mount_id)) {
-			$mount_id = (int)$mount_id;
-		}
-		return new CachedMountInfo($user, (int)$row['storage_id'], (int)$row['root_id'], $row['mount_point'], $mount_id, isset($row['path']) ? $row['path'] : '');
-	}
-
-	/**
-	 * @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', 'mount_id', 'f.path')
-				->from('mounts', 'm')
-				->innerJoin('m', 'filecache', 'f', $builder->expr()->eq('m.root_id', 'f.fileid'))
-				->where($builder->expr()->eq('user_id', $builder->createPositionalParameter($user->getUID())));
-
-			$rows = $query->execute()->fetchAll();
-
-			$this->mountsForUsers[$user->getUID()] = array_filter(array_map([$this, 'dbRowToMountInfo'], $rows));
-		}
-		return $this->mountsForUsers[$user->getUID()];
-	}
-
-	/**
-	 * @param int $numericStorageId
-	 * @param string|null $user limit the results to a single user
-	 * @return CachedMountInfo[]
-	 */
-	public function getMountsForStorageId($numericStorageId, $user = null) {
-		$builder = $this->connection->getQueryBuilder();
-		$query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point', 'mount_id', 'f.path')
-			->from('mounts', 'm')
-			->innerJoin('m', 'filecache', 'f', $builder->expr()->eq('m.root_id', 'f.fileid'))
-			->where($builder->expr()->eq('storage_id', $builder->createPositionalParameter($numericStorageId, IQueryBuilder::PARAM_INT)));
-
-		if ($user) {
-			$query->andWhere($builder->expr()->eq('user_id', $builder->createPositionalParameter($user)));
-		}
-
-		$rows = $query->execute()->fetchAll();
-
-		return array_filter(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', 'mount_id', 'f.path')
-			->from('mounts', 'm')
-			->innerJoin('m', 'filecache', 'f', $builder->expr()->eq('m.root_id', 'f.fileid'))
-			->where($builder->expr()->eq('root_id', $builder->createPositionalParameter($rootFileId, IQueryBuilder::PARAM_INT)));
-
-		$rows = $query->execute()->fetchAll();
-
-		return array_filter(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', 'mimetype')
-				->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'],
-					(int)$row['mimetype']
-				];
-			} else {
-				throw new NotFoundException('File with id "' . $fileId . '" not found');
-			}
-		}
-		return $this->cacheInfoCache[$fileId];
-	}
-
-	/**
-	 * @param int $fileId
-	 * @param string|null $user optionally restrict the results to a single user
-	 * @return ICachedMountFileInfo[]
-	 * @since 9.0.0
-	 */
-	public function getMountsForFileId($fileId, $user = null) {
-		try {
-			list($storageId, $internalPath) = $this->getCacheInfoFromFileId($fileId);
-		} catch (NotFoundException $e) {
-			return [];
-		}
-		$mountsForStorage = $this->getMountsForStorageId($storageId, $user);
-
-		// filter mounts that are from the same storage but a different directory
-		$filteredMounts = array_filter($mountsForStorage, function (ICachedMountInfo $mount) use ($internalPath, $fileId) {
-			if ($fileId === $mount->getRootId()) {
-				return true;
-			}
-			$internalMountPath = $mount->getRootInternalPath();
-
-			return $internalMountPath === '' || substr($internalPath, 0, strlen($internalMountPath) + 1) === $internalMountPath . '/';
-		});
-
-		return array_map(function (ICachedMountInfo $mount) use ($internalPath) {
-			return new CachedMountFileInfo(
-				$mount->getUser(),
-				$mount->getStorageId(),
-				$mount->getRootId(),
-				$mount->getMountPoint(),
-				$mount->getMountId(),
-				$mount->getRootInternalPath(),
-				$internalPath
-			);
-		}, $filteredMounts);
-	}
-
-	/**
-	 * 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();
-	}
-
-	/**
-	 * @param array $users
-	 * @return array
-	 */
-	public function getUsedSpaceForUsers(array $users) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$slash = $builder->createNamedParameter('/');
-
-		$mountPoint = $builder->func()->concat(
-			$builder->func()->concat($slash, 'user_id'),
-			$slash
-		);
-
-		$userIds = array_map(function (IUser $user) {
-			return $user->getUID();
-		}, $users);
-
-		$query = $builder->select('m.user_id', 'f.size')
-			->from('mounts', 'm')
-			->innerJoin('m', 'filecache', 'f',
-				$builder->expr()->andX(
-					$builder->expr()->eq('m.storage_id', 'f.storage'),
-					$builder->expr()->eq('f.path_hash', $builder->createNamedParameter(md5('files')))
-				))
-			->where($builder->expr()->eq('m.mount_point', $mountPoint))
-			->andWhere($builder->expr()->in('m.user_id', $builder->createNamedParameter($userIds, IQueryBuilder::PARAM_STR_ARRAY)));
-
-		$result = $query->execute();
-
-		$results = [];
-		while ($row = $result->fetch()) {
-			$results[$row['user_id']] = $row['size'];
-		}
-		$result->closeCursor();
-		return $results;
-	}
-
-	public function clear(): void {
-		$this->cacheInfoCache = new CappedMemoryCache();
-		$this->mountsForUsers = new CappedMemoryCache();
-	}
+    /**
+     * @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) {
+            // filter out any storages which aren't scanned yet since we aren't interested in files from those storages (yet)
+            if ($mount->getStorageRootId() === -1) {
+                return null;
+            } else {
+                return new LazyStorageMountInfo($user, $mount);
+            }
+        }, $mounts);
+        $newMounts = array_values(array_filter($newMounts));
+        $newMountRootIds = array_map(function (ICachedMountInfo $mount) {
+            return $mount->getRootId();
+        }, $newMounts);
+        $newMounts = array_combine($newMountRootIds, $newMounts);
+
+        $cachedMounts = $this->getMountsForUser($user);
+        $cachedMountRootIds = array_map(function (ICachedMountInfo $mount) {
+            return $mount->getRootId();
+        }, $cachedMounts);
+        $cachedMounts = array_combine($cachedMountRootIds, $cachedMounts);
+
+        $addedMounts = [];
+        $removedMounts = [];
+
+        foreach ($newMounts as $rootId => $newMount) {
+            if (!isset($cachedMounts[$rootId])) {
+                $addedMounts[] = $newMount;
+            }
+        }
+
+        foreach ($cachedMounts as $rootId => $cachedMount) {
+            if (!isset($newMounts[$rootId])) {
+                $removedMounts[] = $cachedMount;
+            }
+        }
+
+        $changedMounts = $this->findChangedMounts($newMounts, $cachedMounts);
+
+        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->updateCachedMount($mount);
+        }
+    }
+
+    /**
+     * @param ICachedMountInfo[] $newMounts
+     * @param ICachedMountInfo[] $cachedMounts
+     * @return ICachedMountInfo[]
+     */
+    private function findChangedMounts(array $newMounts, array $cachedMounts) {
+        $new = [];
+        foreach ($newMounts as $mount) {
+            $new[$mount->getRootId()] = $mount;
+        }
+        $changed = [];
+        foreach ($cachedMounts as $cachedMount) {
+            $rootId = $cachedMount->getRootId();
+            if (isset($new[$rootId])) {
+                $newMount = $new[$rootId];
+                if (
+                    $newMount->getMountPoint() !== $cachedMount->getMountPoint() ||
+                    $newMount->getStorageId() !== $cachedMount->getStorageId() ||
+                    $newMount->getMountId() !== $cachedMount->getMountId()
+                ) {
+                    $changed[] = $newMount;
+                }
+            }
+        }
+        return $changed;
+    }
+
+    private function addToCache(ICachedMountInfo $mount) {
+        if ($mount->getStorageId() !== -1) {
+            $this->connection->insertIfNotExist('*PREFIX*mounts', [
+                'storage_id' => $mount->getStorageId(),
+                'root_id' => $mount->getRootId(),
+                'user_id' => $mount->getUser()->getUID(),
+                'mount_point' => $mount->getMountPoint(),
+                'mount_id' => $mount->getMountId()
+            ], ['root_id', 'user_id']);
+        } else {
+            // in some cases this is legitimate, like orphaned shares
+            $this->logger->debug('Could not get storage info for mount at ' . $mount->getMountPoint());
+        }
+    }
+
+    private function updateCachedMount(ICachedMountInfo $mount) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $query = $builder->update('mounts')
+            ->set('storage_id', $builder->createNamedParameter($mount->getStorageId()))
+            ->set('mount_point', $builder->createNamedParameter($mount->getMountPoint()))
+            ->set('mount_id', $builder->createNamedParameter($mount->getMountId(), IQueryBuilder::PARAM_INT))
+            ->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']);
+        if (is_null($user)) {
+            return null;
+        }
+        $mount_id = $row['mount_id'];
+        if (!is_null($mount_id)) {
+            $mount_id = (int)$mount_id;
+        }
+        return new CachedMountInfo($user, (int)$row['storage_id'], (int)$row['root_id'], $row['mount_point'], $mount_id, isset($row['path']) ? $row['path'] : '');
+    }
+
+    /**
+     * @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', 'mount_id', 'f.path')
+                ->from('mounts', 'm')
+                ->innerJoin('m', 'filecache', 'f', $builder->expr()->eq('m.root_id', 'f.fileid'))
+                ->where($builder->expr()->eq('user_id', $builder->createPositionalParameter($user->getUID())));
+
+            $rows = $query->execute()->fetchAll();
+
+            $this->mountsForUsers[$user->getUID()] = array_filter(array_map([$this, 'dbRowToMountInfo'], $rows));
+        }
+        return $this->mountsForUsers[$user->getUID()];
+    }
+
+    /**
+     * @param int $numericStorageId
+     * @param string|null $user limit the results to a single user
+     * @return CachedMountInfo[]
+     */
+    public function getMountsForStorageId($numericStorageId, $user = null) {
+        $builder = $this->connection->getQueryBuilder();
+        $query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point', 'mount_id', 'f.path')
+            ->from('mounts', 'm')
+            ->innerJoin('m', 'filecache', 'f', $builder->expr()->eq('m.root_id', 'f.fileid'))
+            ->where($builder->expr()->eq('storage_id', $builder->createPositionalParameter($numericStorageId, IQueryBuilder::PARAM_INT)));
+
+        if ($user) {
+            $query->andWhere($builder->expr()->eq('user_id', $builder->createPositionalParameter($user)));
+        }
+
+        $rows = $query->execute()->fetchAll();
+
+        return array_filter(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', 'mount_id', 'f.path')
+            ->from('mounts', 'm')
+            ->innerJoin('m', 'filecache', 'f', $builder->expr()->eq('m.root_id', 'f.fileid'))
+            ->where($builder->expr()->eq('root_id', $builder->createPositionalParameter($rootFileId, IQueryBuilder::PARAM_INT)));
+
+        $rows = $query->execute()->fetchAll();
+
+        return array_filter(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', 'mimetype')
+                ->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'],
+                    (int)$row['mimetype']
+                ];
+            } else {
+                throw new NotFoundException('File with id "' . $fileId . '" not found');
+            }
+        }
+        return $this->cacheInfoCache[$fileId];
+    }
+
+    /**
+     * @param int $fileId
+     * @param string|null $user optionally restrict the results to a single user
+     * @return ICachedMountFileInfo[]
+     * @since 9.0.0
+     */
+    public function getMountsForFileId($fileId, $user = null) {
+        try {
+            list($storageId, $internalPath) = $this->getCacheInfoFromFileId($fileId);
+        } catch (NotFoundException $e) {
+            return [];
+        }
+        $mountsForStorage = $this->getMountsForStorageId($storageId, $user);
+
+        // filter mounts that are from the same storage but a different directory
+        $filteredMounts = array_filter($mountsForStorage, function (ICachedMountInfo $mount) use ($internalPath, $fileId) {
+            if ($fileId === $mount->getRootId()) {
+                return true;
+            }
+            $internalMountPath = $mount->getRootInternalPath();
+
+            return $internalMountPath === '' || substr($internalPath, 0, strlen($internalMountPath) + 1) === $internalMountPath . '/';
+        });
+
+        return array_map(function (ICachedMountInfo $mount) use ($internalPath) {
+            return new CachedMountFileInfo(
+                $mount->getUser(),
+                $mount->getStorageId(),
+                $mount->getRootId(),
+                $mount->getMountPoint(),
+                $mount->getMountId(),
+                $mount->getRootInternalPath(),
+                $internalPath
+            );
+        }, $filteredMounts);
+    }
+
+    /**
+     * 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();
+    }
+
+    /**
+     * @param array $users
+     * @return array
+     */
+    public function getUsedSpaceForUsers(array $users) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $slash = $builder->createNamedParameter('/');
+
+        $mountPoint = $builder->func()->concat(
+            $builder->func()->concat($slash, 'user_id'),
+            $slash
+        );
+
+        $userIds = array_map(function (IUser $user) {
+            return $user->getUID();
+        }, $users);
+
+        $query = $builder->select('m.user_id', 'f.size')
+            ->from('mounts', 'm')
+            ->innerJoin('m', 'filecache', 'f',
+                $builder->expr()->andX(
+                    $builder->expr()->eq('m.storage_id', 'f.storage'),
+                    $builder->expr()->eq('f.path_hash', $builder->createNamedParameter(md5('files')))
+                ))
+            ->where($builder->expr()->eq('m.mount_point', $mountPoint))
+            ->andWhere($builder->expr()->in('m.user_id', $builder->createNamedParameter($userIds, IQueryBuilder::PARAM_STR_ARRAY)));
+
+        $result = $query->execute();
+
+        $results = [];
+        while ($row = $result->fetch()) {
+            $results[$row['user_id']] = $row['size'];
+        }
+        $result->closeCursor();
+        return $results;
+    }
+
+    public function clear(): void {
+        $this->cacheInfoCache = new CappedMemoryCache();
+        $this->mountsForUsers = new CappedMemoryCache();
+    }
 }

lib/private/Files/Cache/Propagator.php

Indentation +165 added lines, -165 removed lines

@@ -33,169 +33,169 @@
  * Propagate etags and mtimes within the storage
  */
 class Propagator implements IPropagator {
-	private $inBatch = false;
-
-	private $batch = [];
-
-	/**
-	 * @var \OC\Files\Storage\Storage
-	 */
-	protected $storage;
-
-	/**
-	 * @var IDBConnection
-	 */
-	private $connection;
-
-	/**
-	 * @var array
-	 */
-	private $ignore = [];
-
-	public function __construct(\OC\Files\Storage\Storage $storage, IDBConnection $connection, array $ignore = []) {
-		$this->storage = $storage;
-		$this->connection = $connection;
-		$this->ignore = $ignore;
-	}
-
-
-	/**
-	 * @param string $internalPath
-	 * @param int $time
-	 * @param int $sizeDifference number of bytes the file has grown
-	 */
-	public function propagateChange($internalPath, $time, $sizeDifference = 0) {
-		// Do not propogate changes in ignored paths
-		foreach ($this->ignore as $ignore) {
-			if (strpos($internalPath, $ignore) === 0) {
-				return;
-			}
-		}
-
-		$storageId = (int)$this->storage->getStorageCache()->getNumericId();
-
-		$parents = $this->getParents($internalPath);
-
-		if ($this->inBatch) {
-			foreach ($parents as $parent) {
-				$this->addToBatch($parent, $time, $sizeDifference);
-			}
-			return;
-		}
-
-		$parentHashes = array_map('md5', $parents);
-		$etag = uniqid(); // since we give all folders the same etag we don't ask the storage for the etag
-
-		$builder = $this->connection->getQueryBuilder();
-		$hashParams = array_map(function ($hash) use ($builder) {
-			return $builder->expr()->literal($hash);
-		}, $parentHashes);
-
-		$builder->update('filecache')
-			->set('mtime', $builder->func()->greatest('mtime', $builder->createNamedParameter((int)$time, IQueryBuilder::PARAM_INT)))
-			->set('etag', $builder->createNamedParameter($etag, IQueryBuilder::PARAM_STR))
-			->where($builder->expr()->eq('storage', $builder->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)))
-			->andWhere($builder->expr()->in('path_hash', $hashParams));
-
-		$builder->execute();
-
-		if ($sizeDifference !== 0) {
-			// we need to do size separably so we can ignore entries with uncalculated size
-			$builder = $this->connection->getQueryBuilder();
-			$builder->update('filecache')
-				->set('size', $builder->func()->greatest(
-					$builder->createNamedParameter(-1, IQueryBuilder::PARAM_INT),
-					$builder->func()->add('size', $builder->createNamedParameter($sizeDifference)))
-				)
-				->where($builder->expr()->eq('storage', $builder->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)))
-				->andWhere($builder->expr()->in('path_hash', $hashParams))
-				->andWhere($builder->expr()->gt('size', $builder->expr()->literal(-1, IQueryBuilder::PARAM_INT)));
-
-			$builder->execute();
-		}
-	}
-
-	protected function getParents($path) {
-		$parts = explode('/', $path);
-		$parent = '';
-		$parents = [];
-		foreach ($parts as $part) {
-			$parents[] = $parent;
-			$parent = trim($parent . '/' . $part, '/');
-		}
-		return $parents;
-	}
-
-	/**
-	 * Mark the beginning of a propagation batch
-	 *
-	 * Note that not all cache setups support propagation in which case this will be a noop
-	 *
-	 * Batching for cache setups that do support it has to be explicit since the cache state is not fully consistent
-	 * before the batch is committed.
-	 */
-	public function beginBatch() {
-		$this->inBatch = true;
-	}
-
-	private function addToBatch($internalPath, $time, $sizeDifference) {
-		if (!isset($this->batch[$internalPath])) {
-			$this->batch[$internalPath] = [
-				'hash' => md5($internalPath),
-				'time' => $time,
-				'size' => $sizeDifference
-			];
-		} else {
-			$this->batch[$internalPath]['size'] += $sizeDifference;
-			if ($time > $this->batch[$internalPath]['time']) {
-				$this->batch[$internalPath]['time'] = $time;
-			}
-		}
-	}
-
-	/**
-	 * Commit the active propagation batch
-	 */
-	public function commitBatch() {
-		if (!$this->inBatch) {
-			throw new \BadMethodCallException('Not in batch');
-		}
-		$this->inBatch = false;
-
-		$this->connection->beginTransaction();
-
-		$query = $this->connection->getQueryBuilder();
-		$storageId = (int)$this->storage->getStorageCache()->getNumericId();
-
-		$query->update('filecache')
-			->set('mtime', $query->createFunction('GREATEST(' . $query->getColumnName('mtime') . ', ' . $query->createParameter('time') . ')'))
-			->set('etag', $query->expr()->literal(uniqid()))
-			->where($query->expr()->eq('storage', $query->expr()->literal($storageId, IQueryBuilder::PARAM_INT)))
-			->andWhere($query->expr()->eq('path_hash', $query->createParameter('hash')));
-
-		$sizeQuery = $this->connection->getQueryBuilder();
-		$sizeQuery->update('filecache')
-			->set('size', $sizeQuery->func()->add('size', $sizeQuery->createParameter('size')))
-			->where($query->expr()->eq('storage', $query->expr()->literal($storageId, IQueryBuilder::PARAM_INT)))
-			->andWhere($query->expr()->eq('path_hash', $query->createParameter('hash')))
-			->andWhere($sizeQuery->expr()->gt('size', $sizeQuery->expr()->literal(-1, IQueryBuilder::PARAM_INT)));
-
-		foreach ($this->batch as $item) {
-			$query->setParameter('time', $item['time'], IQueryBuilder::PARAM_INT);
-			$query->setParameter('hash', $item['hash']);
-
-			$query->execute();
-
-			if ($item['size']) {
-				$sizeQuery->setParameter('size', $item['size'], IQueryBuilder::PARAM_INT);
-				$sizeQuery->setParameter('hash', $item['hash']);
-
-				$sizeQuery->execute();
-			}
-		}
-
-		$this->batch = [];
-
-		$this->connection->commit();
-	}
+    private $inBatch = false;
+
+    private $batch = [];
+
+    /**
+     * @var \OC\Files\Storage\Storage
+     */
+    protected $storage;
+
+    /**
+     * @var IDBConnection
+     */
+    private $connection;
+
+    /**
+     * @var array
+     */
+    private $ignore = [];
+
+    public function __construct(\OC\Files\Storage\Storage $storage, IDBConnection $connection, array $ignore = []) {
+        $this->storage = $storage;
+        $this->connection = $connection;
+        $this->ignore = $ignore;
+    }
+
+
+    /**
+     * @param string $internalPath
+     * @param int $time
+     * @param int $sizeDifference number of bytes the file has grown
+     */
+    public function propagateChange($internalPath, $time, $sizeDifference = 0) {
+        // Do not propogate changes in ignored paths
+        foreach ($this->ignore as $ignore) {
+            if (strpos($internalPath, $ignore) === 0) {
+                return;
+            }
+        }
+
+        $storageId = (int)$this->storage->getStorageCache()->getNumericId();
+
+        $parents = $this->getParents($internalPath);
+
+        if ($this->inBatch) {
+            foreach ($parents as $parent) {
+                $this->addToBatch($parent, $time, $sizeDifference);
+            }
+            return;
+        }
+
+        $parentHashes = array_map('md5', $parents);
+        $etag = uniqid(); // since we give all folders the same etag we don't ask the storage for the etag
+
+        $builder = $this->connection->getQueryBuilder();
+        $hashParams = array_map(function ($hash) use ($builder) {
+            return $builder->expr()->literal($hash);
+        }, $parentHashes);
+
+        $builder->update('filecache')
+            ->set('mtime', $builder->func()->greatest('mtime', $builder->createNamedParameter((int)$time, IQueryBuilder::PARAM_INT)))
+            ->set('etag', $builder->createNamedParameter($etag, IQueryBuilder::PARAM_STR))
+            ->where($builder->expr()->eq('storage', $builder->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)))
+            ->andWhere($builder->expr()->in('path_hash', $hashParams));
+
+        $builder->execute();
+
+        if ($sizeDifference !== 0) {
+            // we need to do size separably so we can ignore entries with uncalculated size
+            $builder = $this->connection->getQueryBuilder();
+            $builder->update('filecache')
+                ->set('size', $builder->func()->greatest(
+                    $builder->createNamedParameter(-1, IQueryBuilder::PARAM_INT),
+                    $builder->func()->add('size', $builder->createNamedParameter($sizeDifference)))
+                )
+                ->where($builder->expr()->eq('storage', $builder->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)))
+                ->andWhere($builder->expr()->in('path_hash', $hashParams))
+                ->andWhere($builder->expr()->gt('size', $builder->expr()->literal(-1, IQueryBuilder::PARAM_INT)));
+
+            $builder->execute();
+        }
+    }
+
+    protected function getParents($path) {
+        $parts = explode('/', $path);
+        $parent = '';
+        $parents = [];
+        foreach ($parts as $part) {
+            $parents[] = $parent;
+            $parent = trim($parent . '/' . $part, '/');
+        }
+        return $parents;
+    }
+
+    /**
+     * Mark the beginning of a propagation batch
+     *
+     * Note that not all cache setups support propagation in which case this will be a noop
+     *
+     * Batching for cache setups that do support it has to be explicit since the cache state is not fully consistent
+     * before the batch is committed.
+     */
+    public function beginBatch() {
+        $this->inBatch = true;
+    }
+
+    private function addToBatch($internalPath, $time, $sizeDifference) {
+        if (!isset($this->batch[$internalPath])) {
+            $this->batch[$internalPath] = [
+                'hash' => md5($internalPath),
+                'time' => $time,
+                'size' => $sizeDifference
+            ];
+        } else {
+            $this->batch[$internalPath]['size'] += $sizeDifference;
+            if ($time > $this->batch[$internalPath]['time']) {
+                $this->batch[$internalPath]['time'] = $time;
+            }
+        }
+    }
+
+    /**
+     * Commit the active propagation batch
+     */
+    public function commitBatch() {
+        if (!$this->inBatch) {
+            throw new \BadMethodCallException('Not in batch');
+        }
+        $this->inBatch = false;
+
+        $this->connection->beginTransaction();
+
+        $query = $this->connection->getQueryBuilder();
+        $storageId = (int)$this->storage->getStorageCache()->getNumericId();
+
+        $query->update('filecache')
+            ->set('mtime', $query->createFunction('GREATEST(' . $query->getColumnName('mtime') . ', ' . $query->createParameter('time') . ')'))
+            ->set('etag', $query->expr()->literal(uniqid()))
+            ->where($query->expr()->eq('storage', $query->expr()->literal($storageId, IQueryBuilder::PARAM_INT)))
+            ->andWhere($query->expr()->eq('path_hash', $query->createParameter('hash')));
+
+        $sizeQuery = $this->connection->getQueryBuilder();
+        $sizeQuery->update('filecache')
+            ->set('size', $sizeQuery->func()->add('size', $sizeQuery->createParameter('size')))
+            ->where($query->expr()->eq('storage', $query->expr()->literal($storageId, IQueryBuilder::PARAM_INT)))
+            ->andWhere($query->expr()->eq('path_hash', $query->createParameter('hash')))
+            ->andWhere($sizeQuery->expr()->gt('size', $sizeQuery->expr()->literal(-1, IQueryBuilder::PARAM_INT)));
+
+        foreach ($this->batch as $item) {
+            $query->setParameter('time', $item['time'], IQueryBuilder::PARAM_INT);
+            $query->setParameter('hash', $item['hash']);
+
+            $query->execute();
+
+            if ($item['size']) {
+                $sizeQuery->setParameter('size', $item['size'], IQueryBuilder::PARAM_INT);
+                $sizeQuery->setParameter('hash', $item['hash']);
+
+                $sizeQuery->execute();
+            }
+        }
+
+        $this->batch = [];
+
+        $this->connection->commit();
+    }
 }

lib/private/Files/Cache/Cache.php

Indentation +937 added lines, -937 removed lines

@@ -62,941 +62,941 @@
  * - ChangePropagator: updates the mtime and etags of parent folders whenever a change to the cache is made to the cache by the updater
  */
 class Cache implements ICache {
-	use MoveFromCacheTrait {
-		MoveFromCacheTrait::moveFromCache as moveFromCacheFallback;
-	}
-
-	/**
-	 * @var array partial data for the cache
-	 */
-	protected $partial = [];
-
-	/**
-	 * @var string
-	 */
-	protected $storageId;
-
-	private $storage;
-
-	/**
-	 * @var Storage $storageCache
-	 */
-	protected $storageCache;
-
-	/** @var IMimeTypeLoader */
-	protected $mimetypeLoader;
-
-	/**
-	 * @var IDBConnection
-	 */
-	protected $connection;
-
-	protected $eventDispatcher;
-
-	/** @var QuerySearchHelper */
-	protected $querySearchHelper;
-
-	/**
-	 * @param IStorage $storage
-	 */
-	public function __construct(IStorage $storage) {
-		$this->storageId = $storage->getId();
-		$this->storage = $storage;
-		if (strlen($this->storageId) > 64) {
-			$this->storageId = md5($this->storageId);
-		}
-
-		$this->storageCache = new Storage($storage);
-		$this->mimetypeLoader = \OC::$server->getMimeTypeLoader();
-		$this->connection = \OC::$server->getDatabaseConnection();
-		$this->eventDispatcher = \OC::$server->getEventDispatcher();
-		$this->querySearchHelper = new QuerySearchHelper($this->mimetypeLoader);
-	}
-
-	private function getQueryBuilder() {
-		return new CacheQueryBuilder(
-			$this->connection,
-			\OC::$server->getSystemConfig(),
-			\OC::$server->getLogger(),
-			$this
-		);
-	}
-
-	/**
-	 * Get the numeric storage id for this cache's storage
-	 *
-	 * @return int
-	 */
-	public function getNumericStorageId() {
-		return $this->storageCache->getNumericId();
-	}
-
-	/**
-	 * get the stored metadata of a file or folder
-	 *
-	 * @param string | int $file either the path of a file or folder or the file id for a file or folder
-	 * @return ICacheEntry|false the cache entry as array of false if the file is not found in the cache
-	 */
-	public function get($file) {
-		$query = $this->getQueryBuilder();
-		$query->selectFileCache();
-
-		if (is_string($file) or $file == '') {
-			// normalize file
-			$file = $this->normalize($file);
-
-			$query->whereStorageId()
-				->wherePath($file);
-		} else { //file id
-			$query->whereFileId($file);
-		}
-
-		$data = $query->execute()->fetch();
-
-		//merge partial data
-		if (!$data and is_string($file) and isset($this->partial[$file])) {
-			return $this->partial[$file];
-		} elseif (!$data) {
-			return $data;
-		} else {
-			return self::cacheEntryFromData($data, $this->mimetypeLoader);
-		}
-	}
-
-	/**
-	 * Create a CacheEntry from database row
-	 *
-	 * @param array $data
-	 * @param IMimeTypeLoader $mimetypeLoader
-	 * @return CacheEntry
-	 */
-	public static function cacheEntryFromData($data, IMimeTypeLoader $mimetypeLoader) {
-		//fix types
-		$data['fileid'] = (int)$data['fileid'];
-		$data['parent'] = (int)$data['parent'];
-		$data['size'] = 0 + $data['size'];
-		$data['mtime'] = (int)$data['mtime'];
-		$data['storage_mtime'] = (int)$data['storage_mtime'];
-		$data['encryptedVersion'] = (int)$data['encrypted'];
-		$data['encrypted'] = (bool)$data['encrypted'];
-		$data['storage_id'] = $data['storage'];
-		$data['storage'] = (int)$data['storage'];
-		$data['mimetype'] = $mimetypeLoader->getMimetypeById($data['mimetype']);
-		$data['mimepart'] = $mimetypeLoader->getMimetypeById($data['mimepart']);
-		if ($data['storage_mtime'] == 0) {
-			$data['storage_mtime'] = $data['mtime'];
-		}
-		$data['permissions'] = (int)$data['permissions'];
-		if (isset($data['creation_time'])) {
-			$data['creation_time'] = (int) $data['creation_time'];
-		}
-		if (isset($data['upload_time'])) {
-			$data['upload_time'] = (int) $data['upload_time'];
-		}
-		return new CacheEntry($data);
-	}
-
-	/**
-	 * get the metadata of all files stored in $folder
-	 *
-	 * @param string $folder
-	 * @return ICacheEntry[]
-	 */
-	public function getFolderContents($folder) {
-		$fileId = $this->getId($folder);
-		return $this->getFolderContentsById($fileId);
-	}
-
-	/**
-	 * get the metadata of all files stored in $folder
-	 *
-	 * @param int $fileId the file id of the folder
-	 * @return ICacheEntry[]
-	 */
-	public function getFolderContentsById($fileId) {
-		if ($fileId > -1) {
-			$query = $this->getQueryBuilder();
-			$query->selectFileCache()
-				->whereParent($fileId)
-				->orderBy('name', 'ASC');
-
-			$files = $query->execute()->fetchAll();
-			return array_map(function (array $data) {
-				return self::cacheEntryFromData($data, $this->mimetypeLoader);
-			}, $files);
-		}
-		return [];
-	}
-
-	/**
-	 * insert or update meta data for a file or folder
-	 *
-	 * @param string $file
-	 * @param array $data
-	 *
-	 * @return int file id
-	 * @throws \RuntimeException
-	 */
-	public function put($file, array $data) {
-		if (($id = $this->getId($file)) > -1) {
-			$this->update($id, $data);
-			return $id;
-		} else {
-			return $this->insert($file, $data);
-		}
-	}
-
-	/**
-	 * insert meta data for a new file or folder
-	 *
-	 * @param string $file
-	 * @param array $data
-	 *
-	 * @return int file id
-	 * @throws \RuntimeException
-	 */
-	public function insert($file, array $data) {
-		// normalize file
-		$file = $this->normalize($file);
-
-		if (isset($this->partial[$file])) { //add any saved partial data
-			$data = array_merge($this->partial[$file], $data);
-			unset($this->partial[$file]);
-		}
-
-		$requiredFields = ['size', 'mtime', 'mimetype'];
-		foreach ($requiredFields as $field) {
-			if (!isset($data[$field])) { //data not complete save as partial and return
-				$this->partial[$file] = $data;
-				return -1;
-			}
-		}
-
-		$data['path'] = $file;
-		if (!isset($data['parent'])) {
-			$data['parent'] = $this->getParentId($file);
-		}
-		$data['name'] = basename($file);
-
-		[$values, $extensionValues] = $this->normalizeData($data);
-		$values['storage'] = $this->getNumericStorageId();
-
-		try {
-			$builder = $this->connection->getQueryBuilder();
-			$builder->insert('filecache');
-
-			foreach ($values as $column => $value) {
-				$builder->setValue($column, $builder->createNamedParameter($value));
-			}
-
-			if ($builder->execute()) {
-				$fileId = $builder->getLastInsertId();
-
-				if (count($extensionValues)) {
-					$query = $this->getQueryBuilder();
-					$query->insert('filecache_extended');
-
-					$query->setValue('fileid', $query->createNamedParameter($fileId, IQueryBuilder::PARAM_INT));
-					foreach ($extensionValues as $column => $value) {
-						$query->setValue($column, $query->createNamedParameter($value));
-					}
-					$query->execute();
-				}
-
-				$this->eventDispatcher->dispatch(CacheInsertEvent::class, new CacheInsertEvent($this->storage, $file, $fileId));
-				return $fileId;
-			}
-		} catch (UniqueConstraintViolationException $e) {
-			// entry exists already
-			if ($this->connection->inTransaction()) {
-				$this->connection->commit();
-				$this->connection->beginTransaction();
-			}
-		}
-
-		// The file was created in the mean time
-		if (($id = $this->getId($file)) > -1) {
-			$this->update($id, $data);
-			return $id;
-		} else {
-			throw new \RuntimeException('File entry could not be inserted but could also not be selected with getId() in order to perform an update. Please try again.');
-		}
-	}
-
-	/**
-	 * update the metadata of an existing file or folder in the cache
-	 *
-	 * @param int $id the fileid of the existing file or folder
-	 * @param array $data [$key => $value] the metadata to update, only the fields provided in the array will be updated, non-provided values will remain unchanged
-	 */
-	public function update($id, array $data) {
-		if (isset($data['path'])) {
-			// normalize path
-			$data['path'] = $this->normalize($data['path']);
-		}
-
-		if (isset($data['name'])) {
-			// normalize path
-			$data['name'] = $this->normalize($data['name']);
-		}
-
-		[$values, $extensionValues] = $this->normalizeData($data);
-
-		if (count($values)) {
-			$query = $this->getQueryBuilder();
-
-			$query->update('filecache')
-				->whereFileId($id)
-				->andWhere($query->expr()->orX(...array_map(function ($key, $value) use ($query) {
-					return $query->expr()->orX(
-						$query->expr()->neq($key, $query->createNamedParameter($value)),
-						$query->expr()->isNull($key)
-					);
-				}, array_keys($values), array_values($values))));
-
-			foreach ($values as $key => $value) {
-				$query->set($key, $query->createNamedParameter($value));
-			}
-
-			$query->execute();
-		}
-
-		if (count($extensionValues)) {
-			try {
-				$query = $this->getQueryBuilder();
-				$query->insert('filecache_extended');
-
-				$query->setValue('fileid', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT));
-				foreach ($extensionValues as $column => $value) {
-					$query->setValue($column, $query->createNamedParameter($value));
-				}
-
-				$query->execute();
-			} catch (UniqueConstraintViolationException $e) {
-				$query = $this->getQueryBuilder();
-				$query->update('filecache_extended')
-					->whereFileId($id)
-					->andWhere($query->expr()->orX(...array_map(function ($key, $value) use ($query) {
-						return $query->expr()->orX(
-							$query->expr()->neq($key, $query->createNamedParameter($value)),
-							$query->expr()->isNull($key)
-						);
-					}, array_keys($extensionValues), array_values($extensionValues))));
-
-				foreach ($extensionValues as $key => $value) {
-					$query->set($key, $query->createNamedParameter($value));
-				}
-
-				$query->execute();
-			}
-		}
-
-		$path = $this->getPathById($id);
-		// path can still be null if the file doesn't exist
-		if ($path !== null) {
-			$this->eventDispatcher->dispatch(CacheUpdateEvent::class, new CacheUpdateEvent($this->storage, $path, $id));
-		}
-	}
-
-	/**
-	 * extract query parts and params array from data array
-	 *
-	 * @param array $data
-	 * @return array
-	 */
-	protected function normalizeData(array $data): array {
-		$fields = [
-			'path', 'parent', 'name', 'mimetype', 'size', 'mtime', 'storage_mtime', 'encrypted',
-			'etag', 'permissions', 'checksum', 'storage'];
-		$extensionFields = ['metadata_etag', 'creation_time', 'upload_time'];
-
-		$doNotCopyStorageMTime = false;
-		if (array_key_exists('mtime', $data) && $data['mtime'] === null) {
-			// this horrific magic tells it to not copy storage_mtime to mtime
-			unset($data['mtime']);
-			$doNotCopyStorageMTime = true;
-		}
-
-		$params = [];
-		$extensionParams = [];
-		foreach ($data as $name => $value) {
-			if (array_search($name, $fields) !== false) {
-				if ($name === 'path') {
-					$params['path_hash'] = md5($value);
-				} elseif ($name === 'mimetype') {
-					$params['mimepart'] = $this->mimetypeLoader->getId(substr($value, 0, strpos($value, '/')));
-					$value = $this->mimetypeLoader->getId($value);
-				} elseif ($name === 'storage_mtime') {
-					if (!$doNotCopyStorageMTime && !isset($data['mtime'])) {
-						$params['mtime'] = $value;
-					}
-				} elseif ($name === 'encrypted') {
-					if (isset($data['encryptedVersion'])) {
-						$value = $data['encryptedVersion'];
-					} else {
-						// Boolean to integer conversion
-						$value = $value ? 1 : 0;
-					}
-				}
-				$params[$name] = $value;
-			}
-			if (array_search($name, $extensionFields) !== false) {
-				$extensionParams[$name] = $value;
-			}
-		}
-		return [$params, array_filter($extensionParams)];
-	}
-
-	/**
-	 * get the file id for a file
-	 *
-	 * A file id is a numeric id for a file or folder that's unique within an owncloud instance which stays the same for the lifetime of a file
-	 *
-	 * File ids are easiest way for apps to store references to a file since unlike paths they are not affected by renames or sharing
-	 *
-	 * @param string $file
-	 * @return int
-	 */
-	public function getId($file) {
-		// normalize file
-		$file = $this->normalize($file);
-
-		$query = $this->getQueryBuilder();
-		$query->select('fileid')
-			->from('filecache')
-			->whereStorageId()
-			->wherePath($file);
-
-		$id = $query->execute()->fetchColumn();
-		return $id === false ? -1 : (int)$id;
-	}
-
-	/**
-	 * get the id of the parent folder of a file
-	 *
-	 * @param string $file
-	 * @return int
-	 */
-	public function getParentId($file) {
-		if ($file === '') {
-			return -1;
-		} else {
-			$parent = $this->getParentPath($file);
-			return (int)$this->getId($parent);
-		}
-	}
-
-	private function getParentPath($path) {
-		$parent = dirname($path);
-		if ($parent === '.') {
-			$parent = '';
-		}
-		return $parent;
-	}
-
-	/**
-	 * check if a file is available in the cache
-	 *
-	 * @param string $file
-	 * @return bool
-	 */
-	public function inCache($file) {
-		return $this->getId($file) != -1;
-	}
-
-	/**
-	 * remove a file or folder from the cache
-	 *
-	 * when removing a folder from the cache all files and folders inside the folder will be removed as well
-	 *
-	 * @param string $file
-	 */
-	public function remove($file) {
-		$entry = $this->get($file);
-
-		if ($entry) {
-			$query = $this->getQueryBuilder();
-			$query->delete('filecache')
-				->whereFileId($entry->getId());
-			$query->execute();
-
-			$query = $this->getQueryBuilder();
-			$query->delete('filecache_extended')
-				->whereFileId($entry->getId());
-			$query->execute();
-
-			if ($entry->getMimeType() == FileInfo::MIMETYPE_FOLDER) {
-				$this->removeChildren($entry);
-			}
-		}
-	}
-
-	/**
-	 * Get all sub folders of a folder
-	 *
-	 * @param ICacheEntry $entry the cache entry of the folder to get the subfolders for
-	 * @return ICacheEntry[] the cache entries for the subfolders
-	 */
-	private function getSubFolders(ICacheEntry $entry) {
-		$children = $this->getFolderContentsById($entry->getId());
-		return array_filter($children, function ($child) {
-			return $child->getMimeType() == FileInfo::MIMETYPE_FOLDER;
-		});
-	}
-
-	/**
-	 * Recursively remove all children of a folder
-	 *
-	 * @param ICacheEntry $entry the cache entry of the folder to remove the children of
-	 * @throws \OC\DatabaseException
-	 */
-	private function removeChildren(ICacheEntry $entry) {
-		$parentIds = [$entry->getId()];
-		$queue = [$entry->getId()];
-
-		// we walk depth first trough the file tree, removing all filecache_extended attributes while we walk
-		// and collecting all folder ids to later use to delete the filecache entries
-		while ($entryId = array_pop($queue)) {
-			$children = $this->getFolderContentsById($entryId);
-			$childIds = array_map(function (ICacheEntry $cacheEntry) {
-				return $cacheEntry->getId();
-			}, $children);
-
-			$query = $this->getQueryBuilder();
-			$query->delete('filecache_extended')
-				->where($query->expr()->in('fileid', $query->createNamedParameter($childIds, IQueryBuilder::PARAM_INT_ARRAY)));
-			$query->execute();
-
-			/** @var ICacheEntry[] $childFolders */
-			$childFolders = array_filter($children, function ($child) {
-				return $child->getMimeType() == FileInfo::MIMETYPE_FOLDER;
-			});
-			foreach ($childFolders as $folder) {
-				$parentIds[] = $folder->getId();
-				$queue[] = $folder->getId();
-			}
-		}
-
-		$query = $this->getQueryBuilder();
-		$query->delete('filecache')
-			->whereParentIn($parentIds);
-		$query->execute();
-	}
-
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * @param string $source
-	 * @param string $target
-	 */
-	public function move($source, $target) {
-		$this->moveFromCache($this, $source, $target);
-	}
-
-	/**
-	 * Get the storage id and path needed for a move
-	 *
-	 * @param string $path
-	 * @return array [$storageId, $internalPath]
-	 */
-	protected function getMoveInfo($path) {
-		return [$this->getNumericStorageId(), $path];
-	}
-
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * @param \OCP\Files\Cache\ICache $sourceCache
-	 * @param string $sourcePath
-	 * @param string $targetPath
-	 * @throws \OC\DatabaseException
-	 * @throws \Exception if the given storages have an invalid id
-	 */
-	public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath) {
-		if ($sourceCache instanceof Cache) {
-			// normalize source and target
-			$sourcePath = $this->normalize($sourcePath);
-			$targetPath = $this->normalize($targetPath);
-
-			$sourceData = $sourceCache->get($sourcePath);
-			$sourceId = $sourceData['fileid'];
-			$newParentId = $this->getParentId($targetPath);
-
-			[$sourceStorageId, $sourcePath] = $sourceCache->getMoveInfo($sourcePath);
-			[$targetStorageId, $targetPath] = $this->getMoveInfo($targetPath);
-
-			if (is_null($sourceStorageId) || $sourceStorageId === false) {
-				throw new \Exception('Invalid source storage id: ' . $sourceStorageId);
-			}
-			if (is_null($targetStorageId) || $targetStorageId === false) {
-				throw new \Exception('Invalid target storage id: ' . $targetStorageId);
-			}
-
-			$this->connection->beginTransaction();
-			if ($sourceData['mimetype'] === 'httpd/unix-directory') {
-				//update all child entries
-				$sourceLength = mb_strlen($sourcePath);
-				$query = $this->connection->getQueryBuilder();
-
-				$fun = $query->func();
-				$newPathFunction = $fun->concat(
-					$query->createNamedParameter($targetPath),
-					$fun->substring('path', $query->createNamedParameter($sourceLength + 1, IQueryBuilder::PARAM_INT))// +1 for the leading slash
-				);
-				$query->update('filecache')
-					->set('storage', $query->createNamedParameter($targetStorageId, IQueryBuilder::PARAM_INT))
-					->set('path_hash', $fun->md5($newPathFunction))
-					->set('path', $newPathFunction)
-					->where($query->expr()->eq('storage', $query->createNamedParameter($sourceStorageId, IQueryBuilder::PARAM_INT)))
-					->andWhere($query->expr()->like('path', $query->createNamedParameter($this->connection->escapeLikeParameter($sourcePath) . '/%')));
-
-				try {
-					$query->execute();
-				} catch (\OC\DatabaseException $e) {
-					$this->connection->rollBack();
-					throw $e;
-				}
-			}
-
-			$query = $this->getQueryBuilder();
-			$query->update('filecache')
-				->set('storage', $query->createNamedParameter($targetStorageId))
-				->set('path', $query->createNamedParameter($targetPath))
-				->set('path_hash', $query->createNamedParameter(md5($targetPath)))
-				->set('name', $query->createNamedParameter(basename($targetPath)))
-				->set('parent', $query->createNamedParameter($newParentId, IQueryBuilder::PARAM_INT))
-				->whereFileId($sourceId);
-			$query->execute();
-
-			$this->connection->commit();
-		} else {
-			$this->moveFromCacheFallback($sourceCache, $sourcePath, $targetPath);
-		}
-	}
-
-	/**
-	 * remove all entries for files that are stored on the storage from the cache
-	 */
-	public function clear() {
-		$query = $this->getQueryBuilder();
-		$query->delete('filecache')
-			->whereStorageId();
-		$query->execute();
-
-		$query = $this->connection->getQueryBuilder();
-		$query->delete('storages')
-			->where($query->expr()->eq('id', $query->createNamedParameter($this->storageId)));
-		$query->execute();
-	}
-
-	/**
-	 * Get the scan status of a file
-	 *
-	 * - Cache::NOT_FOUND: File is not in the cache
-	 * - Cache::PARTIAL: File is not stored in the cache but some incomplete data is known
-	 * - Cache::SHALLOW: The folder and it's direct children are in the cache but not all sub folders are fully scanned
-	 * - Cache::COMPLETE: The file or folder, with all it's children) are fully scanned
-	 *
-	 * @param string $file
-	 *
-	 * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
-	 */
-	public function getStatus($file) {
-		// normalize file
-		$file = $this->normalize($file);
-
-		$query = $this->getQueryBuilder();
-		$query->select('size')
-			->from('filecache')
-			->whereStorageId()
-			->wherePath($file);
-		$size = $query->execute()->fetchColumn();
-		if ($size !== false) {
-			if ((int)$size === -1) {
-				return self::SHALLOW;
-			} else {
-				return self::COMPLETE;
-			}
-		} else {
-			if (isset($this->partial[$file])) {
-				return self::PARTIAL;
-			} else {
-				return self::NOT_FOUND;
-			}
-		}
-	}
-
-	/**
-	 * search for files matching $pattern
-	 *
-	 * @param string $pattern the search pattern using SQL search syntax (e.g. '%searchstring%')
-	 * @return ICacheEntry[] an array of cache entries where the name matches the search pattern
-	 */
-	public function search($pattern) {
-		// normalize pattern
-		$pattern = $this->normalize($pattern);
-
-		if ($pattern === '%%') {
-			return [];
-		}
-
-		$query = $this->getQueryBuilder();
-		$query->selectFileCache()
-			->whereStorageId()
-			->andWhere($query->expr()->iLike('name', $query->createNamedParameter($pattern)));
-
-		return array_map(function (array $data) {
-			return self::cacheEntryFromData($data, $this->mimetypeLoader);
-		}, $query->execute()->fetchAll());
-	}
-
-	/**
-	 * @param Statement $result
-	 * @return CacheEntry[]
-	 */
-	private function searchResultToCacheEntries(Statement $result) {
-		$files = $result->fetchAll();
-
-		return array_map(function (array $data) {
-			return self::cacheEntryFromData($data, $this->mimetypeLoader);
-		}, $files);
-	}
-
-	/**
-	 * search for files by mimetype
-	 *
-	 * @param string $mimetype either a full mimetype to search ('text/plain') or only the first part of a mimetype ('image')
-	 *        where it will search for all mimetypes in the group ('image/*')
-	 * @return ICacheEntry[] an array of cache entries where the mimetype matches the search
-	 */
-	public function searchByMime($mimetype) {
-		$mimeId = $this->mimetypeLoader->getId($mimetype);
-
-		$query = $this->getQueryBuilder();
-		$query->selectFileCache()
-			->whereStorageId();
-
-		if (strpos($mimetype, '/')) {
-			$query->andWhere($query->expr()->eq('mimetype', $query->createNamedParameter($mimeId, IQueryBuilder::PARAM_INT)));
-		} else {
-			$query->andWhere($query->expr()->eq('mimepart', $query->createNamedParameter($mimeId, IQueryBuilder::PARAM_INT)));
-		}
-
-		return array_map(function (array $data) {
-			return self::cacheEntryFromData($data, $this->mimetypeLoader);
-		}, $query->execute()->fetchAll());
-	}
-
-	public function searchQuery(ISearchQuery $searchQuery) {
-		$builder = $this->getQueryBuilder();
-
-		$query = $builder->selectFileCache('file');
-
-		$query->whereStorageId();
-
-		if ($this->querySearchHelper->shouldJoinTags($searchQuery->getSearchOperation())) {
-			$query
-				->innerJoin('file', 'vcategory_to_object', 'tagmap', $builder->expr()->eq('file.fileid', 'tagmap.objid'))
-				->innerJoin('tagmap', 'vcategory', 'tag', $builder->expr()->andX(
-					$builder->expr()->eq('tagmap.type', 'tag.type'),
-					$builder->expr()->eq('tagmap.categoryid', 'tag.id')
-				))
-				->andWhere($builder->expr()->eq('tag.type', $builder->createNamedParameter('files')))
-				->andWhere($builder->expr()->eq('tag.uid', $builder->createNamedParameter($searchQuery->getUser()->getUID())));
-		}
-
-		$searchExpr = $this->querySearchHelper->searchOperatorToDBExpr($builder, $searchQuery->getSearchOperation());
-		if ($searchExpr) {
-			$query->andWhere($searchExpr);
-		}
-
-		if ($searchQuery->limitToHome() && ($this instanceof HomeCache)) {
-			$query->andWhere($builder->expr()->like('path', $query->expr()->literal('files/%')));
-		}
-
-		$this->querySearchHelper->addSearchOrdersToQuery($query, $searchQuery->getOrder());
-
-		if ($searchQuery->getLimit()) {
-			$query->setMaxResults($searchQuery->getLimit());
-		}
-		if ($searchQuery->getOffset()) {
-			$query->setFirstResult($searchQuery->getOffset());
-		}
-
-		$result = $query->execute();
-		return $this->searchResultToCacheEntries($result);
-	}
-
-	/**
-	 * Re-calculate the folder size and the size of all parent folders
-	 *
-	 * @param string|boolean $path
-	 * @param array $data (optional) meta data of the folder
-	 */
-	public function correctFolderSize($path, $data = null, $isBackgroundScan = false) {
-		$this->calculateFolderSize($path, $data);
-		if ($path !== '') {
-			$parent = dirname($path);
-			if ($parent === '.' or $parent === '/') {
-				$parent = '';
-			}
-			if ($isBackgroundScan) {
-				$parentData = $this->get($parent);
-				if ($parentData['size'] !== -1 && $this->getIncompleteChildrenCount($parentData['fileid']) === 0) {
-					$this->correctFolderSize($parent, $parentData, $isBackgroundScan);
-				}
-			} else {
-				$this->correctFolderSize($parent);
-			}
-		}
-	}
-
-	/**
-	 * get the incomplete count that shares parent $folder
-	 *
-	 * @param int $fileId the file id of the folder
-	 * @return int
-	 */
-	public function getIncompleteChildrenCount($fileId) {
-		if ($fileId > -1) {
-			$query = $this->getQueryBuilder();
-			$query->select($query->func()->count())
-				->from('filecache')
-				->whereParent($fileId)
-				->andWhere($query->expr()->lt('size', $query->createNamedParameter(0, IQueryBuilder::PARAM_INT)));
-
-			return (int)$query->execute()->fetchColumn();
-		}
-		return -1;
-	}
-
-	/**
-	 * calculate the size of a folder and set it in the cache
-	 *
-	 * @param string $path
-	 * @param array $entry (optional) meta data of the folder
-	 * @return int
-	 */
-	public function calculateFolderSize($path, $entry = null) {
-		$totalSize = 0;
-		if (is_null($entry) or !isset($entry['fileid'])) {
-			$entry = $this->get($path);
-		}
-		if (isset($entry['mimetype']) && $entry['mimetype'] === FileInfo::MIMETYPE_FOLDER) {
-			$id = $entry['fileid'];
-
-			$query = $this->getQueryBuilder();
-			$query->selectAlias($query->func()->sum('size'), 'f1')
-				->selectAlias($query->func()->min('size'), 'f2')
-				->from('filecache')
-				->whereStorageId()
-				->whereParent($id);
-
-			if ($row = $query->execute()->fetch()) {
-				[$sum, $min] = array_values($row);
-				$sum = 0 + $sum;
-				$min = 0 + $min;
-				if ($min === -1) {
-					$totalSize = $min;
-				} else {
-					$totalSize = $sum;
-				}
-				if ($entry['size'] !== $totalSize) {
-					$this->update($id, ['size' => $totalSize]);
-				}
-			}
-		}
-		return $totalSize;
-	}
-
-	/**
-	 * get all file ids on the files on the storage
-	 *
-	 * @return int[]
-	 */
-	public function getAll() {
-		$query = $this->getQueryBuilder();
-		$query->select('fileid')
-			->from('filecache')
-			->whereStorageId();
-
-		return array_map(function ($id) {
-			return (int)$id;
-		}, $query->execute()->fetchAll(\PDO::FETCH_COLUMN));
-	}
-
-	/**
-	 * find a folder in the cache which has not been fully scanned
-	 *
-	 * If multiple incomplete folders are in the cache, the one with the highest id will be returned,
-	 * use the one with the highest id gives the best result with the background scanner, since that is most
-	 * likely the folder where we stopped scanning previously
-	 *
-	 * @return string|bool the path of the folder or false when no folder matched
-	 */
-	public function getIncomplete() {
-		$query = $this->getQueryBuilder();
-		$query->select('path')
-			->from('filecache')
-			->whereStorageId()
-			->andWhere($query->expr()->lt('size', $query->createNamedParameter(0, IQueryBuilder::PARAM_INT)))
-			->orderBy('fileid', 'DESC');
-
-		return $query->execute()->fetchColumn();
-	}
-
-	/**
-	 * get the path of a file on this storage by it's file id
-	 *
-	 * @param int $id the file id of the file or folder to search
-	 * @return string|null the path of the file (relative to the storage) or null if a file with the given id does not exists within this cache
-	 */
-	public function getPathById($id) {
-		$query = $this->getQueryBuilder();
-		$query->select('path')
-			->from('filecache')
-			->whereStorageId()
-			->whereFileId($id);
-
-		$path = $query->execute()->fetchColumn();
-		return $path === false ? null : $path;
-	}
-
-	/**
-	 * get the storage id of the storage for a file and the internal path of the file
-	 * unlike getPathById this does not limit the search to files on this storage and
-	 * instead does a global search in the cache table
-	 *
-	 * @param int $id
-	 * @return array first element holding the storage id, second the path
-	 * @deprecated use getPathById() instead
-	 */
-	public static function getById($id) {
-		$query = \OC::$server->getDatabaseConnection()->getQueryBuilder();
-		$query->select('path', 'storage')
-			->from('filecache')
-			->where($query->expr()->eq('fileid', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
-		if ($row = $query->execute()->fetch()) {
-			$numericId = $row['storage'];
-			$path = $row['path'];
-		} else {
-			return null;
-		}
-
-		if ($id = Storage::getStorageId($numericId)) {
-			return [$id, $path];
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * normalize the given path
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public function normalize($path) {
-		return trim(\OC_Util::normalizeUnicode($path), '/');
-	}
+    use MoveFromCacheTrait {
+        MoveFromCacheTrait::moveFromCache as moveFromCacheFallback;
+    }
+
+    /**
+     * @var array partial data for the cache
+     */
+    protected $partial = [];
+
+    /**
+     * @var string
+     */
+    protected $storageId;
+
+    private $storage;
+
+    /**
+     * @var Storage $storageCache
+     */
+    protected $storageCache;
+
+    /** @var IMimeTypeLoader */
+    protected $mimetypeLoader;
+
+    /**
+     * @var IDBConnection
+     */
+    protected $connection;
+
+    protected $eventDispatcher;
+
+    /** @var QuerySearchHelper */
+    protected $querySearchHelper;
+
+    /**
+     * @param IStorage $storage
+     */
+    public function __construct(IStorage $storage) {
+        $this->storageId = $storage->getId();
+        $this->storage = $storage;
+        if (strlen($this->storageId) > 64) {
+            $this->storageId = md5($this->storageId);
+        }
+
+        $this->storageCache = new Storage($storage);
+        $this->mimetypeLoader = \OC::$server->getMimeTypeLoader();
+        $this->connection = \OC::$server->getDatabaseConnection();
+        $this->eventDispatcher = \OC::$server->getEventDispatcher();
+        $this->querySearchHelper = new QuerySearchHelper($this->mimetypeLoader);
+    }
+
+    private function getQueryBuilder() {
+        return new CacheQueryBuilder(
+            $this->connection,
+            \OC::$server->getSystemConfig(),
+            \OC::$server->getLogger(),
+            $this
+        );
+    }
+
+    /**
+     * Get the numeric storage id for this cache's storage
+     *
+     * @return int
+     */
+    public function getNumericStorageId() {
+        return $this->storageCache->getNumericId();
+    }
+
+    /**
+     * get the stored metadata of a file or folder
+     *
+     * @param string | int $file either the path of a file or folder or the file id for a file or folder
+     * @return ICacheEntry|false the cache entry as array of false if the file is not found in the cache
+     */
+    public function get($file) {
+        $query = $this->getQueryBuilder();
+        $query->selectFileCache();
+
+        if (is_string($file) or $file == '') {
+            // normalize file
+            $file = $this->normalize($file);
+
+            $query->whereStorageId()
+                ->wherePath($file);
+        } else { //file id
+            $query->whereFileId($file);
+        }
+
+        $data = $query->execute()->fetch();
+
+        //merge partial data
+        if (!$data and is_string($file) and isset($this->partial[$file])) {
+            return $this->partial[$file];
+        } elseif (!$data) {
+            return $data;
+        } else {
+            return self::cacheEntryFromData($data, $this->mimetypeLoader);
+        }
+    }
+
+    /**
+     * Create a CacheEntry from database row
+     *
+     * @param array $data
+     * @param IMimeTypeLoader $mimetypeLoader
+     * @return CacheEntry
+     */
+    public static function cacheEntryFromData($data, IMimeTypeLoader $mimetypeLoader) {
+        //fix types
+        $data['fileid'] = (int)$data['fileid'];
+        $data['parent'] = (int)$data['parent'];
+        $data['size'] = 0 + $data['size'];
+        $data['mtime'] = (int)$data['mtime'];
+        $data['storage_mtime'] = (int)$data['storage_mtime'];
+        $data['encryptedVersion'] = (int)$data['encrypted'];
+        $data['encrypted'] = (bool)$data['encrypted'];
+        $data['storage_id'] = $data['storage'];
+        $data['storage'] = (int)$data['storage'];
+        $data['mimetype'] = $mimetypeLoader->getMimetypeById($data['mimetype']);
+        $data['mimepart'] = $mimetypeLoader->getMimetypeById($data['mimepart']);
+        if ($data['storage_mtime'] == 0) {
+            $data['storage_mtime'] = $data['mtime'];
+        }
+        $data['permissions'] = (int)$data['permissions'];
+        if (isset($data['creation_time'])) {
+            $data['creation_time'] = (int) $data['creation_time'];
+        }
+        if (isset($data['upload_time'])) {
+            $data['upload_time'] = (int) $data['upload_time'];
+        }
+        return new CacheEntry($data);
+    }
+
+    /**
+     * get the metadata of all files stored in $folder
+     *
+     * @param string $folder
+     * @return ICacheEntry[]
+     */
+    public function getFolderContents($folder) {
+        $fileId = $this->getId($folder);
+        return $this->getFolderContentsById($fileId);
+    }
+
+    /**
+     * get the metadata of all files stored in $folder
+     *
+     * @param int $fileId the file id of the folder
+     * @return ICacheEntry[]
+     */
+    public function getFolderContentsById($fileId) {
+        if ($fileId > -1) {
+            $query = $this->getQueryBuilder();
+            $query->selectFileCache()
+                ->whereParent($fileId)
+                ->orderBy('name', 'ASC');
+
+            $files = $query->execute()->fetchAll();
+            return array_map(function (array $data) {
+                return self::cacheEntryFromData($data, $this->mimetypeLoader);
+            }, $files);
+        }
+        return [];
+    }
+
+    /**
+     * insert or update meta data for a file or folder
+     *
+     * @param string $file
+     * @param array $data
+     *
+     * @return int file id
+     * @throws \RuntimeException
+     */
+    public function put($file, array $data) {
+        if (($id = $this->getId($file)) > -1) {
+            $this->update($id, $data);
+            return $id;
+        } else {
+            return $this->insert($file, $data);
+        }
+    }
+
+    /**
+     * insert meta data for a new file or folder
+     *
+     * @param string $file
+     * @param array $data
+     *
+     * @return int file id
+     * @throws \RuntimeException
+     */
+    public function insert($file, array $data) {
+        // normalize file
+        $file = $this->normalize($file);
+
+        if (isset($this->partial[$file])) { //add any saved partial data
+            $data = array_merge($this->partial[$file], $data);
+            unset($this->partial[$file]);
+        }
+
+        $requiredFields = ['size', 'mtime', 'mimetype'];
+        foreach ($requiredFields as $field) {
+            if (!isset($data[$field])) { //data not complete save as partial and return
+                $this->partial[$file] = $data;
+                return -1;
+            }
+        }
+
+        $data['path'] = $file;
+        if (!isset($data['parent'])) {
+            $data['parent'] = $this->getParentId($file);
+        }
+        $data['name'] = basename($file);
+
+        [$values, $extensionValues] = $this->normalizeData($data);
+        $values['storage'] = $this->getNumericStorageId();
+
+        try {
+            $builder = $this->connection->getQueryBuilder();
+            $builder->insert('filecache');
+
+            foreach ($values as $column => $value) {
+                $builder->setValue($column, $builder->createNamedParameter($value));
+            }
+
+            if ($builder->execute()) {
+                $fileId = $builder->getLastInsertId();
+
+                if (count($extensionValues)) {
+                    $query = $this->getQueryBuilder();
+                    $query->insert('filecache_extended');
+
+                    $query->setValue('fileid', $query->createNamedParameter($fileId, IQueryBuilder::PARAM_INT));
+                    foreach ($extensionValues as $column => $value) {
+                        $query->setValue($column, $query->createNamedParameter($value));
+                    }
+                    $query->execute();
+                }
+
+                $this->eventDispatcher->dispatch(CacheInsertEvent::class, new CacheInsertEvent($this->storage, $file, $fileId));
+                return $fileId;
+            }
+        } catch (UniqueConstraintViolationException $e) {
+            // entry exists already
+            if ($this->connection->inTransaction()) {
+                $this->connection->commit();
+                $this->connection->beginTransaction();
+            }
+        }
+
+        // The file was created in the mean time
+        if (($id = $this->getId($file)) > -1) {
+            $this->update($id, $data);
+            return $id;
+        } else {
+            throw new \RuntimeException('File entry could not be inserted but could also not be selected with getId() in order to perform an update. Please try again.');
+        }
+    }
+
+    /**
+     * update the metadata of an existing file or folder in the cache
+     *
+     * @param int $id the fileid of the existing file or folder
+     * @param array $data [$key => $value] the metadata to update, only the fields provided in the array will be updated, non-provided values will remain unchanged
+     */
+    public function update($id, array $data) {
+        if (isset($data['path'])) {
+            // normalize path
+            $data['path'] = $this->normalize($data['path']);
+        }
+
+        if (isset($data['name'])) {
+            // normalize path
+            $data['name'] = $this->normalize($data['name']);
+        }
+
+        [$values, $extensionValues] = $this->normalizeData($data);
+
+        if (count($values)) {
+            $query = $this->getQueryBuilder();
+
+            $query->update('filecache')
+                ->whereFileId($id)
+                ->andWhere($query->expr()->orX(...array_map(function ($key, $value) use ($query) {
+                    return $query->expr()->orX(
+                        $query->expr()->neq($key, $query->createNamedParameter($value)),
+                        $query->expr()->isNull($key)
+                    );
+                }, array_keys($values), array_values($values))));
+
+            foreach ($values as $key => $value) {
+                $query->set($key, $query->createNamedParameter($value));
+            }
+
+            $query->execute();
+        }
+
+        if (count($extensionValues)) {
+            try {
+                $query = $this->getQueryBuilder();
+                $query->insert('filecache_extended');
+
+                $query->setValue('fileid', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT));
+                foreach ($extensionValues as $column => $value) {
+                    $query->setValue($column, $query->createNamedParameter($value));
+                }
+
+                $query->execute();
+            } catch (UniqueConstraintViolationException $e) {
+                $query = $this->getQueryBuilder();
+                $query->update('filecache_extended')
+                    ->whereFileId($id)
+                    ->andWhere($query->expr()->orX(...array_map(function ($key, $value) use ($query) {
+                        return $query->expr()->orX(
+                            $query->expr()->neq($key, $query->createNamedParameter($value)),
+                            $query->expr()->isNull($key)
+                        );
+                    }, array_keys($extensionValues), array_values($extensionValues))));
+
+                foreach ($extensionValues as $key => $value) {
+                    $query->set($key, $query->createNamedParameter($value));
+                }
+
+                $query->execute();
+            }
+        }
+
+        $path = $this->getPathById($id);
+        // path can still be null if the file doesn't exist
+        if ($path !== null) {
+            $this->eventDispatcher->dispatch(CacheUpdateEvent::class, new CacheUpdateEvent($this->storage, $path, $id));
+        }
+    }
+
+    /**
+     * extract query parts and params array from data array
+     *
+     * @param array $data
+     * @return array
+     */
+    protected function normalizeData(array $data): array {
+        $fields = [
+            'path', 'parent', 'name', 'mimetype', 'size', 'mtime', 'storage_mtime', 'encrypted',
+            'etag', 'permissions', 'checksum', 'storage'];
+        $extensionFields = ['metadata_etag', 'creation_time', 'upload_time'];
+
+        $doNotCopyStorageMTime = false;
+        if (array_key_exists('mtime', $data) && $data['mtime'] === null) {
+            // this horrific magic tells it to not copy storage_mtime to mtime
+            unset($data['mtime']);
+            $doNotCopyStorageMTime = true;
+        }
+
+        $params = [];
+        $extensionParams = [];
+        foreach ($data as $name => $value) {
+            if (array_search($name, $fields) !== false) {
+                if ($name === 'path') {
+                    $params['path_hash'] = md5($value);
+                } elseif ($name === 'mimetype') {
+                    $params['mimepart'] = $this->mimetypeLoader->getId(substr($value, 0, strpos($value, '/')));
+                    $value = $this->mimetypeLoader->getId($value);
+                } elseif ($name === 'storage_mtime') {
+                    if (!$doNotCopyStorageMTime && !isset($data['mtime'])) {
+                        $params['mtime'] = $value;
+                    }
+                } elseif ($name === 'encrypted') {
+                    if (isset($data['encryptedVersion'])) {
+                        $value = $data['encryptedVersion'];
+                    } else {
+                        // Boolean to integer conversion
+                        $value = $value ? 1 : 0;
+                    }
+                }
+                $params[$name] = $value;
+            }
+            if (array_search($name, $extensionFields) !== false) {
+                $extensionParams[$name] = $value;
+            }
+        }
+        return [$params, array_filter($extensionParams)];
+    }
+
+    /**
+     * get the file id for a file
+     *
+     * A file id is a numeric id for a file or folder that's unique within an owncloud instance which stays the same for the lifetime of a file
+     *
+     * File ids are easiest way for apps to store references to a file since unlike paths they are not affected by renames or sharing
+     *
+     * @param string $file
+     * @return int
+     */
+    public function getId($file) {
+        // normalize file
+        $file = $this->normalize($file);
+
+        $query = $this->getQueryBuilder();
+        $query->select('fileid')
+            ->from('filecache')
+            ->whereStorageId()
+            ->wherePath($file);
+
+        $id = $query->execute()->fetchColumn();
+        return $id === false ? -1 : (int)$id;
+    }
+
+    /**
+     * get the id of the parent folder of a file
+     *
+     * @param string $file
+     * @return int
+     */
+    public function getParentId($file) {
+        if ($file === '') {
+            return -1;
+        } else {
+            $parent = $this->getParentPath($file);
+            return (int)$this->getId($parent);
+        }
+    }
+
+    private function getParentPath($path) {
+        $parent = dirname($path);
+        if ($parent === '.') {
+            $parent = '';
+        }
+        return $parent;
+    }
+
+    /**
+     * check if a file is available in the cache
+     *
+     * @param string $file
+     * @return bool
+     */
+    public function inCache($file) {
+        return $this->getId($file) != -1;
+    }
+
+    /**
+     * remove a file or folder from the cache
+     *
+     * when removing a folder from the cache all files and folders inside the folder will be removed as well
+     *
+     * @param string $file
+     */
+    public function remove($file) {
+        $entry = $this->get($file);
+
+        if ($entry) {
+            $query = $this->getQueryBuilder();
+            $query->delete('filecache')
+                ->whereFileId($entry->getId());
+            $query->execute();
+
+            $query = $this->getQueryBuilder();
+            $query->delete('filecache_extended')
+                ->whereFileId($entry->getId());
+            $query->execute();
+
+            if ($entry->getMimeType() == FileInfo::MIMETYPE_FOLDER) {
+                $this->removeChildren($entry);
+            }
+        }
+    }
+
+    /**
+     * Get all sub folders of a folder
+     *
+     * @param ICacheEntry $entry the cache entry of the folder to get the subfolders for
+     * @return ICacheEntry[] the cache entries for the subfolders
+     */
+    private function getSubFolders(ICacheEntry $entry) {
+        $children = $this->getFolderContentsById($entry->getId());
+        return array_filter($children, function ($child) {
+            return $child->getMimeType() == FileInfo::MIMETYPE_FOLDER;
+        });
+    }
+
+    /**
+     * Recursively remove all children of a folder
+     *
+     * @param ICacheEntry $entry the cache entry of the folder to remove the children of
+     * @throws \OC\DatabaseException
+     */
+    private function removeChildren(ICacheEntry $entry) {
+        $parentIds = [$entry->getId()];
+        $queue = [$entry->getId()];
+
+        // we walk depth first trough the file tree, removing all filecache_extended attributes while we walk
+        // and collecting all folder ids to later use to delete the filecache entries
+        while ($entryId = array_pop($queue)) {
+            $children = $this->getFolderContentsById($entryId);
+            $childIds = array_map(function (ICacheEntry $cacheEntry) {
+                return $cacheEntry->getId();
+            }, $children);
+
+            $query = $this->getQueryBuilder();
+            $query->delete('filecache_extended')
+                ->where($query->expr()->in('fileid', $query->createNamedParameter($childIds, IQueryBuilder::PARAM_INT_ARRAY)));
+            $query->execute();
+
+            /** @var ICacheEntry[] $childFolders */
+            $childFolders = array_filter($children, function ($child) {
+                return $child->getMimeType() == FileInfo::MIMETYPE_FOLDER;
+            });
+            foreach ($childFolders as $folder) {
+                $parentIds[] = $folder->getId();
+                $queue[] = $folder->getId();
+            }
+        }
+
+        $query = $this->getQueryBuilder();
+        $query->delete('filecache')
+            ->whereParentIn($parentIds);
+        $query->execute();
+    }
+
+    /**
+     * Move a file or folder in the cache
+     *
+     * @param string $source
+     * @param string $target
+     */
+    public function move($source, $target) {
+        $this->moveFromCache($this, $source, $target);
+    }
+
+    /**
+     * Get the storage id and path needed for a move
+     *
+     * @param string $path
+     * @return array [$storageId, $internalPath]
+     */
+    protected function getMoveInfo($path) {
+        return [$this->getNumericStorageId(), $path];
+    }
+
+    /**
+     * Move a file or folder in the cache
+     *
+     * @param \OCP\Files\Cache\ICache $sourceCache
+     * @param string $sourcePath
+     * @param string $targetPath
+     * @throws \OC\DatabaseException
+     * @throws \Exception if the given storages have an invalid id
+     */
+    public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath) {
+        if ($sourceCache instanceof Cache) {
+            // normalize source and target
+            $sourcePath = $this->normalize($sourcePath);
+            $targetPath = $this->normalize($targetPath);
+
+            $sourceData = $sourceCache->get($sourcePath);
+            $sourceId = $sourceData['fileid'];
+            $newParentId = $this->getParentId($targetPath);
+
+            [$sourceStorageId, $sourcePath] = $sourceCache->getMoveInfo($sourcePath);
+            [$targetStorageId, $targetPath] = $this->getMoveInfo($targetPath);
+
+            if (is_null($sourceStorageId) || $sourceStorageId === false) {
+                throw new \Exception('Invalid source storage id: ' . $sourceStorageId);
+            }
+            if (is_null($targetStorageId) || $targetStorageId === false) {
+                throw new \Exception('Invalid target storage id: ' . $targetStorageId);
+            }
+
+            $this->connection->beginTransaction();
+            if ($sourceData['mimetype'] === 'httpd/unix-directory') {
+                //update all child entries
+                $sourceLength = mb_strlen($sourcePath);
+                $query = $this->connection->getQueryBuilder();
+
+                $fun = $query->func();
+                $newPathFunction = $fun->concat(
+                    $query->createNamedParameter($targetPath),
+                    $fun->substring('path', $query->createNamedParameter($sourceLength + 1, IQueryBuilder::PARAM_INT))// +1 for the leading slash
+                );
+                $query->update('filecache')
+                    ->set('storage', $query->createNamedParameter($targetStorageId, IQueryBuilder::PARAM_INT))
+                    ->set('path_hash', $fun->md5($newPathFunction))
+                    ->set('path', $newPathFunction)
+                    ->where($query->expr()->eq('storage', $query->createNamedParameter($sourceStorageId, IQueryBuilder::PARAM_INT)))
+                    ->andWhere($query->expr()->like('path', $query->createNamedParameter($this->connection->escapeLikeParameter($sourcePath) . '/%')));
+
+                try {
+                    $query->execute();
+                } catch (\OC\DatabaseException $e) {
+                    $this->connection->rollBack();
+                    throw $e;
+                }
+            }
+
+            $query = $this->getQueryBuilder();
+            $query->update('filecache')
+                ->set('storage', $query->createNamedParameter($targetStorageId))
+                ->set('path', $query->createNamedParameter($targetPath))
+                ->set('path_hash', $query->createNamedParameter(md5($targetPath)))
+                ->set('name', $query->createNamedParameter(basename($targetPath)))
+                ->set('parent', $query->createNamedParameter($newParentId, IQueryBuilder::PARAM_INT))
+                ->whereFileId($sourceId);
+            $query->execute();
+
+            $this->connection->commit();
+        } else {
+            $this->moveFromCacheFallback($sourceCache, $sourcePath, $targetPath);
+        }
+    }
+
+    /**
+     * remove all entries for files that are stored on the storage from the cache
+     */
+    public function clear() {
+        $query = $this->getQueryBuilder();
+        $query->delete('filecache')
+            ->whereStorageId();
+        $query->execute();
+
+        $query = $this->connection->getQueryBuilder();
+        $query->delete('storages')
+            ->where($query->expr()->eq('id', $query->createNamedParameter($this->storageId)));
+        $query->execute();
+    }
+
+    /**
+     * Get the scan status of a file
+     *
+     * - Cache::NOT_FOUND: File is not in the cache
+     * - Cache::PARTIAL: File is not stored in the cache but some incomplete data is known
+     * - Cache::SHALLOW: The folder and it's direct children are in the cache but not all sub folders are fully scanned
+     * - Cache::COMPLETE: The file or folder, with all it's children) are fully scanned
+     *
+     * @param string $file
+     *
+     * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
+     */
+    public function getStatus($file) {
+        // normalize file
+        $file = $this->normalize($file);
+
+        $query = $this->getQueryBuilder();
+        $query->select('size')
+            ->from('filecache')
+            ->whereStorageId()
+            ->wherePath($file);
+        $size = $query->execute()->fetchColumn();
+        if ($size !== false) {
+            if ((int)$size === -1) {
+                return self::SHALLOW;
+            } else {
+                return self::COMPLETE;
+            }
+        } else {
+            if (isset($this->partial[$file])) {
+                return self::PARTIAL;
+            } else {
+                return self::NOT_FOUND;
+            }
+        }
+    }
+
+    /**
+     * search for files matching $pattern
+     *
+     * @param string $pattern the search pattern using SQL search syntax (e.g. '%searchstring%')
+     * @return ICacheEntry[] an array of cache entries where the name matches the search pattern
+     */
+    public function search($pattern) {
+        // normalize pattern
+        $pattern = $this->normalize($pattern);
+
+        if ($pattern === '%%') {
+            return [];
+        }
+
+        $query = $this->getQueryBuilder();
+        $query->selectFileCache()
+            ->whereStorageId()
+            ->andWhere($query->expr()->iLike('name', $query->createNamedParameter($pattern)));
+
+        return array_map(function (array $data) {
+            return self::cacheEntryFromData($data, $this->mimetypeLoader);
+        }, $query->execute()->fetchAll());
+    }
+
+    /**
+     * @param Statement $result
+     * @return CacheEntry[]
+     */
+    private function searchResultToCacheEntries(Statement $result) {
+        $files = $result->fetchAll();
+
+        return array_map(function (array $data) {
+            return self::cacheEntryFromData($data, $this->mimetypeLoader);
+        }, $files);
+    }
+
+    /**
+     * search for files by mimetype
+     *
+     * @param string $mimetype either a full mimetype to search ('text/plain') or only the first part of a mimetype ('image')
+     *        where it will search for all mimetypes in the group ('image/*')
+     * @return ICacheEntry[] an array of cache entries where the mimetype matches the search
+     */
+    public function searchByMime($mimetype) {
+        $mimeId = $this->mimetypeLoader->getId($mimetype);
+
+        $query = $this->getQueryBuilder();
+        $query->selectFileCache()
+            ->whereStorageId();
+
+        if (strpos($mimetype, '/')) {
+            $query->andWhere($query->expr()->eq('mimetype', $query->createNamedParameter($mimeId, IQueryBuilder::PARAM_INT)));
+        } else {
+            $query->andWhere($query->expr()->eq('mimepart', $query->createNamedParameter($mimeId, IQueryBuilder::PARAM_INT)));
+        }
+
+        return array_map(function (array $data) {
+            return self::cacheEntryFromData($data, $this->mimetypeLoader);
+        }, $query->execute()->fetchAll());
+    }
+
+    public function searchQuery(ISearchQuery $searchQuery) {
+        $builder = $this->getQueryBuilder();
+
+        $query = $builder->selectFileCache('file');
+
+        $query->whereStorageId();
+
+        if ($this->querySearchHelper->shouldJoinTags($searchQuery->getSearchOperation())) {
+            $query
+                ->innerJoin('file', 'vcategory_to_object', 'tagmap', $builder->expr()->eq('file.fileid', 'tagmap.objid'))
+                ->innerJoin('tagmap', 'vcategory', 'tag', $builder->expr()->andX(
+                    $builder->expr()->eq('tagmap.type', 'tag.type'),
+                    $builder->expr()->eq('tagmap.categoryid', 'tag.id')
+                ))
+                ->andWhere($builder->expr()->eq('tag.type', $builder->createNamedParameter('files')))
+                ->andWhere($builder->expr()->eq('tag.uid', $builder->createNamedParameter($searchQuery->getUser()->getUID())));
+        }
+
+        $searchExpr = $this->querySearchHelper->searchOperatorToDBExpr($builder, $searchQuery->getSearchOperation());
+        if ($searchExpr) {
+            $query->andWhere($searchExpr);
+        }
+
+        if ($searchQuery->limitToHome() && ($this instanceof HomeCache)) {
+            $query->andWhere($builder->expr()->like('path', $query->expr()->literal('files/%')));
+        }
+
+        $this->querySearchHelper->addSearchOrdersToQuery($query, $searchQuery->getOrder());
+
+        if ($searchQuery->getLimit()) {
+            $query->setMaxResults($searchQuery->getLimit());
+        }
+        if ($searchQuery->getOffset()) {
+            $query->setFirstResult($searchQuery->getOffset());
+        }
+
+        $result = $query->execute();
+        return $this->searchResultToCacheEntries($result);
+    }
+
+    /**
+     * Re-calculate the folder size and the size of all parent folders
+     *
+     * @param string|boolean $path
+     * @param array $data (optional) meta data of the folder
+     */
+    public function correctFolderSize($path, $data = null, $isBackgroundScan = false) {
+        $this->calculateFolderSize($path, $data);
+        if ($path !== '') {
+            $parent = dirname($path);
+            if ($parent === '.' or $parent === '/') {
+                $parent = '';
+            }
+            if ($isBackgroundScan) {
+                $parentData = $this->get($parent);
+                if ($parentData['size'] !== -1 && $this->getIncompleteChildrenCount($parentData['fileid']) === 0) {
+                    $this->correctFolderSize($parent, $parentData, $isBackgroundScan);
+                }
+            } else {
+                $this->correctFolderSize($parent);
+            }
+        }
+    }
+
+    /**
+     * get the incomplete count that shares parent $folder
+     *
+     * @param int $fileId the file id of the folder
+     * @return int
+     */
+    public function getIncompleteChildrenCount($fileId) {
+        if ($fileId > -1) {
+            $query = $this->getQueryBuilder();
+            $query->select($query->func()->count())
+                ->from('filecache')
+                ->whereParent($fileId)
+                ->andWhere($query->expr()->lt('size', $query->createNamedParameter(0, IQueryBuilder::PARAM_INT)));
+
+            return (int)$query->execute()->fetchColumn();
+        }
+        return -1;
+    }
+
+    /**
+     * calculate the size of a folder and set it in the cache
+     *
+     * @param string $path
+     * @param array $entry (optional) meta data of the folder
+     * @return int
+     */
+    public function calculateFolderSize($path, $entry = null) {
+        $totalSize = 0;
+        if (is_null($entry) or !isset($entry['fileid'])) {
+            $entry = $this->get($path);
+        }
+        if (isset($entry['mimetype']) && $entry['mimetype'] === FileInfo::MIMETYPE_FOLDER) {
+            $id = $entry['fileid'];
+
+            $query = $this->getQueryBuilder();
+            $query->selectAlias($query->func()->sum('size'), 'f1')
+                ->selectAlias($query->func()->min('size'), 'f2')
+                ->from('filecache')
+                ->whereStorageId()
+                ->whereParent($id);
+
+            if ($row = $query->execute()->fetch()) {
+                [$sum, $min] = array_values($row);
+                $sum = 0 + $sum;
+                $min = 0 + $min;
+                if ($min === -1) {
+                    $totalSize = $min;
+                } else {
+                    $totalSize = $sum;
+                }
+                if ($entry['size'] !== $totalSize) {
+                    $this->update($id, ['size' => $totalSize]);
+                }
+            }
+        }
+        return $totalSize;
+    }
+
+    /**
+     * get all file ids on the files on the storage
+     *
+     * @return int[]
+     */
+    public function getAll() {
+        $query = $this->getQueryBuilder();
+        $query->select('fileid')
+            ->from('filecache')
+            ->whereStorageId();
+
+        return array_map(function ($id) {
+            return (int)$id;
+        }, $query->execute()->fetchAll(\PDO::FETCH_COLUMN));
+    }
+
+    /**
+     * find a folder in the cache which has not been fully scanned
+     *
+     * If multiple incomplete folders are in the cache, the one with the highest id will be returned,
+     * use the one with the highest id gives the best result with the background scanner, since that is most
+     * likely the folder where we stopped scanning previously
+     *
+     * @return string|bool the path of the folder or false when no folder matched
+     */
+    public function getIncomplete() {
+        $query = $this->getQueryBuilder();
+        $query->select('path')
+            ->from('filecache')
+            ->whereStorageId()
+            ->andWhere($query->expr()->lt('size', $query->createNamedParameter(0, IQueryBuilder::PARAM_INT)))
+            ->orderBy('fileid', 'DESC');
+
+        return $query->execute()->fetchColumn();
+    }
+
+    /**
+     * get the path of a file on this storage by it's file id
+     *
+     * @param int $id the file id of the file or folder to search
+     * @return string|null the path of the file (relative to the storage) or null if a file with the given id does not exists within this cache
+     */
+    public function getPathById($id) {
+        $query = $this->getQueryBuilder();
+        $query->select('path')
+            ->from('filecache')
+            ->whereStorageId()
+            ->whereFileId($id);
+
+        $path = $query->execute()->fetchColumn();
+        return $path === false ? null : $path;
+    }
+
+    /**
+     * get the storage id of the storage for a file and the internal path of the file
+     * unlike getPathById this does not limit the search to files on this storage and
+     * instead does a global search in the cache table
+     *
+     * @param int $id
+     * @return array first element holding the storage id, second the path
+     * @deprecated use getPathById() instead
+     */
+    public static function getById($id) {
+        $query = \OC::$server->getDatabaseConnection()->getQueryBuilder();
+        $query->select('path', 'storage')
+            ->from('filecache')
+            ->where($query->expr()->eq('fileid', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
+        if ($row = $query->execute()->fetch()) {
+            $numericId = $row['storage'];
+            $path = $row['path'];
+        } else {
+            return null;
+        }
+
+        if ($id = Storage::getStorageId($numericId)) {
+            return [$id, $path];
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * normalize the given path
+     *
+     * @param string $path
+     * @return string
+     */
+    public function normalize($path) {
+        return trim(\OC_Util::normalizeUnicode($path), '/');
+    }
 }

lib/private/DB/Adapter.php

Indentation +95 added lines, -95 removed lines

@@ -38,108 +38,108 @@
  */
 class Adapter {
 
-	/**
-	 * @var \OC\DB\Connection $conn
-	 */
-	protected $conn;
+    /**
+     * @var \OC\DB\Connection $conn
+     */
+    protected $conn;
 
-	public function __construct($conn) {
-		$this->conn = $conn;
-	}
+    public function __construct($conn) {
+        $this->conn = $conn;
+    }
 
-	/**
-	 * @param string $table name
-	 * @return int id of last insert statement
-	 */
-	public function lastInsertId($table) {
-		return $this->conn->realLastInsertId($table);
-	}
+    /**
+     * @param string $table name
+     * @return int id of last insert statement
+     */
+    public function lastInsertId($table) {
+        return $this->conn->realLastInsertId($table);
+    }
 
-	/**
-	 * @param string $statement that needs to be changed so the db can handle it
-	 * @return string changed statement
-	 */
-	public function fixupStatement($statement) {
-		return $statement;
-	}
+    /**
+     * @param string $statement that needs to be changed so the db can handle it
+     * @return string changed statement
+     */
+    public function fixupStatement($statement) {
+        return $statement;
+    }
 
-	/**
-	 * Create an exclusive read+write lock on a table
-	 *
-	 * @param string $tableName
-	 * @since 9.1.0
-	 */
-	public function lockTable($tableName) {
-		$this->conn->beginTransaction();
-		$this->conn->executeUpdate('LOCK TABLE `' .$tableName . '` IN EXCLUSIVE MODE');
-	}
+    /**
+     * Create an exclusive read+write lock on a table
+     *
+     * @param string $tableName
+     * @since 9.1.0
+     */
+    public function lockTable($tableName) {
+        $this->conn->beginTransaction();
+        $this->conn->executeUpdate('LOCK TABLE `' .$tableName . '` IN EXCLUSIVE MODE');
+    }
 
-	/**
-	 * Release a previous acquired lock again
-	 *
-	 * @since 9.1.0
-	 */
-	public function unlockTable() {
-		$this->conn->commit();
-	}
+    /**
+     * Release a previous acquired lock again
+     *
+     * @since 9.1.0
+     */
+    public function unlockTable() {
+        $this->conn->commit();
+    }
 
-	/**
-	 * Insert a row if the matching row does not exists. To accomplish proper race condition avoidance
-	 * it is needed that there is also a unique constraint on the values. Then this method will
-	 * catch the exception and return 0.
-	 *
-	 * @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
-	 * @deprecated 15.0.0 - use unique index and "try { $db->insert() } catch (UniqueConstraintViolationException $e) {}" instead, because it is more reliable and does not have the risk for deadlocks - see https://github.com/nextcloud/server/pull/12371
-	 */
-	public function insertIfNotExist($table, $input, array $compare = null) {
-		if (empty($compare)) {
-			$compare = array_keys($input);
-		}
-		$query = 'INSERT INTO `' .$table . '` (`'
-			. implode('`,`', array_keys($input)) . '`) SELECT '
-			. str_repeat('?,', count($input)-1).'? ' // Is there a prettier alternative?
-			. 'FROM `' . $table . '` WHERE ';
+    /**
+     * Insert a row if the matching row does not exists. To accomplish proper race condition avoidance
+     * it is needed that there is also a unique constraint on the values. Then this method will
+     * catch the exception and return 0.
+     *
+     * @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
+     * @deprecated 15.0.0 - use unique index and "try { $db->insert() } catch (UniqueConstraintViolationException $e) {}" instead, because it is more reliable and does not have the risk for deadlocks - see https://github.com/nextcloud/server/pull/12371
+     */
+    public function insertIfNotExist($table, $input, array $compare = null) {
+        if (empty($compare)) {
+            $compare = array_keys($input);
+        }
+        $query = 'INSERT INTO `' .$table . '` (`'
+            . implode('`,`', array_keys($input)) . '`) SELECT '
+            . str_repeat('?,', count($input)-1).'? ' // Is there a prettier alternative?
+            . 'FROM `' . $table . '` WHERE ';
 
-		$inserts = array_values($input);
-		foreach ($compare as $key) {
-			$query .= '`' . $key . '`';
-			if (is_null($input[$key])) {
-				$query .= ' IS NULL AND ';
-			} else {
-				$inserts[] = $input[$key];
-				$query .= ' = ? AND ';
-			}
-		}
-		$query = substr($query, 0, -5);
-		$query .= ' HAVING COUNT(*) = 0';
+        $inserts = array_values($input);
+        foreach ($compare as $key) {
+            $query .= '`' . $key . '`';
+            if (is_null($input[$key])) {
+                $query .= ' IS NULL AND ';
+            } else {
+                $inserts[] = $input[$key];
+                $query .= ' = ? AND ';
+            }
+        }
+        $query = substr($query, 0, -5);
+        $query .= ' HAVING COUNT(*) = 0';
 
-		try {
-			return $this->conn->executeUpdate($query, $inserts);
-		} catch (UniqueConstraintViolationException $e) {
-			// if this is thrown then a concurrent insert happened between the insert and the sub-select in the insert, that should have avoided it
-			// it's fine to ignore this then
-			//
-			// more discussions about this can be found at https://github.com/nextcloud/server/pull/12315
-			return 0;
-		}
-	}
+        try {
+            return $this->conn->executeUpdate($query, $inserts);
+        } catch (UniqueConstraintViolationException $e) {
+            // if this is thrown then a concurrent insert happened between the insert and the sub-select in the insert, that should have avoided it
+            // it's fine to ignore this then
+            //
+            // more discussions about this can be found at https://github.com/nextcloud/server/pull/12315
+            return 0;
+        }
+    }
 
-	public function insertIgnoreConflict(string $table,array $values) : int {
-		try {
-			$builder = $this->conn->getQueryBuilder();
-			$builder->insert($table);
-			foreach ($values as $key => $value) {
-				$builder->setValue($key, $builder->createNamedParameter($value));
-			}
-			return $builder->execute();
-		} catch (UniqueConstraintViolationException $e) {
-			return 0;
-		}
-	}
+    public function insertIgnoreConflict(string $table,array $values) : int {
+        try {
+            $builder = $this->conn->getQueryBuilder();
+            $builder->insert($table);
+            foreach ($values as $key => $value) {
+                $builder->setValue($key, $builder->createNamedParameter($value));
+            }
+            return $builder->execute();
+        } catch (UniqueConstraintViolationException $e) {
+            return 0;
+        }
+    }
 }

Spacing +7 added lines, -7 removed lines

@@ -71,7 +71,7 @@ 
 	 */
 	public function lockTable($tableName) {
 		$this->conn->beginTransaction();
-		$this->conn->executeUpdate('LOCK TABLE `' .$tableName . '` IN EXCLUSIVE MODE');
+		$this->conn->executeUpdate('LOCK TABLE `'.$tableName.'` IN EXCLUSIVE MODE');
 	}
 
 	/**
@@ -101,14 +101,14 @@ 
 		if (empty($compare)) {
 			$compare = array_keys($input);
 		}
-		$query = 'INSERT INTO `' .$table . '` (`'
-			. implode('`,`', array_keys($input)) . '`) SELECT '
-			. str_repeat('?,', count($input)-1).'? ' // Is there a prettier alternative?
-			. 'FROM `' . $table . '` WHERE ';
+		$query = 'INSERT INTO `'.$table.'` (`'
+			. implode('`,`', array_keys($input)).'`) SELECT '
+			. str_repeat('?,', count($input) - 1).'? ' // Is there a prettier alternative?
+			. 'FROM `'.$table.'` WHERE ';
 
 		$inserts = array_values($input);
 		foreach ($compare as $key) {
-			$query .= '`' . $key . '`';
+			$query .= '`'.$key.'`';
 			if (is_null($input[$key])) {
 				$query .= ' IS NULL AND ';
 			} else {
@@ -130,7 +130,7 @@ 
 		}
 	}
 
-	public function insertIgnoreConflict(string $table,array $values) : int {
+	public function insertIgnoreConflict(string $table, array $values) : int {
 		try {
 			$builder = $this->conn->getQueryBuilder();
 			$builder->insert($table);

lib/private/DB/Connection.php

Indentation +402 added lines, -402 removed lines

@@ -47,406 +47,406 @@
 use OCP\PreConditionNotMetException;
 
 class Connection extends ReconnectWrapper implements IDBConnection {
-	/**
-	 * @var string $tablePrefix
-	 */
-	protected $tablePrefix;
-
-	/**
-	 * @var \OC\DB\Adapter $adapter
-	 */
-	protected $adapter;
-
-	protected $lockedTable = null;
-
-	public function connect() {
-		try {
-			return parent::connect();
-		} catch (DBALException $e) {
-			// throw a new exception to prevent leaking info from the stacktrace
-			throw new DBALException('Failed to connect to the database: ' . $e->getMessage(), $e->getCode());
-		}
-	}
-
-	/**
-	 * Returns a QueryBuilder for the connection.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder
-	 */
-	public function getQueryBuilder() {
-		return new QueryBuilder(
-			$this,
-			\OC::$server->getSystemConfig(),
-			\OC::$server->getLogger()
-		);
-	}
-
-	/**
-	 * Gets the QueryBuilder for the connection.
-	 *
-	 * @return \Doctrine\DBAL\Query\QueryBuilder
-	 * @deprecated please use $this->getQueryBuilder() instead
-	 */
-	public function createQueryBuilder() {
-		$backtrace = $this->getCallerBacktrace();
-		\OC::$server->getLogger()->debug('Doctrine QueryBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
-		return parent::createQueryBuilder();
-	}
-
-	/**
-	 * Gets the ExpressionBuilder for the connection.
-	 *
-	 * @return \Doctrine\DBAL\Query\Expression\ExpressionBuilder
-	 * @deprecated please use $this->getQueryBuilder()->expr() instead
-	 */
-	public function getExpressionBuilder() {
-		$backtrace = $this->getCallerBacktrace();
-		\OC::$server->getLogger()->debug('Doctrine ExpressionBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
-		return parent::getExpressionBuilder();
-	}
-
-	/**
-	 * Get the file and line that called the method where `getCallerBacktrace()` was used
-	 *
-	 * @return string
-	 */
-	protected function getCallerBacktrace() {
-		$traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
-
-		// 0 is the method where we use `getCallerBacktrace`
-		// 1 is the target method which uses the method we want to log
-		if (isset($traces[1])) {
-			return $traces[1]['file'] . ':' . $traces[1]['line'];
-		}
-
-		return '';
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getPrefix() {
-		return $this->tablePrefix;
-	}
-
-	/**
-	 * Initializes a new instance of the Connection class.
-	 *
-	 * @param array $params  The connection parameters.
-	 * @param \Doctrine\DBAL\Driver $driver
-	 * @param \Doctrine\DBAL\Configuration $config
-	 * @param \Doctrine\Common\EventManager $eventManager
-	 * @throws \Exception
-	 */
-	public function __construct(array $params, Driver $driver, Configuration $config = null,
-		EventManager $eventManager = null) {
-		if (!isset($params['adapter'])) {
-			throw new \Exception('adapter not set');
-		}
-		if (!isset($params['tablePrefix'])) {
-			throw new \Exception('tablePrefix not set');
-		}
-		parent::__construct($params, $driver, $config, $eventManager);
-		$this->adapter = new $params['adapter']($this);
-		$this->tablePrefix = $params['tablePrefix'];
-	}
-
-	/**
-	 * 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);
-
-		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 = [], $types = [], 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 $types = []) {
-		$query = $this->replaceTablePrefix($query);
-		$query = $this->adapter->fixupStatement($query);
-		return parent::executeUpdate($query, $params, $types);
-	}
-
-	/**
-	 * Returns the ID of the last inserted row, or the last value from a sequence object,
-	 * depending on the underlying driver.
-	 *
-	 * Note: This method may not return a meaningful or consistent result across different drivers,
-	 * because the underlying database may not even support the notion of AUTO_INCREMENT/IDENTITY
-	 * columns or sequences.
-	 *
-	 * @param string $seqName Name of the sequence object from which the ID should be returned.
-	 * @return string A string representation of the last inserted ID.
-	 */
-	public function lastInsertId($seqName = null) {
-		if ($seqName) {
-			$seqName = $this->replaceTablePrefix($seqName);
-		}
-		return $this->adapter->lastInsertId($seqName);
-	}
-
-	// internal use
-	public function realLastInsertId($seqName = null) {
-		return parent::lastInsertId($seqName);
-	}
-
-	/**
-	 * Insert a row if the matching row does not exists. To accomplish proper race condition avoidance
-	 * it is needed that there is also a unique constraint on the values. Then this method will
-	 * catch the exception and return 0.
-	 *
-	 * @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
-	 * @deprecated 15.0.0 - use unique index and "try { $db->insert() } catch (UniqueConstraintViolationException $e) {}" instead, because it is more reliable and does not have the risk for deadlocks - see https://github.com/nextcloud/server/pull/12371
-	 */
-	public function insertIfNotExist($table, $input, array $compare = null) {
-		return $this->adapter->insertIfNotExist($table, $input, $compare);
-	}
-
-	public function insertIgnoreConflict(string $table, array $values) : int {
-		return $this->adapter->insertIgnoreConflict($table, $values);
-	}
-
-	private function getType($value) {
-		if (is_bool($value)) {
-			return IQueryBuilder::PARAM_BOOL;
-		} elseif (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 (ConstraintViolationException $e) {
-			// value already exists, try update
-			$updateQb = $this->getQueryBuilder();
-			$updateQb->update($table);
-			foreach ($values as $name => $value) {
-				$updateQb->set($name, $updateQb->createNamedParameter($value, $this->getType($value)));
-			}
-			$where = $updateQb->expr()->andX();
-			$whereValues = array_merge($keys, $updatePreconditionValues);
-			foreach ($whereValues as $name => $value) {
-				$where->add($updateQb->expr()->eq(
-					$name,
-					$updateQb->createNamedParameter($value, $this->getType($value)),
-					$this->getType($value)
-				));
-			}
-			$updateQb->where($where);
-			$affected = $updateQb->execute();
-
-			if ($affected === 0 && !empty($updatePreconditionValues)) {
-				throw new PreConditionNotMetException();
-			}
-
-			return 0;
-		}
-	}
-
-	/**
-	 * Create an exclusive read+write lock on a table
-	 *
-	 * @param string $tableName
-	 * @throws \BadMethodCallException When trying to acquire a second lock
-	 * @since 9.1.0
-	 */
-	public function lockTable($tableName) {
-		if ($this->lockedTable !== null) {
-			throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
-		}
-
-		$tableName = $this->tablePrefix . $tableName;
-		$this->lockedTable = $tableName;
-		$this->adapter->lockTable($tableName);
-	}
-
-	/**
-	 * Release a previous acquired lock again
-	 *
-	 * @since 9.1.0
-	 */
-	public function unlockTable() {
-		$this->adapter->unlockTable();
-		$this->lockedTable = null;
-	}
-
-	/**
-	 * returns the error code and message as a string for logging
-	 * works with DoctrineException
-	 * @return string
-	 */
-	public function getError() {
-		$msg = $this->errorCode() . ': ';
-		$errorInfo = $this->errorInfo();
-		if (is_array($errorInfo)) {
-			$msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
-			$msg .= 'Driver Code = '.$errorInfo[1] . ', ';
-			$msg .= 'Driver Message = '.$errorInfo[2];
-		}
-		return $msg;
-	}
-
-	/**
-	 * Drop a table from the database if it exists
-	 *
-	 * @param string $table table name without the prefix
-	 */
-	public function dropTable($table) {
-		$table = $this->tablePrefix . trim($table);
-		$schema = $this->getSchemaManager();
-		if ($schema->tablesExist([$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([$table]);
-	}
-
-	// internal use
-	/**
-	 * @param string $statement
-	 * @return string
-	 */
-	protected function replaceTablePrefix($statement) {
-		return str_replace('*PREFIX*', $this->tablePrefix, $statement);
-	}
-
-	/**
-	 * Check if a transaction is active
-	 *
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function inTransaction() {
-		return $this->getTransactionNestingLevel() > 0;
-	}
-
-	/**
-	 * Escape a parameter to be used in a LIKE query
-	 *
-	 * @param string $param
-	 * @return string
-	 */
-	public function escapeLikeParameter($param) {
-		return addcslashes($param, '\\_%');
-	}
-
-	/**
-	 * Check whether or not the current database support 4byte wide unicode
-	 *
-	 * @return bool
-	 * @since 11.0.0
-	 */
-	public function supports4ByteText() {
-		if (!$this->getDatabasePlatform() instanceof MySqlPlatform) {
-			return true;
-		}
-		return $this->getParams()['charset'] === 'utf8mb4';
-	}
-
-
-	/**
-	 * Create the schema of the connected database
-	 *
-	 * @return Schema
-	 */
-	public function createSchema() {
-		$schemaManager = new MDB2SchemaManager($this);
-		$migrator = $schemaManager->getMigrator();
-		return $migrator->createSchema();
-	}
-
-	/**
-	 * Migrate the database to the given schema
-	 *
-	 * @param Schema $toSchema
-	 */
-	public function migrateToSchema(Schema $toSchema) {
-		$schemaManager = new MDB2SchemaManager($this);
-		$migrator = $schemaManager->getMigrator();
-		$migrator->migrate($toSchema);
-	}
+    /**
+     * @var string $tablePrefix
+     */
+    protected $tablePrefix;
+
+    /**
+     * @var \OC\DB\Adapter $adapter
+     */
+    protected $adapter;
+
+    protected $lockedTable = null;
+
+    public function connect() {
+        try {
+            return parent::connect();
+        } catch (DBALException $e) {
+            // throw a new exception to prevent leaking info from the stacktrace
+            throw new DBALException('Failed to connect to the database: ' . $e->getMessage(), $e->getCode());
+        }
+    }
+
+    /**
+     * Returns a QueryBuilder for the connection.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder
+     */
+    public function getQueryBuilder() {
+        return new QueryBuilder(
+            $this,
+            \OC::$server->getSystemConfig(),
+            \OC::$server->getLogger()
+        );
+    }
+
+    /**
+     * Gets the QueryBuilder for the connection.
+     *
+     * @return \Doctrine\DBAL\Query\QueryBuilder
+     * @deprecated please use $this->getQueryBuilder() instead
+     */
+    public function createQueryBuilder() {
+        $backtrace = $this->getCallerBacktrace();
+        \OC::$server->getLogger()->debug('Doctrine QueryBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
+        return parent::createQueryBuilder();
+    }
+
+    /**
+     * Gets the ExpressionBuilder for the connection.
+     *
+     * @return \Doctrine\DBAL\Query\Expression\ExpressionBuilder
+     * @deprecated please use $this->getQueryBuilder()->expr() instead
+     */
+    public function getExpressionBuilder() {
+        $backtrace = $this->getCallerBacktrace();
+        \OC::$server->getLogger()->debug('Doctrine ExpressionBuilder retrieved in {backtrace}', ['app' => 'core', 'backtrace' => $backtrace]);
+        return parent::getExpressionBuilder();
+    }
+
+    /**
+     * Get the file and line that called the method where `getCallerBacktrace()` was used
+     *
+     * @return string
+     */
+    protected function getCallerBacktrace() {
+        $traces = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
+
+        // 0 is the method where we use `getCallerBacktrace`
+        // 1 is the target method which uses the method we want to log
+        if (isset($traces[1])) {
+            return $traces[1]['file'] . ':' . $traces[1]['line'];
+        }
+
+        return '';
+    }
+
+    /**
+     * @return string
+     */
+    public function getPrefix() {
+        return $this->tablePrefix;
+    }
+
+    /**
+     * Initializes a new instance of the Connection class.
+     *
+     * @param array $params  The connection parameters.
+     * @param \Doctrine\DBAL\Driver $driver
+     * @param \Doctrine\DBAL\Configuration $config
+     * @param \Doctrine\Common\EventManager $eventManager
+     * @throws \Exception
+     */
+    public function __construct(array $params, Driver $driver, Configuration $config = null,
+        EventManager $eventManager = null) {
+        if (!isset($params['adapter'])) {
+            throw new \Exception('adapter not set');
+        }
+        if (!isset($params['tablePrefix'])) {
+            throw new \Exception('tablePrefix not set');
+        }
+        parent::__construct($params, $driver, $config, $eventManager);
+        $this->adapter = new $params['adapter']($this);
+        $this->tablePrefix = $params['tablePrefix'];
+    }
+
+    /**
+     * 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);
+
+        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 = [], $types = [], 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 $types = []) {
+        $query = $this->replaceTablePrefix($query);
+        $query = $this->adapter->fixupStatement($query);
+        return parent::executeUpdate($query, $params, $types);
+    }
+
+    /**
+     * Returns the ID of the last inserted row, or the last value from a sequence object,
+     * depending on the underlying driver.
+     *
+     * Note: This method may not return a meaningful or consistent result across different drivers,
+     * because the underlying database may not even support the notion of AUTO_INCREMENT/IDENTITY
+     * columns or sequences.
+     *
+     * @param string $seqName Name of the sequence object from which the ID should be returned.
+     * @return string A string representation of the last inserted ID.
+     */
+    public function lastInsertId($seqName = null) {
+        if ($seqName) {
+            $seqName = $this->replaceTablePrefix($seqName);
+        }
+        return $this->adapter->lastInsertId($seqName);
+    }
+
+    // internal use
+    public function realLastInsertId($seqName = null) {
+        return parent::lastInsertId($seqName);
+    }
+
+    /**
+     * Insert a row if the matching row does not exists. To accomplish proper race condition avoidance
+     * it is needed that there is also a unique constraint on the values. Then this method will
+     * catch the exception and return 0.
+     *
+     * @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
+     * @deprecated 15.0.0 - use unique index and "try { $db->insert() } catch (UniqueConstraintViolationException $e) {}" instead, because it is more reliable and does not have the risk for deadlocks - see https://github.com/nextcloud/server/pull/12371
+     */
+    public function insertIfNotExist($table, $input, array $compare = null) {
+        return $this->adapter->insertIfNotExist($table, $input, $compare);
+    }
+
+    public function insertIgnoreConflict(string $table, array $values) : int {
+        return $this->adapter->insertIgnoreConflict($table, $values);
+    }
+
+    private function getType($value) {
+        if (is_bool($value)) {
+            return IQueryBuilder::PARAM_BOOL;
+        } elseif (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 (ConstraintViolationException $e) {
+            // value already exists, try update
+            $updateQb = $this->getQueryBuilder();
+            $updateQb->update($table);
+            foreach ($values as $name => $value) {
+                $updateQb->set($name, $updateQb->createNamedParameter($value, $this->getType($value)));
+            }
+            $where = $updateQb->expr()->andX();
+            $whereValues = array_merge($keys, $updatePreconditionValues);
+            foreach ($whereValues as $name => $value) {
+                $where->add($updateQb->expr()->eq(
+                    $name,
+                    $updateQb->createNamedParameter($value, $this->getType($value)),
+                    $this->getType($value)
+                ));
+            }
+            $updateQb->where($where);
+            $affected = $updateQb->execute();
+
+            if ($affected === 0 && !empty($updatePreconditionValues)) {
+                throw new PreConditionNotMetException();
+            }
+
+            return 0;
+        }
+    }
+
+    /**
+     * Create an exclusive read+write lock on a table
+     *
+     * @param string $tableName
+     * @throws \BadMethodCallException When trying to acquire a second lock
+     * @since 9.1.0
+     */
+    public function lockTable($tableName) {
+        if ($this->lockedTable !== null) {
+            throw new \BadMethodCallException('Can not lock a new table until the previous lock is released.');
+        }
+
+        $tableName = $this->tablePrefix . $tableName;
+        $this->lockedTable = $tableName;
+        $this->adapter->lockTable($tableName);
+    }
+
+    /**
+     * Release a previous acquired lock again
+     *
+     * @since 9.1.0
+     */
+    public function unlockTable() {
+        $this->adapter->unlockTable();
+        $this->lockedTable = null;
+    }
+
+    /**
+     * returns the error code and message as a string for logging
+     * works with DoctrineException
+     * @return string
+     */
+    public function getError() {
+        $msg = $this->errorCode() . ': ';
+        $errorInfo = $this->errorInfo();
+        if (is_array($errorInfo)) {
+            $msg .= 'SQLSTATE = '.$errorInfo[0] . ', ';
+            $msg .= 'Driver Code = '.$errorInfo[1] . ', ';
+            $msg .= 'Driver Message = '.$errorInfo[2];
+        }
+        return $msg;
+    }
+
+    /**
+     * Drop a table from the database if it exists
+     *
+     * @param string $table table name without the prefix
+     */
+    public function dropTable($table) {
+        $table = $this->tablePrefix . trim($table);
+        $schema = $this->getSchemaManager();
+        if ($schema->tablesExist([$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([$table]);
+    }
+
+    // internal use
+    /**
+     * @param string $statement
+     * @return string
+     */
+    protected function replaceTablePrefix($statement) {
+        return str_replace('*PREFIX*', $this->tablePrefix, $statement);
+    }
+
+    /**
+     * Check if a transaction is active
+     *
+     * @return bool
+     * @since 8.2.0
+     */
+    public function inTransaction() {
+        return $this->getTransactionNestingLevel() > 0;
+    }
+
+    /**
+     * Escape a parameter to be used in a LIKE query
+     *
+     * @param string $param
+     * @return string
+     */
+    public function escapeLikeParameter($param) {
+        return addcslashes($param, '\\_%');
+    }
+
+    /**
+     * Check whether or not the current database support 4byte wide unicode
+     *
+     * @return bool
+     * @since 11.0.0
+     */
+    public function supports4ByteText() {
+        if (!$this->getDatabasePlatform() instanceof MySqlPlatform) {
+            return true;
+        }
+        return $this->getParams()['charset'] === 'utf8mb4';
+    }
+
+
+    /**
+     * Create the schema of the connected database
+     *
+     * @return Schema
+     */
+    public function createSchema() {
+        $schemaManager = new MDB2SchemaManager($this);
+        $migrator = $schemaManager->getMigrator();
+        return $migrator->createSchema();
+    }
+
+    /**
+     * Migrate the database to the given schema
+     *
+     * @param Schema $toSchema
+     */
+    public function migrateToSchema(Schema $toSchema) {
+        $schemaManager = new MDB2SchemaManager($this);
+        $migrator = $schemaManager->getMigrator();
+        $migrator->migrate($toSchema);
+    }
 }

lib/private/DB/AdapterPgSql.php

Indentation +32 added lines, -32 removed lines

@@ -28,43 +28,43 @@
 namespace OC\DB;
 
 class AdapterPgSql extends Adapter {
-	protected $compatModePre9_5 = null;
+    protected $compatModePre9_5 = null;
 
-	public function lastInsertId($table) {
-		return $this->conn->fetchColumn('SELECT lastval()');
-	}
+    public function lastInsertId($table) {
+        return $this->conn->fetchColumn('SELECT lastval()');
+    }
 
-	public const UNIX_TIMESTAMP_REPLACEMENT = 'cast(extract(epoch from current_timestamp) as integer)';
-	public function fixupStatement($statement) {
-		$statement = str_replace('`', '"', $statement);
-		$statement = str_ireplace('UNIX_TIMESTAMP()', self::UNIX_TIMESTAMP_REPLACEMENT, $statement);
-		return $statement;
-	}
+    public const UNIX_TIMESTAMP_REPLACEMENT = 'cast(extract(epoch from current_timestamp) as integer)';
+    public function fixupStatement($statement) {
+        $statement = str_replace('`', '"', $statement);
+        $statement = str_ireplace('UNIX_TIMESTAMP()', self::UNIX_TIMESTAMP_REPLACEMENT, $statement);
+        return $statement;
+    }
 
-	public function insertIgnoreConflict(string $table,array $values) : int {
-		if ($this->isPre9_5CompatMode() === true) {
-			return parent::insertIgnoreConflict($table, $values);
-		}
+    public function insertIgnoreConflict(string $table,array $values) : int {
+        if ($this->isPre9_5CompatMode() === true) {
+            return parent::insertIgnoreConflict($table, $values);
+        }
 
-		// "upsert" is only available since PgSQL 9.5, but the generic way
-		// would leave error logs in the DB.
-		$builder = $this->conn->getQueryBuilder();
-		$builder->insert($table);
-		foreach ($values as $key => $value) {
-			$builder->setValue($key, $builder->createNamedParameter($value));
-		}
-		$queryString = $builder->getSQL() . ' ON CONFLICT DO NOTHING';
-		return $this->conn->executeUpdate($queryString, $builder->getParameters(), $builder->getParameterTypes());
-	}
+        // "upsert" is only available since PgSQL 9.5, but the generic way
+        // would leave error logs in the DB.
+        $builder = $this->conn->getQueryBuilder();
+        $builder->insert($table);
+        foreach ($values as $key => $value) {
+            $builder->setValue($key, $builder->createNamedParameter($value));
+        }
+        $queryString = $builder->getSQL() . ' ON CONFLICT DO NOTHING';
+        return $this->conn->executeUpdate($queryString, $builder->getParameters(), $builder->getParameterTypes());
+    }
 
-	protected function isPre9_5CompatMode(): bool {
-		if ($this->compatModePre9_5 !== null) {
-			return $this->compatModePre9_5;
-		}
+    protected function isPre9_5CompatMode(): bool {
+        if ($this->compatModePre9_5 !== null) {
+            return $this->compatModePre9_5;
+        }
 
-		$version = $this->conn->fetchColumn('SHOW SERVER_VERSION');
-		$this->compatModePre9_5 = version_compare($version, '9.5', '<');
+        $version = $this->conn->fetchColumn('SHOW SERVER_VERSION');
+        $this->compatModePre9_5 = version_compare($version, '9.5', '<');
 
-		return $this->compatModePre9_5;
-	}
+        return $this->compatModePre9_5;
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -41,7 +41,7 @@ 
 		return $statement;
 	}
 
-	public function insertIgnoreConflict(string $table,array $values) : int {
+	public function insertIgnoreConflict(string $table, array $values) : int {
 		if ($this->isPre9_5CompatMode() === true) {
 			return parent::insertIgnoreConflict($table, $values);
 		}
@@ -53,7 +53,7 @@ 
 		foreach ($values as $key => $value) {
 			$builder->setValue($key, $builder->createNamedParameter($value));
 		}
-		$queryString = $builder->getSQL() . ' ON CONFLICT DO NOTHING';
+		$queryString = $builder->getSQL().' ON CONFLICT DO NOTHING';
 		return $this->conn->executeUpdate($queryString, $builder->getParameters(), $builder->getParameterTypes());
 	}
 

lib/private/Repair/RepairInvalidShares.php

Indentation +85 added lines, -85 removed lines

@@ -33,89 +33,89 @@
  * Repairs shares with invalid data
  */
 class RepairInvalidShares implements IRepairStep {
-	public const CHUNK_SIZE = 200;
-
-	/** @var \OCP\IConfig */
-	protected $config;
-
-	/** @var \OCP\IDBConnection */
-	protected $connection;
-
-	/**
-	 * @param \OCP\IConfig $config
-	 * @param \OCP\IDBConnection $connection
-	 */
-	public function __construct($config, $connection) {
-		$this->connection = $connection;
-		$this->config = $config;
-	}
-
-	public function getName() {
-		return 'Repair invalid shares';
-	}
-
-	/**
-	 * Adjust file share permissions
-	 */
-	private function adjustFileSharePermissions(IOutput $out) {
-		$mask = \OCP\Constants::PERMISSION_READ | \OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_SHARE;
-		$builder = $this->connection->getQueryBuilder();
-
-		$permsFunc = $builder->expr()->bitwiseAnd('permissions', $mask);
-		$builder
-			->update('share')
-			->set('permissions', $permsFunc)
-			->where($builder->expr()->eq('item_type', $builder->expr()->literal('file')))
-			->andWhere($builder->expr()->neq('permissions', $permsFunc));
-
-		$updatedEntries = $builder->execute();
-		if ($updatedEntries > 0) {
-			$out->info('Fixed file share permissions for ' . $updatedEntries . ' shares');
-		}
-	}
-
-	/**
-	 * Remove shares where the parent share does not exist anymore
-	 */
-	private function removeSharesNonExistingParent(IOutput $out) {
-		$deletedEntries = 0;
-
-		$query = $this->connection->getQueryBuilder();
-		$query->select('s1.parent')
-			->from('share', 's1')
-			->where($query->expr()->isNotNull('s1.parent'))
-				->andWhere($query->expr()->isNull('s2.id'))
-			->leftJoin('s1', 'share', 's2', $query->expr()->eq('s1.parent', 's2.id'))
-			->groupBy('s1.parent')
-			->setMaxResults(self::CHUNK_SIZE);
-
-		$deleteQuery = $this->connection->getQueryBuilder();
-		$deleteQuery->delete('share')
-			->where($deleteQuery->expr()->eq('parent', $deleteQuery->createParameter('parent')));
-
-		$deletedInLastChunk = self::CHUNK_SIZE;
-		while ($deletedInLastChunk === self::CHUNK_SIZE) {
-			$deletedInLastChunk = 0;
-			$result = $query->execute();
-			while ($row = $result->fetch()) {
-				$deletedInLastChunk++;
-				$deletedEntries += $deleteQuery->setParameter('parent', (int) $row['parent'])
-					->execute();
-			}
-			$result->closeCursor();
-		}
-
-		if ($deletedEntries) {
-			$out->info('Removed ' . $deletedEntries . ' shares where the parent did not exist');
-		}
-	}
-
-	public function run(IOutput $out) {
-		$ocVersionFromBeforeUpdate = $this->config->getSystemValue('version', '0.0.0');
-		if (version_compare($ocVersionFromBeforeUpdate, '12.0.0.11', '<')) {
-			$this->adjustFileSharePermissions($out);
-		}
-
-		$this->removeSharesNonExistingParent($out);
-	}
+    public const CHUNK_SIZE = 200;
+
+    /** @var \OCP\IConfig */
+    protected $config;
+
+    /** @var \OCP\IDBConnection */
+    protected $connection;
+
+    /**
+     * @param \OCP\IConfig $config
+     * @param \OCP\IDBConnection $connection
+     */
+    public function __construct($config, $connection) {
+        $this->connection = $connection;
+        $this->config = $config;
+    }
+
+    public function getName() {
+        return 'Repair invalid shares';
+    }
+
+    /**
+     * Adjust file share permissions
+     */
+    private function adjustFileSharePermissions(IOutput $out) {
+        $mask = \OCP\Constants::PERMISSION_READ | \OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_SHARE;
+        $builder = $this->connection->getQueryBuilder();
+
+        $permsFunc = $builder->expr()->bitwiseAnd('permissions', $mask);
+        $builder
+            ->update('share')
+            ->set('permissions', $permsFunc)
+            ->where($builder->expr()->eq('item_type', $builder->expr()->literal('file')))
+            ->andWhere($builder->expr()->neq('permissions', $permsFunc));
+
+        $updatedEntries = $builder->execute();
+        if ($updatedEntries > 0) {
+            $out->info('Fixed file share permissions for ' . $updatedEntries . ' shares');
+        }
+    }
+
+    /**
+     * Remove shares where the parent share does not exist anymore
+     */
+    private function removeSharesNonExistingParent(IOutput $out) {
+        $deletedEntries = 0;
+
+        $query = $this->connection->getQueryBuilder();
+        $query->select('s1.parent')
+            ->from('share', 's1')
+            ->where($query->expr()->isNotNull('s1.parent'))
+                ->andWhere($query->expr()->isNull('s2.id'))
+            ->leftJoin('s1', 'share', 's2', $query->expr()->eq('s1.parent', 's2.id'))
+            ->groupBy('s1.parent')
+            ->setMaxResults(self::CHUNK_SIZE);
+
+        $deleteQuery = $this->connection->getQueryBuilder();
+        $deleteQuery->delete('share')
+            ->where($deleteQuery->expr()->eq('parent', $deleteQuery->createParameter('parent')));
+
+        $deletedInLastChunk = self::CHUNK_SIZE;
+        while ($deletedInLastChunk === self::CHUNK_SIZE) {
+            $deletedInLastChunk = 0;
+            $result = $query->execute();
+            while ($row = $result->fetch()) {
+                $deletedInLastChunk++;
+                $deletedEntries += $deleteQuery->setParameter('parent', (int) $row['parent'])
+                    ->execute();
+            }
+            $result->closeCursor();
+        }
+
+        if ($deletedEntries) {
+            $out->info('Removed ' . $deletedEntries . ' shares where the parent did not exist');
+        }
+    }
+
+    public function run(IOutput $out) {
+        $ocVersionFromBeforeUpdate = $this->config->getSystemValue('version', '0.0.0');
+        if (version_compare($ocVersionFromBeforeUpdate, '12.0.0.11', '<')) {
+            $this->adjustFileSharePermissions($out);
+        }
+
+        $this->removeSharesNonExistingParent($out);
+    }
 }