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 => "🧑🏽‍💻" is a single emoji from the picker throw new \UnexpectedValueException('Reactions can only be a single emoji'); } if ($comment->getId() === '') { $comment->setChildrenCount(0); $comment->setLatestChildDateTime(null); } try { $comment->getCreationDateTime(); } catch (\LogicException $e) { $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 * @throws NotFoundException */ protected function determineTopmostParentId($id): string { $comment = $this->get($id); if ($comment->getParentId() === '0') { return $comment->getId(); } return $this->determineTopmostParentId($comment->getParentId()); } /** * updates child information of a comment * * @param string $id * @param \DateTime $cDateTime the date time of the most recent child * @throws NotFoundException */ protected function updateChildrenInformation($id, \DateTime $cDateTime): void { $qb = $this->dbConn->getQueryBuilder(); $query = $qb->select($qb->func()->count('id')) ->from('comments') ->where($qb->expr()->eq('parent_id', $qb->createParameter('id'))) ->setParameter('id', $id); $resultStatement = $query->execute(); $data = $resultStatement->fetch(\PDO::FETCH_NUM); $resultStatement->closeCursor(); $children = (int)$data[0]; $comment = $this->get($id); $comment->setChildrenCount($children); $comment->setLatestChildDateTime($cDateTime); $this->save($comment); } /** * Tests whether actor or object type and id parameters are acceptable. * Throws exception if not. * * @param string $role * @param string $type * @param string $id * @throws \InvalidArgumentException */ protected function checkRoleParameters($role, $type, $id): void { 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 */ protected function cache(IComment $comment): void { $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): void { $id = (string)$id; if (isset($this->commentsCache[$id])) { unset($this->commentsCache[$id]); } } /** * returns a comment instance * * @param string $id the ID of the comment * @throws NotFoundException * @throws \InvalidArgumentException * @since 9.0.0 */ public function get($id): IComment { if ((int)$id === 0) { throw new \InvalidArgumentException('IDs must be translatable to a number in this implementation.'); } if (isset($this->commentsCache[$id])) { return $this->commentsCache[$id]; } $qb = $this->dbConn->getQueryBuilder(); $resultStatement = $qb->select('*') ->from('comments') ->where($qb->expr()->eq('id', $qb->createParameter('id'))) ->setParameter('id', $id, IQueryBuilder::PARAM_INT) ->execute(); $data = $resultStatement->fetch(); $resultStatement->closeCursor(); if (!$data) { throw new NotFoundException(); } $comment = $this->getCommentFromData($data); $this->cache($comment); return $comment; } /** * @inheritDoc */ public function getTree($id, $limit = 0, $offset = 0): array { $tree = []; $tree['comment'] = $this->get($id); $tree['replies'] = []; $qb = $this->dbConn->getQueryBuilder(); $query = $qb->select('*') ->from('comments') ->where($qb->expr()->eq('topmost_parent_id', $qb->createParameter('id'))) ->orderBy('creation_timestamp', 'DESC') ->setParameter('id', $id); if ($limit > 0) { $query->setMaxResults($limit); } if ($offset > 0) { $query->setFirstResult($offset); } $resultStatement = $query->execute(); while ($data = $resultStatement->fetch()) { $comment = $this->getCommentFromData($data); $this->cache($comment); $tree['replies'][] = [ 'comment' => $comment, 'replies' => [] ]; } $resultStatement->closeCursor(); return $tree; } /** * returns comments for a specific object (e.g. a file). * * The sort order is always newest to oldest. * * @param string $objectType the object type, e.g. 'files' * @param string $objectId the id of the object * @param int $limit optional, number of maximum comments to be returned. if * not specified, all comments are returned. * @param int $offset optional, starting point * @param \DateTime $notOlderThan optional, timestamp of the oldest comments * that may be returned * @return list * @since 9.0.0 */ public function getForObject( $objectType, $objectId, $limit = 0, $offset = 0, ?\DateTime $notOlderThan = null, ) { $comments = []; $qb = $this->dbConn->getQueryBuilder(); $query = $qb->select('*') ->from('comments') ->where($qb->expr()->eq('object_type', $qb->createParameter('type'))) ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id'))) ->orderBy('creation_timestamp', 'DESC') ->setParameter('type', $objectType) ->setParameter('id', $objectId); if ($limit > 0) { $query->setMaxResults($limit); } if ($offset > 0) { $query->setFirstResult($offset); } if (!is_null($notOlderThan)) { $query ->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan'))) ->setParameter('notOlderThan', $notOlderThan, 'datetime'); } $resultStatement = $query->execute(); while ($data = $resultStatement->fetch()) { $comment = $this->getCommentFromData($data); $this->cache($comment); $comments[] = $comment; } $resultStatement->closeCursor(); return $comments; } /** * @param string $objectType the object type, e.g. 'files' * @param string $objectId the id of the object * @param int $lastKnownCommentId the last known comment (will be used as offset) * @param string $sortDirection direction of the comments (`asc` or `desc`) * @param int $limit optional, number of maximum comments to be returned. if * set to 0, all comments are returned. * @param bool $includeLastKnown * @return list */ public function getForObjectSince( string $objectType, string $objectId, int $lastKnownCommentId, string $sortDirection = 'asc', int $limit = 30, bool $includeLastKnown = false, ): array { return $this->getCommentsWithVerbForObjectSinceComment( $objectType, $objectId, [], $lastKnownCommentId, $sortDirection, $limit, $includeLastKnown ); } /** * @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 * @return list */ public function getCommentsWithVerbForObjectSinceComment( string $objectType, string $objectId, array $verbs, int $lastKnownCommentId, string $sortDirection = 'asc', int $limit = 30, bool $includeLastKnown = false, ): array { $comments = []; $query = $this->dbConn->getQueryBuilder(); $query->select('*') ->from('comments') ->where($query->expr()->eq('object_type', $query->createNamedParameter($objectType))) ->andWhere($query->expr()->eq('object_id', $query->createNamedParameter($objectId))) ->orderBy('creation_timestamp', $sortDirection === 'desc' ? 'DESC' : 'ASC') ->addOrderBy('id', $sortDirection === 'desc' ? 'DESC' : 'ASC'); if ($limit > 0) { $query->setMaxResults($limit); } if (!empty($verbs)) { $query->andWhere($query->expr()->in('verb', $query->createNamedParameter($verbs, IQueryBuilder::PARAM_STR_ARRAY))); } $lastKnownComment = $lastKnownCommentId > 0 ? $this->getLastKnownComment( $objectType, $objectId, $lastKnownCommentId ) : null; if ($lastKnownComment instanceof IComment) { $lastKnownCommentDateTime = $lastKnownComment->getCreationDateTime(); if ($sortDirection === 'desc') { if ($includeLastKnown) { $idComparison = $query->expr()->lte('id', $query->createNamedParameter($lastKnownCommentId)); } else { $idComparison = $query->expr()->lt('id', $query->createNamedParameter($lastKnownCommentId)); } $query->andWhere( $query->expr()->orX( $query->expr()->lt( 'creation_timestamp', $query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATETIME_MUTABLE), IQueryBuilder::PARAM_DATETIME_MUTABLE ), $query->expr()->andX( $query->expr()->eq( 'creation_timestamp', $query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATETIME_MUTABLE), IQueryBuilder::PARAM_DATETIME_MUTABLE ), $idComparison ) ) ); } else { if ($includeLastKnown) { $idComparison = $query->expr()->gte('id', $query->createNamedParameter($lastKnownCommentId)); } else { $idComparison = $query->expr()->gt('id', $query->createNamedParameter($lastKnownCommentId)); } $query->andWhere( $query->expr()->orX( $query->expr()->gt( 'creation_timestamp', $query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATETIME_MUTABLE), IQueryBuilder::PARAM_DATETIME_MUTABLE ), $query->expr()->andX( $query->expr()->eq( 'creation_timestamp', $query->createNamedParameter($lastKnownCommentDateTime, IQueryBuilder::PARAM_DATETIME_MUTABLE), IQueryBuilder::PARAM_DATETIME_MUTABLE ), $idComparison ) ) ); } } elseif ($lastKnownCommentId > 0) { // We didn't find the "$lastKnownComment" but we still use the ID as an offset. // This is required as a fall-back for expired messages in talk and deleted comments in other apps. if ($sortDirection === 'desc') { if ($includeLastKnown) { $query->andWhere($query->expr()->lte('id', $query->createNamedParameter($lastKnownCommentId))); } else { $query->andWhere($query->expr()->lt('id', $query->createNamedParameter($lastKnownCommentId))); } } else { if ($includeLastKnown) { $query->andWhere($query->expr()->gte('id', $query->createNamedParameter($lastKnownCommentId))); } else { $query->andWhere($query->expr()->gt('id', $query->createNamedParameter($lastKnownCommentId))); } } } $resultStatement = $query->execute(); while ($data = $resultStatement->fetch()) { $comment = $this->getCommentFromData($data); $this->cache($comment); $comments[] = $comment; } $resultStatement->closeCursor(); return $comments; } /** * @param string $objectType the object type, e.g. 'files' * @param string $objectId the id of the object * @param int $id the comment to look for */ protected function getLastKnownComment(string $objectType, string $objectId, int $id): ?IComment { $query = $this->dbConn->getQueryBuilder(); $query->select('*') ->from('comments') ->where($query->expr()->eq('object_type', $query->createNamedParameter($objectType))) ->andWhere($query->expr()->eq('object_id', $query->createNamedParameter($objectId))) ->andWhere($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT))); $result = $query->execute(); $row = $result->fetch(); $result->closeCursor(); if ($row) { $comment = $this->getCommentFromData($row); $this->cache($comment); return $comment; } return null; } /** * Search for comments with a given content * * @param string $search content to search for * @param string $objectType Limit the search by object type * @param string $objectId Limit the search by object id * @param string $verb Limit the verb of the comment * @param int $offset * @param int $limit * @return list */ public function search(string $search, string $objectType, string $objectId, string $verb, int $offset, int $limit = 50): array { $objectIds = []; if ($objectId) { $objectIds[] = $objectId; } return $this->searchForObjects($search, $objectType, $objectIds, $verb, $offset, $limit); } /** * 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 list */ public function searchForObjects(string $search, string $objectType, array $objectIds, string $verb, int $offset, int $limit = 50): array { $query = $this->dbConn->getQueryBuilder(); $query->select('*') ->from('comments') ->orderBy('creation_timestamp', 'DESC') ->addOrderBy('id', 'DESC') ->setMaxResults($limit); if ($search !== '') { $query->where($query->expr()->iLike('message', $query->createNamedParameter( '%' . $this->dbConn->escapeLikeParameter($search) . '%' ))); } if ($objectType !== '') { $query->andWhere($query->expr()->eq('object_type', $query->createNamedParameter($objectType))); } if (!empty($objectIds)) { $query->andWhere($query->expr()->in('object_id', $query->createNamedParameter($objectIds, IQueryBuilder::PARAM_STR_ARRAY))); } if ($verb !== '') { $query->andWhere($query->expr()->eq('verb', $query->createNamedParameter($verb))); } if ($offset !== 0) { $query->setFirstResult($offset); } $comments = []; $result = $query->execute(); while ($data = $result->fetch()) { $comment = $this->getCommentFromData($data); $this->cache($comment); $comments[] = $comment; } $result->closeCursor(); return $comments; } /** * @param $objectType string the object type, e.g. 'files' * @param $objectId string the id of the object * @param \DateTime $notOlderThan optional, timestamp of the oldest comments * that may be returned * @param string $verb Limit the verb of the comment - Added in 14.0.0 * @return Int * @since 9.0.0 */ public function getNumberOfCommentsForObject($objectType, $objectId, ?\DateTime $notOlderThan = null, $verb = '') { $qb = $this->dbConn->getQueryBuilder(); $query = $qb->select($qb->func()->count('id')) ->from('comments') ->where($qb->expr()->eq('object_type', $qb->createParameter('type'))) ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id'))) ->setParameter('type', $objectType) ->setParameter('id', $objectId); if (!is_null($notOlderThan)) { $query ->andWhere($qb->expr()->gt('creation_timestamp', $qb->createParameter('notOlderThan'))) ->setParameter('notOlderThan', $notOlderThan, 'datetime'); } if ($verb !== '') { $query->andWhere($qb->expr()->eq('verb', $qb->createNamedParameter($verb))); } $resultStatement = $query->execute(); $data = $resultStatement->fetch(\PDO::FETCH_NUM); $resultStatement->closeCursor(); return (int)$data[0]; } /** * @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 * @since 21.0.0 */ public function getNumberOfUnreadCommentsForObjects(string $objectType, array $objectIds, IUser $user, $verb = ''): array { $unreadComments = []; $query = $this->dbConn->getQueryBuilder(); $query->select('c.object_id', $query->func()->count('c.id', 'num_comments')) ->from('comments', 'c') ->leftJoin('c', 'comments_read_markers', 'm', $query->expr()->andX( $query->expr()->eq('m.user_id', $query->createNamedParameter($user->getUID())), $query->expr()->eq('c.object_type', 'm.object_type'), $query->expr()->eq('c.object_id', 'm.object_id') )) ->where($query->expr()->eq('c.object_type', $query->createNamedParameter($objectType))) ->andWhere($query->expr()->in('c.object_id', $query->createParameter('ids'))) ->andWhere($query->expr()->orX( $query->expr()->gt('c.creation_timestamp', 'm.marker_datetime'), $query->expr()->isNull('m.marker_datetime') )) ->groupBy('c.object_id'); if ($verb !== '') { $query->andWhere($query->expr()->eq('c.verb', $query->createNamedParameter($verb))); } $unreadComments = array_fill_keys($objectIds, 0); foreach (array_chunk($objectIds, 1000) as $chunk) { $query->setParameter('ids', $chunk, IQueryBuilder::PARAM_STR_ARRAY); $result = $query->executeQuery(); while ($row = $result->fetch()) { $unreadComments[$row['object_id']] = (int)$row['num_comments']; } $result->closeCursor(); } return $unreadComments; } /** * @param string $objectType * @param string $objectId * @param int $lastRead * @param string $verb * @return int * @since 21.0.0 */ public function getNumberOfCommentsForObjectSinceComment(string $objectType, string $objectId, int $lastRead, string $verb = ''): int { if ($verb !== '') { return $this->getNumberOfCommentsWithVerbsForObjectSinceComment($objectType, $objectId, $lastRead, [$verb]); } return $this->getNumberOfCommentsWithVerbsForObjectSinceComment($objectType, $objectId, $lastRead, []); } /** * @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 { $query = $this->dbConn->getQueryBuilder(); $query->select($query->func()->count('id', 'num_messages')) ->from('comments') ->where($query->expr()->eq('object_type', $query->createNamedParameter($objectType))) ->andWhere($query->expr()->eq('object_id', $query->createNamedParameter($objectId))) ->andWhere($query->expr()->gt('id', $query->createNamedParameter($lastRead))); if (!empty($verbs)) { $query->andWhere($query->expr()->in('verb', $query->createNamedParameter($verbs, IQueryBuilder::PARAM_STR_ARRAY))); } $result = $query->executeQuery(); $data = $result->fetch(); $result->closeCursor(); return (int)($data['num_messages'] ?? 0); } /** * @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 { $query = $this->dbConn->getQueryBuilder(); $query->select('id') ->from('comments') ->where($query->expr()->eq('object_type', $query->createNamedParameter($objectType))) ->andWhere($query->expr()->eq('object_id', $query->createNamedParameter($objectId))) ->andWhere($query->expr()->lt('creation_timestamp', $query->createNamedParameter($beforeDate, IQueryBuilder::PARAM_DATETIME_MUTABLE))) ->orderBy('creation_timestamp', 'desc'); if ($verb !== '') { $query->andWhere($query->expr()->eq('verb', $query->createNamedParameter($verb))); } $result = $query->execute(); $data = $result->fetch(); $result->closeCursor(); return (int)($data['id'] ?? 0); } /** * @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 * @since 21.0.0 */ public function getLastCommentDateByActor( string $objectType, string $objectId, string $verb, string $actorType, array $actors, ): array { $lastComments = []; $query = $this->dbConn->getQueryBuilder(); $query->select('actor_id') ->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))) ->andWhere($query->expr()->eq('verb', $query->createNamedParameter($verb))) ->andWhere($query->expr()->eq('actor_type', $query->createNamedParameter($actorType))) ->andWhere($query->expr()->in('actor_id', $query->createNamedParameter($actors, IQueryBuilder::PARAM_STR_ARRAY))) ->groupBy('actor_id'); $result = $query->execute(); while ($row = $result->fetch()) { $lastComments[$row['actor_id']] = $this->timeFactory->getDateTime($row['last_comment']); } $result->closeCursor(); return $lastComments; } /** * Get the number of unread comments for all files in a folder * * This is unused since 8bd39fccf411195839f2dadee085fad18ec52c23 * * @param int $folderId * @param IUser $user * @return array [$fileId => $unreadCount] */ public function getNumberOfUnreadCommentsForFolder($folderId, IUser $user) { $directory = $this->rootFolder->getFirstNodeById($folderId); if (!$directory instanceof Folder) { return []; } $children = $directory->getDirectoryListing(); $ids = array_map(fn (FileInfo $child) => (string)$child->getId(), $children); $ids[] = (string)$directory->getId(); $counts = $this->getNumberOfUnreadCommentsForObjects('files', $ids, $user); return array_filter($counts, function (int $count) { return $count > 0; }); } /** * creates a new comment and returns it. At this point of time, it is not * saved in the used data storage. Use save() after setting other fields * of the comment (e.g. message or verb). * * @param string $actorType the actor type (e.g. 'users') * @param string $actorId a user id * @param string $objectType the object type the comment is attached to * @param string $objectId the object id the comment is attached to * @return IComment * @since 9.0.0 */ public function create($actorType, $actorId, $objectType, $objectId) { $comment = new Comment(); $comment ->setActor($actorType, $actorId) ->setObject($objectType, $objectId); return $comment; } /** * permanently deletes the comment specified by the ID * * When the comment has child comments, their parent ID will be changed to * the parent ID of the item that is to be deleted. * * @param string $id * @return bool * @throws \InvalidArgumentException * @since 9.0.0 */ public function delete($id) { if (!is_string($id)) { throw new \InvalidArgumentException('Parameter must be string'); } try { $comment = $this->get($id); } catch (\Exception $e) { // Ignore exceptions, we just don't fire a hook then $comment = null; } $qb = $this->dbConn->getQueryBuilder(); $query = $qb->delete('comments') ->where($qb->expr()->eq('id', $qb->createParameter('id'))) ->setParameter('id', $id); try { $affectedRows = $query->execute(); $this->uncache($id); } catch (DriverException $e) { $this->logger->error($e->getMessage(), [ 'exception' => $e, 'app' => 'core_comments', ]); return false; } if ($affectedRows > 0 && $comment instanceof IComment) { if ($comment->getVerb() === 'reaction_deleted') { $this->deleteReaction($comment); } $this->sendEvent(CommentsEvent::EVENT_DELETE, $comment); } return ($affectedRows > 0); } private function deleteReaction(IComment $reaction): void { $qb = $this->dbConn->getQueryBuilder(); $qb->delete('reactions') ->where($qb->expr()->eq('parent_id', $qb->createNamedParameter($reaction->getParentId()))) ->andWhere($qb->expr()->eq('message_id', $qb->createNamedParameter($reaction->getId()))) ->executeStatement(); $this->sumReactions($reaction->getParentId()); } /** * 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 { $this->throwIfNotSupportReactions(); $qb = $this->dbConn->getQueryBuilder(); $messageId = $qb ->select('message_id') ->from('reactions') ->where($qb->expr()->eq('parent_id', $qb->createNamedParameter($parentId))) ->andWhere($qb->expr()->eq('actor_type', $qb->createNamedParameter($actorType))) ->andWhere($qb->expr()->eq('actor_id', $qb->createNamedParameter($actorId))) ->andWhere($qb->expr()->eq('reaction', $qb->createNamedParameter($reaction))) ->executeQuery() ->fetchOne(); if (!$messageId) { throw new NotFoundException('Comment related with reaction not found'); } return $this->get($messageId); } /** * 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 { $this->throwIfNotSupportReactions(); $qb = $this->dbConn->getQueryBuilder(); $result = $qb ->select('message_id') ->from('reactions') ->where($qb->expr()->eq('parent_id', $qb->createNamedParameter($parentId))) ->orderBy('message_id', 'DESC') ->executeQuery(); $commentIds = []; while ($data = $result->fetch()) { $commentIds[] = $data['message_id']; } return $this->getCommentsById($commentIds); } /** * 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 { $this->throwIfNotSupportReactions(); $qb = $this->dbConn->getQueryBuilder(); $result = $qb ->select('message_id') ->from('reactions') ->where($qb->expr()->eq('parent_id', $qb->createNamedParameter($parentId))) ->andWhere($qb->expr()->eq('reaction', $qb->createNamedParameter($reaction))) ->executeQuery(); $commentIds = []; while ($data = $result->fetch()) { $commentIds[] = $data['message_id']; } $comments = []; if ($commentIds) { $comments = $this->getCommentsById($commentIds); } return $comments; } /** * Support reactions * * @return bool * @since 24.0.0 */ public function supportReactions(): bool { return $this->emojiHelper->doesPlatformSupportEmoji(); } /** * @throws PreConditionNotMetException * @since 24.0.0 */ private function throwIfNotSupportReactions() { if (!$this->supportReactions()) { throw new PreConditionNotMetException('The database does not support reactions'); } } /** * Get all comments on list * * @param int[] $commentIds * @return IComment[] * @since 24.0.0 */ private function getCommentsById(array $commentIds): array { if (!$commentIds) { return []; } $chunks = array_chunk($commentIds, 500); $query = $this->dbConn->getQueryBuilder(); $query->select('*') ->from('comments') ->where($query->expr()->in('id', $query->createParameter('ids'))) ->orderBy('creation_timestamp', 'DESC') ->addOrderBy('id', 'DESC'); $comments = []; foreach ($chunks as $ids) { $query->setParameter('ids', $ids, IQueryBuilder::PARAM_STR_ARRAY); $result = $query->executeQuery(); while ($data = $result->fetch()) { $comment = $this->getCommentFromData($data); $this->cache($comment); $comments[] = $comment; } $result->closeCursor(); } return $comments; } /** * 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. * * Throws PreConditionNotMetException when the system haven't the minimum requirements to * use reactions * * @param IComment $comment * @return bool * @throws NotFoundException * @throws PreConditionNotMetException * @since 9.0.0 */ public function save(IComment $comment) { if ($comment->getVerb() === 'reaction') { $this->throwIfNotSupportReactions(); } if ($this->prepareCommentForDatabaseWrite($comment)->getId() === '') { $result = $this->insert($comment); } else { $result = $this->update($comment); } if ($result && (bool)$comment->getParentId()) { $this->updateChildrenInformation( $comment->getParentId(), $comment->getCreationDateTime() ); $this->cache($comment); } return $result; } /** * inserts the provided comment in the database * * @param IComment $comment * @return bool */ protected function insert(IComment $comment): bool { $qb = $this->dbConn->getQueryBuilder(); $values = [ 'parent_id' => $qb->createNamedParameter($comment->getParentId()), 'topmost_parent_id' => $qb->createNamedParameter($comment->getTopmostParentId()), 'children_count' => $qb->createNamedParameter($comment->getChildrenCount()), 'actor_type' => $qb->createNamedParameter($comment->getActorType()), 'actor_id' => $qb->createNamedParameter($comment->getActorId()), 'message' => $qb->createNamedParameter($comment->getMessage()), 'verb' => $qb->createNamedParameter($comment->getVerb()), 'creation_timestamp' => $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime'), 'latest_child_timestamp' => $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime'), 'object_type' => $qb->createNamedParameter($comment->getObjectType()), 'object_id' => $qb->createNamedParameter($comment->getObjectId()), 'expire_date' => $qb->createNamedParameter($comment->getExpireDate(), 'datetime'), 'reference_id' => $qb->createNamedParameter($comment->getReferenceId()), 'meta_data' => $qb->createNamedParameter(json_encode($comment->getMetaData())), ]; $affectedRows = $qb->insert('comments') ->values($values) ->execute(); if ($affectedRows > 0) { $comment->setId((string)$qb->getLastInsertId()); if ($comment->getVerb() === 'reaction') { $this->addReaction($comment); } $this->sendEvent(CommentsEvent::EVENT_ADD, $comment); } return $affectedRows > 0; } private function addReaction(IComment $reaction): void { // Prevent violate constraint $qb = $this->dbConn->getQueryBuilder(); $qb->select($qb->func()->count('*')) ->from('reactions') ->where($qb->expr()->eq('parent_id', $qb->createNamedParameter($reaction->getParentId()))) ->andWhere($qb->expr()->eq('actor_type', $qb->createNamedParameter($reaction->getActorType()))) ->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(); if (!$exists) { $qb = $this->dbConn->getQueryBuilder(); try { $qb->insert('reactions') ->values([ 'parent_id' => $qb->createNamedParameter($reaction->getParentId()), 'message_id' => $qb->createNamedParameter($reaction->getId()), 'actor_type' => $qb->createNamedParameter($reaction->getActorType()), 'actor_id' => $qb->createNamedParameter($reaction->getActorId()), 'reaction' => $qb->createNamedParameter($reaction->getMessage()), ]) ->executeStatement(); } catch (\Exception $e) { $this->logger->error($e->getMessage(), [ 'exception' => $e, 'app' => 'core_comments', ]); } } $this->sumReactions($reaction->getParentId()); } private function sumReactions(string $parentId): void { $totalQuery = $this->dbConn->getQueryBuilder(); $totalQuery ->selectAlias( $totalQuery->func()->concat( $totalQuery->expr()->literal('"'), 'reaction', $totalQuery->expr()->literal('":'), $totalQuery->func()->count('id') ), 'colonseparatedvalue' ) ->selectAlias($totalQuery->func()->count('id'), 'total') ->from('reactions', 'r') ->where($totalQuery->expr()->eq('r.parent_id', $totalQuery->createNamedParameter($parentId))) ->groupBy('r.reaction') ->orderBy('total', 'DESC') ->addOrderBy('r.reaction', 'ASC') ->setMaxResults(20); $jsonQuery = $this->dbConn->getQueryBuilder(); $jsonQuery ->selectAlias( $jsonQuery->func()->concat( $jsonQuery->expr()->literal('{'), $jsonQuery->func()->groupConcat('colonseparatedvalue'), $jsonQuery->expr()->literal('}') ), 'json' ) ->from($jsonQuery->createFunction('(' . $totalQuery->getSQL() . ')'), 'json'); $qb = $this->dbConn->getQueryBuilder(); $qb ->update('comments') ->set('reactions', $qb->createFunction('(' . $jsonQuery->getSQL() . ')')) ->where($qb->expr()->eq('id', $qb->createNamedParameter($parentId))) ->executeStatement(); } /** * 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()); $result = $this->updateQuery($comment); if ($comment->getVerb() === 'reaction_deleted') { $this->deleteReaction($comment); } $this->sendEvent(CommentsEvent::EVENT_UPDATE, $comment); return $result; } protected function updateQuery(IComment $comment): bool { $qb = $this->dbConn->getQueryBuilder(); $qb ->update('comments') ->set('parent_id', $qb->createNamedParameter($comment->getParentId())) ->set('topmost_parent_id', $qb->createNamedParameter($comment->getTopmostParentId())) ->set('children_count', $qb->createNamedParameter($comment->getChildrenCount())) ->set('actor_type', $qb->createNamedParameter($comment->getActorType())) ->set('actor_id', $qb->createNamedParameter($comment->getActorId())) ->set('message', $qb->createNamedParameter($comment->getMessage())) ->set('verb', $qb->createNamedParameter($comment->getVerb())) ->set('creation_timestamp', $qb->createNamedParameter($comment->getCreationDateTime(), 'datetime')) ->set('latest_child_timestamp', $qb->createNamedParameter($comment->getLatestChildDateTime(), 'datetime')) ->set('object_type', $qb->createNamedParameter($comment->getObjectType())) ->set('object_id', $qb->createNamedParameter($comment->getObjectId())) ->set('expire_date', $qb->createNamedParameter($comment->getExpireDate(), 'datetime')) ->set('reference_id', $qb->createNamedParameter($comment->getReferenceId())) ->set('meta_data', $qb->createNamedParameter(json_encode($comment->getMetaData()))) ->where($qb->expr()->eq('id', $qb->createNamedParameter($comment->getId()))); $affectedRows = $qb->executeStatement(); if ($affectedRows === 0) { throw new NotFoundException('Comment to update does ceased to exist'); } return $affectedRows > 0; } /** * removes references to specific actor (e.g. on user delete) of a comment. * The comment itself must not get lost/deleted. * * @param string $actorType the actor type (e.g. 'users') * @param string $actorId a user id * @return boolean * @since 9.0.0 */ public function deleteReferencesOfActor($actorType, $actorId) { $this->checkRoleParameters('Actor', $actorType, $actorId); $qb = $this->dbConn->getQueryBuilder(); $affectedRows = $qb ->update('comments') ->set('actor_type', $qb->createNamedParameter(ICommentsManager::DELETED_USER)) ->set('actor_id', $qb->createNamedParameter(ICommentsManager::DELETED_USER)) ->where($qb->expr()->eq('actor_type', $qb->createParameter('type'))) ->andWhere($qb->expr()->eq('actor_id', $qb->createParameter('id'))) ->setParameter('type', $actorType) ->setParameter('id', $actorId) ->execute(); $this->commentsCache = []; return is_int($affectedRows); } /** * deletes all comments made of a specific object (e.g. on file delete) * * @param string $objectType the object type (e.g. 'files') * @param string $objectId e.g. the file id * @return boolean * @since 9.0.0 */ public function deleteCommentsAtObject($objectType, $objectId) { $this->checkRoleParameters('Object', $objectType, $objectId); $qb = $this->dbConn->getQueryBuilder(); $affectedRows = $qb ->delete('comments') ->where($qb->expr()->eq('object_type', $qb->createParameter('type'))) ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('id'))) ->setParameter('type', $objectType) ->setParameter('id', $objectId) ->execute(); $this->commentsCache = []; return is_int($affectedRows); } /** * deletes the read markers for the specified user * * @param \OCP\IUser $user * @return bool * @since 9.0.0 */ public function deleteReadMarksFromUser(IUser $user) { $qb = $this->dbConn->getQueryBuilder(); $query = $qb->delete('comments_read_markers') ->where($qb->expr()->eq('user_id', $qb->createParameter('user_id'))) ->setParameter('user_id', $user->getUID()); try { $affectedRows = $query->execute(); } catch (DriverException $e) { $this->logger->error($e->getMessage(), [ 'exception' => $e, 'app' => 'core_comments', ]); return false; } return ($affectedRows > 0); } /** * sets the read marker for a given file to the specified date for the * provided user * * @param string $objectType * @param string $objectId * @param \DateTime $dateTime * @param IUser $user * @since 9.0.0 */ public function setReadMark($objectType, $objectId, \DateTime $dateTime, IUser $user) { $this->checkRoleParameters('Object', $objectType, $objectId); $qb = $this->dbConn->getQueryBuilder(); $values = [ 'user_id' => $qb->createNamedParameter($user->getUID()), 'marker_datetime' => $qb->createNamedParameter($dateTime, 'datetime'), 'object_type' => $qb->createNamedParameter($objectType), 'object_id' => $qb->createNamedParameter($objectId), ]; // Strategy: try to update, if this does not return affected rows, do an insert. $affectedRows = $qb ->update('comments_read_markers') ->set('user_id', $values['user_id']) ->set('marker_datetime', $values['marker_datetime']) ->set('object_type', $values['object_type']) ->set('object_id', $values['object_id']) ->where($qb->expr()->eq('user_id', $qb->createParameter('user_id'))) ->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type'))) ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id'))) ->setParameter('user_id', $user->getUID(), IQueryBuilder::PARAM_STR) ->setParameter('object_type', $objectType, IQueryBuilder::PARAM_STR) ->setParameter('object_id', $objectId, IQueryBuilder::PARAM_STR) ->execute(); if ($affectedRows > 0) { return; } $qb->insert('comments_read_markers') ->values($values) ->execute(); } /** * returns the read marker for a given file to the specified date for the * provided user. It returns null, when the marker is not present, i.e. * no comments were marked as read. * * @param string $objectType * @param string $objectId * @param IUser $user * @return \DateTime|null * @since 9.0.0 */ public function getReadMark($objectType, $objectId, IUser $user) { $qb = $this->dbConn->getQueryBuilder(); $resultStatement = $qb->select('marker_datetime') ->from('comments_read_markers') ->where($qb->expr()->eq('user_id', $qb->createParameter('user_id'))) ->andWhere($qb->expr()->eq('object_type', $qb->createParameter('object_type'))) ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id'))) ->setParameter('user_id', $user->getUID(), IQueryBuilder::PARAM_STR) ->setParameter('object_type', $objectType, IQueryBuilder::PARAM_STR) ->setParameter('object_id', $objectId, IQueryBuilder::PARAM_STR) ->execute(); $data = $resultStatement->fetch(); $resultStatement->closeCursor(); if (!$data || is_null($data['marker_datetime'])) { return null; } return new \DateTime($data['marker_datetime']); } /** * deletes the read markers on the specified object * * @param string $objectType * @param string $objectId * @return bool * @since 9.0.0 */ public function deleteReadMarksOnObject($objectType, $objectId) { $this->checkRoleParameters('Object', $objectType, $objectId); $qb = $this->dbConn->getQueryBuilder(); $query = $qb->delete('comments_read_markers') ->where($qb->expr()->eq('object_type', $qb->createParameter('object_type'))) ->andWhere($qb->expr()->eq('object_id', $qb->createParameter('object_id'))) ->setParameter('object_type', $objectType) ->setParameter('object_id', $objectId); try { $affectedRows = $query->execute(); } catch (DriverException $e) { $this->logger->error($e->getMessage(), [ 'exception' => $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); } $this->eventDispatcher->dispatchTyped($event); } /** * Load the Comments app into the page * * @since 21.0.0 */ public function load(): void { $this->initialStateService->provideInitialState('comments', 'max-message-length', IComment::MAX_MESSAGE_LENGTH); Util::addScript('comments', 'comments-app'); } /** * @inheritDoc */ public function deleteCommentsExpiredAtObject(string $objectType, string $objectId = ''): bool { $qb = $this->dbConn->getQueryBuilder(); $qb->delete('comments') ->where($qb->expr()->lte('expire_date', $qb->createNamedParameter($this->timeFactory->getDateTime(), IQueryBuilder::PARAM_DATETIME_MUTABLE))) ->andWhere($qb->expr()->eq('object_type', $qb->createNamedParameter($objectType))); if ($objectId !== '') { $qb->andWhere($qb->expr()->eq('object_id', $qb->createNamedParameter($objectId))); } $affectedRows = $qb->executeStatement(); $this->commentsCache = []; return $affectedRows > 0; } } 7/stable28 Nextcloud server, a safe home for all your data: https://github.com/nextcloud/serverwww-data
aboutsummaryrefslogtreecommitdiffstats
blob: 53e9efd5d9ed0d2f3cd9726aa653e7f0cb88050f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607