Defuse mentions in m->d reply if client says so

2026-03-20 00:42:51 +13:00
parent 8c87d93011
commit 9dbd871e0b
2 changed files with 147 additions and 10 deletions
--- a/src/m2d/converters/event-to-message.js
+++ b/src/m2d/converters/event-to-message.js
@@ -471,7 +471,8 @@ async function checkWrittenMentions(content, senderMxid, roomID, guild, di) {
 					// @ts-ignore - typescript doesn't know about indices yet
 					content: content.slice(0, writtenMentionMatch.indices[1][0]-1) + `@everyone` + content.slice(writtenMentionMatch.indices[1][1]),
 					ensureJoined: [],
-					allowedMentionsParse: ["everyone"]
+					allowedMentionsParse: ["everyone"],
+					allowedMentionsUsers: []
 				}
 			}
 		} else if (writtenMentionMatch[1].length < 40) { // the API supports up to 100 characters, but really if you're searching more than 40, something messed up
@@ -482,7 +483,8 @@ async function checkWrittenMentions(content, senderMxid, roomID, guild, di) {
 					// @ts-ignore - typescript doesn't know about indices yet
 					content: content.slice(0, writtenMentionMatch.indices[1][0]-1) + `<@${results[0].user.id}>` + content.slice(writtenMentionMatch.indices[1][1]),
 					ensureJoined: [results[0].user],
-					allowedMentionsParse: []
+					allowedMentionsParse: [],
+					allowedMentionsUsers: [results[0].user.id]
 				}
 			}
 		}
@@ -544,6 +546,7 @@ async function eventToMessage(event, guild, channel, di) {
 	let displayName = event.sender
 	let avatarURL = undefined
 	const allowedMentionsParse = ["users", "roles"]
+	const allowedMentionsUsers = []
 	/** @type {string[]} */
 	let messageIDsToEdit = []
 	let replyLine = ""
@@ -986,16 +989,34 @@ async function eventToMessage(event, guild, channel, di) {
 		}
 	}

+	// Complete content
 	content = displayNameRunoff + replyLine + content
-
 	// Split into 2000 character chunks
 	const chunks = chunk(content, 2000)
+
+	// If m.mentions is specified and valid, overwrite allowedMentionsParse with a converted m.mentions
+	let allowed_mentions = {parse: allowedMentionsParse}
+	if (event.content["m.mentions"]) {
+		// Combine requested mentions with detected written mentions to get the full list
+		if (Array.isArray(event.content["m.mentions"].user_ids)) {
+			for (const mxid of event.content["m.mentions"].user_ids) {
+				const user_id = select("sim", "user_id", {mxid}).pluck().get()
+				if (!user_id) continue
+				allowedMentionsUsers.push(
+					select("sim_proxy", "proxy_owner_id", {user_id}).pluck().get() || user_id
+				)
+			}
+		}
+		// Specific mentions were requested, so do not parse users
+		allowed_mentions.parse = allowed_mentions.parse.filter(x => x !== "users")
+		allowed_mentions.users = allowedMentionsUsers
+	}
+
+	// Assemble chunks into Discord messages content
 	/** @type {(DiscordTypes.RESTPostAPIWebhookWithTokenJSONBody & {files?: {name: string, file: Buffer | stream.Readable}[]})[]} */
 	const messages = chunks.map(content => ({
 		content,
-		allowed_mentions: {
-			parse: allowedMentionsParse
-		},
+		allowed_mentions,
 		username: displayNameShortened,
 		avatar_url: avatarURL
 	}))
--- a/src/m2d/converters/event-to-message.test.js
+++ b/src/m2d/converters/event-to-message.test.js
@@ -266,7 +266,8 @@ test("event2message: markdown in link text does not attempt to be escaped becaus
 				content: "hey [@mario sports mix [she/her]](<https://matrix.to/#/%40cadence%3Acadence.moe>), is it possible to listen on a unix socket?",
 				avatar_url: undefined,
 				allowed_mentions: {
-					parse: ["users", "roles"]
+					parse: ["roles"],
+					users: []
 				}
 			}]
 		}
@@ -547,7 +548,8 @@ test("event2message: links don't have angle brackets added by accident", async t
 				content: "Wanted to automate WG→AWG config enrichment and ended up basically coding a batch INI processor.\nhttps://github.com/Erquint/wgcbp",
 				avatar_url: undefined,
 				allowed_mentions: {
-					parse: ["users", "roles"]
+					parse: ["roles"],
+					users: []
 				}
 			}]
 		}
@@ -1296,7 +1298,8 @@ test("event2message: lists have appropriate line breaks", async t => {
 				content: `i am not certain what you mean by "already exists with as discord". my goals are\n\n* bridgeing specific channels with existing matrix rooms\n  * optionally maybe entire "servers"\n* offering the bridge as a public service`,
 				avatar_url: undefined,
 				allowed_mentions: {
-					parse: ["users", "roles"]
+					parse: ["roles"],
+					users: []
 				}
 			}]
 		}
@@ -1337,7 +1340,8 @@ test("event2message: ordered list start attribute works", async t => {
 				content: `i am not certain what you mean by "already exists with as discord". my goals are\n\n1. bridgeing specific channels with existing matrix rooms\n  2. optionally maybe entire "servers"\n2. offering the bridge as a public service`,
 				avatar_url: undefined,
 				allowed_mentions: {
-					parse: ["users", "roles"]
+					parse: ["roles"],
+					users: []
 				}
 			}]
 		}
@@ -1463,6 +1467,118 @@ test("event2message: rich reply to a sim user", async t => {
 	)
 })

+test("event2message: rich reply to a sim user, explicitly enabling mentions in client", async t => {
+	t.deepEqual(
+		await eventToMessage({
+			"type": "m.room.message",
+			"sender": "@cadence:cadence.moe",
+			"content": {
+				"msgtype": "m.text",
+				"body": "> <@_ooye_kyuugryphon:cadence.moe> Slow news day.\n\nTesting this reply, ignore",
+				"format": "org.matrix.custom.html",
+				"formatted_body": "<mx-reply><blockquote><a href=\"https://matrix.to/#/!fGgIymcYWOqjbSRUdV:cadence.moe/$Fxy8SMoJuTduwReVkHZ1uHif9EuvNx36Hg79cltiA04?via=cadence.moe&via=feather.onl\">In reply to</a> <a href=\"https://matrix.to/#/@_ooye_kyuugryphon:cadence.moe\">@_ooye_kyuugryphon:cadence.moe</a><br>Slow news day.</blockquote></mx-reply>Testing this reply, ignore",
+				"m.relates_to": {
+					"m.in_reply_to": {
+						"event_id": "$Fxy8SMoJuTduwReVkHZ1uHif9EuvNx36Hg79cltiA04"
+					}
+				},
+				"m.mentions": {
+					user_ids: ["@_ooye_kyuugryphon:cadence.moe"]
+				}
+			},
+			"origin_server_ts": 1693029683016,
+			"unsigned": {
+				"age": 91,
+				"transaction_id": "m1693029682894.510"
+			},
+			"event_id": "$v_Gtr-bzv9IVlSLBO5DstzwmiDd-GSFaNfHX66IupV8",
+			"room_id": "!fGgIymcYWOqjbSRUdV:cadence.moe"
+		}, data.guild.general, data.channel.general, {
+			api: {
+				getEvent: mockGetEvent(t, "!fGgIymcYWOqjbSRUdV:cadence.moe", "$Fxy8SMoJuTduwReVkHZ1uHif9EuvNx36Hg79cltiA04", {
+					type: "m.room.message",
+					content: {
+						msgtype: "m.text",
+						body: "Slow news day."
+					},
+					sender: "@_ooye_kyuugryphon:cadence.moe"
+				})
+			}
+		}),
+		{
+			ensureJoined: [],
+			messagesToDelete: [],
+			messagesToEdit: [],
+			messagesToSend: [{
+				username: "cadence [they]",
+				content: "-# > <:L1:1144820033948762203><:L2:1144820084079087647>https://discord.com/channels/112760669178241024/687028734322147344/1144865310588014633 <@111604486476181504>:"
+					+ " Slow news day."
+					+ "\nTesting this reply, ignore",
+				avatar_url: "https://bridge.example.org/download/matrix/cadence.moe/azCAhThKTojXSZJRoWwZmhvU",
+				allowed_mentions: {
+					parse: ["roles"],
+					users: ["111604486476181504"]
+				}
+			}]
+		}
+	)
+})
+
+test("event2message: rich reply to a sim user, explicitly disabling mentions in client", async t => {
+	t.deepEqual(
+		await eventToMessage({
+			"type": "m.room.message",
+			"sender": "@cadence:cadence.moe",
+			"content": {
+				"msgtype": "m.text",
+				"body": "> <@_ooye_kyuugryphon:cadence.moe> Slow news day.\n\nTesting this reply, ignore",
+				"format": "org.matrix.custom.html",
+				"formatted_body": "<mx-reply><blockquote><a href=\"https://matrix.to/#/!fGgIymcYWOqjbSRUdV:cadence.moe/$Fxy8SMoJuTduwReVkHZ1uHif9EuvNx36Hg79cltiA04?via=cadence.moe&via=feather.onl\">In reply to</a> <a href=\"https://matrix.to/#/@_ooye_kyuugryphon:cadence.moe\">@_ooye_kyuugryphon:cadence.moe</a><br>Slow news day.</blockquote></mx-reply>Testing this reply, ignore",
+				"m.relates_to": {
+					"m.in_reply_to": {
+						"event_id": "$Fxy8SMoJuTduwReVkHZ1uHif9EuvNx36Hg79cltiA04"
+					}
+				},
+				"m.mentions": {}
+			},
+			"origin_server_ts": 1693029683016,
+			"unsigned": {
+				"age": 91,
+				"transaction_id": "m1693029682894.510"
+			},
+			"event_id": "$v_Gtr-bzv9IVlSLBO5DstzwmiDd-GSFaNfHX66IupV8",
+			"room_id": "!fGgIymcYWOqjbSRUdV:cadence.moe"
+		}, data.guild.general, data.channel.general, {
+			api: {
+				getEvent: mockGetEvent(t, "!fGgIymcYWOqjbSRUdV:cadence.moe", "$Fxy8SMoJuTduwReVkHZ1uHif9EuvNx36Hg79cltiA04", {
+					type: "m.room.message",
+					content: {
+						msgtype: "m.text",
+						body: "Slow news day."
+					},
+					sender: "@_ooye_kyuugryphon:cadence.moe"
+				})
+			}
+		}),
+		{
+			ensureJoined: [],
+			messagesToDelete: [],
+			messagesToEdit: [],
+			messagesToSend: [{
+				username: "cadence [they]",
+				content: "-# > <:L1:1144820033948762203><:L2:1144820084079087647>https://discord.com/channels/112760669178241024/687028734322147344/1144865310588014633 <@111604486476181504>:"
+					+ " Slow news day."
+					+ "\nTesting this reply, ignore",
+				avatar_url: "https://bridge.example.org/download/matrix/cadence.moe/azCAhThKTojXSZJRoWwZmhvU",
+				allowed_mentions: {
+					parse: ["roles"],
+					users: []
+				}
+			}]
+		}
+	)
+})
+
 test("event2message: rich reply to a rich reply to a multi-line message should correctly strip reply fallback", async t => {
 	t.deepEqual(
 		await eventToMessage({