📌 Pinned messages - API

appinfo/info.xml

@@ -18,7 +18,7 @@
 * 🌉 **Sync with other chat solutions** With [Matterbridge](https://github.com/42wim/matterbridge/) being integrated in Talk, you can easily sync a lot of other chat solutions to Nextcloud Talk and vice-versa.
 ]]></description>
 
-	<version>23.0.0-dev.1</version>
+	<version>23.0.0-dev.2</version>
 	<licence>agpl</licence>
 
 	<author>Anna Larch</author>

docs/capabilities.md

@@ -197,3 +197,6 @@
 ## 22
 * `threads` - Whether the chat supports threads
 * `config => call => live-transcription` - Whether live transcription is supported in calls
+
+## 23
+* `pinned-messages` - Whether messages can be pinned

lib/BackgroundJob/UnpinMessage.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Talk\BackgroundJob;
+
+use OCA\Talk\Chat\ChatManager;
+use OCA\Talk\Exceptions\RoomNotFoundException;
+use OCA\Talk\Manager;
+use OCA\Talk\Model\Attachment;
+use OCA\Talk\Service\AttachmentService;
+use OCA\Talk\Service\RoomService;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\QueuedJob;
+use OCP\Comments\NotFoundException;
+
+class UnpinMessage extends QueuedJob {
+	public function __construct(
+		ITimeFactory $time,
+		protected Manager $manager,
+		protected ChatManager $chatManager,
+		protected AttachmentService $attachmentService,
+		protected RoomService $roomService,
+	) {
+		parent::__construct($time);
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	#[\Override]
+	protected function run($argument): void {
+		$roomId = (int)$argument['roomId'];
+
+		try {
+			$room = $this->manager->getRoomById($roomId);
+		} catch (RoomNotFoundException) {
+			return;
+		}
+
+		$messageId = (int)$argument['messageId'];
+		try {
+			$comment = $this->chatManager->getComment($room, (string)$messageId);
+		} catch (NotFoundException) {
+			// Message most likely expired, reset the last_pinned_id if matching
+			if ($room->getLastPinnedId() === $messageId) {
+				$newLastPinned = 0;
+				$attachments = $this->attachmentService->getAttachmentsByType($room, Attachment::TYPE_PINNED, 0, 1);
+				if (isset($attachments[0])) {
+					$newLastPinned = $attachments[0]->getMessageId();
+				}
+				$this->roomService->setLastPinnedId($room, $newLastPinned);
+			}
+			return;
+		}
+
+		$this->chatManager->unpinMessage($room, $comment, null);
+	}
+}

lib/Capabilities.php

@@ -124,6 +124,7 @@ class Capabilities implements IPublicCapability {
 		'upcoming-reminders',
 		'sensitive-conversations',
 		'threads',
+		'pinned-messages',
 	];
 
 	public const CONDITIONAL_FEATURES = [

lib/Chat/ChatManager.php

@@ -11,6 +11,7 @@
 use DateInterval;
 use OC\Memcache\ArrayCache;
 use OC\Memcache\NullCache;
+use OCA\Talk\BackgroundJob\UnpinMessage;
 use OCA\Talk\CachePrefix;
 use OCA\Talk\Events\BeforeChatMessageSentEvent;
 use OCA\Talk\Events\BeforeSystemMessageSentEvent;
@@ -19,6 +20,7 @@
 use OCA\Talk\Exceptions\InvalidRoomException;
 use OCA\Talk\Exceptions\MessagingNotAllowedException;
 use OCA\Talk\Exceptions\ParticipantNotFoundException;
+use OCA\Talk\Model\Attachment;
 use OCA\Talk\Model\Attendee;
 use OCA\Talk\Model\Message;
 use OCA\Talk\Model\Poll;
@@ -34,6 +36,7 @@
 use OCA\Talk\Share\RoomShareProvider;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\IJobList;
 use OCP\Collaboration\Reference\IReferenceManager;
 use OCP\Comments\IComment;
 use OCP\Comments\MessageTooLongException;
@@ -122,6 +125,7 @@ public function __construct(
 		protected IReferenceManager $referenceManager,
 		protected ILimiter $rateLimiter,
 		protected IRequest $request,
+		protected IJobList $jobList,
 		protected IL10N $l,
 		protected LoggerInterface $logger,
 	) {
@@ -751,6 +755,129 @@ public function editMessage(Room $chat, IComment $comment, Participant $particip
 		);
 	}
 
+	public function pinMessage(Room $chat, IComment $comment, Participant $participant, int $pinUntil): ?IComment {
+		$metaData = $comment->getMetaData() ?? [];
+
+		if (!empty($metaData[Message::METADATA_PINNED_MESSAGE_ID])) {
+			// Message is already pinned
+			return null;
+		}
+
+		$message = $this->addSystemMessage(
+			$chat,
+			$participant,
+			$participant->getAttendee()->getActorType(),
+			$participant->getAttendee()->getActorId(),
+			json_encode(['message' => 'message_pinned', 'parameters' => ['message' => $comment->getId()]]),
+			$this->timeFactory->getDateTime(),
+			false,
+			null,
+			$comment,
+		);
+
+		if ($pinUntil === 0) {
+			// Pinned without expiration, pin until message expiration, if applicable
+			$pinUntil = $message->getExpireDate()?->getTimestamp() ?? 0;
+		} elseif ($message->getExpireDate()) {
+			// When the message expires, expire the pin latest at that time
+			$pinUntil = min($pinUntil, $message->getExpireDate()->getTimestamp());
+		}
+
+		$metaData[Message::METADATA_PINNED_AT] = $this->timeFactory->getTime();
+		$metaData[Message::METADATA_PINNED_MESSAGE_ID] = (int)$message->getId();
+		$metaData[Message::METADATA_PINNED_BY_TYPE] = $participant->getAttendee()->getActorType();
+		$metaData[Message::METADATA_PINNED_BY_ID] = $participant->getAttendee()->getActorId();
+		if ($pinUntil) {
+			$metaData[Message::METADATA_PINNED_UNTIL] = $pinUntil;
+		}
+		$comment->setMetaData($metaData);
+		$this->commentsManager->save($comment);
+
+		$this->participantService->resetHiddenPinnedId($chat, (int)$comment->getId());
+
+		$this->roomService->setLastPinnedId($chat, (int)$comment->getId());
+
+		$this->attachmentService->createAttachmentEntryGeneric(
+			$chat,
+			$comment,
+			Attachment::TYPE_PINNED,
+		);
+
+		if ($pinUntil) {
+			$this->jobList->scheduleAfter(
+				UnpinMessage::class,
+				$pinUntil,
+				[
+					'roomId' => $chat->getId(),
+					'messageId' => (int)$comment->getId(),
+				],
+			);
+		}
+
+		return $message;
+	}
+
+	public function unpinMessage(Room $chat, IComment $comment, ?Participant $participant): ?IComment {
+		$metaData = $comment->getMetaData() ?? [];
+
+		if (empty($metaData[Message::METADATA_PINNED_MESSAGE_ID])) {
+			// Message is not pinned
+			return null;
+		}
+
+		$pinnedId = (int)$comment->getId();
+		unset(
+			$metaData[Message::METADATA_PINNED_AT],
+			$metaData[Message::METADATA_PINNED_MESSAGE_ID],
+			$metaData[Message::METADATA_PINNED_BY_TYPE],
+			$metaData[Message::METADATA_PINNED_BY_ID],
+			$metaData[Message::METADATA_PINNED_UNTIL],
+		);
+		$comment->setMetaData($metaData);
+		$this->commentsManager->save($comment);
+
+		$this->attachmentService->deleteAttachmentByMessageId($pinnedId);
+
+		$this->jobList->remove(
+			UnpinMessage::class,
+			[
+				'roomId' => $chat->getId(),
+				'messageId' => $pinnedId,
+			],
+		);
+
+		if ($chat->getLastPinnedId() === $pinnedId) {
+			$newLastPinned = 0;
+			$attachments = $this->attachmentService->getAttachmentsByType($chat, Attachment::TYPE_PINNED, 0, 1);
+			if (isset($attachments[0])) {
+				$newLastPinned = $attachments[0]->getMessageId();
+			}
+			$this->roomService->setLastPinnedId($chat, $newLastPinned);
+		}
+
+		if ($participant instanceof Participant) {
+			$actorType = $participant->getAttendee()->getActorType();
+			$actorId = $participant->getAttendee()->getActorId();
+		} else {
+			$actorType = Attendee::ACTOR_GUESTS;
+			$actorId = Attendee::ACTOR_ID_SYSTEM;
+		}
+
+		return $this->addSystemMessage(
+			$chat,
+			$participant,
+			$actorType,
+			$actorId,
+			json_encode(['message' => 'message_unpinned', 'parameters' => ['message' => $comment->getId()]]),
+			$this->timeFactory->getDateTime(),
+			false,
+			null,
+			$comment,
+			true,
+			true,
+		);
+	}
+
 	protected static function compareMention(array $mention1, array $mention2): int {
 		if ($mention1['type'] === $mention2['type']) {
 			return $mention1['id'] <=> $mention2['id'];

lib/Chat/MessageParser.php

@@ -44,7 +44,10 @@ public function __construct(
 	}
 
 	public function createMessage(Room $room, ?Participant $participant, IComment $comment, IL10N $l): Message {
-		return new Message($room, $participant, $comment, $l);
+		$message = new Message($room, $participant, $comment, $l);
+		$metaData = $this->addPinnedActorDisplayNameInfo($message, $comment->getMetaData() ?? []);
+		$message->setMetaData($metaData);
+		return $message;
 	}
 
 	public function createMessageFromProxyCache(Room $room, ?Participant $participant, ProxyCacheMessage $proxy, IL10N $l): Message {
@@ -63,6 +66,15 @@ public function createMessageFromProxyCache(Room $room, ?Participant $participan
 			$proxy->getParsedMessageParameters()
 		);
 
+		try {
+			$metaData = json_decode($proxy->getMetaData(), true, flags: JSON_THROW_ON_ERROR);
+			if (is_array($metaData)) {
+				$metaData = $this->addPinnedActorDisplayNameInfo($message, $metaData);
+				$message->setMetaData($metaData);
+			}
+		} catch (\JsonException) {
+		}
+
 		return $message;
 	}
 
@@ -121,6 +133,21 @@ protected function setLastEditInfo(Message $message): void {
 		}
 	}
 
+	protected function addPinnedActorDisplayNameInfo(Message $message, array $metaData): array {
+		if (isset($metaData[Message::METADATA_PINNED_BY_TYPE], $metaData[Message::METADATA_PINNED_BY_ID])) {
+			[$actorType, $actorId, $displayName] = $this->getActorInformation(
+				$message,
+				$metaData[Message::METADATA_PINNED_BY_TYPE],
+				$metaData[Message::METADATA_PINNED_BY_ID],
+			);
+
+			$metaData[Message::METADATA_PINNED_BY_TYPE] = $actorType;
+			$metaData[Message::METADATA_PINNED_BY_ID] = $actorId;
+			$metaData[Message::METADATA_PINNED_BY_NAME] = $displayName;
+		}
+		return $metaData;
+	}
+
 	protected function getActorInformation(Message $message, string $actorType, string $actorId, string $displayName = ''): array {
 		if ($actorType === Attendee::ACTOR_USERS) {
 			$tempDisplayName = $this->userManager->getDisplayName($actorId);

lib/Chat/Parser/SystemMessage.php

@@ -622,6 +622,21 @@ protected function parseMessage(Message $chatMessage, $allowInaccurate): void {
 			if ($currentUserIsActor) {
 				$parsedMessage = $this->l->t('You edited a message');
 			}
+		} elseif ($message === 'message_pinned') {
+			$parsedMessage = $this->l->t('{actor} pinned a message');
+			if ($currentUserIsActor) {
+				$parsedMessage = $this->l->t('You pinned a message');
+			}
+		} elseif ($message === 'message_unpinned') {
+			$systemIsActor = $parsedParameters['actor']['type'] === Attendee::ACTOR_GUESTS
+				&& $parsedParameters['actor']['id'] === Attendee::ACTOR_ID_SYSTEM;
+
+			$parsedMessage = $this->l->t('{actor} unpinned a message');
+			if ($systemIsActor) {
+				$parsedMessage = $this->l->t('Message was automatically unpinned');
+			} elseif ($currentUserIsActor) {
+				$parsedMessage = $this->l->t('You unpinned a message');
+			}
 		} elseif ($message === 'reaction_revoked') {
 			$parsedMessage = $this->l->t('{actor} deleted a reaction');
 			if ($currentUserIsActor) {