nextcloud / server

lib/public/Comments/ICommentsManager.php

Indentation +244 added lines, -244 removed lines

@@ -38,267 +38,267 @@
  */
 interface ICommentsManager {
 
-	/**
-	 * @const DELETED_USER type and id for a user that has been deleted
-	 * @see deleteReferencesOfActor
-	 * @since 9.0.0
-	 *
-	 * To be used as replacement for user type actors in deleteReferencesOfActor().
-	 *
-	 * User interfaces shall show "Deleted user" as display name, if needed.
-	 */
-	const DELETED_USER = 'deleted_users';
+    /**
+     * @const DELETED_USER type and id for a user that has been deleted
+     * @see deleteReferencesOfActor
+     * @since 9.0.0
+     *
+     * To be used as replacement for user type actors in deleteReferencesOfActor().
+     *
+     * User interfaces shall show "Deleted user" as display name, if needed.
+     */
+    const DELETED_USER = 'deleted_users';
 
-	/**
-	 * returns a comment instance
-	 *
-	 * @param string $id the ID of the comment
-	 * @return IComment
-	 * @throws NotFoundException
-	 * @since 9.0.0
-	 */
-	public function get($id);
+    /**
+     * returns a comment instance
+     *
+     * @param string $id the ID of the comment
+     * @return IComment
+     * @throws NotFoundException
+     * @since 9.0.0
+     */
+    public function get($id);
 
-	/**
-	 * returns the comment specified by the id and all it's child comments
-	 *
-	 * @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' =>
-	 *       [
-	 *         0 =>
-	 *         [
-	 *           'comment' => IComment,
-	 *           'replies' => [ … ]
-	 *         ],
-	 *         …
-	 *       ]
-	 *     ]
-	 *     1 =>
-	 *     [
-	 *       'comment' => IComment,
-	 *       'replies'=> [ … ]
-	 *     ],
-	 *     …
-	 *   ]
-	 * ]
-	 */
-	public function getTree($id, $limit = 0, $offset = 0);
+    /**
+     * returns the comment specified by the id and all it's child comments
+     *
+     * @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' =>
+     *       [
+     *         0 =>
+     *         [
+     *           'comment' => IComment,
+     *           'replies' => [ … ]
+     *         ],
+     *         …
+     *       ]
+     *     ]
+     *     1 =>
+     *     [
+     *       'comment' => IComment,
+     *       'replies'=> [ … ]
+     *     ],
+     *     …
+     *   ]
+     * ]
+     */
+    public function getTree($id, $limit = 0, $offset = 0);
 
-	/**
-	 * 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|null $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
-	);
+    /**
+     * 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|null $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
+    );
 
-	/**
-	 * 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
-	 * @return IComment[]
-	 * @since 14.0.0
-	 */
-	public function search(string $search, string $objectType, string $objectId, string $verb): array;
+    /**
+     * 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
+     * @return IComment[]
+     * @since 14.0.0
+     */
+    public function search(string $search, string $objectType, string $objectId, string $verb): array;
 
-	/**
-	 * @param $objectType string the object type, e.g. 'files'
-	 * @param $objectId string the id of the object
-	 * @param \DateTime|null $notOlderThan optional, timestamp of the oldest comments
-	 * that may be returned
-	 * @return Int
-	 * @since 9.0.0
-	 */
-	public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null);
+    /**
+     * @param $objectType string the object type, e.g. 'files'
+     * @param $objectId string the id of the object
+     * @param \DateTime|null $notOlderThan optional, timestamp of the oldest comments
+     * that may be returned
+     * @return Int
+     * @since 9.0.0
+     */
+    public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null);
 
-	/**
-	 * Get the number of unread comments for all files in a folder
-	 *
-	 * @param int $folderId
-	 * @param IUser $user
-	 * @return array [$fileId => $unreadCount]
-	 * @since 12.0.0
-	 */
-	public function getNumberOfUnreadCommentsForFolder($folderId, IUser $user);
+    /**
+     * Get the number of unread comments for all files in a folder
+     *
+     * @param int $folderId
+     * @param IUser $user
+     * @return array [$fileId => $unreadCount]
+     * @since 12.0.0
+     */
+    public function getNumberOfUnreadCommentsForFolder($folderId, IUser $user);
 
-	/**
-	 * 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);
+    /**
+     * 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);
 
-	/**
-	 * 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
-	 * @since 9.0.0
-	 */
-	public function delete($id);
+    /**
+     * 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
+     * @since 9.0.0
+     */
+    public function delete($id);
 
-	/**
-	 * 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);
+    /**
+     * 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);
 
-	/**
-	 * removes references to specific actor (e.g. on user delete) of a comment.
-	 * The comment itself must not get lost/deleted.
-	 *
-	 * A 'users' type actor (type and id) should get replaced by the
-	 * value of the DELETED_USER constant of this interface.
-	 *
-	 * @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);
+    /**
+     * removes references to specific actor (e.g. on user delete) of a comment.
+     * The comment itself must not get lost/deleted.
+     *
+     * A 'users' type actor (type and id) should get replaced by the
+     * value of the DELETED_USER constant of this interface.
+     *
+     * @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);
 
-	/**
-	 * 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);
+    /**
+     * 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);
 
-	/**
-	 * 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 \OCP\IUser $user
-	 * @since 9.0.0
-	 */
-	public function setReadMark($objectType, $objectId, \DateTime $dateTime, \OCP\IUser $user);
+    /**
+     * 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 \OCP\IUser $user
+     * @since 9.0.0
+     */
+    public function setReadMark($objectType, $objectId, \DateTime $dateTime, \OCP\IUser $user);
 
-	/**
-	 * 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 \OCP\IUser $user
-	 * @return \DateTime|null
-	 * @since 9.0.0
-	 */
-	public function getReadMark($objectType, $objectId, \OCP\IUser $user);
+    /**
+     * 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 \OCP\IUser $user
+     * @return \DateTime|null
+     * @since 9.0.0
+     */
+    public function getReadMark($objectType, $objectId, \OCP\IUser $user);
 
-	/**
-	 * deletes the read markers for the specified user
-	 *
-	 * @param \OCP\IUser $user
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function deleteReadMarksFromUser(\OCP\IUser $user);
+    /**
+     * deletes the read markers for the specified user
+     *
+     * @param \OCP\IUser $user
+     * @return bool
+     * @since 9.0.0
+     */
+    public function deleteReadMarksFromUser(\OCP\IUser $user);
 
-	/**
-	 * 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);
+    /**
+     * 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);
 
-	/**
-	 * registers an Entity to the manager, so event notifications can be send
-	 * to consumers of the comments infrastructure
-	 *
-	 * @param \Closure $closure
-	 * @since 11.0.0
-	 */
-	public function registerEventHandler(\Closure $closure);
+    /**
+     * registers an Entity to the manager, so event notifications can be send
+     * to consumers of the comments infrastructure
+     *
+     * @param \Closure $closure
+     * @since 11.0.0
+     */
+    public function registerEventHandler(\Closure $closure);
 
-	/**
-	 * 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);
+    /**
+     * 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);
 
-	/**
-	 * 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);
+    /**
+     * 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);
 
 }

lib/public/Search/Provider.php

Indentation +51 added lines, -51 removed lines

@@ -32,60 +32,60 @@
  */
 abstract class Provider {
 
-	/**
-	 * @since 8.0.0
-	 */
-	const OPTION_APPS = 'apps';
+    /**
+     * @since 8.0.0
+     */
+    const OPTION_APPS = 'apps';
 
-	/**
-	 * List of options
-	 * @var array
-	 * @since 7.0.0
-	 */
-	protected $options;
+    /**
+     * List of options
+     * @var array
+     * @since 7.0.0
+     */
+    protected $options;
 
-	/**
-	 * Constructor
-	 * @param array $options as key => value
-	 * @since 7.0.0 - default value for $options was added in 8.0.0
-	 */
-	public function __construct($options = array()) {
-		$this->options = $options;
-	}
+    /**
+     * Constructor
+     * @param array $options as key => value
+     * @since 7.0.0 - default value for $options was added in 8.0.0
+     */
+    public function __construct($options = array()) {
+        $this->options = $options;
+    }
 
-	/**
-	 * get a value from the options array or null
-	 * @param string $key
-	 * @return mixed
-	 * @since 8.0.0
-	 */
-	public function getOption($key) {
-		if (is_array($this->options) && isset($this->options[$key])) {
-			return $this->options[$key];
-		} else {
-			return null;
-		}
-	}
+    /**
+     * get a value from the options array or null
+     * @param string $key
+     * @return mixed
+     * @since 8.0.0
+     */
+    public function getOption($key) {
+        if (is_array($this->options) && isset($this->options[$key])) {
+            return $this->options[$key];
+        } else {
+            return null;
+        }
+    }
 
-	/**
-	 * checks if the given apps and the apps this provider has results for intersect
-	 * returns true if the given array is empty (all apps)
-	 * or if this provider does not have a list of apps it provides results for (legacy search providers)
-	 * or if the two above arrays have elements in common (intersect)
-	 * @param string[] $apps
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function providesResultsFor(array $apps = array()) {
-		$forApps = $this->getOption(self::OPTION_APPS);
-		return empty($apps) || empty($forApps) || array_intersect($forApps, $apps);
-	}
+    /**
+     * checks if the given apps and the apps this provider has results for intersect
+     * returns true if the given array is empty (all apps)
+     * or if this provider does not have a list of apps it provides results for (legacy search providers)
+     * or if the two above arrays have elements in common (intersect)
+     * @param string[] $apps
+     * @return bool
+     * @since 8.0.0
+     */
+    public function providesResultsFor(array $apps = array()) {
+        $forApps = $this->getOption(self::OPTION_APPS);
+        return empty($apps) || empty($forApps) || array_intersect($forApps, $apps);
+    }
 
-	/**
-	 * Search for $query
-	 * @param string $query
-	 * @return Result[] An array of OCP\Search\Result's
-	 * @since 7.0.0
-	 */
-	abstract public function search($query);
+    /**
+     * Search for $query
+     * @param string $query
+     * @return Result[] An array of OCP\Search\Result's
+     * @since 7.0.0
+     */
+    abstract public function search($query);
 }

lib/private/Comments/Manager.php

Indentation +888 added lines, -888 removed lines

@@ -41,892 +41,892 @@
 
 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'];
-		return $data;
-	}
-
-	/**
-	 * prepares a comment for an insert or update operation after making sure
-	 * all necessary fields have a value assigned.
-	 *
-	 * @param IComment $comment
-	 * @return IComment returns the same updated IComment instance as provided
-	 *                  by parameter for convenience
-	 * @throws \UnexpectedValueException
-	 */
-	protected function prepareCommentForDatabaseWrite(IComment $comment) {
-		if (!$comment->getActorType()
-			|| !$comment->getActorId()
-			|| !$comment->getObjectType()
-			|| !$comment->getObjectId()
-			|| !$comment->getVerb()
-		) {
-			throw new \UnexpectedValueException('Actor, Object and Verb information must be provided for saving');
-		}
-
-		if ($comment->getId() === '') {
-			$comment->setChildrenCount(0);
-			$comment->setLatestChildDateTime(new \DateTime('0000-00-00 00:00:00', new \DateTimeZone('UTC')));
-			$comment->setLatestChildDateTime(null);
-		}
-
-		if (is_null($comment->getCreationDateTime())) {
-			$comment->setCreationDateTime(new \DateTime());
-		}
-
-		if ($comment->getParentId() !== '0') {
-			$comment->setTopmostParentId($this->determineTopmostParentId($comment->getParentId()));
-		} else {
-			$comment->setTopmostParentId('0');
-		}
-
-		$this->cache($comment);
-
-		return $comment;
-	}
-
-	/**
-	 * returns the topmost parent id of a given comment identified by ID
-	 *
-	 * @param string $id
-	 * @return string
-	 * @throws NotFoundException
-	 */
-	protected function determineTopmostParentId($id) {
-		$comment = $this->get($id);
-		if ($comment->getParentId() === '0') {
-			return $comment->getId();
-		} else {
-			return $this->determineTopmostParentId($comment->getId());
-		}
-	}
-
-	/**
-	 * updates child information of a comment
-	 *
-	 * @param string $id
-	 * @param \DateTime $cDateTime the date time of the most recent child
-	 * @throws NotFoundException
-	 */
-	protected function updateChildrenInformation($id, \DateTime $cDateTime) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select($qb->createFunction('COUNT(`id`)'))
-			->from('comments')
-			->where($qb->expr()->eq('parent_id', $qb->createParameter('id')))
-			->setParameter('id', $id);
-
-		$resultStatement = $query->execute();
-		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
-		$resultStatement->closeCursor();
-		$children = (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 = new Comment($this->normalizeDatabaseData($data));
-		$this->cache($comment);
-		return $comment;
-	}
-
-	/**
-	 * returns the comment specified by the id and all it's child comments.
-	 * At this point of time, we do only support one level depth.
-	 *
-	 * @param string $id
-	 * @param int $limit max number of entries to return, 0 returns all
-	 * @param int $offset the start entry
-	 * @return array
-	 * @since 9.0.0
-	 *
-	 * The return array looks like this
-	 * [
-	 *   'comment' => IComment, // root comment
-	 *   'replies' =>
-	 *   [
-	 *     0 =>
-	 *     [
-	 *       'comment' => IComment,
-	 *       'replies' => []
-	 *     ]
-	 *     1 =>
-	 *     [
-	 *       'comment' => IComment,
-	 *       'replies'=> []
-	 *     ],
-	 *     …
-	 *   ]
-	 * ]
-	 */
-	public function getTree($id, $limit = 0, $offset = 0) {
-		$tree = [];
-		$tree['comment'] = $this->get($id);
-		$tree['replies'] = [];
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select('*')
-			->from('comments')
-			->where($qb->expr()->eq('topmost_parent_id', $qb->createParameter('id')))
-			->orderBy('creation_timestamp', 'DESC')
-			->setParameter('id', $id);
-
-		if ($limit > 0) {
-			$query->setMaxResults($limit);
-		}
-		if ($offset > 0) {
-			$query->setFirstResult($offset);
-		}
-
-		$resultStatement = $query->execute();
-		while ($data = $resultStatement->fetch()) {
-			$comment = new Comment($this->normalizeDatabaseData($data));
-			$this->cache($comment);
-			$tree['replies'][] = [
-				'comment' => $comment,
-				'replies' => []
-			];
-		}
-		$resultStatement->closeCursor();
-
-		return $tree;
-	}
-
-	/**
-	 * returns comments for a specific object (e.g. a file).
-	 *
-	 * The sort order is always newest to oldest.
-	 *
-	 * @param string $objectType the object type, e.g. 'files'
-	 * @param string $objectId the id of the object
-	 * @param int $limit optional, number of maximum comments to be returned. if
-	 * not specified, all comments are returned.
-	 * @param int $offset optional, starting point
-	 * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
-	 * that may be returned
-	 * @return IComment[]
-	 * @since 9.0.0
-	 */
-	public function getForObject(
-		$objectType,
-		$objectId,
-		$limit = 0,
-		$offset = 0,
-		\DateTime $notOlderThan = null
-	) {
-		$comments = [];
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select('*')
-			->from('comments')
-			->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
-			->orderBy('creation_timestamp', 'DESC')
-			->setParameter('type', $objectType)
-			->setParameter('id', $objectId);
-
-		if ($limit > 0) {
-			$query->setMaxResults($limit);
-		}
-		if ($offset > 0) {
-			$query->setFirstResult($offset);
-		}
-		if (!is_null($notOlderThan)) {
-			$query
-				->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
-				->setParameter('notOlderThan', $notOlderThan, 'datetime');
-		}
-
-		$resultStatement = $query->execute();
-		while ($data = $resultStatement->fetch()) {
-			$comment = new Comment($this->normalizeDatabaseData($data));
-			$this->cache($comment);
-			$comments[] = $comment;
-		}
-		$resultStatement->closeCursor();
-
-		return $comments;
-	}
-
-	/**
-	 * 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
-	 * @return IComment[]
-	 */
-	public function search(string $search, string $objectType, string $objectId, string $verb): 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');
-
-		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)));
-		}
-
-		$comments = [];
-		$result = $query->execute();
-		while ($data = $result->fetch()) {
-			$comment = new Comment($this->normalizeDatabaseData($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
-	 * @return Int
-	 * @since 9.0.0
-	 */
-	public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->select($qb->createFunction('COUNT(`id`)'))
-			->from('comments')
-			->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
-			->setParameter('type', $objectType)
-			->setParameter('id', $objectId);
-
-		if (!is_null($notOlderThan)) {
-			$query
-				->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
-				->setParameter('notOlderThan', $notOlderThan, 'datetime');
-		}
-
-		$resultStatement = $query->execute();
-		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
-		$resultStatement->closeCursor();
-		return (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')
-			->selectAlias(
-				$qb->createFunction('COUNT(' . $qb->getColumnName('c.id') . ')'),
-				'num_ids'
-			)
-			->from('comments', 'c')
-			->innerJoin('c', 'filecache', 'f', $qb->expr()->andX(
-				$qb->expr()->eq('c.object_type', $qb->createNamedParameter('files')),
-				$qb->expr()->eq('f.fileid', $qb->expr()->castColumn('c.object_id', IQueryBuilder::PARAM_INT))
-			))
-			->leftJoin('c', 'comments_read_markers', 'm', $qb->expr()->andX(
-				$qb->expr()->eq('m.object_type', $qb->createNamedParameter('files')),
-				$qb->expr()->eq('m.object_id', 'c.object_id'),
-				$qb->expr()->eq('m.user_id', $qb->createNamedParameter($user->getUID()))
-			))
-			->andWhere($qb->expr()->eq('f.parent', $qb->createNamedParameter($folderId)))
-			->andWhere($qb->expr()->orX(
-				$qb->expr()->gt('c.creation_timestamp', 'marker_datetime'),
-				$qb->expr()->isNull('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) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->insert('comments')
-			->values([
-				'parent_id' => $qb->createNamedParameter($comment->getParentId()),
-				'topmost_parent_id' => $qb->createNamedParameter($comment->getTopmostParentId()),
-				'children_count' => $qb->createNamedParameter($comment->getChildrenCount()),
-				'actor_type' => $qb->createNamedParameter($comment->getActorType()),
-				'actor_id' => $qb->createNamedParameter($comment->getActorId()),
-				'message' => $qb->createNamedParameter($comment->getMessage()),
-				'verb' => $qb->createNamedParameter($comment->getVerb()),
-				'creation_timestamp' => $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'),
-				'latest_child_timestamp' => $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'),
-				'object_type' => $qb->createNamedParameter($comment->getObjectType()),
-				'object_id' => $qb->createNamedParameter($comment->getObjectId()),
-			])
-			->execute();
-
-		if ($affectedRows > 0) {
-			$comment->setId((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());
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->update('comments')
-			->set('parent_id', $qb->createNamedParameter($comment->getParentId()))
-			->set('topmost_parent_id', $qb->createNamedParameter($comment->getTopmostParentId()))
-			->set('children_count', $qb->createNamedParameter($comment->getChildrenCount()))
-			->set('actor_type', $qb->createNamedParameter($comment->getActorType()))
-			->set('actor_id', $qb->createNamedParameter($comment->getActorId()))
-			->set('message', $qb->createNamedParameter($comment->getMessage()))
-			->set('verb', $qb->createNamedParameter($comment->getVerb()))
-			->set('creation_timestamp', $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'))
-			->set('latest_child_timestamp', $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'))
-			->set('object_type', $qb->createNamedParameter($comment->getObjectType()))
-			->set('object_id', $qb->createNamedParameter($comment->getObjectId()))
-			->where($qb->expr()->eq('id', $qb->createParameter('id')))
-			->setParameter('id', $comment->getId())
-			->execute();
-
-		if ($affectedRows === 0) {
-			throw new NotFoundException('Comment to update does ceased to exist');
-		}
-
-		$this->sendEvent(CommentsEvent::EVENT_UPDATE, $comment);
-
-		return $affectedRows > 0;
-	}
-
-	/**
-	 * removes references to specific actor (e.g. on user delete) of a comment.
-	 * The comment itself must not get lost/deleted.
-	 *
-	 * @param string $actorType the actor type (e.g. 'users')
-	 * @param string $actorId a user id
-	 * @return boolean
-	 * @since 9.0.0
-	 */
-	public function deleteReferencesOfActor($actorType, $actorId) {
-		$this->checkRoleParameters('Actor', $actorType, $actorId);
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->update('comments')
-			->set('actor_type', $qb->createNamedParameter(ICommentsManager::DELETED_USER))
-			->set('actor_id', $qb->createNamedParameter(ICommentsManager::DELETED_USER))
-			->where($qb->expr()->eq('actor_type', $qb->createParameter('type')))
-			->andWhere($qb->expr()->eq('actor_id', $qb->createParameter('id')))
-			->setParameter('type', $actorType)
-			->setParameter('id', $actorId)
-			->execute();
-
-		$this->commentsCache = [];
-
-		return is_int($affectedRows);
-	}
-
-	/**
-	 * deletes all comments made of a specific object (e.g. on file delete)
-	 *
-	 * @param string $objectType the object type (e.g. 'files')
-	 * @param string $objectId e.g. the file id
-	 * @return boolean
-	 * @since 9.0.0
-	 */
-	public function deleteCommentsAtObject($objectType, $objectId) {
-		$this->checkRoleParameters('Object', $objectType, $objectId);
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$affectedRows = $qb
-			->delete('comments')
-			->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
-			->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
-			->setParameter('type', $objectType)
-			->setParameter('id', $objectId)
-			->execute();
-
-		$this->commentsCache = [];
-
-		return is_int($affectedRows);
-	}
-
-	/**
-	 * deletes the read markers for the specified user
-	 *
-	 * @param \OCP\IUser $user
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function deleteReadMarksFromUser(IUser $user) {
-		$qb = $this->dbConn->getQueryBuilder();
-		$query = $qb->delete('comments_read_markers')
-			->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
-			->setParameter('user_id', $user->getUID());
-
-		try {
-			$affectedRows = $query->execute();
-		} catch (DriverException $e) {
-			$this->logger->logException($e, ['app' => 'core_comments']);
-			return false;
-		}
-		return ($affectedRows > 0);
-	}
-
-	/**
-	 * sets the read marker for a given file to the specified date for the
-	 * provided user
-	 *
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @param \DateTime $dateTime
-	 * @param IUser $user
-	 * @since 9.0.0
-	 * @suppress SqlInjectionChecker
-	 */
-	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'];
+        return $data;
+    }
+
+    /**
+     * prepares a comment for an insert or update operation after making sure
+     * all necessary fields have a value assigned.
+     *
+     * @param IComment $comment
+     * @return IComment returns the same updated IComment instance as provided
+     *                  by parameter for convenience
+     * @throws \UnexpectedValueException
+     */
+    protected function prepareCommentForDatabaseWrite(IComment $comment) {
+        if (!$comment->getActorType()
+            || !$comment->getActorId()
+            || !$comment->getObjectType()
+            || !$comment->getObjectId()
+            || !$comment->getVerb()
+        ) {
+            throw new \UnexpectedValueException('Actor, Object and Verb information must be provided for saving');
+        }
+
+        if ($comment->getId() === '') {
+            $comment->setChildrenCount(0);
+            $comment->setLatestChildDateTime(new \DateTime('0000-00-00 00:00:00', new \DateTimeZone('UTC')));
+            $comment->setLatestChildDateTime(null);
+        }
+
+        if (is_null($comment->getCreationDateTime())) {
+            $comment->setCreationDateTime(new \DateTime());
+        }
+
+        if ($comment->getParentId() !== '0') {
+            $comment->setTopmostParentId($this->determineTopmostParentId($comment->getParentId()));
+        } else {
+            $comment->setTopmostParentId('0');
+        }
+
+        $this->cache($comment);
+
+        return $comment;
+    }
+
+    /**
+     * returns the topmost parent id of a given comment identified by ID
+     *
+     * @param string $id
+     * @return string
+     * @throws NotFoundException
+     */
+    protected function determineTopmostParentId($id) {
+        $comment = $this->get($id);
+        if ($comment->getParentId() === '0') {
+            return $comment->getId();
+        } else {
+            return $this->determineTopmostParentId($comment->getId());
+        }
+    }
+
+    /**
+     * updates child information of a comment
+     *
+     * @param string $id
+     * @param \DateTime $cDateTime the date time of the most recent child
+     * @throws NotFoundException
+     */
+    protected function updateChildrenInformation($id, \DateTime $cDateTime) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select($qb->createFunction('COUNT(`id`)'))
+            ->from('comments')
+            ->where($qb->expr()->eq('parent_id', $qb->createParameter('id')))
+            ->setParameter('id', $id);
+
+        $resultStatement = $query->execute();
+        $data = $resultStatement->fetch(\PDO::FETCH_NUM);
+        $resultStatement->closeCursor();
+        $children = (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 = new Comment($this->normalizeDatabaseData($data));
+        $this->cache($comment);
+        return $comment;
+    }
+
+    /**
+     * returns the comment specified by the id and all it's child comments.
+     * At this point of time, we do only support one level depth.
+     *
+     * @param string $id
+     * @param int $limit max number of entries to return, 0 returns all
+     * @param int $offset the start entry
+     * @return array
+     * @since 9.0.0
+     *
+     * The return array looks like this
+     * [
+     *   'comment' => IComment, // root comment
+     *   'replies' =>
+     *   [
+     *     0 =>
+     *     [
+     *       'comment' => IComment,
+     *       'replies' => []
+     *     ]
+     *     1 =>
+     *     [
+     *       'comment' => IComment,
+     *       'replies'=> []
+     *     ],
+     *     …
+     *   ]
+     * ]
+     */
+    public function getTree($id, $limit = 0, $offset = 0) {
+        $tree = [];
+        $tree['comment'] = $this->get($id);
+        $tree['replies'] = [];
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select('*')
+            ->from('comments')
+            ->where($qb->expr()->eq('topmost_parent_id', $qb->createParameter('id')))
+            ->orderBy('creation_timestamp', 'DESC')
+            ->setParameter('id', $id);
+
+        if ($limit > 0) {
+            $query->setMaxResults($limit);
+        }
+        if ($offset > 0) {
+            $query->setFirstResult($offset);
+        }
+
+        $resultStatement = $query->execute();
+        while ($data = $resultStatement->fetch()) {
+            $comment = new Comment($this->normalizeDatabaseData($data));
+            $this->cache($comment);
+            $tree['replies'][] = [
+                'comment' => $comment,
+                'replies' => []
+            ];
+        }
+        $resultStatement->closeCursor();
+
+        return $tree;
+    }
+
+    /**
+     * returns comments for a specific object (e.g. a file).
+     *
+     * The sort order is always newest to oldest.
+     *
+     * @param string $objectType the object type, e.g. 'files'
+     * @param string $objectId the id of the object
+     * @param int $limit optional, number of maximum comments to be returned. if
+     * not specified, all comments are returned.
+     * @param int $offset optional, starting point
+     * @param \DateTime $notOlderThan optional, timestamp of the oldest comments
+     * that may be returned
+     * @return IComment[]
+     * @since 9.0.0
+     */
+    public function getForObject(
+        $objectType,
+        $objectId,
+        $limit = 0,
+        $offset = 0,
+        \DateTime $notOlderThan = null
+    ) {
+        $comments = [];
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select('*')
+            ->from('comments')
+            ->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
+            ->orderBy('creation_timestamp', 'DESC')
+            ->setParameter('type', $objectType)
+            ->setParameter('id', $objectId);
+
+        if ($limit > 0) {
+            $query->setMaxResults($limit);
+        }
+        if ($offset > 0) {
+            $query->setFirstResult($offset);
+        }
+        if (!is_null($notOlderThan)) {
+            $query
+                ->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
+                ->setParameter('notOlderThan', $notOlderThan, 'datetime');
+        }
+
+        $resultStatement = $query->execute();
+        while ($data = $resultStatement->fetch()) {
+            $comment = new Comment($this->normalizeDatabaseData($data));
+            $this->cache($comment);
+            $comments[] = $comment;
+        }
+        $resultStatement->closeCursor();
+
+        return $comments;
+    }
+
+    /**
+     * 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
+     * @return IComment[]
+     */
+    public function search(string $search, string $objectType, string $objectId, string $verb): 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');
+
+        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)));
+        }
+
+        $comments = [];
+        $result = $query->execute();
+        while ($data = $result->fetch()) {
+            $comment = new Comment($this->normalizeDatabaseData($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
+     * @return Int
+     * @since 9.0.0
+     */
+    public function getNumberOfCommentsForObject($objectType, $objectId, \DateTime $notOlderThan = null) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->select($qb->createFunction('COUNT(`id`)'))
+            ->from('comments')
+            ->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
+            ->setParameter('type', $objectType)
+            ->setParameter('id', $objectId);
+
+        if (!is_null($notOlderThan)) {
+            $query
+                ->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
+                ->setParameter('notOlderThan', $notOlderThan, 'datetime');
+        }
+
+        $resultStatement = $query->execute();
+        $data = $resultStatement->fetch(\PDO::FETCH_NUM);
+        $resultStatement->closeCursor();
+        return (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')
+            ->selectAlias(
+                $qb->createFunction('COUNT(' . $qb->getColumnName('c.id') . ')'),
+                'num_ids'
+            )
+            ->from('comments', 'c')
+            ->innerJoin('c', 'filecache', 'f', $qb->expr()->andX(
+                $qb->expr()->eq('c.object_type', $qb->createNamedParameter('files')),
+                $qb->expr()->eq('f.fileid', $qb->expr()->castColumn('c.object_id', IQueryBuilder::PARAM_INT))
+            ))
+            ->leftJoin('c', 'comments_read_markers', 'm', $qb->expr()->andX(
+                $qb->expr()->eq('m.object_type', $qb->createNamedParameter('files')),
+                $qb->expr()->eq('m.object_id', 'c.object_id'),
+                $qb->expr()->eq('m.user_id', $qb->createNamedParameter($user->getUID()))
+            ))
+            ->andWhere($qb->expr()->eq('f.parent', $qb->createNamedParameter($folderId)))
+            ->andWhere($qb->expr()->orX(
+                $qb->expr()->gt('c.creation_timestamp', 'marker_datetime'),
+                $qb->expr()->isNull('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) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->insert('comments')
+            ->values([
+                'parent_id' => $qb->createNamedParameter($comment->getParentId()),
+                'topmost_parent_id' => $qb->createNamedParameter($comment->getTopmostParentId()),
+                'children_count' => $qb->createNamedParameter($comment->getChildrenCount()),
+                'actor_type' => $qb->createNamedParameter($comment->getActorType()),
+                'actor_id' => $qb->createNamedParameter($comment->getActorId()),
+                'message' => $qb->createNamedParameter($comment->getMessage()),
+                'verb' => $qb->createNamedParameter($comment->getVerb()),
+                'creation_timestamp' => $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'),
+                'latest_child_timestamp' => $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'),
+                'object_type' => $qb->createNamedParameter($comment->getObjectType()),
+                'object_id' => $qb->createNamedParameter($comment->getObjectId()),
+            ])
+            ->execute();
+
+        if ($affectedRows > 0) {
+            $comment->setId((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());
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->update('comments')
+            ->set('parent_id', $qb->createNamedParameter($comment->getParentId()))
+            ->set('topmost_parent_id', $qb->createNamedParameter($comment->getTopmostParentId()))
+            ->set('children_count', $qb->createNamedParameter($comment->getChildrenCount()))
+            ->set('actor_type', $qb->createNamedParameter($comment->getActorType()))
+            ->set('actor_id', $qb->createNamedParameter($comment->getActorId()))
+            ->set('message', $qb->createNamedParameter($comment->getMessage()))
+            ->set('verb', $qb->createNamedParameter($comment->getVerb()))
+            ->set('creation_timestamp', $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'))
+            ->set('latest_child_timestamp', $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'))
+            ->set('object_type', $qb->createNamedParameter($comment->getObjectType()))
+            ->set('object_id', $qb->createNamedParameter($comment->getObjectId()))
+            ->where($qb->expr()->eq('id', $qb->createParameter('id')))
+            ->setParameter('id', $comment->getId())
+            ->execute();
+
+        if ($affectedRows === 0) {
+            throw new NotFoundException('Comment to update does ceased to exist');
+        }
+
+        $this->sendEvent(CommentsEvent::EVENT_UPDATE, $comment);
+
+        return $affectedRows > 0;
+    }
+
+    /**
+     * removes references to specific actor (e.g. on user delete) of a comment.
+     * The comment itself must not get lost/deleted.
+     *
+     * @param string $actorType the actor type (e.g. 'users')
+     * @param string $actorId a user id
+     * @return boolean
+     * @since 9.0.0
+     */
+    public function deleteReferencesOfActor($actorType, $actorId) {
+        $this->checkRoleParameters('Actor', $actorType, $actorId);
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->update('comments')
+            ->set('actor_type', $qb->createNamedParameter(ICommentsManager::DELETED_USER))
+            ->set('actor_id', $qb->createNamedParameter(ICommentsManager::DELETED_USER))
+            ->where($qb->expr()->eq('actor_type', $qb->createParameter('type')))
+            ->andWhere($qb->expr()->eq('actor_id', $qb->createParameter('id')))
+            ->setParameter('type', $actorType)
+            ->setParameter('id', $actorId)
+            ->execute();
+
+        $this->commentsCache = [];
+
+        return is_int($affectedRows);
+    }
+
+    /**
+     * deletes all comments made of a specific object (e.g. on file delete)
+     *
+     * @param string $objectType the object type (e.g. 'files')
+     * @param string $objectId e.g. the file id
+     * @return boolean
+     * @since 9.0.0
+     */
+    public function deleteCommentsAtObject($objectType, $objectId) {
+        $this->checkRoleParameters('Object', $objectType, $objectId);
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $affectedRows = $qb
+            ->delete('comments')
+            ->where($qb->expr()->eq('object_type', $qb->createParameter('type')))
+            ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id')))
+            ->setParameter('type', $objectType)
+            ->setParameter('id', $objectId)
+            ->execute();
+
+        $this->commentsCache = [];
+
+        return is_int($affectedRows);
+    }
+
+    /**
+     * deletes the read markers for the specified user
+     *
+     * @param \OCP\IUser $user
+     * @return bool
+     * @since 9.0.0
+     */
+    public function deleteReadMarksFromUser(IUser $user) {
+        $qb = $this->dbConn->getQueryBuilder();
+        $query = $qb->delete('comments_read_markers')
+            ->where($qb->expr()->eq('user_id', $qb->createParameter('user_id')))
+            ->setParameter('user_id', $user->getUID());
+
+        try {
+            $affectedRows = $query->execute();
+        } catch (DriverException $e) {
+            $this->logger->logException($e, ['app' => 'core_comments']);
+            return false;
+        }
+        return ($affectedRows > 0);
+    }
+
+    /**
+     * sets the read marker for a given file to the specified date for the
+     * provided user
+     *
+     * @param string $objectType
+     * @param string $objectId
+     * @param \DateTime $dateTime
+     * @param IUser $user
+     * @since 9.0.0
+     * @suppress SqlInjectionChecker
+     */
+    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);
+        }
+    }
 }

apps/comments/lib/AppInfo/Application.php

Indentation +8 added lines, -8 removed lines

@@ -31,15 +31,15 @@
 
 class Application extends App {
 
-	public function __construct (array $urlParams = array()) {
-		parent::__construct('comments', $urlParams);
-		$container = $this->getContainer();
+    public function __construct (array $urlParams = array()) {
+        parent::__construct('comments', $urlParams);
+        $container = $this->getContainer();
 
-		$container->registerAlias('NotificationsController', Notifications::class);
+        $container->registerAlias('NotificationsController', Notifications::class);
 
-		$jsSettingsHelper = new JSSettingsHelper($container->getServer());
-		Util::connectHook('\OCP\Config', 'js', $jsSettingsHelper, 'extend');
+        $jsSettingsHelper = new JSSettingsHelper($container->getServer());
+        Util::connectHook('\OCP\Config', 'js', $jsSettingsHelper, 'extend');
 
-		$container->getServer()->getSearch()->registerProvider(Provider::class, ['apps' => ['files']]);
-	}
+        $container->getServer()->getSearch()->registerProvider(Provider::class, ['apps' => ['files']]);
+    }
 }

apps/comments/lib/Search/Provider.php

Indentation +52 added lines, -52 removed lines

@@ -30,66 +30,66 @@
 
 class Provider extends \OCP\Search\Provider {
 
-	/**
-	 * Search for $query
-	 *
-	 * @param string $query
-	 * @return array An array of OCP\Search\Result's
-	 * @since 7.0.0
-	 */
-	public function search($query): array {
-		$cm = \OC::$server->getCommentsManager();
-		$us = \OC::$server->getUserSession();
+    /**
+     * Search for $query
+     *
+     * @param string $query
+     * @return array An array of OCP\Search\Result's
+     * @since 7.0.0
+     */
+    public function search($query): array {
+        $cm = \OC::$server->getCommentsManager();
+        $us = \OC::$server->getUserSession();
 
-		$user = $us->getUser();
-		if (!$user instanceof IUser) {
-			return [];
-		}
-		$uf = \OC::$server->getUserFolder($user->getUID());
+        $user = $us->getUser();
+        if (!$user instanceof IUser) {
+            return [];
+        }
+        $uf = \OC::$server->getUserFolder($user->getUID());
 
-		if ($uf === null) {
-			return [];
-		}
+        if ($uf === null) {
+            return [];
+        }
 
-		/** @var IComment[] $comments */
-		$comments = $cm->search('files', '', 'comment', $query);
+        /** @var IComment[] $comments */
+        $comments = $cm->search('files', '', 'comment', $query);
 
 
-		$result = [];
-		foreach ($comments as $comment) {
-			if ($comment->getActorType() !== 'users') {
-				continue;
-			}
+        $result = [];
+        foreach ($comments as $comment) {
+            if ($comment->getActorType() !== 'users') {
+                continue;
+            }
 
-			$displayName = $cm->resolveDisplayName($comment->getActorType(), $comment->getActorId());
+            $displayName = $cm->resolveDisplayName($comment->getActorType(), $comment->getActorId());
 
-			try {
-				$file = $this->getFileForComment($uf, $comment);
-				$result[] = new Result($query,
-					$comment,
-					$displayName,
-					$file->getPath()
-				);
-			} catch (NotFoundException $e) {
-				continue;
-			}
-		}
+            try {
+                $file = $this->getFileForComment($uf, $comment);
+                $result[] = new Result($query,
+                    $comment,
+                    $displayName,
+                    $file->getPath()
+                );
+            } catch (NotFoundException $e) {
+                continue;
+            }
+        }
 
-		return $result;
-	}
+        return $result;
+    }
 
-	/**
-	 * @param Folder $userFolder
-	 * @param IComment $comment
-	 * @return Node
-	 * @throws NotFoundException
-	 */
-	protected function getFileForComment(Folder $userFolder, IComment $comment): Node {
-		$nodes = $userFolder->getById((int) $comment->getObjectId());
-		if (empty($nodes)) {
-			throw new NotFoundException('File not found');
-		}
+    /**
+     * @param Folder $userFolder
+     * @param IComment $comment
+     * @return Node
+     * @throws NotFoundException
+     */
+    protected function getFileForComment(Folder $userFolder, IComment $comment): Node {
+        $nodes = $userFolder->getById((int) $comment->getObjectId());
+        if (empty($nodes)) {
+            throw new NotFoundException('File not found');
+        }
 
-		return array_shift($nodes);
-	}
+        return array_shift($nodes);
+    }
 }

apps/comments/lib/Search/Result.php

Indentation +68 added lines, -68 removed lines

@@ -27,83 +27,83 @@
 
 class Result extends BaseResult {
 
-	public $type = 'comment';
-	public $comment;
-	public $authorId;
-	public $authorName;
-	public $path;
-	public $fileName;
+    public $type = 'comment';
+    public $comment;
+    public $authorId;
+    public $authorName;
+    public $path;
+    public $fileName;
 
-	/**
-	 * @param string $search
-	 * @param IComment $comment
-	 * @param string $authorName
-	 * @param string $path
-	 * @throws NotFoundException
-	 */
-	public function __construct(string $search,
-								IComment $comment,
-								string $authorName,
-								string $path) {
-		parent::__construct(
-			(int) $comment->getId(),
-			$comment->getMessage()
-		/* @todo , [link to file] */
-		);
+    /**
+     * @param string $search
+     * @param IComment $comment
+     * @param string $authorName
+     * @param string $path
+     * @throws NotFoundException
+     */
+    public function __construct(string $search,
+                                IComment $comment,
+                                string $authorName,
+                                string $path) {
+        parent::__construct(
+            (int) $comment->getId(),
+            $comment->getMessage()
+        /* @todo , [link to file] */
+        );
 
-		$this->comment = $this->getRelevantMessagePart($comment->getMessage(), $search);
-		$this->authorId = $comment->getActorId();
-		$this->authorName = $authorName;
-		$this->fileName = basename($path);
-		$this->path = $this->getVisiblePath($path);
-	}
+        $this->comment = $this->getRelevantMessagePart($comment->getMessage(), $search);
+        $this->authorId = $comment->getActorId();
+        $this->authorName = $authorName;
+        $this->fileName = basename($path);
+        $this->path = $this->getVisiblePath($path);
+    }
 
-	/**
-	 * @param string $path
-	 * @return string
-	 * @throws NotFoundException
-	 */
-	protected function getVisiblePath(string $path): string {
-		$segments = explode('/', trim($path, '/'), 3);
+    /**
+     * @param string $path
+     * @return string
+     * @throws NotFoundException
+     */
+    protected function getVisiblePath(string $path): string {
+        $segments = explode('/', trim($path, '/'), 3);
 
-		if (!isset($segments[2])) {
-			throw new NotFoundException('Path not inside visible section');
-		}
+        if (!isset($segments[2])) {
+            throw new NotFoundException('Path not inside visible section');
+        }
 
-		return $segments[2];
-	}
+        return $segments[2];
+    }
 
-	/**
-	 * @param string $message
-	 * @param string $search
-	 * @return string
-	 * @throws NotFoundException
-	 */
-	protected function getRelevantMessagePart(string $message, string $search): string {
-		$start = stripos($message, $search);
-		if ($start === false) {
-			throw new NotFoundException('Comment section not found');
-		}
+    /**
+     * @param string $message
+     * @param string $search
+     * @return string
+     * @throws NotFoundException
+     */
+    protected function getRelevantMessagePart(string $message, string $search): string {
+        $start = stripos($message, $search);
+        if ($start === false) {
+            throw new NotFoundException('Comment section not found');
+        }
 
-		$end = $start + strlen($search);
+        $end = $start + strlen($search);
 
-		if ($start <= 25) {
-			$start = 0;
-			$prefix = '';
-		} else {
-			$start -= 25;
-			$prefix = '…';
-		}
+        if ($start <= 25) {
+            $start = 0;
+            $prefix = '';
+        } else {
+            $start -= 25;
+            $prefix = '…';
+        }
 
-		if ((strlen($message) - $end) <= 25) {
-			$end = strlen($message);
-			$suffix = '';
-		} else {
-			$end += 25;
-			$suffix = '…';
-		}
+        if ((strlen($message) - $end) <= 25) {
+            $end = strlen($message);
+            $suffix = '';
+        } else {
+            $end += 25;
+            $suffix = '…';
+        }
 
-		return $prefix . substr($message, $start, $end - $start) . $suffix;
-	}
+        return $prefix . substr($message, $start, $end - $start) . $suffix;
+    }
 
 }