fix(federation): Expose local token with the invite so UI can render proxy avatars

lib/Controller/AEnvironmentAwareController.php

@@ -28,6 +28,7 @@
 namespace OCA\Talk\Controller;
 
 use OC\AppFramework\Http\Dispatcher;
+use OCA\Talk\Model\Invitation;
 use OCA\Talk\Participant;
 use OCA\Talk\Room;
 use OCP\AppFramework\OCSController;
@@ -36,6 +37,7 @@ abstract class AEnvironmentAwareController extends OCSController {
 	protected int $apiVersion = 1;
 	protected ?Room $room = null;
 	protected ?Participant $participant = null;
+	protected ?Invitation $invitation = null;
 
 	public function setAPIVersion(int $apiVersion): void {
 		$this->apiVersion = $apiVersion;
@@ -61,6 +63,14 @@ public function getParticipant(): ?Participant {
 		return $this->participant;
 	}
 
+	public function setInvitation(Invitation $invitation): void {
+		$this->invitation = $invitation;
+	}
+
+	public function getInvitation(): ?Invitation {
+		return $this->invitation;
+	}
+
 	/**
 	 * Following the logic of {@see Dispatcher::executeController}
 	 * @return string Either 'json' or 'xml'

lib/Controller/AvatarController.php

@@ -29,6 +29,7 @@
 
 use InvalidArgumentException;
 use OCA\Talk\Exceptions\CannotReachRemoteException;
+use OCA\Talk\Middleware\Attribute\AllowWithoutParticipantWhenPendingInvitation;
 use OCA\Talk\Middleware\Attribute\FederationSupported;
 use OCA\Talk\Middleware\Attribute\RequireLoggedInParticipant;
 use OCA\Talk\Middleware\Attribute\RequireModeratorParticipant;
@@ -143,13 +144,14 @@ public function emojiAvatar(string $emoji, ?string $color): DataResponse {
 	#[FederationSupported]
 	#[PublicPage]
 	#[NoCSRFRequired]
+	#[AllowWithoutParticipantWhenPendingInvitation]
 	#[RequireParticipantOrLoggedInAndListedConversation]
 	public function getAvatar(bool $darkTheme = false): FileDisplayResponse {
 		if ($this->room->getRemoteServer() !== '') {
 			/** @var \OCA\Talk\Federation\Proxy\TalkV1\Controller\AvatarController $proxy */
 			$proxy = \OCP\Server::get(\OCA\Talk\Federation\Proxy\TalkV1\Controller\AvatarController::class);
 			try {
-				return $proxy->getAvatar($this->room, $this->participant, $darkTheme);
+				return $proxy->getAvatar($this->room, $this->participant, $this->invitation, $darkTheme);
 			} catch (CannotReachRemoteException) {
 				// Falling back to a local "globe" avatar for indicating the federation
 			}
@@ -172,6 +174,7 @@ public function getAvatar(bool $darkTheme = false): FileDisplayResponse {
 	#[FederationSupported]
 	#[PublicPage]
 	#[NoCSRFRequired]
+	#[AllowWithoutParticipantWhenPendingInvitation]
 	#[RequireParticipantOrLoggedInAndListedConversation]
 	public function getAvatarDark(): FileDisplayResponse {
 		return $this->getAvatar(true);
@@ -193,6 +196,7 @@ public function getAvatarDark(): FileDisplayResponse {
 	#[OpenAPI(scope: OpenAPI::SCOPE_FEDERATION)]
 	#[PublicPage]
 	#[NoCSRFRequired]
+	#[AllowWithoutParticipantWhenPendingInvitation]
 	#[RequireLoggedInParticipant]
 	public function getUserProxyAvatar(int $size, string $cloudId, bool $darkTheme = false): FileDisplayResponse {
 		try {
@@ -252,6 +256,7 @@ public function getUserProxyAvatar(int $size, string $cloudId, bool $darkTheme =
 	#[OpenAPI(scope: OpenAPI::SCOPE_FEDERATION)]
 	#[PublicPage]
 	#[NoCSRFRequired]
+	#[AllowWithoutParticipantWhenPendingInvitation]
 	#[RequireLoggedInParticipant]
 	public function getUserProxyAvatarDark(int $size, string $cloudId): FileDisplayResponse {
 		return $this->getUserProxyAvatar($size, $cloudId, true);

lib/Controller/FederationController.php

@@ -180,7 +180,6 @@ public function getShares(): DataResponse {
 	 * @return TalkFederationInvite|null
 	 */
 	protected function enrichInvite(Invitation $invitation): ?array {
-
 		try {
 			$room = $this->talkManager->getRoomById($invitation->getLocalRoomId());
 		} catch (RoomNotFoundException) {
@@ -189,6 +188,7 @@ protected function enrichInvite(Invitation $invitation): ?array {
 
 		$federationInvite = $invitation->jsonSerialize();
 		$federationInvite['roomName'] = $room->getName();
+		$federationInvite['localToken'] = $room->getToken();
 		return $federationInvite;
 	}
 }

lib/Federation/Proxy/TalkV1/Controller/AvatarController.php

@@ -28,6 +28,7 @@
 
 use OCA\Talk\Exceptions\CannotReachRemoteException;
 use OCA\Talk\Federation\Proxy\TalkV1\ProxyRequest;
+use OCA\Talk\Model\Invitation;
 use OCA\Talk\Participant;
 use OCA\Talk\ResponseDefinitions;
 use OCA\Talk\Room;
@@ -53,10 +54,14 @@ public function __construct(
 	 *
 	 * 200: Room avatar returned
 	 */
-	public function getAvatar(Room $room, Participant $participant, bool $darkTheme): FileDisplayResponse {
+	public function getAvatar(Room $room, ?Participant $participant, ?Invitation $invitation, bool $darkTheme): FileDisplayResponse {
+		if ($participant === null && $invitation === null) {
+			throw new CannotReachRemoteException('Must receive either participant or invitation');
+		}
+
 		$proxy = $this->proxy->get(
-			$participant->getAttendee()->getInvitedCloudId(),
-			$participant->getAttendee()->getAccessToken(),
+			$participant ? $participant->getAttendee()->getInvitedCloudId() : $invitation->getLocalCloudId(),
+			$participant ? $participant->getAttendee()->getAccessToken() : $invitation->getAccessToken(),
 			$room->getRemoteServer() . '/ocs/v2.php/apps/spreed/api/v1/room/' . $room->getRemoteToken() . '/avatar' . ($darkTheme ? '/dark' : ''),
 		);
 

lib/Middleware/Attribute/AllowWithoutParticipantWhenPendingInvitation.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2024 Joas Schilling <coding@schilljs.com>
+ *
+ * @author Joas Schilling <coding@schilljs.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace OCA\Talk\Middleware\Attribute;
+
+use Attribute;
+use OCA\Talk\Middleware\InjectionMiddleware;
+
+/**
+ * @see InjectionMiddleware::getRoomByInvite()
+ */
+#[Attribute(Attribute::TARGET_METHOD)]
+class AllowWithoutParticipantWhenPendingInvitation extends RequireRoom {
+}

lib/Middleware/InjectionMiddleware.php

@@ -30,6 +30,7 @@
 use OCA\Talk\Exceptions\RoomNotFoundException;
 use OCA\Talk\Federation\Authenticator;
 use OCA\Talk\Manager;
+use OCA\Talk\Middleware\Attribute\AllowWithoutParticipantWhenPendingInvitation;
 use OCA\Talk\Middleware\Attribute\FederationSupported;
 use OCA\Talk\Middleware\Attribute\RequireAuthenticatedParticipant;
 use OCA\Talk\Middleware\Attribute\RequireLoggedInModeratorParticipant;
@@ -46,12 +47,14 @@
 use OCA\Talk\Middleware\Exceptions\NotAModeratorException;
 use OCA\Talk\Middleware\Exceptions\ReadOnlyException;
 use OCA\Talk\Model\Attendee;
+use OCA\Talk\Model\InvitationMapper;
 use OCA\Talk\Participant;
 use OCA\Talk\Room;
 use OCA\Talk\Service\ParticipantService;
 use OCA\Talk\TalkSession;
 use OCA\Talk\Webinary;
 use OCP\AppFramework\Controller;
+use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Http;
 use OCP\AppFramework\Http\Attribute\BruteForceProtection;
 use OCP\AppFramework\Http\RedirectResponse;
@@ -74,6 +77,7 @@ public function __construct(
 		protected ICloudIdManager $cloudIdManager,
 		protected IThrottler $throttler,
 		protected IURLGenerator $url,
+		protected InvitationMapper $invitationMapper,
 		protected Authenticator $federationAuthenticator,
 		protected ?string $userId,
 	) {
@@ -98,6 +102,15 @@ public function beforeController(Controller $controller, string $methodName): vo
 		$apiVersion = $this->request->getParam('apiVersion');
 		$controller->setAPIVersion((int) substr($apiVersion, 1));
 
+		if (!empty($reflectionMethod->getAttributes(AllowWithoutParticipantWhenPendingInvitation::class))) {
+			try {
+				$this->getRoomByInvite($controller);
+				return;
+			} catch (RoomNotFoundException|ParticipantNotFoundException) {
+				// Falling back to bellow checks
+			}
+		}
+
 		if (!empty($reflectionMethod->getAttributes(RequireAuthenticatedParticipant::class))) {
 			$this->getLoggedInOrGuest($controller, false, requireFederationWhenNotLoggedIn: true);
 		}
@@ -232,6 +245,34 @@ protected function getLoggedInOrGuest(AEnvironmentAwareController $controller, b
 		}
 	}
 
+	/**
+	 * @param AEnvironmentAwareController $controller
+	 * @throws RoomNotFoundException
+	 * @throws ParticipantNotFoundException
+	 */
+	protected function getRoomByInvite(AEnvironmentAwareController $controller): void {
+		if ($this->userId === null) {
+			throw new ParticipantNotFoundException('No user available');
+		}
+
+		$room = $controller->getRoom();
+		if (!$room instanceof Room) {
+			$token = $this->request->getParam('token');
+			$room = $this->manager->getRoomByToken($token);
+			$controller->setRoom($room);
+		}
+
+		$participant = $controller->getParticipant();
+		if (!$participant instanceof Participant) {
+			try {
+				$invitation = $this->invitationMapper->getInvitationsForUserByLocalRoom($room, $this->userId);
+				$controller->setInvitation($invitation);
+			} catch (DoesNotExistException $e) {
+				throw new ParticipantNotFoundException('No invite available', $e->getCode(), $e);
+			}
+		}
+	}
+
 	/**
 	 * @param AEnvironmentAwareController $controller
 	 * @throws FederationUnsupportedFeatureException

lib/Model/Invitation.php

@@ -79,14 +79,13 @@ public function __construct() {
 	}
 
 	/**
-	 * @return array{id: int, localRoomId: int, localCloudId: string, remoteAttendeeId: int, remoteServerUrl: string, remoteToken: string, state: int, userId: string, inviterCloudId: string, inviterDisplayName: string}
+	 * @return array{id: int, localCloudId: string, remoteAttendeeId: int, remoteServerUrl: string, remoteToken: string, state: int, userId: string, inviterCloudId: string, inviterDisplayName: string}
 	 */
 	public function jsonSerialize(): array {
 		return [
 			'id' => $this->getId(),
 			'userId' => $this->getUserId(),
 			'state' => $this->getState(),
-			'localRoomId' => $this->getLocalRoomId(),
 			'localCloudId' => $this->getLocalCloudId(),
 			'remoteServerUrl' => $this->getRemoteServerUrl(),
 			'remoteToken' => $this->getRemoteToken(),

lib/Model/InvitationMapper.php

@@ -95,6 +95,20 @@ public function getInvitationsForUser(IUser $user): array {
 		return $this->findEntities($qb);
 	}
 
+	/**
+	 * @throws DoesNotExistException
+	 */
+	public function getInvitationsForUserByLocalRoom(Room $room, string $userId): Invitation {
+		$query = $this->db->getQueryBuilder();
+
+		$query->select('*')
+			->from($this->getTableName())
+			->where($query->expr()->eq('user_id', $query->createNamedParameter($userId)))
+			->andWhere($query->expr()->eq('local_room_id', $query->createNamedParameter($room->getId())));
+
+		return $this->findEntity($query);
+	}
+
 	public function countInvitationsForLocalRoom(Room $room): int {
 		$qb = $this->db->getQueryBuilder();
 

lib/ResponseDefinitions.php

@@ -117,7 +117,7 @@
  *     id: int,
  *     state: int,
  *     localCloudId: string,
- *     localRoomId: int,
+ *     localToken: string,
  *     remoteAttendeeId: int,
  *     remoteServerUrl: string,
  *     remoteToken: string,

openapi-federation.json

@@ -316,7 +316,7 @@
                     "id",
                     "state",
                     "localCloudId",
-                    "localRoomId",
+                    "localToken",
                     "remoteAttendeeId",
                     "remoteServerUrl",
                     "remoteToken",
@@ -337,9 +337,8 @@
                     "localCloudId": {
                         "type": "string"
                     },
-                    "localRoomId": {
-                        "type": "integer",
-                        "format": "int64"
+                    "localToken": {
+                        "type": "string"
                     },
                     "remoteAttendeeId": {
                         "type": "integer",

openapi-full.json

@@ -517,7 +517,7 @@
                     "id",
                     "state",
                     "localCloudId",
-                    "localRoomId",
+                    "localToken",
                     "remoteAttendeeId",
                     "remoteServerUrl",
                     "remoteToken",
@@ -538,9 +538,8 @@
                     "localCloudId": {
                         "type": "string"
                     },
-                    "localRoomId": {
-                        "type": "integer",
-                        "format": "int64"
+                    "localToken": {
+                        "type": "string"
                     },
                     "remoteAttendeeId": {
                         "type": "integer",

src/components/ConversationIcon.vue

@@ -179,7 +179,7 @@ export default {
 			if (this.item.isDummyConversation) {
 				// Prevent a 404 when trying to load an avatar before the conversation data is actually loaded
 				// Also used in new conversation / invitation handler dialog
-				const isFed = this.item.isFederatedConversation && 'icon-conversation-federation'
+				const isFed = this.item.remoteServer && 'icon-conversation-federation'
 				const type = this.item.type === CONVERSATION.TYPE.PUBLIC ? 'icon-conversation-public' : 'icon-conversation-group'
 				const theme = isDarkTheme ? 'dark' : 'bright'
 				return `${isFed || type} icon--dummy icon--${theme}`