feat: localize federated user mention in card comment

Signed-off-by: Luka Trovic <luka@nextcloud.com>

Author: luka-nextcloud

lib/Service/CommentService.php

@@ -19,6 +19,7 @@
 use OCP\Comments\MessageTooLongException;
 use OCP\Comments\NotFoundException as CommentNotFoundException;
 use OCP\Federation\ICloudIdManager;
+use OCP\IURLGenerator;
 use OCP\IUserManager;
 use OutOfBoundsException;
 use Psr\Log\LoggerInterface;
@@ -32,6 +33,7 @@ public function __construct(
 		private IUserManager $userManager,
 		private LoggerInterface $logger,
 		private ICloudIdManager $cloudIdManager,
+		private IURLGenerator $urlGenerator,
 		private ?string $userId,
 	) {
 	}
@@ -172,16 +174,23 @@ private function formatComment(IComment $comment, bool $addReplyTo = false): arr
 			'actorDisplayName' => $actorDisplayName,
 			'creationDateTime' => $comment->getCreationDateTime()->format(\DateTime::ATOM),
 			'mentions' => array_map(function ($mention) {
+				$remote = $this->cloudIdManager->isValidCloudId($mention['id']) ? $this->cloudIdManager->resolveCloudId($mention['id'])->getRemote() : null;
+
 				try {
 					$displayName = $this->commentsManager->resolveDisplayName($mention['type'], $mention['id']);
 				} catch (OutOfBoundsException $e) {
 					$this->logger->warning('Mention type not registered, can not resolve display name.', ['exception' => $e, 'mention_type' => $mention['type']]);
 					// No display name, upon client's discretion what to display.
 					$displayName = $mention['id'] ?? '';
+					if ($remote === $this->urlGenerator->getBaseUrl()) {
+						$uid = $this->cloudIdManager->resolveCloudId($mention['id'])->getUser();
+						$displayName = $this->commentsManager->resolveDisplayName('user', $uid);
+					}
 				}
 
 				return [
 					'mentionId' => $mention['id'],
+					'mentionRemote' => $remote,
 					'mentionType' => $mention['type'],
 					'mentionDisplayName' => $displayName
 				];

lib/Service/ExternalBoardService.php

@@ -108,6 +108,7 @@ public function LocalizeRemoteBoard(array $remoteBoard, Board $localBoard) {
 		$remoteBoard['acl'] = $localBoard->getAcl();
 		$remoteBoard['permissions'] = $localBoard->getPermissions();
 		$remoteBoard['users'] = $this->localizeRemoteUsers($remoteBoard['users'], $localBoard);
+		$remoteBoard['externalId'] = $localBoard->getExternalId();
 		return $remoteBoard;
 	}
 
@@ -122,6 +123,7 @@ public function localizeRemoteUsers(array $users, Board $localBoard) {
 
 	public function localizeRemoteComments(Board $localBoard, array $comments): array {
 		foreach ($comments as $i => $comment) {
+			// Localize actors
 			$localizedActor = $this->localizeRemoteUser($localBoard, ['uid' => $comment['actorId'], 'remote' => $comment['actorRemote']]);
 			if ($localizedActor instanceof FederatedUser) {
 				$comments[$i]['actorDisplayName'] = $localizedActor->getCloudId()->getId();
@@ -146,6 +148,25 @@ public function localizeRemoteComments(Board $localBoard, array $comments): arra
 					$comments[$i]['replyTo']['actorRemote'] = null;
 				}
 			}
+
+			// Localize mentions
+			foreach ($comment['mentions'] as $j => $mention) {
+				$localizedMention = $this->localizeRemoteUser($localBoard, ['uid' => $mention['mentionId'], 'remote' => $mention['mentionRemote']]);
+				if ($localizedMention instanceof User) {
+					$comments[$i]['message'] = str_replace('@"federated_user/' . $mention['mentionId'], '@"' . $localizedMention->getUID(), $comment['message']);
+					$comments[$i]['mentions'][$j]['mentionDisplayName'] = $localizedMention->getDisplayName();
+					$comments[$i]['mentions'][$j]['mentionId'] = $localizedMention->getUID();
+					$comments[$i]['mentions'][$j]['mentionRemote'] = null;
+					$comments[$i]['mentions'][$j]['mentionType'] = 'user';
+				}
+				if ($localizedMention instanceof FederatedUser) {
+					$comments[$i]['message'] = str_replace('@' . $mention['mentionId'], '@federated_user/' . $localizedMention->getUID(), $comment['message']);
+					$comments[$i]['mentions'][$j]['mentionDisplayName'] = $localizedMention->getCloudId()->getId();
+					$comments[$i]['mentions'][$j]['mentionId'] = $localizedMention->getCloudId()->getId();
+					$comments[$i]['mentions'][$j]['mentionRemote'] = $localizedMention->getCloudId()->getRemote();
+					$comments[$i]['mentions'][$j]['mentionType'] = 'federated_user';
+				}
+			}
 		}
 		return $comments;
 	}
@@ -499,6 +520,7 @@ public function createCardCommentOnRemote(Board $localBoard, int $cardId, string
 		$participantCloudId = $this->cloudIdManager->getCloudId($this->userId, null);
 		$ownerCloudId = $this->cloudIdManager->resolveCloudId($localBoard->getOwner());
 		$url = $ownerCloudId->getRemote() . '/ocs/v2.php/apps/deck/api/v1.0/cards/' . $cardId . '/comments';
+
 		$params = [
 			'boardId' => $localBoard->getExternalId(),
 			'message' => $message,

src/components/card/CommentForm.vue

@@ -58,11 +58,17 @@ export default {
 		members() {
 			const obj = {}
 			this.currentBoard.users.forEach(user => {
-				obj[user.remote ? `federated_user/${user.uid}` : user.uid] = {
+				let uid = user.uid
+				if (user.remote) {
+					uid = `federated_user/${user.uid}`
+				} else if (this.currentBoard.externalId) {
+					uid = `federated_user/${user.uid}@${window.location.origin}`
+				}
+				obj[uid] = {
 					icon: 'icon-user',
-					id: user.remote ? `federated_user/${user.uid}` : user.uid,
+					id: uid,
 					label: user.remote ? user.uid : user.displayname,
-					source: user.remote ? 'federated_user' : 'users',
+					source: 'users',
 				}
 			})
 			return obj

src/components/card/CommentItem.vue

@@ -149,12 +149,17 @@ export default {
 		richText() {
 			return (comment) => {
 				let message = this.parsedMessage(comment.message)
+				message = message.replace('federated_user/', '')
 				comment.mentions.forEach((mention, index) => {
+					let mentionId = mention.mentionId
+					if (mention.mentionRemote === window.location.origin) {
+						mentionId = mention.mentionId.replace('@' + window.location.origin, '')
+						message = message.replace(mention.mentionId, mentionId)
+					}
 					// Currently only [a-z\-_0-9] are allowed inside of placeholders so we use a hash of the mention id as a unique identifier
-					const hash = md5(mention.mentionId)
-					message = message.replace('federated_user/', '')
-					message = message.split('@' + mention.mentionId + '').join(`{user-${hash}}`)
-					message = message.split('@"' + mention.mentionId + '"').join(`{user-${hash}}`)
+					const hash = md5(mentionId)
+					message = message.split('@' + mentionId + '').join(`{user-${hash}}`)
+					message = message.split('@"' + mentionId + '"').join(`{user-${hash}}`)
 				})
 				return message
 			}
@@ -163,11 +168,15 @@ export default {
 			return (comment) => {
 				const mentions = [...comment.mentions]
 				const result = mentions.reduce((result, item, index) => {
-					const itemKey = 'user-' + md5(item.mentionId)
+					let mentionId = item.mentionId
+					if (item.mentionRemote === window.location.origin) {
+						mentionId = item.mentionId.replace('@' + window.location.origin, '')
+					}
+					const itemKey = 'user-' + md5(mentionId)
 					result[itemKey] = {
 						component: AtMention,
 						props: {
-							user: (item.mentionType === 'federated_user' ? 'federated_user/' : '') + item.mentionId,
+							user: mentionId,
 							displayName: item.mentionDisplayName,
 						},
 					}