nextcloud / server

lib/public/Comments/ICommentsManager.php

Indentation +469 added lines, -469 removed lines

@@ -18,473 +18,473 @@
  * @since 9.0.0
  */
 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.
-	 */
-	public 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 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{comment: IComment, replies: list<array{comment: IComment, replies: array<empty, empty>}>}
-	 * @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 list<IComment>
-	 * @since 9.0.0
-	 */
-	public function getForObject(
-		$objectType,
-		$objectId,
-		$limit = 0,
-		$offset = 0,
-		?\DateTime $notOlderThan = null,
-	);
-
-	/**
-	 * @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.
-	 * @param bool $includeLastKnown
-	 * @param string $topmostParentId Limit the comments to a list of replies and its original root comment
-	 * @return list<IComment>
-	 * @since 14.0.0
-	 * @deprecated 24.0.0 - Use getCommentsWithVerbForObjectSinceComment instead
-	 */
-	public function getForObjectSince(
-		string $objectType,
-		string $objectId,
-		int $lastKnownCommentId,
-		string $sortDirection = 'asc',
-		int $limit = 30,
-		bool $includeLastKnown = false,
-		string $topmostParentId = '',
-	): array;
-
-	/**
-	 * @param string $objectType the object type, e.g. 'files'
-	 * @param string $objectId the id of the object
-	 * @param string[] $verbs List of verbs to filter by
-	 * @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.
-	 * @param bool $includeLastKnown
-	 * @param string $topmostParentId Limit the comments to a list of replies and its original root comment
-	 * @return list<IComment>
-	 * @since 24.0.0
-	 */
-	public function getCommentsWithVerbForObjectSinceComment(
-		string $objectType,
-		string $objectId,
-		array $verbs,
-		int $lastKnownCommentId,
-		string $sortDirection = 'asc',
-		int $limit = 30,
-		bool $includeLastKnown = false,
-		string $topmostParentId = '',
-	): 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
-	 * @param int $offset
-	 * @param int $limit
-	 * @return list<IComment>
-	 * @since 14.0.0
-	 */
-	public function search(string $search, string $objectType, string $objectId, string $verb, int $offset, int $limit = 50): array;
-
-	/**
-	 * Search for comments on one or more objects with a given content
-	 *
-	 * @param string $search content to search for
-	 * @param string $objectType Limit the search by object type
-	 * @param array $objectIds Limit the search by object ids
-	 * @param string $verb Limit the verb of the comment
-	 * @param int $offset
-	 * @param int $limit
-	 * @return IComment[]
-	 * @since 21.0.0
-	 */
-	public function searchForObjects(string $search, string $objectType, array $objectIds, string $verb, int $offset, int $limit = 50): 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
-	 * @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 = '');
-
-	/**
-	 * @param $objectType string the object type, e.g. 'files'
-	 * @param $objectIds string[] the ids of the object
-	 * @param \DateTime|null $notOlderThan optional, timestamp of the oldest comments
-	 *                                     that may be returned
-	 * @param string $verb Limit the verb of the comment
-	 * @return array<string, int>
-	 * @since 32.0.0
-	 */
-	public function getNumberOfCommentsForObjects(string $objectType, array $objectIds, ?\DateTime $notOlderThan = null, string $verb = '');
-
-	/**
-	 * @param string $objectType the object type, e.g. 'files'
-	 * @param string[] $objectIds the id of the object
-	 * @param IUser $user
-	 * @param string $verb Limit the verb of the comment - Added in 14.0.0
-	 * @return array Map with object id => # of unread comments
-	 * @psalm-return array<string, int>
-	 * @since 21.0.0
-	 */
-	public function getNumberOfUnreadCommentsForObjects(string $objectType, array $objectIds, IUser $user, $verb = ''): array;
-
-	/**
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @param int $lastRead
-	 * @param string $verb
-	 * @return int
-	 * @since 21.0.0
-	 * @deprecated 24.0.0 - Use getNumberOfCommentsWithVerbsForObjectSinceComment instead
-	 */
-	public function getNumberOfCommentsForObjectSinceComment(string $objectType, string $objectId, int $lastRead, string $verb = ''): int;
-
-
-	/**
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @param int $lastRead
-	 * @param string[] $verbs
-	 * @return int
-	 * @since 24.0.0
-	 */
-	public function getNumberOfCommentsWithVerbsForObjectSinceComment(string $objectType, string $objectId, int $lastRead, array $verbs): int;
-
-	/**
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @param \DateTime $beforeDate
-	 * @param string $verb
-	 * @return int
-	 * @since 21.0.0
-	 */
-	public function getLastCommentBeforeDate(string $objectType, string $objectId, \DateTime $beforeDate, string $verb = ''): int;
-
-	/**
-	 * @param string $objectType
-	 * @param string $objectId
-	 * @param string $verb
-	 * @param string $actorType
-	 * @param string[] $actors
-	 * @return \DateTime[] Map of "string actor" => "\DateTime most recent comment date"
-	 * @psalm-return array<string, \DateTime>
-	 * @since 21.0.0
-	 */
-	public function getLastCommentDateByActor(
-		string $objectType,
-		string $objectId,
-		string $verb,
-		string $actorType,
-		array $actors,
-	): array;
-
-	/**
-	 * 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
-	 * @deprecated 29.0.0 use getNumberOfUnreadCommentsForObjects instead
-	 */
-	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);
-
-	/**
-	 * 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);
-
-	/**
-	 * Get comment related with user reaction
-	 *
-	 * Throws PreConditionNotMetException when the system haven't the minimum requirements to
-	 * use reactions
-	 *
-	 * @param int $parentId
-	 * @param string $actorType
-	 * @param string $actorId
-	 * @param string $reaction
-	 * @return IComment
-	 * @throws NotFoundException
-	 * @throws PreConditionNotMetException
-	 * @since 24.0.0
-	 */
-	public function getReactionComment(int $parentId, string $actorType, string $actorId, string $reaction): IComment;
-
-	/**
-	 * Retrieve all reactions of a message
-	 *
-	 * Throws PreConditionNotMetException when the system haven't the minimum requirements to
-	 * use reactions
-	 *
-	 * @param int $parentId
-	 * @return IComment[]
-	 * @throws PreConditionNotMetException
-	 * @since 24.0.0
-	 */
-	public function retrieveAllReactions(int $parentId): array;
-
-	/**
-	 * Retrieve all reactions with specific reaction of a message
-	 *
-	 * Throws PreConditionNotMetException when the system haven't the minimum requirements to
-	 * use reactions
-	 *
-	 * @param int $parentId
-	 * @param string $reaction
-	 * @return IComment[]
-	 * @throws PreConditionNotMetException
-	 * @since 24.0.0
-	 */
-	public function retrieveAllReactionsWithSpecificReaction(int $parentId, string $reaction): array;
-
-	/**
-	 * Support reactions
-	 *
-	 * @return bool
-	 * @since 24.0.0
-	 */
-	public function supportReactions(): bool;
-
-	/**
-	 * 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);
-
-	/**
-	 * 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);
-
-	/**
-	 * 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 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 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);
-
-	/**
-	 * Load the Comments app into the page
-	 *
-	 * @since 21.0.0
-	 */
-	public function load(): void;
-
-	/**
-	 * Delete comments with field expire_date less than current date
-	 * Only will delete the message related with the object.
-	 *
-	 * @param string $objectType the object type (e.g. 'files')
-	 * @param string $objectId e.g. the file id, leave empty to expire on all objects of this type
-	 * @return boolean true if at least one row was deleted
-	 * @since 25.0.0
-	 */
-	public function deleteCommentsExpiredAtObject(string $objectType, string $objectId = ''): bool;
+    /**
+     * @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.
+     */
+    public 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 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{comment: IComment, replies: list<array{comment: IComment, replies: array<empty, empty>}>}
+     * @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 list<IComment>
+     * @since 9.0.0
+     */
+    public function getForObject(
+        $objectType,
+        $objectId,
+        $limit = 0,
+        $offset = 0,
+        ?\DateTime $notOlderThan = null,
+    );
+
+    /**
+     * @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.
+     * @param bool $includeLastKnown
+     * @param string $topmostParentId Limit the comments to a list of replies and its original root comment
+     * @return list<IComment>
+     * @since 14.0.0
+     * @deprecated 24.0.0 - Use getCommentsWithVerbForObjectSinceComment instead
+     */
+    public function getForObjectSince(
+        string $objectType,
+        string $objectId,
+        int $lastKnownCommentId,
+        string $sortDirection = 'asc',
+        int $limit = 30,
+        bool $includeLastKnown = false,
+        string $topmostParentId = '',
+    ): array;
+
+    /**
+     * @param string $objectType the object type, e.g. 'files'
+     * @param string $objectId the id of the object
+     * @param string[] $verbs List of verbs to filter by
+     * @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.
+     * @param bool $includeLastKnown
+     * @param string $topmostParentId Limit the comments to a list of replies and its original root comment
+     * @return list<IComment>
+     * @since 24.0.0
+     */
+    public function getCommentsWithVerbForObjectSinceComment(
+        string $objectType,
+        string $objectId,
+        array $verbs,
+        int $lastKnownCommentId,
+        string $sortDirection = 'asc',
+        int $limit = 30,
+        bool $includeLastKnown = false,
+        string $topmostParentId = '',
+    ): 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
+     * @param int $offset
+     * @param int $limit
+     * @return list<IComment>
+     * @since 14.0.0
+     */
+    public function search(string $search, string $objectType, string $objectId, string $verb, int $offset, int $limit = 50): array;
+
+    /**
+     * Search for comments on one or more objects with a given content
+     *
+     * @param string $search content to search for
+     * @param string $objectType Limit the search by object type
+     * @param array $objectIds Limit the search by object ids
+     * @param string $verb Limit the verb of the comment
+     * @param int $offset
+     * @param int $limit
+     * @return IComment[]
+     * @since 21.0.0
+     */
+    public function searchForObjects(string $search, string $objectType, array $objectIds, string $verb, int $offset, int $limit = 50): 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
+     * @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 = '');
+
+    /**
+     * @param $objectType string the object type, e.g. 'files'
+     * @param $objectIds string[] the ids of the object
+     * @param \DateTime|null $notOlderThan optional, timestamp of the oldest comments
+     *                                     that may be returned
+     * @param string $verb Limit the verb of the comment
+     * @return array<string, int>
+     * @since 32.0.0
+     */
+    public function getNumberOfCommentsForObjects(string $objectType, array $objectIds, ?\DateTime $notOlderThan = null, string $verb = '');
+
+    /**
+     * @param string $objectType the object type, e.g. 'files'
+     * @param string[] $objectIds the id of the object
+     * @param IUser $user
+     * @param string $verb Limit the verb of the comment - Added in 14.0.0
+     * @return array Map with object id => # of unread comments
+     * @psalm-return array<string, int>
+     * @since 21.0.0
+     */
+    public function getNumberOfUnreadCommentsForObjects(string $objectType, array $objectIds, IUser $user, $verb = ''): array;
+
+    /**
+     * @param string $objectType
+     * @param string $objectId
+     * @param int $lastRead
+     * @param string $verb
+     * @return int
+     * @since 21.0.0
+     * @deprecated 24.0.0 - Use getNumberOfCommentsWithVerbsForObjectSinceComment instead
+     */
+    public function getNumberOfCommentsForObjectSinceComment(string $objectType, string $objectId, int $lastRead, string $verb = ''): int;
+
+
+    /**
+     * @param string $objectType
+     * @param string $objectId
+     * @param int $lastRead
+     * @param string[] $verbs
+     * @return int
+     * @since 24.0.0
+     */
+    public function getNumberOfCommentsWithVerbsForObjectSinceComment(string $objectType, string $objectId, int $lastRead, array $verbs): int;
+
+    /**
+     * @param string $objectType
+     * @param string $objectId
+     * @param \DateTime $beforeDate
+     * @param string $verb
+     * @return int
+     * @since 21.0.0
+     */
+    public function getLastCommentBeforeDate(string $objectType, string $objectId, \DateTime $beforeDate, string $verb = ''): int;
+
+    /**
+     * @param string $objectType
+     * @param string $objectId
+     * @param string $verb
+     * @param string $actorType
+     * @param string[] $actors
+     * @return \DateTime[] Map of "string actor" => "\DateTime most recent comment date"
+     * @psalm-return array<string, \DateTime>
+     * @since 21.0.0
+     */
+    public function getLastCommentDateByActor(
+        string $objectType,
+        string $objectId,
+        string $verb,
+        string $actorType,
+        array $actors,
+    ): array;
+
+    /**
+     * 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
+     * @deprecated 29.0.0 use getNumberOfUnreadCommentsForObjects instead
+     */
+    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);
+
+    /**
+     * 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);
+
+    /**
+     * Get comment related with user reaction
+     *
+     * Throws PreConditionNotMetException when the system haven't the minimum requirements to
+     * use reactions
+     *
+     * @param int $parentId
+     * @param string $actorType
+     * @param string $actorId
+     * @param string $reaction
+     * @return IComment
+     * @throws NotFoundException
+     * @throws PreConditionNotMetException
+     * @since 24.0.0
+     */
+    public function getReactionComment(int $parentId, string $actorType, string $actorId, string $reaction): IComment;
+
+    /**
+     * Retrieve all reactions of a message
+     *
+     * Throws PreConditionNotMetException when the system haven't the minimum requirements to
+     * use reactions
+     *
+     * @param int $parentId
+     * @return IComment[]
+     * @throws PreConditionNotMetException
+     * @since 24.0.0
+     */
+    public function retrieveAllReactions(int $parentId): array;
+
+    /**
+     * Retrieve all reactions with specific reaction of a message
+     *
+     * Throws PreConditionNotMetException when the system haven't the minimum requirements to
+     * use reactions
+     *
+     * @param int $parentId
+     * @param string $reaction
+     * @return IComment[]
+     * @throws PreConditionNotMetException
+     * @since 24.0.0
+     */
+    public function retrieveAllReactionsWithSpecificReaction(int $parentId, string $reaction): array;
+
+    /**
+     * Support reactions
+     *
+     * @return bool
+     * @since 24.0.0
+     */
+    public function supportReactions(): bool;
+
+    /**
+     * 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);
+
+    /**
+     * 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);
+
+    /**
+     * 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 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 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);
+
+    /**
+     * Load the Comments app into the page
+     *
+     * @since 21.0.0
+     */
+    public function load(): void;
+
+    /**
+     * Delete comments with field expire_date less than current date
+     * Only will delete the message related with the object.
+     *
+     * @param string $objectType the object type (e.g. 'files')
+     * @param string $objectId e.g. the file id, leave empty to expire on all objects of this type
+     * @return boolean true if at least one row was deleted
+     * @since 25.0.0
+     */
+    public function deleteCommentsExpiredAtObject(string $objectType, string $objectId = ''): bool;
 }

lib/private/Comments/Manager.php

Indentation +1554 added lines, -1554 removed lines

@@ -30,1558 +30,1558 @@
 use Psr\Log\LoggerInterface;
 
 class Manager implements ICommentsManager {
-	/** @var IComment[] */
-	protected array $commentsCache = [];
-
-	/** @var \Closure[] */
-	protected array $eventHandlerClosures = [];
-
-	/** @var ICommentsEventHandler[] */
-	protected array $eventHandlers = [];
-
-	/** @var \Closure[] */
-	protected array $displayNameResolvers = [];
-
-	public function __construct(
-		protected IDBConnection $dbConn,
-		protected LoggerInterface $logger,
-		protected IConfig $config,
-		protected ITimeFactory $timeFactory,
-		protected IEmojiHelper $emojiHelper,
-		protected IInitialStateService $initialStateService,
-		protected IRootFolder $rootFolder,
-		protected IEventDispatcher $eventDispatcher,
-	) {
-	}
-
-	/**
-	 * converts data base data into PHP native, proper types as defined by
-	 * IComment interface.
-	 *
-	 * @param array $data
-	 */
-	protected function normalizeDatabaseData(array $data): array {
-		$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']);
-		}
-		if (!is_null($data['expire_date'])) {
-			$data['expire_date'] = new \DateTime($data['expire_date']);
-		}
-		$data['children_count'] = (int)$data['children_count'];
-		$data['reference_id'] = $data['reference_id'];
-		$data['meta_data'] = json_decode($data['meta_data'], true);
-		if ($this->supportReactions()) {
-			if ($data['reactions'] !== null) {
-				$list = json_decode($data['reactions'], true);
-				// Ordering does not work on the database with group concat and Oracle,
-				// So we simply sort on the output.
-				if (is_array($list)) {
-					uasort($list, static function ($a, $b) {
-						if ($a === $b) {
-							return 0;
-						}
-						return ($a > $b) ? -1 : 1;
-					});
-					$data['reactions'] = $list;
-				} else {
-					$data['reactions'] = [];
-				}
-			} else {
-				$data['reactions'] = [];
-			}
-		}
-		return $data;
-	}
-
-	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): IComment {
-		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->getVerb() === 'reaction' && !$this->emojiHelper->isValidSingleEmoji($comment->getMessage())) {
-			// 4 characters: laptop + person + gender + skin color => "

Spacing +25 added lines, -25 removed lines

@@ -61,9 +61,9 @@ 
 	 * @param array $data
 	 */
 	protected function normalizeDatabaseData(array $data): array {
-		$data['id'] = (string)$data['id'];
-		$data['parent_id'] = (string)$data['parent_id'];
-		$data['topmost_parent_id'] = (string)$data['topmost_parent_id'];
+		$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']);
@@ -71,7 +71,7 @@ 
 		if (!is_null($data['expire_date'])) {
 			$data['expire_date'] = new \DateTime($data['expire_date']);
 		}
-		$data['children_count'] = (int)$data['children_count'];
+		$data['children_count'] = (int) $data['children_count'];
 		$data['reference_id'] = $data['reference_id'];
 		$data['meta_data'] = json_decode($data['meta_data'], true);
 		if ($this->supportReactions()) {
@@ -80,7 +80,7 @@ 
 				// Ordering does not work on the database with group concat and Oracle,
 				// So we simply sort on the output.
 				if (is_array($list)) {
-					uasort($list, static function ($a, $b) {
+					uasort($list, static function($a, $b) {
 						if ($a === $b) {
 							return 0;
 						}
@@ -179,7 +179,7 @@ 
 		$resultStatement = $query->execute();
 		$data = $resultStatement->fetch(\PDO::FETCH_NUM);
 		$resultStatement->closeCursor();
-		$children = (int)$data[0];
+		$children = (int) $data[0];
 
 		$comment = $this->get($id);
 		$comment->setChildrenCount($children);
@@ -201,7 +201,7 @@ 
 			!is_string($type) || empty($type)
 			|| !is_string($id) || empty($id)
 		) {
-			throw new \InvalidArgumentException($role . ' parameters must be string and not empty');
+			throw new \InvalidArgumentException($role.' parameters must be string and not empty');
 		}
 	}
 
@@ -213,7 +213,7 @@ 
 		if (empty($id)) {
 			return;
 		}
-		$this->commentsCache[(string)$id] = $comment;
+		$this->commentsCache[(string) $id] = $comment;
 	}
 
 	/**
@@ -222,7 +222,7 @@ 
 	 * @param mixed $id the comment's id
 	 */
 	protected function uncache($id): void {
-		$id = (string)$id;
+		$id = (string) $id;
 		if (isset($this->commentsCache[$id])) {
 			unset($this->commentsCache[$id]);
 		}
@@ -237,7 +237,7 @@ 
 	 * @since 9.0.0
 	 */
 	public function get($id): IComment {
-		if ((int)$id === 0) {
+		if ((int) $id === 0) {
 			throw new \InvalidArgumentException('IDs must be translatable to a number in this implementation.');
 		}
 
@@ -587,7 +587,7 @@ 
 
 		if ($search !== '') {
 			$query->where($query->expr()->iLike('message', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
+				'%'.$this->dbConn->escapeLikeParameter($search).'%'
 			)));
 		}
 
@@ -651,7 +651,7 @@ 
 		$comments = array_fill_keys($objectIds, 0);
 		$resultStatement = $query->execute();
 		while ($data = $resultStatement->fetch()) {
-			$comments[$data['object_id']] = (int)$data['num_comments'];
+			$comments[$data['object_id']] = (int) $data['num_comments'];
 		}
 		$resultStatement->closeCursor();
 
@@ -695,7 +695,7 @@ 
 
 			$result = $query->executeQuery();
 			while ($row = $result->fetch()) {
-				$unreadComments[$row['object_id']] = (int)$row['num_comments'];
+				$unreadComments[$row['object_id']] = (int) $row['num_comments'];
 			}
 			$result->closeCursor();
 		}
@@ -743,7 +743,7 @@ 
 		$data = $result->fetch();
 		$result->closeCursor();
 
-		return (int)($data['num_messages'] ?? 0);
+		return (int) ($data['num_messages'] ?? 0);
 	}
 
 	/**
@@ -771,7 +771,7 @@ 
 		$data = $result->fetch();
 		$result->closeCursor();
 
-		return (int)($data['id'] ?? 0);
+		return (int) ($data['id'] ?? 0);
 	}
 
 	/**
@@ -795,7 +795,7 @@ 
 
 		$query = $this->dbConn->getQueryBuilder();
 		$query->select('actor_id')
-			->selectAlias($query->createFunction('MAX(' . $query->getColumnName('creation_timestamp') . ')'), 'last_comment')
+			->selectAlias($query->createFunction('MAX('.$query->getColumnName('creation_timestamp').')'), 'last_comment')
 			->from('comments')
 			->where($query->expr()->eq('object_type', $query->createNamedParameter($objectType)))
 			->andWhere($query->expr()->eq('object_id', $query->createNamedParameter($objectId)))
@@ -828,11 +828,11 @@ 
 			return [];
 		}
 		$children = $directory->getDirectoryListing();
-		$ids = array_map(fn (FileInfo $child) => (string)$child->getId(), $children);
+		$ids = array_map(fn (FileInfo $child) => (string) $child->getId(), $children);
 
-		$ids[] = (string)$directory->getId();
+		$ids[] = (string) $directory->getId();
 		$counts = $this->getNumberOfUnreadCommentsForObjects('files', $ids, $user);
-		return array_filter($counts, function (int $count) {
+		return array_filter($counts, function(int $count) {
 			return $count > 0;
 		});
 	}
@@ -1099,7 +1099,7 @@ 
 			$result = $this->update($comment);
 		}
 
-		if ($result && (bool)$comment->getParentId()) {
+		if ($result && (bool) $comment->getParentId()) {
 			$this->updateChildrenInformation(
 				$comment->getParentId(),
 				$comment->getCreationDateTime()
@@ -1141,7 +1141,7 @@ 
 			->execute();
 
 		if ($affectedRows > 0) {
-			$comment->setId((string)$qb->getLastInsertId());
+			$comment->setId((string) $qb->getLastInsertId());
 			if ($comment->getVerb() === 'reaction') {
 				$this->addReaction($comment);
 			}
@@ -1161,7 +1161,7 @@ 
 			->andWhere($qb->expr()->eq('actor_id', $qb->createNamedParameter($reaction->getActorId())))
 			->andWhere($qb->expr()->eq('reaction', $qb->createNamedParameter($reaction->getMessage())));
 		$result = $qb->executeQuery();
-		$exists = (int)$result->fetchOne();
+		$exists = (int) $result->fetchOne();
 		if (!$exists) {
 			$qb = $this->dbConn->getQueryBuilder();
 			try {
@@ -1214,12 +1214,12 @@ 
 				),
 				'json'
 			)
-			->from($jsonQuery->createFunction('(' . $totalQuery->getSQL() . ')'), 'json');
+			->from($jsonQuery->createFunction('('.$totalQuery->getSQL().')'), 'json');
 
 		$qb = $this->dbConn->getQueryBuilder();
 		$qb
 			->update('comments')
-			->set('reactions', $qb->createFunction('(' . $jsonQuery->getSQL() . ')'))
+			->set('reactions', $qb->createFunction('('.$jsonQuery->getSQL().')'))
 			->where($qb->expr()->eq('id', $qb->createNamedParameter($parentId)))
 			->executeStatement();
 	}
@@ -1514,7 +1514,7 @@ 
 		if (!isset($this->displayNameResolvers[$type])) {
 			throw new \OutOfBoundsException('No Displayname resolver for this type registered');
 		}
-		return (string)$this->displayNameResolvers[$type]($id);
+		return (string) $this->displayNameResolvers[$type]($id);
 	}
 
 	/**

apps/dav/lib/Connector/Sabre/CommentPropertiesPlugin.php

Indentation +148 added lines, -148 removed lines

@@ -16,152 +16,152 @@
 use Sabre\DAV\ServerPlugin;
 
 class CommentPropertiesPlugin extends ServerPlugin {
-	public const PROPERTY_NAME_HREF = '{http://owncloud.org/ns}comments-href';
-	public const PROPERTY_NAME_COUNT = '{http://owncloud.org/ns}comments-count';
-	public const PROPERTY_NAME_UNREAD = '{http://owncloud.org/ns}comments-unread';
-
-	protected ?Server $server = null;
-	private array $cachedUnreadCount = [];
-	private array $cachedCount = [];
-	private array $cachedDirectories = [];
-
-	public function __construct(
-		private ICommentsManager $commentsManager,
-		private IUserSession $userSession,
-	) {
-	}
-
-	/**
-	 * This initializes the plugin.
-	 *
-	 * This function is called by Sabre\DAV\Server, after
-	 * addPlugin is called.
-	 *
-	 * This method should set up the required event subscriptions.
-	 *
-	 * @param \Sabre\DAV\Server $server
-	 * @return void
-	 */
-	public function initialize(\Sabre\DAV\Server $server) {
-		$this->server = $server;
-
-		$this->server->on('preloadCollection', $this->preloadCollection(...));
-		$this->server->on('propFind', [$this, 'handleGetProperties']);
-	}
-
-	private function cacheDirectory(Directory $directory, PropFind $propFind): void {
-		if (is_null($propFind->getStatus(self::PROPERTY_NAME_UNREAD)) && is_null($propFind->getStatus(self::PROPERTY_NAME_COUNT))) {
-			return;
-		}
-
-		$children = $directory->getChildren();
-
-		$ids = [];
-		foreach ($children as $child) {
-			if (!($child instanceof File || $child instanceof Directory)) {
-				continue;
-			}
-
-			$id = $child->getId();
-			if ($id === null) {
-				continue;
-			}
-
-			$ids[] = (string)$id;
-		}
-
-		$ids[] = (string)$directory->getId();
-		if (!is_null($propFind->getStatus(self::PROPERTY_NAME_UNREAD))) {
-			$user = $this->userSession->getUser();
-			if ($user) {
-				$unread = $this->commentsManager->getNumberOfUnreadCommentsForObjects('files', $ids, $user);
-				foreach ($unread as $id => $count) {
-					$this->cachedUnreadCount[(int)$id] = $count;
-				}
-			} else {
-				foreach ($ids as $id) {
-					$this->cachedUnreadCount[(int)$id] = null;
-				}
-			}
-		}
-
-		if (!is_null($propFind->getStatus(self::PROPERTY_NAME_COUNT))) {
-			$commentCounts = $this->commentsManager->getNumberOfCommentsForObjects('files', $ids);
-			foreach ($commentCounts as $id => $count) {
-				$this->cachedCount[(int)$id] = $count;
-			}
-		}
-
-	}
-
-	private function preloadCollection(PropFind $propFind, ICollection $collection): void {
-		if (!($collection instanceof Directory)) {
-			return;
-		}
-
-		$collectionPath = $collection->getPath();
-		if (!isset($this->cachedDirectories[$collectionPath]) && (
-			$propFind->getStatus(self::PROPERTY_NAME_UNREAD) !== null
-			|| $propFind->getStatus(self::PROPERTY_NAME_COUNT) !== null)) {
-			$this->cacheDirectory($collection, $propFind);
-			$this->cachedDirectories[$collectionPath] = true;
-		}
-	}
-
-	/**
-	 * Adds tags and favorites properties to the response,
-	 * if requested.
-	 *
-	 * @param PropFind $propFind
-	 * @param \Sabre\DAV\INode $node
-	 * @return void
-	 */
-	public function handleGetProperties(
-		PropFind $propFind,
-		\Sabre\DAV\INode $node,
-	) {
-		if (!($node instanceof File) && !($node instanceof Directory)) {
-			return;
-		}
-
-		$propFind->handle(self::PROPERTY_NAME_COUNT, function () use ($node): int {
-			return $this->cachedCount[$node->getId()] ?? $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId());
-		});
-
-		$propFind->handle(self::PROPERTY_NAME_HREF, function () use ($node): ?string {
-			return $this->getCommentsLink($node);
-		});
-
-		$propFind->handle(self::PROPERTY_NAME_UNREAD, function () use ($node): ?int {
-			return $this->cachedUnreadCount[$node->getId()] ?? $this->getUnreadCount($node);
-		});
-	}
-
-	/**
-	 * Returns a reference to the comments node
-	 */
-	public function getCommentsLink(Node $node): ?string {
-		$href = $this->server->getBaseUri();
-		$entryPoint = strpos($href, '/remote.php/');
-		if ($entryPoint === false) {
-			// in case we end up somewhere else, unexpectedly.
-			return null;
-		}
-		$commentsPart = 'dav/comments/files/' . rawurldecode((string)$node->getId());
-		return substr_replace($href, $commentsPart, $entryPoint + strlen('/remote.php/'));
-	}
-
-	/**
-	 * Returns the number of unread comments for the currently logged in user
-	 * on the given file or directory node
-	 */
-	public function getUnreadCount(Node $node): ?int {
-		$user = $this->userSession->getUser();
-		if (is_null($user)) {
-			return null;
-		}
-
-		$objectId = (string)$node->getId();
-		return $this->commentsManager->getNumberOfUnreadCommentsForObjects('files', [$objectId], $user)[$objectId];
-	}
+    public const PROPERTY_NAME_HREF = '{http://owncloud.org/ns}comments-href';
+    public const PROPERTY_NAME_COUNT = '{http://owncloud.org/ns}comments-count';
+    public const PROPERTY_NAME_UNREAD = '{http://owncloud.org/ns}comments-unread';
+
+    protected ?Server $server = null;
+    private array $cachedUnreadCount = [];
+    private array $cachedCount = [];
+    private array $cachedDirectories = [];
+
+    public function __construct(
+        private ICommentsManager $commentsManager,
+        private IUserSession $userSession,
+    ) {
+    }
+
+    /**
+     * This initializes the plugin.
+     *
+     * This function is called by Sabre\DAV\Server, after
+     * addPlugin is called.
+     *
+     * This method should set up the required event subscriptions.
+     *
+     * @param \Sabre\DAV\Server $server
+     * @return void
+     */
+    public function initialize(\Sabre\DAV\Server $server) {
+        $this->server = $server;
+
+        $this->server->on('preloadCollection', $this->preloadCollection(...));
+        $this->server->on('propFind', [$this, 'handleGetProperties']);
+    }
+
+    private function cacheDirectory(Directory $directory, PropFind $propFind): void {
+        if (is_null($propFind->getStatus(self::PROPERTY_NAME_UNREAD)) && is_null($propFind->getStatus(self::PROPERTY_NAME_COUNT))) {
+            return;
+        }
+
+        $children = $directory->getChildren();
+
+        $ids = [];
+        foreach ($children as $child) {
+            if (!($child instanceof File || $child instanceof Directory)) {
+                continue;
+            }
+
+            $id = $child->getId();
+            if ($id === null) {
+                continue;
+            }
+
+            $ids[] = (string)$id;
+        }
+
+        $ids[] = (string)$directory->getId();
+        if (!is_null($propFind->getStatus(self::PROPERTY_NAME_UNREAD))) {
+            $user = $this->userSession->getUser();
+            if ($user) {
+                $unread = $this->commentsManager->getNumberOfUnreadCommentsForObjects('files', $ids, $user);
+                foreach ($unread as $id => $count) {
+                    $this->cachedUnreadCount[(int)$id] = $count;
+                }
+            } else {
+                foreach ($ids as $id) {
+                    $this->cachedUnreadCount[(int)$id] = null;
+                }
+            }
+        }
+
+        if (!is_null($propFind->getStatus(self::PROPERTY_NAME_COUNT))) {
+            $commentCounts = $this->commentsManager->getNumberOfCommentsForObjects('files', $ids);
+            foreach ($commentCounts as $id => $count) {
+                $this->cachedCount[(int)$id] = $count;
+            }
+        }
+
+    }
+
+    private function preloadCollection(PropFind $propFind, ICollection $collection): void {
+        if (!($collection instanceof Directory)) {
+            return;
+        }
+
+        $collectionPath = $collection->getPath();
+        if (!isset($this->cachedDirectories[$collectionPath]) && (
+            $propFind->getStatus(self::PROPERTY_NAME_UNREAD) !== null
+            || $propFind->getStatus(self::PROPERTY_NAME_COUNT) !== null)) {
+            $this->cacheDirectory($collection, $propFind);
+            $this->cachedDirectories[$collectionPath] = true;
+        }
+    }
+
+    /**
+     * Adds tags and favorites properties to the response,
+     * if requested.
+     *
+     * @param PropFind $propFind
+     * @param \Sabre\DAV\INode $node
+     * @return void
+     */
+    public function handleGetProperties(
+        PropFind $propFind,
+        \Sabre\DAV\INode $node,
+    ) {
+        if (!($node instanceof File) && !($node instanceof Directory)) {
+            return;
+        }
+
+        $propFind->handle(self::PROPERTY_NAME_COUNT, function () use ($node): int {
+            return $this->cachedCount[$node->getId()] ?? $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId());
+        });
+
+        $propFind->handle(self::PROPERTY_NAME_HREF, function () use ($node): ?string {
+            return $this->getCommentsLink($node);
+        });
+
+        $propFind->handle(self::PROPERTY_NAME_UNREAD, function () use ($node): ?int {
+            return $this->cachedUnreadCount[$node->getId()] ?? $this->getUnreadCount($node);
+        });
+    }
+
+    /**
+     * Returns a reference to the comments node
+     */
+    public function getCommentsLink(Node $node): ?string {
+        $href = $this->server->getBaseUri();
+        $entryPoint = strpos($href, '/remote.php/');
+        if ($entryPoint === false) {
+            // in case we end up somewhere else, unexpectedly.
+            return null;
+        }
+        $commentsPart = 'dav/comments/files/' . rawurldecode((string)$node->getId());
+        return substr_replace($href, $commentsPart, $entryPoint + strlen('/remote.php/'));
+    }
+
+    /**
+     * Returns the number of unread comments for the currently logged in user
+     * on the given file or directory node
+     */
+    public function getUnreadCount(Node $node): ?int {
+        $user = $this->userSession->getUser();
+        if (is_null($user)) {
+            return null;
+        }
+
+        $objectId = (string)$node->getId();
+        return $this->commentsManager->getNumberOfUnreadCommentsForObjects('files', [$objectId], $user)[$objectId];
+    }
 }

Spacing +11 added lines, -11 removed lines

@@ -67,20 +67,20 @@ 
 				continue;
 			}
 
-			$ids[] = (string)$id;
+			$ids[] = (string) $id;
 		}
 
-		$ids[] = (string)$directory->getId();
+		$ids[] = (string) $directory->getId();
 		if (!is_null($propFind->getStatus(self::PROPERTY_NAME_UNREAD))) {
 			$user = $this->userSession->getUser();
 			if ($user) {
 				$unread = $this->commentsManager->getNumberOfUnreadCommentsForObjects('files', $ids, $user);
 				foreach ($unread as $id => $count) {
-					$this->cachedUnreadCount[(int)$id] = $count;
+					$this->cachedUnreadCount[(int) $id] = $count;
 				}
 			} else {
 				foreach ($ids as $id) {
-					$this->cachedUnreadCount[(int)$id] = null;
+					$this->cachedUnreadCount[(int) $id] = null;
 				}
 			}
 		}
@@ -88,7 +88,7 @@ 
 		if (!is_null($propFind->getStatus(self::PROPERTY_NAME_COUNT))) {
 			$commentCounts = $this->commentsManager->getNumberOfCommentsForObjects('files', $ids);
 			foreach ($commentCounts as $id => $count) {
-				$this->cachedCount[(int)$id] = $count;
+				$this->cachedCount[(int) $id] = $count;
 			}
 		}
 
@@ -124,15 +124,15 @@ 
 			return;
 		}
 
-		$propFind->handle(self::PROPERTY_NAME_COUNT, function () use ($node): int {
-			return $this->cachedCount[$node->getId()] ?? $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId());
+		$propFind->handle(self::PROPERTY_NAME_COUNT, function() use ($node): int {
+			return $this->cachedCount[$node->getId()] ?? $this->commentsManager->getNumberOfCommentsForObject('files', (string) $node->getId());
 		});
 
-		$propFind->handle(self::PROPERTY_NAME_HREF, function () use ($node): ?string {
+		$propFind->handle(self::PROPERTY_NAME_HREF, function() use ($node): ?string {
 			return $this->getCommentsLink($node);
 		});
 
-		$propFind->handle(self::PROPERTY_NAME_UNREAD, function () use ($node): ?int {
+		$propFind->handle(self::PROPERTY_NAME_UNREAD, function() use ($node): ?int {
 			return $this->cachedUnreadCount[$node->getId()] ?? $this->getUnreadCount($node);
 		});
 	}
@@ -147,7 +147,7 @@ 
 			// in case we end up somewhere else, unexpectedly.
 			return null;
 		}
-		$commentsPart = 'dav/comments/files/' . rawurldecode((string)$node->getId());
+		$commentsPart = 'dav/comments/files/'.rawurldecode((string) $node->getId());
 		return substr_replace($href, $commentsPart, $entryPoint + strlen('/remote.php/'));
 	}
 
@@ -161,7 +161,7 @@ 
 			return null;
 		}
 
-		$objectId = (string)$node->getId();
+		$objectId = (string) $node->getId();
 		return $this->commentsManager->getNumberOfUnreadCommentsForObjects('files', [$objectId], $user)[$objectId];
 	}
 }

apps/dav/tests/unit/Connector/Sabre/CommentsPropertiesPluginTest.php

Indentation +95 added lines, -95 removed lines

@@ -19,99 +19,99 @@
 use Sabre\DAV\Server;
 
 class CommentsPropertiesPluginTest extends \Test\TestCase {
-	protected CommentPropertiesPluginImplementation $plugin;
-	protected ICommentsManager&MockObject $commentsManager;
-	protected IUserSession&MockObject $userSession;
-	protected Server&MockObject $server;
-
-	protected function setUp(): void {
-		parent::setUp();
-
-		$this->commentsManager = $this->createMock(ICommentsManager::class);
-		$this->userSession = $this->createMock(IUserSession::class);
-		$this->server = $this->createMock(Server::class);
-
-		$this->plugin = new CommentPropertiesPluginImplementation($this->commentsManager, $this->userSession);
-		$this->plugin->initialize($this->server);
-	}
-
-	public static function nodeProvider(): array {
-		return [
-			[File::class, true],
-			[Directory::class, true],
-			[\Sabre\DAV\INode::class, false]
-		];
-	}
-
-	#[\PHPUnit\Framework\Attributes\DataProvider('nodeProvider')]
-	public function testHandleGetProperties(string $class, bool $expectedSuccessful): void {
-		$propFind = $this->createMock(PropFind::class);
-
-		if ($expectedSuccessful) {
-			$propFind->expects($this->exactly(3))
-				->method('handle');
-		} else {
-			$propFind->expects($this->never())
-				->method('handle');
-		}
-
-		$node = $this->createMock($class);
-		$this->plugin->handleGetProperties($propFind, $node);
-	}
-
-	public static function baseUriProvider(): array {
-		return [
-			['owncloud/remote.php/webdav/', '4567', 'owncloud/remote.php/dav/comments/files/4567'],
-			['owncloud/remote.php/files/', '4567', 'owncloud/remote.php/dav/comments/files/4567'],
-			['owncloud/wicked.php/files/', '4567', null]
-		];
-	}
-
-	#[\PHPUnit\Framework\Attributes\DataProvider('baseUriProvider')]
-	public function testGetCommentsLink(string $baseUri, string $fid, ?string $expectedHref): void {
-		$node = $this->createMock(File::class);
-		$node->expects($this->any())
-			->method('getId')
-			->willReturn($fid);
-
-		$this->server->expects($this->once())
-			->method('getBaseUri')
-			->willReturn($baseUri);
-
-		$href = $this->plugin->getCommentsLink($node);
-		$this->assertSame($expectedHref, $href);
-	}
-
-	public static function userProvider(): array {
-		return [
-			[IUser::class],
-			[null]
-		];
-	}
-
-	#[\PHPUnit\Framework\Attributes\DataProvider('userProvider')]
-	public function testGetUnreadCount(?string $user): void {
-		$node = $this->createMock(File::class);
-		$node->expects($this->any())
-			->method('getId')
-			->willReturn('4567');
-
-		if ($user !== null) {
-			$user = $this->createMock($user);
-		}
-		$this->userSession->expects($this->once())
-			->method('getUser')
-			->willReturn($user);
-
-		$this->commentsManager->expects($this->any())
-			->method('getNumberOfUnreadCommentsForObjects')
-			->willReturn(['4567' => 42]);
-
-		$unread = $this->plugin->getUnreadCount($node);
-		if (is_null($user)) {
-			$this->assertNull($unread);
-		} else {
-			$this->assertSame($unread, 42);
-		}
-	}
+    protected CommentPropertiesPluginImplementation $plugin;
+    protected ICommentsManager&MockObject $commentsManager;
+    protected IUserSession&MockObject $userSession;
+    protected Server&MockObject $server;
+
+    protected function setUp(): void {
+        parent::setUp();
+
+        $this->commentsManager = $this->createMock(ICommentsManager::class);
+        $this->userSession = $this->createMock(IUserSession::class);
+        $this->server = $this->createMock(Server::class);
+
+        $this->plugin = new CommentPropertiesPluginImplementation($this->commentsManager, $this->userSession);
+        $this->plugin->initialize($this->server);
+    }
+
+    public static function nodeProvider(): array {
+        return [
+            [File::class, true],
+            [Directory::class, true],
+            [\Sabre\DAV\INode::class, false]
+        ];
+    }
+
+    #[\PHPUnit\Framework\Attributes\DataProvider('nodeProvider')]
+    public function testHandleGetProperties(string $class, bool $expectedSuccessful): void {
+        $propFind = $this->createMock(PropFind::class);
+
+        if ($expectedSuccessful) {
+            $propFind->expects($this->exactly(3))
+                ->method('handle');
+        } else {
+            $propFind->expects($this->never())
+                ->method('handle');
+        }
+
+        $node = $this->createMock($class);
+        $this->plugin->handleGetProperties($propFind, $node);
+    }
+
+    public static function baseUriProvider(): array {
+        return [
+            ['owncloud/remote.php/webdav/', '4567', 'owncloud/remote.php/dav/comments/files/4567'],
+            ['owncloud/remote.php/files/', '4567', 'owncloud/remote.php/dav/comments/files/4567'],
+            ['owncloud/wicked.php/files/', '4567', null]
+        ];
+    }
+
+    #[\PHPUnit\Framework\Attributes\DataProvider('baseUriProvider')]
+    public function testGetCommentsLink(string $baseUri, string $fid, ?string $expectedHref): void {
+        $node = $this->createMock(File::class);
+        $node->expects($this->any())
+            ->method('getId')
+            ->willReturn($fid);
+
+        $this->server->expects($this->once())
+            ->method('getBaseUri')
+            ->willReturn($baseUri);
+
+        $href = $this->plugin->getCommentsLink($node);
+        $this->assertSame($expectedHref, $href);
+    }
+
+    public static function userProvider(): array {
+        return [
+            [IUser::class],
+            [null]
+        ];
+    }
+
+    #[\PHPUnit\Framework\Attributes\DataProvider('userProvider')]
+    public function testGetUnreadCount(?string $user): void {
+        $node = $this->createMock(File::class);
+        $node->expects($this->any())
+            ->method('getId')
+            ->willReturn('4567');
+
+        if ($user !== null) {
+            $user = $this->createMock($user);
+        }
+        $this->userSession->expects($this->once())
+            ->method('getUser')
+            ->willReturn($user);
+
+        $this->commentsManager->expects($this->any())
+            ->method('getNumberOfUnreadCommentsForObjects')
+            ->willReturn(['4567' => 42]);
+
+        $unread = $this->plugin->getUnreadCount($node);
+        if (is_null($user)) {
+            $this->assertNull($unread);
+        } else {
+            $this->assertSame($unread, 42);
+        }
+    }
 }

tests/lib/Comments/FakeManager.php

Indentation +127 added lines, -127 removed lines

@@ -16,144 +16,144 @@
  * Class FakeManager
  */
 class FakeManager implements ICommentsManager {
-	public function get($id) {
-	}
-
-	public function getTree($id, $limit = 0, $offset = 0) {
-	}
-
-	public function getForObject(
-		$objectType,
-		$objectId,
-		$limit = 0,
-		$offset = 0,
-		?\DateTime $notOlderThan = null,
-	) {
-	}
+    public function get($id) {
+    }
+
+    public function getTree($id, $limit = 0, $offset = 0) {
+    }
+
+    public function getForObject(
+        $objectType,
+        $objectId,
+        $limit = 0,
+        $offset = 0,
+        ?\DateTime $notOlderThan = null,
+    ) {
+    }
 
-	public function getForObjectSince(
-		string $objectType,
-		string $objectId,
-		int $lastKnownCommentId,
-		string $sortDirection = 'asc',
-		int $limit = 30,
-		bool $includeLastKnown = false,
-		string $topmostParentId = '',
-	): array {
-		return [];
-	}
+    public function getForObjectSince(
+        string $objectType,
+        string $objectId,
+        int $lastKnownCommentId,
+        string $sortDirection = 'asc',
+        int $limit = 30,
+        bool $includeLastKnown = false,
+        string $topmostParentId = '',
+    ): array {
+        return [];
+    }
 
-	public function getCommentsWithVerbForObjectSinceComment(
-		string $objectType,
-		string $objectId,
-		array $verbs,
-		int $lastKnownCommentId,
-		string $sortDirection = 'asc',
-		int $limit = 30,
-		bool $includeLastKnown = false,
-		string $topmostParentId = '',
-	): array {
-		return [];
-	}
-
-	public function getNumberOfCommentsForObject($objectType, $objectId, ?\DateTime $notOlderThan = null, $verb = '') {
-	}
-
-	public function getNumberOfCommentsForObjects(string $objectType, array $objectIds, ?\DateTime $notOlderThan = null, string $verb = '') :array {
-		return array_fill_keys($objectIds, 0);
-	}
-
-	public function search(string $search, string $objectType, string $objectId, string $verb, int $offset, int $limit = 50): array {
-		return [];
-	}
-
-	public function create($actorType, $actorId, $objectType, $objectId) {
-	}
-
-	public function delete($id) {
-	}
-
-	public function getReactionComment(int $parentId, string $actorType, string $actorId, string $reaction): IComment {
-		return new Comment();
-	}
-
-	public function retrieveAllReactions(int $parentId): array {
-		return [];
-	}
-
-	public function retrieveAllReactionsWithSpecificReaction(int $parentId, string $reaction): array {
-		return [];
-	}
-
-	public function supportReactions(): bool {
-		return false;
-	}
-
-	public function save(IComment $comment) {
-	}
-
-	public function deleteReferencesOfActor($actorType, $actorId) {
-	}
-
-	public function deleteCommentsAtObject($objectType, $objectId) {
-	}
-
-	public function setReadMark($objectType, $objectId, \DateTime $dateTime, IUser $user) {
-	}
-
-	public function getReadMark($objectType, $objectId, IUser $user) {
-	}
-
-	public function deleteReadMarksFromUser(IUser $user) {
-	}
-
-	public function deleteReadMarksOnObject($objectType, $objectId) {
-	}
-
-	public function registerEventHandler(\Closure $closure) {
-	}
-
-	public function registerDisplayNameResolver($type, \Closure $closure) {
-	}
-
-	public function resolveDisplayName($type, $id) {
-	}
+    public function getCommentsWithVerbForObjectSinceComment(
+        string $objectType,
+        string $objectId,
+        array $verbs,
+        int $lastKnownCommentId,
+        string $sortDirection = 'asc',
+        int $limit = 30,
+        bool $includeLastKnown = false,
+        string $topmostParentId = '',
+    ): array {
+        return [];
+    }
+
+    public function getNumberOfCommentsForObject($objectType, $objectId, ?\DateTime $notOlderThan = null, $verb = '') {
+    }
+
+    public function getNumberOfCommentsForObjects(string $objectType, array $objectIds, ?\DateTime $notOlderThan = null, string $verb = '') :array {
+        return array_fill_keys($objectIds, 0);
+    }
+
+    public function search(string $search, string $objectType, string $objectId, string $verb, int $offset, int $limit = 50): array {
+        return [];
+    }
+
+    public function create($actorType, $actorId, $objectType, $objectId) {
+    }
+
+    public function delete($id) {
+    }
+
+    public function getReactionComment(int $parentId, string $actorType, string $actorId, string $reaction): IComment {
+        return new Comment();
+    }
+
+    public function retrieveAllReactions(int $parentId): array {
+        return [];
+    }
+
+    public function retrieveAllReactionsWithSpecificReaction(int $parentId, string $reaction): array {
+        return [];
+    }
+
+    public function supportReactions(): bool {
+        return false;
+    }
+
+    public function save(IComment $comment) {
+    }
+
+    public function deleteReferencesOfActor($actorType, $actorId) {
+    }
+
+    public function deleteCommentsAtObject($objectType, $objectId) {
+    }
+
+    public function setReadMark($objectType, $objectId, \DateTime $dateTime, IUser $user) {
+    }
+
+    public function getReadMark($objectType, $objectId, IUser $user) {
+    }
+
+    public function deleteReadMarksFromUser(IUser $user) {
+    }
+
+    public function deleteReadMarksOnObject($objectType, $objectId) {
+    }
+
+    public function registerEventHandler(\Closure $closure) {
+    }
+
+    public function registerDisplayNameResolver($type, \Closure $closure) {
+    }
+
+    public function resolveDisplayName($type, $id) {
+    }
 
-	public function getNumberOfUnreadCommentsForFolder($folderId, IUser $user) {
-	}
+    public function getNumberOfUnreadCommentsForFolder($folderId, IUser $user) {
+    }
 
-	public function getNumberOfUnreadCommentsForObjects(string $objectType, array $objectIds, IUser $user, $verb = ''): array {
-		return [];
-	}
+    public function getNumberOfUnreadCommentsForObjects(string $objectType, array $objectIds, IUser $user, $verb = ''): array {
+        return [];
+    }
 
 
-	public function getActorsInTree($id) {
-	}
+    public function getActorsInTree($id) {
+    }
 
-	public function load(): void {
-	}
+    public function load(): void {
+    }
 
-	public function searchForObjects(string $search, string $objectType, array $objectIds, string $verb, int $offset, int $limit = 50): array {
-		return [];
-	}
+    public function searchForObjects(string $search, string $objectType, array $objectIds, string $verb, int $offset, int $limit = 50): array {
+        return [];
+    }
 
-	public function getNumberOfCommentsForObjectSinceComment(string $objectType, string $objectId, int $lastRead, string $verb = ''): int {
-		return 0;
-	}
+    public function getNumberOfCommentsForObjectSinceComment(string $objectType, string $objectId, int $lastRead, string $verb = ''): int {
+        return 0;
+    }
 
-	public function getNumberOfCommentsWithVerbsForObjectSinceComment(string $objectType, string $objectId, int $lastRead, array $verbs): int {
-		return 0;
-	}
+    public function getNumberOfCommentsWithVerbsForObjectSinceComment(string $objectType, string $objectId, int $lastRead, array $verbs): int {
+        return 0;
+    }
 
-	public function getLastCommentBeforeDate(string $objectType, string $objectId, \DateTime $beforeDate, string $verb = ''): int {
-		return 0;
-	}
+    public function getLastCommentBeforeDate(string $objectType, string $objectId, \DateTime $beforeDate, string $verb = ''): int {
+        return 0;
+    }
 
-	public function getLastCommentDateByActor(string $objectType, string $objectId, string $verb, string $actorType, array $actors): array {
-		return [];
-	}
+    public function getLastCommentDateByActor(string $objectType, string $objectId, string $verb, string $actorType, array $actors): array {
+        return [];
+    }
 
-	public function deleteCommentsExpiredAtObject(string $objectType, string $objectId = ''): bool {
-		return true;
-	}
+    public function deleteCommentsExpiredAtObject(string $objectType, string $objectId = ''): bool {
+        return true;
+    }
 }