feat: Add actions to the notification

Signed-off-by: Joas Schilling <[email protected]>

appinfo/routes/routesChatController.php

@@ -48,6 +48,8 @@
 		['name' => 'Chat#getMessageContext', 'url' => '/api/{apiVersion}/chat/{token}/{messageId}/context', 'verb' => 'GET', 'requirements' => $requirementsWithMessageId],
 		/** @see \OCA\Talk\Controller\ChatController::remindLater() */
 		['name' => 'Chat#remindLater', 'url' => '/api/{apiVersion}/chat/{token}/{messageId}/reminder', 'verb' => 'POST', 'requirements' => $requirementsWithMessageId],
+		/** @see \OCA\Talk\Controller\ChatController::dismissReminder() */
+		['name' => 'Chat#dismissReminder', 'url' => '/api/{apiVersion}/chat/{token}/{messageId}/reminder', 'verb' => 'DELETE', 'requirements' => $requirementsWithMessageId],
 		/** @see \OCA\Talk\Controller\ChatController::setReadMarker() */
 		['name' => 'Chat#setReadMarker', 'url' => '/api/{apiVersion}/chat/{token}/read', 'verb' => 'POST', 'requirements' => $requirements],
 		/** @see \OCA\Talk\Controller\ChatController::markUnread() */

docs/chat.md

@@ -319,6 +319,20 @@ See [OCP\RichObjectStrings\Definitions](https://github.com/nextcloud/server/blob
 		+ `404 Not Found` When the room could not be found for the participant,
 		  or the participant is a guest.
 
+## Delete reminder notification
+
+* Required capability: `remind-me-later`
+* Method: `DELETE`
+* Endpoint: `/chat/{token}/{messageId}/reminder`
+
+* Response:
+	- Status code:
+		+ `200 OK`
+		+ `401 Unauthorized` when the user is not logged in
+		+ `404 Not Found` When the message could not be found in the room
+		+ `404 Not Found` When the room could not be found for the participant,
+		  or the participant is a guest.
+
 ## Mark chat as read
 
 * Required capability: `chat-read-marker`

lib/BackgroundJob/ChatMessageReminder.php

@@ -58,22 +58,28 @@ public function start(IJobList $jobList): void {
 				$this->argument['execute-after'],
 				$this->argument['token'],
 				$this->argument['user'],
-				$this->argument['message'],
+				$this->argument['message_id'],
 			);
 		}
 	}
 
 	/**
-	 * @psalm-param array{token: string, message: string, user: string, execute-after: int} $argument
+	 * @psalm-param array{token: string, message_id: string, message_actor_type: string, message_actor_id: string, user: string, execute-after: int} $argument
 	 */
 	protected function run($argument): void {
 		$notification = $this->notificationManager->createNotification();
 		$notification->setApp(Application::APP_ID)
 			->setUser($argument['user'])
-			->setObject('chat', $argument['message'])
+			->setObject('reminder', $argument['token'])
 			->setDateTime($this->time->getDateTime('@' . $this->argument['execute-after']))
 			->setSubject('reminder', [
 				'token' => $argument['token'],
+				'message' => $argument['message_id'],
+				'userType' => $argument['message_actor_type'],
+				'userId' => $argument['message_actor_id'],
+			])
+			->setMessage('reminder', [
+				'commentId' => $argument['message_id'],
 			]);
 		$this->notificationManager->notify($notification);
 	}

lib/Chat/ChatManager.php

@@ -27,6 +27,7 @@
 use DateInterval;
 use OC\Memcache\ArrayCache;
 use OC\Memcache\NullCache;
+use OCA\Talk\AppInfo\Application;
 use OCA\Talk\BackgroundJob\ChatMessageReminder;
 use OCA\Talk\Events\ChatEvent;
 use OCA\Talk\Events\ChatParticipantEvent;
@@ -727,11 +728,24 @@ public function queueRemindLaterBackgroundJob(Room $chat, IComment $comment, Att
 		$this->jobList->add(ChatMessageReminder::class, [
 			'execute-after' => $timestamp,
 			'token' => $chat->getToken(),
-			'message' => $comment->getId(),
+			'message_id' => $comment->getId(),
+			'message_actor_type' => $comment->getActorType(),
+			'message_actor_id' => $comment->getActorId(),
 			'user' => $attendee->getActorId(),
 		]);
 	}
 
+	public function dismissReminderNotification(Room $chat, IComment $comment, Attendee $attendee): void {
+		$notification = $this->notificationManager->createNotification();
+		$notification->setApp(Application::APP_ID)
+			->setUser($attendee->getActorId())
+			->setObject('reminder', $chat->getToken())
+			->setMessage('reminder', [
+				'commentId' => $comment->getId(),
+			]);
+		$this->notificationManager->dismissNotification($notification);
+	}
+
 	/**
 	 * Search for comments with a given content
 	 *

lib/Chat/Notifier.php

@@ -324,6 +324,7 @@ public function removePendingNotificationsForRoom(Room $chat, bool $chatOnly = f
 
 		$objectTypes = [
 			'chat',
+			'reminder',
 		];
 		if (!$chatOnly) {
 			$objectTypes = [

lib/Controller/ChatController.php

@@ -704,6 +704,25 @@ public function remindLater(int $messageId, int $timestamp): DataResponse {
 		return new DataResponse([], Http::STATUS_CREATED);
 	}
 
+	#[NoAdminRequired]
+	#[RequireModeratorOrNoLobby]
+	#[RequireLoggedInParticipant]
+	public function dismissReminder(int $messageId): DataResponse {
+		try {
+			$message = $this->chatManager->getComment($this->room, (string) $messageId);
+		} catch (NotFoundException) {
+			return new DataResponse([], Http::STATUS_NOT_FOUND);
+		}
+
+		$this->chatManager->dismissReminderNotification(
+			$this->room,
+			$message,
+			$this->participant->getAttendee()
+		);
+
+		return new DataResponse([], Http::STATUS_OK);
+	}
+
 	#[NoAdminRequired]
 	#[RequireModeratorParticipant]
 	#[RequireReadWriteConversation]

lib/Notification/Notifier.php

@@ -265,6 +265,7 @@ public function prepare(INotification $notification, string $languageCode): INot
 				throw new AlreadyProcessedException();
 			}
 
+			\OC::$server->getLogger()->error('parseChatMessage');
 			return $this->parseChatMessage($notification, $room, $participant, $l);
 		}
 
@@ -446,7 +447,7 @@ protected function parseRemoteInvitationMessage(INotification $notification, IL1
 	 * @throws \InvalidArgumentException
 	 */
 	protected function parseChatMessage(INotification $notification, Room $room, Participant $participant, IL10N $l): INotification {
-		if ($notification->getObjectType() !== 'chat') {
+		if ($notification->getObjectType() !== 'chat' && $notification->getObjectType() !== 'reminder') {
 			throw new \InvalidArgumentException('Unknown object type');
 		}
 
@@ -521,7 +522,7 @@ protected function parseChatMessage(INotification $notification, Room $room, Par
 			$notification->setRichMessage($message->getMessage(), $message->getMessageParameters());
 
 			// Forward the message ID as well to the clients, so they can quote the message on replies
-			$notification->setObject('chat', $notification->getObjectId() . '/' . $comment->getId());
+			$notification->setObject($notification->getObjectType(), $notification->getObjectId() . '/' . $comment->getId());
 		}
 
 		$richSubjectParameters = [
@@ -539,18 +540,37 @@ protected function parseChatMessage(INotification $notification, Room $room, Par
 				'id' => $message->getComment()->getId(),
 				'name' => $shortenMessage,
 			];
-			if ($room->getType() === Room::TYPE_ONE_TO_ONE || $room->getType() === Room::TYPE_ONE_TO_ONE_FORMER) {
-				$subject = "{user}\n{message}";
-			} elseif ($richSubjectUser) {
-				$subject = $l->t('{user} in {call}') . "\n{message}";
-			} elseif (!$isGuest) {
-				$subject = $l->t('Deleted user in {call}') . "\n{message}";
+			if ($notification->getSubject() === 'reminder') {
+				if ($comment->getActorId() === $notification->getUser()) {
+					$subject = $l->t('Reminder: You in {call}') . "\n{message}";
+				} elseif ($room->getType() === Room::TYPE_ONE_TO_ONE || $room->getType() === Room::TYPE_ONE_TO_ONE_FORMER) {
+					$subject = $l->t('Reminder: {user} in {call}') . "\n{message}";
+				} elseif ($richSubjectUser) {
+					$subject = $l->t('Reminder: {user} in {call}') . "\n{message}";
+				} elseif (!$isGuest) {
+					$subject = $l->t('Reminder: Deleted user in {call}') . "\n{message}";
+				} else {
+					try {
+						$richSubjectParameters['guest'] = $this->getGuestParameter($room, $comment->getActorId());
+						$subject = $l->t('Reminder: {guest} (guest) in {call}') . "\n{message}";
+					} catch (ParticipantNotFoundException $e) {
+						$subject = $l->t('Reminder: Guest in {call}') . "\n{message}";
+					}
+				}
 			} else {
-				try {
-					$richSubjectParameters['guest'] = $this->getGuestParameter($room, $comment->getActorId());
-					$subject = $l->t('{guest} (guest) in {call}') . "\n{message}";
-				} catch (ParticipantNotFoundException $e) {
-					$subject = $l->t('Guest in {call}') . "\n{message}";
+				if ($room->getType() === Room::TYPE_ONE_TO_ONE || $room->getType() === Room::TYPE_ONE_TO_ONE_FORMER) {
+					$subject = "{user}\n{message}";
+				} elseif ($richSubjectUser) {
+					$subject = $l->t('{user} in {call}') . "\n{message}";
+				} elseif (!$isGuest) {
+					$subject = $l->t('Deleted user in {call}') . "\n{message}";
+				} else {
+					try {
+						$richSubjectParameters['guest'] = $this->getGuestParameter($room, $comment->getActorId());
+						$subject = $l->t('{guest} (guest) in {call}') . "\n{message}";
+					} catch (ParticipantNotFoundException $e) {
+						$subject = $l->t('Guest in {call}') . "\n{message}";
+					}
 				}
 			}
 		} elseif ($notification->getSubject() === 'chat') {
@@ -693,7 +713,29 @@ protected function parseChatMessage(INotification $notification, Room $room, Par
 				}
 			}
 		}
-		$notification = $this->addActionButton($notification, $l->t('View chat'), false);
+
+		if ($notification->getObjectType() === 'reminder') {
+			$notification = $this->addActionButton($notification, $l->t('View message'));
+
+			$action = $notification->createAction();
+			$action->setLabel($l->t('Dismiss reminder'))
+				->setParsedLabel($l->t('Dismiss reminder'))
+				->setLink(
+					$this->urlGenerator->linkToOCSRouteAbsolute(
+						'spreed.Chat.dismissReminder',
+						[
+							'apiVersion' => 'v1',
+							'token' => $room->getToken(),
+							'messageId' => $comment->getId(),
+						]
+					),
+					IAction::TYPE_DELETE
+				);
+
+			$notification->addParsedAction($action);
+		} else {
+			$notification = $this->addActionButton($notification, $l->t('View chat'), false);
+		}
 
 		if ($richSubjectParameters['user'] === null) {
 			unset($richSubjectParameters['user']);