Fix chat endpoints with empty reactions in XML format

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

Author: nickvergessen

lib/Controller/AEnvironmentAwareController.php

@@ -30,6 +30,7 @@
 use OCA\Talk\Participant;
 use OCA\Talk\Room;
 use OCP\AppFramework\OCSController;
+use OCP\IRequest;
 
 abstract class AEnvironmentAwareController extends OCSController {
 	protected int $apiVersion = 1;
@@ -59,4 +60,24 @@ public function setParticipant(Participant $participant): void {
 	public function getParticipant(): ?Participant {
 		return $this->participant;
 	}
+
+	/**
+	 * @return string Either 'json' or 'xml'
+	 */
+	public function getResponseFormat(): string {
+		// get format from the url format or request format parameter
+		$format = $this->request->getParam('format');
+
+		// if none is given try the first Accept header
+		if ($format === null) {
+			$headers = $this->request->getHeader('Accept');
+			$format = $this->getResponderByHTTPHeader($headers, null);
+		}
+
+		/**
+		 * Default value of
+		 * @see OCSController::buildResponse()
+		 */
+		return $format ?? 'xml';
+	}
 }

lib/Controller/ChatController.php

@@ -168,9 +168,9 @@ public function parseCommentToResponse(IComment $comment, Message $parentMessage
 
 		$this->participantService->updateLastReadMessage($this->participant, (int) $comment->getId());
 
-		$data = $chatMessage->toArray();
+		$data = $chatMessage->toArray($this->getResponseFormat());
 		if ($parentMessage instanceof Message) {
-			$data['parent'] = $parentMessage->toArray();
+			$data['parent'] = $parentMessage->toArray($this->getResponseFormat());
 		}
 
 		$response = new DataResponse($data, Http::STATUS_CREATED);
@@ -481,7 +481,7 @@ public function receiveMessages(int $lookIntoFuture,
 				$parentIds[$id] = $comment->getParentId();
 			}
 
-			$messages[] = $message->toArray();
+			$messages[] = $message->toArray($this->getResponseFormat());
 			$commentIdToIndex[$id] = $i;
 			$i++;
 		}
@@ -517,7 +517,7 @@ public function receiveMessages(int $lookIntoFuture,
 					$this->messageParser->parseMessage($message);
 
 					if ($message->getVisibility()) {
-						$loadedParents[$parentId] = $message->toArray();
+						$loadedParents[$parentId] = $message->toArray($this->getResponseFormat());
 						$messages[$commentKey]['parent'] = $loadedParents[$parentId];
 						continue;
 					}
@@ -667,8 +667,8 @@ public function deleteMessage(int $messageId): DataResponse {
 		$message = $this->messageParser->createMessage($this->room, $this->participant, $comment, $this->l);
 		$this->messageParser->parseMessage($message);
 
-		$data = $systemMessage->toArray();
-		$data['parent'] = $message->toArray();
+		$data = $systemMessage->toArray($this->getResponseFormat());
+		$data['parent'] = $message->toArray($this->getResponseFormat());
 
 		$bridge = $this->matterbridgeManager->getBridgeOfRoom($this->room);
 
@@ -704,7 +704,7 @@ public function clearHistory(): DataResponse {
 		$this->messageParser->parseMessage($systemMessage);
 
 
-		$data = $systemMessage->toArray();
+		$data = $systemMessage->toArray($this->getResponseFormat());
 
 		$bridge = $this->matterbridgeManager->getBridgeOfRoom($this->room);
 
@@ -797,7 +797,7 @@ public function getObjectsSharedInRoomOverview(int $limit = 7): DataResponse {
 				continue;
 			}
 
-			$messages[(int) $comment->getId()] = $message->toArray();
+			$messages[(int) $comment->getId()] = $message->toArray($this->getResponseFormat());
 		}
 
 		$messagesByType = [];
@@ -853,7 +853,7 @@ protected function getMessagesForRoom(Room $room, array $messageIds): array {
 				continue;
 			}
 
-			$messages[(int) $comment->getId()] = $message->toArray();
+			$messages[(int) $comment->getId()] = $message->toArray($this->getResponseFormat());
 		}
 
 		return $messages;

lib/Controller/RoomController.php

@@ -624,7 +624,7 @@ protected function formatLastMessage(Room $room, Participant $participant, IComm
 			return [];
 		}
 
-		return $message->toArray();
+		return $message->toArray($this->getResponseFormat());
 	}
 
 	/**

lib/Model/Message.php

@@ -28,6 +28,7 @@
 use OCA\Talk\Room;
 use OCP\Comments\IComment;
 use OCP\IL10N;
+use OCP\IRequest;
 
 class Message {
 	/** @var Room */
@@ -168,11 +169,11 @@ public function isReplyable(): bool {
 			\in_array($this->getActorType(), [Attendee::ACTOR_USERS, Attendee::ACTOR_GUESTS]);
 	}
 
-	public function toArray(): array {
+	public function toArray(string $format): array {
 		$expireDate = $this->getComment()->getExpireDate();
 
 		$reactions = $this->getComment()->getReactions();
-		if (empty($reactions)) {
+		if ($format === 'json' && empty($reactions)) {
 			// Cheating here to make sure the reactions array is always a
 			// JSON object on the API, even when there is no reaction at all.
 			$reactions = new \StdClass();