fix(API): Add constants for known comments metadata

Signed-off-by: Joas Schilling <coding@schilljs.com>
nextcloud · Mar 6, 2024 · 81008aa · 81008aa
1 parent d4c11cc
commit 81008aa
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 14 deletions.
diff --git a/lib/Chat/ChatManager.php b/lib/Chat/ChatManager.php
@@ -34,6 +34,7 @@
 use OCA\Talk\Exceptions\MessagingNotAllowedException;
 use OCA\Talk\Exceptions\ParticipantNotFoundException;
 use OCA\Talk\Model\Attendee;
+use OCA\Talk\Model\Message;
 use OCA\Talk\Model\Poll;
 use OCA\Talk\Participant;
 use OCA\Talk\Room;
@@ -165,7 +166,7 @@ public function addSystemMessage(
 
 		if ($silent) {
 			$comment->setMetaData([
-				'silent' => true,
+				Message::METADATA_SILENT => true,
 			]);
 		}
 
@@ -322,7 +323,7 @@ public function sendMessage(Room $chat, ?Participant $participant, string $actor
 
 		if ($silent) {
 			$comment->setMetaData([
-				'silent' => true,
+				Message::METADATA_SILENT => true,
 			]);
 		}
 
@@ -502,9 +503,9 @@ public function deleteMessage(Room $chat, IComment $comment, Participant $partic
 		$metaData = $comment->getMetaData() ?? [];
 		if (isset($metaData['last_edited_by_type'])) {
 			unset(
-				$metaData['last_edited_by_type'],
-				$metaData['last_edited_by_id'],
-				$metaData['last_edited_time']
+				$metaData[Message::METADATA_LASTEDITEDBY_TYPE],
+				$metaData[Message::METADATA_LASTEDITEDBY_ID],
+				$metaData[Message::METADATA_LASTEDITEDBY_TIME]
 			);
 			$comment->setMetaData($metaData);
 		}
@@ -557,12 +558,12 @@ public function editMessage(Room $chat, IComment $comment, Participant $particip
 		}
 
 		$metaData = $comment->getMetaData() ?? [];
-		$metaData['last_edited_by_type'] = $participant->getAttendee()->getActorType();
-		$metaData['last_edited_by_id'] = $participant->getAttendee()->getActorId();
-		$metaData['last_edited_time'] = $editTime->getTimestamp();
+		$metaData[Message::METADATA_LASTEDITEDBY_TYPE] = $participant->getAttendee()->getActorType();
+		$metaData[Message::METADATA_LASTEDITEDBY_ID] = $participant->getAttendee()->getActorId();
+		$metaData[Message::METADATA_LASTEDITEDBY_TIME] = $editTime->getTimestamp();
 		$comment->setMetaData($metaData);
 
-		$wasSilent = $metaData['silent'] ?? false;
+		$wasSilent = $metaData[Message::METADATA_SILENT] ?? false;
 
 		if (!$wasSilent) {
 			$mentionsBefore = $comment->getMentions();

diff --git a/lib/Chat/Parser/SystemMessage.php b/lib/Chat/Parser/SystemMessage.php
@@ -207,7 +207,7 @@ protected function parseMessage(Message $chatMessage): void {
 			}
 		} elseif ($message === 'call_started') {
 			$metaData = $comment->getMetaData() ?? [];
-			$silentCall = $metaData['silent'] ?? false;
+			$silentCall = $metaData[Message::METADATA_SILENT] ?? false;
 			if ($silentCall) {
 				if ($currentUserIsActor) {
 					$parsedMessage = $this->l->t('You started a silent call');

diff --git a/lib/Chat/SystemMessage/Listener.php b/lib/Chat/SystemMessage/Listener.php
@@ -43,6 +43,7 @@
 use OCA\Talk\Manager;
 use OCA\Talk\Model\Attendee;
 use OCA\Talk\Model\BreakoutRoom;
+use OCA\Talk\Model\Message;
 use OCA\Talk\Model\Session;
 use OCA\Talk\Participant;
 use OCA\Talk\Room;
@@ -425,8 +426,8 @@ protected function fixMimeTypeOfVoiceMessage(ShareCreatedEvent|BeforeDuplicateSh
 			}
 		}
 
-		if (isset($metaData['silent'])) {
-			$silent = (bool) $metaData['silent'];
+		if (isset($metaData[Message::METADATA_SILENT])) {
+			$silent = (bool) $metaData[Message::METADATA_SILENT];
 		} else {
 			$silent = false;
 		}

diff --git a/lib/Model/Message.php b/lib/Model/Message.php
@@ -36,6 +36,10 @@
  * @psalm-import-type TalkChatMessage from ResponseDefinitions
  */
 class Message {
+	public const METADATA_LASTEDITEDBY_TYPE = 'last_edited_by_type';
+	public const METADATA_LASTEDITEDBY_ID = 'last_edited_by_id';
+	public const METADATA_LASTEDITEDBY_TIME = 'last_edited_by_time';
+	public const METADATA_SILENT = 'silent';
 
 	/** @var bool */
 	protected $visible = true;
@@ -226,8 +230,8 @@ public function toArray(string $format): array {
 		}
 
 		$metaData = $this->comment->getMetaData() ?? [];
-		if (!empty($metaData['silent'])) {
-			$data['silent'] = true;
+		if (!empty($metaData[self::METADATA_SILENT])) {
+			$data[self::METADATA_SILENT] = true;
 		}
 
 		return $data;