Consolidate convertEmoji function
This commit is contained in:
		
							parent
							
								
									369e0862e5
								
							
						
					
					
						commit
						67939860b2
					
				
					 2 changed files with 97 additions and 40 deletions
				
			
		| 
						 | 
				
			
			@ -162,32 +162,8 @@ turndownService.addRule("emoji", {
 | 
			
		|||
 | 
			
		||||
	replacement: function (content, node) {
 | 
			
		||||
		const mxcUrl = node.getAttribute("src")
 | 
			
		||||
		// Get the known emoji from the database. (We may not be able to actually use this if it was from another server.)
 | 
			
		||||
		const row = select("emoji", ["emoji_id", "name", "animated"], {mxc_url: mxcUrl}).get()
 | 
			
		||||
		// Also guess a suitable emoji based on the ID (if available) or name
 | 
			
		||||
		let guess = null
 | 
			
		||||
		const guessedName = node.getAttribute("title").replace(/^:|:$/g, "")
 | 
			
		||||
		for (const guild of discord.guilds.values()) {
 | 
			
		||||
			/** @type {{name: string, id: string, animated: number}[]} */
 | 
			
		||||
			// @ts-ignore
 | 
			
		||||
			const emojis = guild.emojis
 | 
			
		||||
			const match = emojis.find(e => e.id === row?.emoji_id) || emojis.find(e => e.name === guessedName) || emojis.find(e => e.name?.toLowerCase() === guessedName.toLowerCase())
 | 
			
		||||
			if (match) {
 | 
			
		||||
				guess = match
 | 
			
		||||
				break
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
		if (guess) {
 | 
			
		||||
			// We know an emoji, and we can use it
 | 
			
		||||
			const animatedChar = guess.animated ? "a" : ""
 | 
			
		||||
			return `<${animatedChar}:${guess.name}:${guess.id}>`
 | 
			
		||||
		} else if (endOfMessageEmojis.includes(mxcUrl)) {
 | 
			
		||||
			// We can't locate or use a suitable emoji. After control returns, it will rewind over this, delete this section, and upload the emojis as a sprite sheet.
 | 
			
		||||
			return `<::>`
 | 
			
		||||
		} else {
 | 
			
		||||
			// We prefer not to upload this as a sprite sheet because the emoji is not at the end of the message, it is in the middle.
 | 
			
		||||
			return `[${node.getAttribute("title")}](${mxUtils.getPublicUrlForMxc(mxcUrl)})`
 | 
			
		||||
		}
 | 
			
		||||
		return convertEmoji(mxcUrl, guessedName, true, true)
 | 
			
		||||
	}
 | 
			
		||||
})
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -216,6 +192,52 @@ turndownService.addRule("fencedCodeBlock", {
 | 
			
		|||
	}
 | 
			
		||||
})
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * @param {string | null} mxcUrl
 | 
			
		||||
 * @param {string | null} nameForGuess without colons
 | 
			
		||||
 * @param {boolean} allowSpriteSheetIndicator
 | 
			
		||||
 * @param {boolean} allowLink
 | 
			
		||||
 * @returns {string} discord markdown that represents the custom emoji in some form
 | 
			
		||||
 */
 | 
			
		||||
function convertEmoji(mxcUrl, nameForGuess, allowSpriteSheetIndicator, allowLink) {
 | 
			
		||||
	// Get the known emoji from the database.
 | 
			
		||||
	let row
 | 
			
		||||
	if (mxcUrl) row = select("emoji", ["emoji_id", "name", "animated"], {mxc_url: mxcUrl}).get()
 | 
			
		||||
	if (!row && nameForGuess) {
 | 
			
		||||
		// We don't know the emoji, but we could guess a suitable emoji based on the name
 | 
			
		||||
		const nameForGuessLower = nameForGuess.toLowerCase()
 | 
			
		||||
		for (const guild of discord.guilds.values()) {
 | 
			
		||||
			/** @type {{name: string, id: string, animated: number}[]} */
 | 
			
		||||
			// @ts-ignore
 | 
			
		||||
			const emojis = guild.emojis
 | 
			
		||||
			const found = emojis.find(e => e.name?.toLowerCase() === nameForGuessLower)
 | 
			
		||||
			if (found) {
 | 
			
		||||
				row = {
 | 
			
		||||
					animated: found.animated,
 | 
			
		||||
					emoji_id: found.id,
 | 
			
		||||
					name: found.name
 | 
			
		||||
				}
 | 
			
		||||
				break
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
	if (row) {
 | 
			
		||||
		// We know an emoji, and we can use it
 | 
			
		||||
		const animatedChar = row.animated ? "a" : ""
 | 
			
		||||
		return `<${animatedChar}:${row.name}:${row.emoji_id}>`
 | 
			
		||||
	} else if (allowSpriteSheetIndicator && mxcUrl && endOfMessageEmojis.includes(mxcUrl)) {
 | 
			
		||||
		// We can't locate or use a suitable emoji. After control returns, it will rewind over this, delete this section, and upload the emojis as a sprite sheet.
 | 
			
		||||
		return `<::>`
 | 
			
		||||
	} else if (allowLink && mxcUrl && nameForGuess) {
 | 
			
		||||
		// We prefer not to upload this as a sprite sheet because the emoji is not at the end of the message, it is in the middle.
 | 
			
		||||
		return `[:${nameForGuess}:](${mxUtils.getPublicUrlForMxc(mxcUrl)})`
 | 
			
		||||
	} else if (nameForGuess) {
 | 
			
		||||
		return `:${nameForGuess}:`
 | 
			
		||||
	} else {
 | 
			
		||||
		return ""
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * @param {string} roomID
 | 
			
		||||
 * @param {string} mxid
 | 
			
		||||
| 
						 | 
				
			
			@ -530,21 +552,9 @@ async function eventToMessage(event, guild, di) {
 | 
			
		|||
				repliedToContent = repliedToContent.replace(/(?:\n|<br>)+/g, " ") // Should all be on one line
 | 
			
		||||
				repliedToContent = repliedToContent.replace(/<span [^>]*data-mx-spoiler\b[^>]*>.*?<\/span>/g, "[spoiler]") // Good enough method of removing spoiler content. (I don't want to break out the HTML parser unless I have to.)
 | 
			
		||||
				repliedToContent = repliedToContent.replace(/<img([^>]*)>/g, (_, att) => { // Convert Matrix emoji images into Discord emoji markdown
 | 
			
		||||
					if (!att.includes("data-mx-emoticon")) return ""
 | 
			
		||||
					// Try to get the equivalent Discord emoji, if there is a src and if we know about it
 | 
			
		||||
					const mxcUrlMatch = att.match(/\bsrc="(mxc:\/\/[^"]+)"/)
 | 
			
		||||
					if (mxcUrlMatch) {
 | 
			
		||||
						const row = select("emoji", ["emoji_id", "name", "animated"], {mxc_url: mxcUrlMatch[1]}).get()
 | 
			
		||||
						if (row) {
 | 
			
		||||
							const animatedChar = row.animated ? "a" : ""
 | 
			
		||||
							return `<${animatedChar}:${row.name}:${row.emoji_id}>`
 | 
			
		||||
						}
 | 
			
		||||
					}
 | 
			
		||||
					// Emoji is unknown or inaccessible, try substituting the title text instead
 | 
			
		||||
					const titleTextMatch = att.match(/\btitle=":?([^:"]+)/)
 | 
			
		||||
					if (titleTextMatch) return `:${titleTextMatch[1]}:`
 | 
			
		||||
					// Otherwise we can't use the emoji.
 | 
			
		||||
					return ""
 | 
			
		||||
					return convertEmoji(mxcUrlMatch?.[1], titleTextMatch?.[1], false, false)
 | 
			
		||||
				})
 | 
			
		||||
				repliedToContent = repliedToContent.replace(/<[^:>][^>]*>/g, "") // Completely strip all HTML tags and formatting.
 | 
			
		||||
				repliedToContent = entities.decodeHTML5Strict(repliedToContent) // Remove entities like & "
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -1339,7 +1339,7 @@ test("event2message: reply preview converts emoji formatting when replying to a
 | 
			
		|||
	)
 | 
			
		||||
})
 | 
			
		||||
 | 
			
		||||
test("event2message: reply preview uses emoji title text when replying to an unknown custom emoji", async t => {
 | 
			
		||||
test("event2message: reply preview can guess custom emoji based on the name if it is unknown", async t => {
 | 
			
		||||
	t.deepEqual(
 | 
			
		||||
		await eventToMessage({
 | 
			
		||||
			type: "m.room.message",
 | 
			
		||||
| 
						 | 
				
			
			@ -1378,7 +1378,54 @@ test("event2message: reply preview uses emoji title text when replying to an unk
 | 
			
		|||
			messagesToSend: [{
 | 
			
		||||
				username: "cadence [they]",
 | 
			
		||||
				content: "> <:L1:1144820033948762203><:L2:1144820084079087647>Ⓜ️**cadence [they]**:"
 | 
			
		||||
					+ "\n> :hippo:"
 | 
			
		||||
					+ "\n> <:hippo:230201364309868544>"
 | 
			
		||||
					+ "\nreply",
 | 
			
		||||
				avatar_url: undefined
 | 
			
		||||
			}]
 | 
			
		||||
		}
 | 
			
		||||
	)
 | 
			
		||||
})
 | 
			
		||||
 | 
			
		||||
test("event2message: reply preview uses emoji title text when replying to an unknown custom emoji", async t => {
 | 
			
		||||
	t.deepEqual(
 | 
			
		||||
		await eventToMessage({
 | 
			
		||||
			type: "m.room.message",
 | 
			
		||||
			sender: "@cadence:cadence.moe",
 | 
			
		||||
			content: {
 | 
			
		||||
				msgtype: "m.text",
 | 
			
		||||
				body: "> <@cadence:cadence.moe> :svkftngur_gkdne:\n\nreply",
 | 
			
		||||
				format: "org.matrix.custom.html",
 | 
			
		||||
				formatted_body: "<mx-reply><blockquote><a href=\"https://matrix.to/#/!TqlyQmifxGUggEmdBN:cadence.moe/$zmO-dtPO6FubBkDxJZ5YmutPIsG1RgV5JJku-9LeGWs?via=cadence.moe&via=matrix.org&via=conduit.rory.gay\">In reply to</a> <a href=\"https://matrix.to/#/@cadence:cadence.moe\">@cadence:cadence.moe</a><br><img data-mx-emoticon height=\"32\" src=\"mxc://cadence.moe/AHKNeXoRlprdULRMalhqfCdj\" title=\":svkftngur_gkdne:\" alt=\":svkftngur_gkdne:\" /></blockquote></mx-reply>reply",
 | 
			
		||||
				"m.relates_to": {
 | 
			
		||||
					"m.in_reply_to": {
 | 
			
		||||
						event_id: "$zmO-dtPO6FubBkDxJZ5YmutPIsG1RgV5JJku-9LeGWs"
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
			},
 | 
			
		||||
			event_id: "$bCMLaLiMfoRajaGTgzaxAci-g8hJfkspVJIKwYktnvc",
 | 
			
		||||
			room_id: "!TqlyQmifxGUggEmdBN:cadence.moe"
 | 
			
		||||
		}, data.guild.general, {
 | 
			
		||||
			api: {
 | 
			
		||||
				getEvent: mockGetEvent(t, "!TqlyQmifxGUggEmdBN:cadence.moe", "$zmO-dtPO6FubBkDxJZ5YmutPIsG1RgV5JJku-9LeGWs", {
 | 
			
		||||
					type: "m.room.message",
 | 
			
		||||
					sender: "@cadence:cadence.moe",
 | 
			
		||||
					content: {
 | 
			
		||||
						msgtype: "m.text",
 | 
			
		||||
						body: ":svkftngur_gkdne:",
 | 
			
		||||
						format: "org.matrix.custom.html",
 | 
			
		||||
						formatted_body: "<img data-mx-emoticon height=\"32\" src=\"mxc://cadence.moe/AHKNeXoRlprdULRMalhqfCdj\" title=\":svkftngur_gkdne:\" alt=\":svkftngur_gkdne:\">"
 | 
			
		||||
					}
 | 
			
		||||
				})
 | 
			
		||||
			}
 | 
			
		||||
		}),
 | 
			
		||||
		{
 | 
			
		||||
			ensureJoined: [],
 | 
			
		||||
			messagesToDelete: [],
 | 
			
		||||
			messagesToEdit: [],
 | 
			
		||||
			messagesToSend: [{
 | 
			
		||||
				username: "cadence [they]",
 | 
			
		||||
				content: "> <:L1:1144820033948762203><:L2:1144820084079087647>Ⓜ️**cadence [they]**:"
 | 
			
		||||
					+ "\n> :svkftngur_gkdne:"
 | 
			
		||||
					+ "\nreply",
 | 
			
		||||
				avatar_url: undefined
 | 
			
		||||
			}]
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue