Allow getting the unread comment count for an entire folder at once

Signed-off-by: Robin Appelman <robin@icewind.nl>

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

@@ -42,6 +42,10 @@ class CommentPropertiesPlugin extends ServerPlugin {
 	/** @var IUserSession */
 	private $userSession;
 
+	private $cachedUnreadCount = [];
+
+	private $cachedFolders = [];
+
 	public function __construct(ICommentsManager $commentsManager, IUserSession $userSession) {
 		$this->commentsManager = $commentsManager;
 		$this->userSession = $userSession;
@@ -79,6 +83,18 @@ class CommentPropertiesPlugin extends ServerPlugin {
 			return;
 		}
 
+		// need prefetch ?
+		if ($node instanceof \OCA\DAV\Connector\Sabre\Directory
+			&& $propFind->getDepth() !== 0
+			&& !is_null($propFind->getStatus(self::PROPERTY_NAME_UNREAD))
+		) {
+			$unreadCounts = $this->commentsManager->getNumberOfUnreadCommentsForFolder($node->getId(), $this->userSession->getUser());
+			$this->cachedFolders[] = $node->getPath();
+			foreach ($unreadCounts as $id => $count) {
+				$this->cachedUnreadCount[$id] = $count;
+			}
+		}
+
 		$propFind->handle(self::PROPERTY_NAME_COUNT, function() use ($node) {
 			return $this->commentsManager->getNumberOfCommentsForObject('files', strval($node->getId()));
 		});
@@ -88,7 +104,20 @@ class CommentPropertiesPlugin extends ServerPlugin {
 		});
 
 		$propFind->handle(self::PROPERTY_NAME_UNREAD, function() use ($node) {
+			if (isset($this->cachedUnreadCount[$node->getId()])) {
+				return $this->cachedUnreadCount[$node->getId()];
+			} else {
+				list($parentPath,) = \Sabre\Uri\split($node->getPath());
+				if ($parentPath === '') {
+					$parentPath = '/';
+				}
+				// if we already cached the folder this file is in we know there are no shares for this file
+				if (array_search($parentPath, $this->cachedFolders) === false) {
 					return $this->getUnreadCount($node);
+				} else {
+					return 0;
+				}
+			}
 		});
 	}
 

lib/private/Comments/Manager.php

@@ -21,9 +21,13 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>
  *
  */
+
 namespace OC\Comments;
 
 use Doctrine\DBAL\Exception\DriverException;
+use OC\DB\QueryBuilder\Literal;
+use OC\DB\QueryBuilder\QueryBuilder;
+use OC\DB\QueryBuilder\QueryFunction;
 use OCP\Comments\CommentsEvent;
 use OCP\Comments\IComment;
 use OCP\Comments\ICommentsEventHandler;
@@ -104,7 +108,7 @@ class Manager implements ICommentsManager {
 	 * @throws \UnexpectedValueException
 	 */
 	protected function prepareCommentForDatabaseWrite(IComment $comment) {
-		if(    !$comment->getActorType()
+		if (!$comment->getActorType()
 			|| !$comment->getActorId()
 			|| !$comment->getObjectType()
 			|| !$comment->getObjectId()
@@ -113,17 +117,17 @@ class Manager implements ICommentsManager {
 			throw new \UnexpectedValueException('Actor, Object and Verb information must be provided for saving');
 		}
 
-		if($comment->getId() === '') {
+		if ($comment->getId() === '') {
 			$comment->setChildrenCount(0);
 			$comment->setLatestChildDateTime(new \DateTime('0000-00-00 00:00:00', new \DateTimeZone('UTC')));
 			$comment->setLatestChildDateTime(null);
 		}
 
-		if(is_null($comment->getCreationDateTime())) {
+		if (is_null($comment->getCreationDateTime())) {
 			$comment->setCreationDateTime(new \DateTime());
 		}
 
-		if($comment->getParentId() !== '0') {
+		if ($comment->getParentId() !== '0') {
 			$comment->setTopmostParentId($this->determineTopmostParentId($comment->getParentId()));
 		} else {
 			$comment->setTopmostParentId('0');
@@ -143,7 +147,7 @@ class Manager implements ICommentsManager {
 	 */
 	protected function determineTopmostParentId($id) {
 		$comment = $this->get($id);
-		if($comment->getParentId() === '0') {
+		if ($comment->getParentId() === '0') {
 			return $comment->getId();
 		} else {
 			return $this->determineTopmostParentId($comment->getId());
@@ -185,7 +189,7 @@ class Manager implements ICommentsManager {
 	 * @throws \InvalidArgumentException
 	 */
 	protected function checkRoleParameters($role, $type, $id) {
-		if(
+		if (
 			!is_string($type) || empty($type)
 			|| !is_string($id) || empty($id)
 		) {
@@ -200,7 +204,7 @@ class Manager implements ICommentsManager {
 	 */
 	protected function cache(IComment $comment) {
 		$id = $comment->getId();
-		if(empty($id)) {
+		if (empty($id)) {
 			return;
 		}
 		$this->commentsCache[strval($id)] = $comment;
@@ -228,11 +232,11 @@ class Manager implements ICommentsManager {
 	 * @since 9.0.0
 	 */
 	public function get($id) {
-		if(intval($id) === 0) {
+		if (intval($id) === 0) {
 			throw new \InvalidArgumentException('IDs must be translatable to a number in this implementation.');
 		}
 
-		if(isset($this->commentsCache[$id])) {
+		if (isset($this->commentsCache[$id])) {
 			return $this->commentsCache[$id];
 		}
 
@@ -245,7 +249,7 @@ class Manager implements ICommentsManager {
 
 		$data = $resultStatement->fetch();
 		$resultStatement->closeCursor();
-		if(!$data) {
+		if (!$data) {
 			throw new NotFoundException();
 		}
 
@@ -295,15 +299,15 @@ class Manager implements ICommentsManager {
 			->orderBy('creation_timestamp', 'DESC')
 			->setParameter('id', $id);
 
-		if($limit > 0) {
+		if ($limit > 0) {
 			$query->setMaxResults($limit);
 		}
-		if($offset > 0) {
+		if ($offset > 0) {
 			$query->setFirstResult($offset);
 		}
 
 		$resultStatement = $query->execute();
-		while($data = $resultStatement->fetch()) {
+		while ($data = $resultStatement->fetch()) {
 			$comment = new Comment($this->normalizeDatabaseData($data));
 			$this->cache($comment);
 			$tree['replies'][] = [
@@ -349,20 +353,20 @@ class Manager implements ICommentsManager {
 			->setParameter('type', $objectType)
 			->setParameter('id', $objectId);
 
-		if($limit > 0) {
+		if ($limit > 0) {
 			$query->setMaxResults($limit);
 		}
-		if($offset > 0) {
+		if ($offset > 0) {
 			$query->setFirstResult($offset);
 		}
-		if(!is_null($notOlderThan)) {
+		if (!is_null($notOlderThan)) {
 			$query
 				->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
 				->setParameter('notOlderThan', $notOlderThan, 'datetime');
 		}
 
 		$resultStatement = $query->execute();
-		while($data = $resultStatement->fetch()) {
+		while ($data = $resultStatement->fetch()) {
 			$comment = new Comment($this->normalizeDatabaseData($data));
 			$this->cache($comment);
 			$comments[] = $comment;
@@ -389,7 +393,7 @@ class Manager implements ICommentsManager {
 			->setParameter('type', $objectType)
 			->setParameter('id', $objectId);
 
-		if(!is_null($notOlderThan)) {
+		if (!is_null($notOlderThan)) {
 			$query
 				->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan')))
 				->setParameter('notOlderThan', $notOlderThan, 'datetime');
@@ -401,6 +405,40 @@ class Manager implements ICommentsManager {
 		return intval($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('fileid', $qb->createFunction(
+			'COUNT(' . $qb->getColumnName('c.id') . ')')
+		)->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->createFunction(
+					'cast(' . $qb->getColumnName('c.object_id') . ' as 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();
+		return $resultStatement->fetchAll(\PDO::FETCH_KEY_PAIR);
+	}
+
 	/**
 	 * 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
@@ -433,7 +471,7 @@ class Manager implements ICommentsManager {
 	 * @since 9.0.0
 	 */
 	public function delete($id) {
-		if(!is_string($id)) {
+		if (!is_string($id)) {
 			throw new \InvalidArgumentException('Parameter must be string');
 		}
 
@@ -481,13 +519,13 @@ class Manager implements ICommentsManager {
 	 * @since 9.0.0
 	 */
 	public function save(IComment $comment) {
-		if($this->prepareCommentForDatabaseWrite($comment)->getId() === '') {
+		if ($this->prepareCommentForDatabaseWrite($comment)->getId() === '') {
 			$result = $this->insert($comment);
 		} else {
 			$result = $this->update($comment);
 		}
 
-		if($result && !!$comment->getParentId()) {
+		if ($result && !!$comment->getParentId()) {
 			$this->updateChildrenInformation(
 				$comment->getParentId(),
 				$comment->getCreationDateTime()
@@ -563,7 +601,7 @@ class Manager implements ICommentsManager {
 			->setParameter('id', $comment->getId())
 			->execute();
 
-		if($affectedRows === 0) {
+		if ($affectedRows === 0) {
 			throw new NotFoundException('Comment to update does ceased to exist');
 		}
 
@@ -717,7 +755,7 @@ class Manager implements ICommentsManager {
 
 		$data = $resultStatement->fetch();
 		$resultStatement->closeCursor();
-		if(!$data || is_null($data['marker_datetime'])) {
+		if (!$data || is_null($data['marker_datetime'])) {
 			return null;
 		}
 
@@ -774,10 +812,10 @@ class Manager implements ICommentsManager {
 	 * \OutOfBoundsException has to thrown.
 	 */
 	public function registerDisplayNameResolver($type, \Closure $closure) {
-		if(!is_string($type)) {
+		if (!is_string($type)) {
 			throw new \InvalidArgumentException('String expected.');
 		}
-		if(isset($this->displayNameResolvers[$type])) {
+		if (isset($this->displayNameResolvers[$type])) {
 			throw new \OutOfBoundsException('Displayname resolver for this type already registered');
 		}
 		$this->displayNameResolvers[$type] = $closure;
@@ -797,10 +835,10 @@ class Manager implements ICommentsManager {
 	 * provided ID is unknown. It must be ensured that a string is returned.
 	 */
 	public function resolveDisplayName($type, $id) {
-		if(!is_string($type)) {
+		if (!is_string($type)) {
 			throw new \InvalidArgumentException('String expected.');
 		}
-		if(!isset($this->displayNameResolvers[$type])) {
+		if (!isset($this->displayNameResolvers[$type])) {
 			throw new \OutOfBoundsException('No Displayname resolver for this type registered');
 		}
 		return (string)$this->displayNameResolvers[$type]($id);
@@ -812,7 +850,7 @@ class Manager implements ICommentsManager {
 	 * @return \OCP\Comments\ICommentsEventHandler[]
 	 */
 	private function getEventHandlers() {
-		if(!empty($this->eventHandlers)) {
+		if (!empty($this->eventHandlers)) {
 			return $this->eventHandlers;
 		}
 

lib/private/DB/QueryBuilder/QuoteHelper.php

@@ -73,7 +73,7 @@ class QuoteHelper {
 				return $string;
 			}
 
-			return $alias . '.`' . $columnName . '`';
+			return '`' . $alias . '`.`' . $columnName . '`';
 		}
 
 		return '`' . $string . '`';

lib/public/Comments/ICommentsManager.php

@@ -23,6 +23,8 @@
  */
 namespace OCP\Comments;
 
+use OCP\IUser;
+
 /**
  * Interface ICommentsManager
  *
@@ -125,6 +127,16 @@ interface ICommentsManager {
 	 */
 	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);
+
 	/**
 	 * 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