Document encryption as unsupported

- Autojoined child spaces are recorded as invited
- Update entry when reinvited
- Delete entry when uninvited or removed from room
- Allow linking with spaces you moderate, even if you didn't invite
- Store power levels immediately for new invited rooms
  - Mark members as missing profile in this case
- Only delete from invite table if it left the space

.c8rc.json

@@ -0,0 +1,8 @@
+{
+	"watermarks": {
+		"statements": [60, 100],
+		"lines": [60, 100],
+		"functions": [60, 100],
+		"branches": [60, 100]
+	}
+}

.gitignore

@@ -1,5 +1,18 @@
-node_modules
+# Secrets
 config.js
 registration.yaml
+ooye.db*
+events.db*
+backfill.db*
+custom-webroot
+
+# Automatically generated
+node_modules
 coverage
-db/ooye.db*
+test/res/*
+!test/res/lottie*
+icon.svg
+*~
+.#*
+\#*#
+launch.json

addbot.js

@@ -1,15 +1,27 @@
+#!/usr/bin/env node
 // @ts-check
 
-const config = require("./config")
+const DiscordTypes = require("discord-api-types/v10")
+
+const {reg} = require("./src/matrix/read-registration")
+const token = reg.ooye.discord_token
+const id = Buffer.from(token.split(".")[0], "base64").toString()
+const permissions =
+( DiscordTypes.PermissionFlagsBits.ManageWebhooks
+| DiscordTypes.PermissionFlagsBits.ManageGuildExpressions
+| DiscordTypes.PermissionFlagsBits.ManageMessages
+| DiscordTypes.PermissionFlagsBits.PinMessages
+| DiscordTypes.PermissionFlagsBits.UseExternalEmojis)
 
 function addbot() {
-	const token = config.discordToken
+	return `Open this link to add the bot to a Discord server:\nhttps://discord.com/oauth2/authorize?client_id=${id}&scope=bot&permissions=${permissions} `
-	const id = Buffer.from(token.split(".")[0], "base64")
-	return `Open this link to add the bot to a Discord server:\nhttps://discord.com/oauth2/authorize?client_id=${id}&scope=bot&permissions=1610883072 `
 }
 
+/* c8 ignore next 3 */
 if (process.argv.find(a => a.endsWith("addbot") || a.endsWith("addbot.js"))) {
 	console.log(addbot())
 }
 
+module.exports.id = id
 module.exports.addbot = addbot
+module.exports.permissions = permissions

addbot.sh

@@ -1,3 +1,3 @@
 #!/usr/bin/env sh
 echo "Open this link to add the bot to a Discord server:"
-echo "https://discord.com/oauth2/authorize?client_id=$(grep discordToken config.js | sed -E 's!.*: ["'\'']([A-Za-z0-9+=/_-]*).*!\1!g' | base64 -d)&scope=bot&permissions=1610883072"
+echo "https://discord.com/oauth2/authorize?client_id=$(grep discord_token registration.yaml | sed -E 's!.*: ["'\'']([A-Za-z0-9+=/_-]*).*!\1!g' | base64 -d)&scope=bot&permissions=1610883072"

config.example.js

@@ -1,3 +0,0 @@
-module.exports = {
-	discordToken: "yes"
-}

d2m/actions/create-room.js

@@ -1,414 +0,0 @@
-// @ts-check
-
-const assert = require("assert").strict
-const DiscordTypes = require("discord-api-types/v10")
-const reg = require("../../matrix/read-registration")
-
-const passthrough = require("../../passthrough")
-const {discord, sync, db, select} = passthrough
-/** @type {import("../../matrix/file")} */
-const file = sync.require("../../matrix/file")
-/** @type {import("../../matrix/api")} */
-const api = sync.require("../../matrix/api")
-/** @type {import("../../matrix/kstate")} */
-const ks = sync.require("../../matrix/kstate")
-/** @type {import("./create-space")}) */
-const createSpace = sync.require("./create-space") // watch out for the require loop
-
-/**
- * There are 3 levels of room privacy:
- * 0: Room is invite-only.
- * 1: Anybody can use a link to join.
- * 2: Room is published in room directory.
- */
-const PRIVACY_ENUMS = {
-	PRESET: ["private_chat", "public_chat", "public_chat"],
-	VISIBILITY: ["private", "private", "public"],
-	SPACE_HISTORY_VISIBILITY: ["invited", "world_readable", "world_readable"], // copying from element client
-	ROOM_HISTORY_VISIBILITY: ["shared", "shared", "world_readable"], // any events sent after <value> are visible, but for world_readable anybody can read without even joining
-	GUEST_ACCESS: ["can_join", "forbidden", "forbidden"], // whether guests can join space if other conditions are met
-	SPACE_JOIN_RULES: ["invite", "public", "public"],
-	ROOM_JOIN_RULES: ["restricted", "public", "public"]
-}
-
-const DEFAULT_PRIVACY_LEVEL = 0
-
-/** @type {Map<string, Promise<string>>} channel ID -> Promise<room ID> */
-const inflightRoomCreate = new Map()
-
-/**
- * Async because it gets all room state from the homeserver.
- * @param {string} roomID
- */
-async function roomToKState(roomID) {
-	const root = await api.getAllState(roomID)
-	return ks.stateToKState(root)
-}
-
-/**
- * @param {string} roomID
- * @param {any} kstate
- */
-function applyKStateDiffToRoom(roomID, kstate) {
-	const events = ks.kstateToState(kstate)
-	return Promise.all(events.map(({type, state_key, content}) =>
-		api.sendState(roomID, type, state_key, content)
-	))
-}
-
-/**
- * @param {{id: string, name: string, topic?: string?, type: number}} channel
- * @param {{id: string}} guild
- * @param {string | null | undefined} customName
- */
-function convertNameAndTopic(channel, guild, customName) {
-	let channelPrefix =
-		( channel.type === DiscordTypes.ChannelType.PublicThread ? "[⛓️] "
-		: channel.type === DiscordTypes.ChannelType.PrivateThread ? "[🔒⛓️] "
-		: channel.type === DiscordTypes.ChannelType.GuildVoice ? "[🔊] "
-		: "")
-	const chosenName = customName || (channelPrefix + channel.name);
-	const maybeTopicWithPipe = channel.topic ? ` | ${channel.topic}` : '';
-	const maybeTopicWithNewlines = channel.topic ? `${channel.topic}\n\n` : '';
-	const channelIDPart = `Channel ID: ${channel.id}`;
-	const guildIDPart = `Guild ID: ${guild.id}`;
-
-	const convertedTopic = customName
-		 ? `#${channel.name}${maybeTopicWithPipe}\n\n${channelIDPart}\n${guildIDPart}`
-		 : `${maybeTopicWithNewlines}${channelIDPart}\n${guildIDPart}`;
-
-	return [chosenName, convertedTopic];
-}
-
-/**
- * Async because it may create the guild and/or upload the guild icon to mxc.
- * @param {DiscordTypes.APIGuildTextChannel | DiscordTypes.APIThreadChannel} channel
- * @param {DiscordTypes.APIGuild} guild
- */
-async function channelToKState(channel, guild) {
-	const spaceID = await createSpace.ensureSpace(guild)
-	assert(typeof spaceID === "string")
-	const privacyLevel = select("guild_space", "privacy_level", {space_id: spaceID}).pluck().get()
-	assert(typeof privacyLevel === "number")
-
-	const row = select("channel_room", ["nick", "custom_avatar"], {channel_id: channel.id}).get()
-	const customName = row?.nick
-	const customAvatar = row?.custom_avatar
-	const [convertedName, convertedTopic] = convertNameAndTopic(channel, guild, customName)
-
-	const avatarEventContent = {}
-	if (customAvatar) {
-		avatarEventContent.url = customAvatar
-	} else if (guild.icon) {
-		avatarEventContent.discord_path = file.guildIcon(guild)
-		avatarEventContent.url = await file.uploadDiscordFileToMxc(avatarEventContent.discord_path) // TODO: somehow represent future values in kstate (callbacks?), while still allowing for diffing, so test cases don't need to touch the media API
-	}
-
-	let history_visibility = PRIVACY_ENUMS.ROOM_HISTORY_VISIBILITY[privacyLevel]
-	if (channel["thread_metadata"]) history_visibility = "world_readable"
-
-	/** @type {{join_rule: string, allow?: any}} */
-	let join_rules = {
-		join_rule: "restricted",
-		allow: [{
-			type: "m.room_membership",
-			room_id: spaceID
-		}]
-	}
-	if (PRIVACY_ENUMS.ROOM_JOIN_RULES[privacyLevel] !== "restricted") {
-		join_rules = {join_rule: PRIVACY_ENUMS.ROOM_JOIN_RULES[privacyLevel]}
-	}
-
-	const channelKState = {
-		"m.room.name/": {name: convertedName},
-		"m.room.topic/": {topic: convertedTopic},
-		"m.room.avatar/": avatarEventContent,
-		"m.room.guest_access/": {guest_access: PRIVACY_ENUMS.GUEST_ACCESS[privacyLevel]},
-		"m.room.history_visibility/": {history_visibility},
-		[`m.space.parent/${spaceID}`]: {
-			via: [reg.ooye.server_name],
-			canonical: true
-		},
-		/** @type {{join_rule: string, [x: string]: any}} */
-		"m.room.join_rules/": join_rules,
-		"m.room.power_levels/": {
-			events: {
-				"m.room.avatar": 0
-			},
-			users: reg.ooye.invite.reduce((a, c) => (a[c] = 100, a), {})
-		},
-		"chat.schildi.hide_ui/read_receipts": {
-			hidden: true
-		},
-		[`uk.half-shot.bridge/moe.cadence.ooye://discord/${guild.id}/${channel.id}`]: {
-			bridgebot: `@${reg.sender_localpart}:${reg.ooye.server_name}`,
-			protocol: {
-				id: "discord",
-				displayname: "Discord"
-			},
-			network: {
-				id: guild.id,
-				displayname: guild.name,
-				avatar_url: await file.uploadDiscordFileToMxc(file.guildIcon(guild))
-			},
-			channel: {
-				id: channel.id,
-				displayname: channel.name,
-				external_url: `https://discord.com/channels/${guild.id}/${channel.id}`
-			}
-		}
-	}
-
-	return {spaceID, privacyLevel, channelKState}
-}
-
-/**
- * Create a bridge room, store the relationship in the database, and add it to the guild's space.
- * @param {DiscordTypes.APIGuildTextChannel} channel
- * @param guild
- * @param {string} spaceID
- * @param {any} kstate
- * @param {number} privacyLevel
- * @returns {Promise<string>} room ID
- */
-async function createRoom(channel, guild, spaceID, kstate, privacyLevel) {
-	let threadParent = null
-	if (channel.type === DiscordTypes.ChannelType.PublicThread) threadParent = channel.parent_id
-
-	// Name and topic can be done earlier in room creation rather than in initial_state
-	// https://spec.matrix.org/latest/client-server-api/#creation
-	const name = kstate["m.room.name/"].name
-	delete kstate["m.room.name/"]
-	assert(name)
-	const topic = kstate["m.room.topic/"].topic
-	delete kstate["m.room.topic/"]
-	assert(topic)
-
-	const roomID = await postApplyPowerLevels(kstate, async kstate => {
-		const roomID = await api.createRoom({
-			name,
-			topic,
-			preset: PRIVACY_ENUMS.PRESET[privacyLevel], // This is closest to what we want, but properties from kstate override it anyway
-			visibility: PRIVACY_ENUMS.VISIBILITY[privacyLevel],
-			invite: [],
-			initial_state: ks.kstateToState(kstate)
-		})
-
-		db.prepare("INSERT INTO channel_room (channel_id, room_id, name, nick, thread_parent) VALUES (?, ?, ?, NULL, ?)").run(channel.id, roomID, channel.name, threadParent)
-
-		return roomID
-	})
-
-	// Put the newly created child into the space, no need to await this
-	_syncSpaceMember(channel, spaceID, roomID)
-
-	return roomID
-}
-
-/**
- * Handling power levels separately. The spec doesn't specify what happens, Dendrite differs,
- * and Synapse does an absolutely insane *shallow merge* of what I provide on top of what it creates.
- * We don't want the `events` key to be overridden completely.
- * https://github.com/matrix-org/synapse/blob/develop/synapse/handlers/room.py#L1170-L1210
- * https://github.com/matrix-org/matrix-spec/issues/492
- * @param {any} kstate
- * @param {(_: any) => Promise<string>} callback must return room ID
- * @returns {Promise<string>} room ID
- */
-async function postApplyPowerLevels(kstate, callback) {
-	const powerLevelContent = kstate["m.room.power_levels/"]
-	const kstateWithoutPowerLevels = {...kstate}
-	delete kstateWithoutPowerLevels["m.room.power_levels/"]
-
-	/** @type {string} */
-	const roomID = await callback(kstateWithoutPowerLevels)
-
-	// Now *really* apply the power level overrides on top of what Synapse *really* set
-	if (powerLevelContent) {
-		const newRoomKState = await roomToKState(roomID)
-		const newRoomPowerLevelsDiff = ks.diffKState(newRoomKState, {"m.room.power_levels/": powerLevelContent})
-		await applyKStateDiffToRoom(roomID, newRoomPowerLevelsDiff)
-	}
-
-	return roomID
-}
-
-/**
- * @param {DiscordTypes.APIGuildChannel} channel
- */
-function channelToGuild(channel) {
-	const guildID = channel.guild_id
-	assert(guildID)
-	const guild = discord.guilds.get(guildID)
-	assert(guild)
-	return guild
-}
-
-/*
-	Ensure flow:
-	1. Get IDs
-	2. Does room exist? If so great!
-	(it doesn't, so it needs to be created)
-	3. Get kstate for channel
-	4. Create room, return new ID
-
-	Ensure + sync flow:
-	1. Get IDs
-	2. Does room exist?
-	2.5: If room does exist AND wasn't asked to sync: return here
-	3. Get kstate for channel
-	4. Create room with kstate if room doesn't exist
-	5. Get and update room state with kstate if room does exist
-*/
-
-/**
- * @param {string} channelID
- * @param {boolean} shouldActuallySync false if just need to ensure room exists (which is a quick database check), true if also want to sync room data when it does exist (slow)
- * @returns {Promise<string>} room ID
- */
-async function _syncRoom(channelID, shouldActuallySync) {
-	/** @ts-ignore @type {DiscordTypes.APIGuildChannel} */
-	const channel = discord.channels.get(channelID)
-	assert.ok(channel)
-	const guild = channelToGuild(channel)
-
-	if (inflightRoomCreate.has(channelID)) {
-		await inflightRoomCreate.get(channelID) // just waiting, and then doing a new db query afterwards, is the simplest way of doing it
-	}
-
-	const existing = select("channel_room", ["room_id", "thread_parent"], {channel_id: channelID}).get()
-
-	if (!existing) {
-		const creation = (async () => {
-			const {spaceID, privacyLevel, channelKState} = await channelToKState(channel, guild)
-			const roomID = await createRoom(channel, guild, spaceID, channelKState, privacyLevel)
-			inflightRoomCreate.delete(channelID) // OK to release inflight waiters now. they will read the correct `existing` row
-			return roomID
-		})()
-		inflightRoomCreate.set(channelID, creation)
-		return creation // Naturally, the newly created room is already up to date, so we can always skip syncing here.
-	}
-
-	const roomID = existing.room_id
-
-	if (!shouldActuallySync) {
-		return existing.room_id // only need to ensure room exists, and it does. return the room ID
-	}
-
-	console.log(`[room sync] to matrix: ${channel.name}`)
-
-	const {spaceID, channelKState} = await channelToKState(channel, guild) // calling this in both branches because we don't want to calculate this if not syncing
-
-	// sync channel state to room
-	const roomKState = await roomToKState(roomID)
-	if (+roomKState["m.room.create/"].room_version <= 8) {
-		// join_rule `restricted` is not available in room version < 8 and not working properly in version == 8
-		// read more: https://spec.matrix.org/v1.8/rooms/v9/
-		// we have to use `public` instead, otherwise the room will be unjoinable.
-		channelKState["m.room.join_rules/"] = {join_rule: "public"}
-	}
-	const roomDiff = ks.diffKState(roomKState, channelKState)
-	const roomApply = applyKStateDiffToRoom(roomID, roomDiff)
-	db.prepare("UPDATE channel_room SET name = ? WHERE room_id = ?").run(channel.name, roomID)
-
-	// sync room as space member
-	const spaceApply = _syncSpaceMember(channel, spaceID, roomID)
-	await Promise.all([roomApply, spaceApply])
-
-	return roomID
-}
-
-/** Ensures the room exists. If it doesn't, creates the room with an accurate initial state. */
-function ensureRoom(channelID) {
-	return _syncRoom(channelID, false)
-}
-
-/** Actually syncs. Gets all room state from the homeserver in order to diff, and uploads the icon to mxc if it has changed. */
-function syncRoom(channelID) {
-	return _syncRoom(channelID, true)
-}
-
-async function _unbridgeRoom(channelID) {
-	/** @ts-ignore @type {DiscordTypes.APIGuildChannel} */
-	const channel = discord.channels.get(channelID)
-	assert.ok(channel)
-	return unbridgeDeletedChannel(channel.id, channel.guild_id)
-}
-
-async function unbridgeDeletedChannel(channelID, guildID) {
-	const roomID = select("channel_room", "room_id", {channel_id: channelID}).pluck().get()
-	assert.ok(roomID)
-	const spaceID = select("guild_space", "space_id", {guild_id: guildID}).pluck().get()
-	assert.ok(spaceID)
-
-	// remove room from being a space member
-	await api.sendState(roomID, "m.space.parent", spaceID, {})
-	await api.sendState(spaceID, "m.space.child", roomID, {})
-
-	// remove declaration that the room is bridged
-	await api.sendState(roomID, "uk.half-shot.bridge", `moe.cadence.ooye://discord/${guildID}/${channelID}`, {})
-
-	// send a notification in the room
-	await api.sendEvent(roomID, "m.room.message", {
-		msgtype: "m.notice",
-		body: "⚠️ This room was removed from the bridge."
-	})
-
-	// leave room
-	await api.leaveRoom(roomID)
-
-	// delete room from database
-	const {changes} = db.prepare("DELETE FROM channel_room WHERE room_id = ? AND channel_id = ?").run(roomID, channelID)
-	assert.equal(changes, 1)
-}
-
-/**
- * Async because it gets all space state from the homeserver, then if necessary sends one state event back.
- * @param {DiscordTypes.APIGuildTextChannel} channel
- * @param {string} spaceID
- * @param {string} roomID
- * @returns {Promise<string[]>}
- */
-async function _syncSpaceMember(channel, spaceID, roomID) {
-	const spaceKState = await roomToKState(spaceID)
-	let spaceEventContent = {}
-	if (
-		channel.type !== DiscordTypes.ChannelType.PrivateThread // private threads do not belong in the space (don't offer people something they can't join)
-		&& !channel["thread_metadata"]?.archived // archived threads do not belong in the space (don't offer people conversations that are no longer relevant)
-	) {
-		spaceEventContent = {
-			via: [reg.ooye.server_name]
-		}
-	}
-	const spaceDiff = ks.diffKState(spaceKState, {
-		[`m.space.child/${roomID}`]: spaceEventContent
-	})
-	return applyKStateDiffToRoom(spaceID, spaceDiff)
-}
-
-async function createAllForGuild(guildID) {
-	const channelIDs = discord.guildChannelMap.get(guildID)
-	assert.ok(channelIDs)
-	for (const channelID of channelIDs) {
-		const allowedTypes = [DiscordTypes.ChannelType.GuildText, DiscordTypes.ChannelType.PublicThread]
-		// @ts-ignore
-		if (allowedTypes.includes(discord.channels.get(channelID)?.type)) {
-			const roomID = await syncRoom(channelID)
-			console.log(`synced ${channelID} <-> ${roomID}`)
-		}
-	}
-}
-
-module.exports.DEFAULT_PRIVACY_LEVEL = DEFAULT_PRIVACY_LEVEL
-module.exports.PRIVACY_ENUMS = PRIVACY_ENUMS
-module.exports.createRoom = createRoom
-module.exports.ensureRoom = ensureRoom
-module.exports.syncRoom = syncRoom
-module.exports.createAllForGuild = createAllForGuild
-module.exports.channelToKState = channelToKState
-module.exports.roomToKState = roomToKState
-module.exports.applyKStateDiffToRoom = applyKStateDiffToRoom
-module.exports.postApplyPowerLevels = postApplyPowerLevels
-module.exports._convertNameAndTopic = convertNameAndTopic
-module.exports._unbridgeRoom = _unbridgeRoom
-module.exports.unbridgeDeletedChannel = unbridgeDeletedChannel

d2m/actions/create-room.test.js

@@ -1,89 +0,0 @@
-// @ts-check
-
-const {channelToKState, _convertNameAndTopic} = require("./create-room")
-const {kstateStripConditionals} = require("../../matrix/kstate")
-const {test} = require("supertape")
-const testData = require("../../test/data")
-
-const passthrough = require("../../passthrough")
-const {db} = passthrough
-
-test("channel2room: discoverable privacy room", async t => {
-	db.prepare("UPDATE guild_space SET privacy_level = 2").run()
-	t.deepEqual(
-		kstateStripConditionals(await channelToKState(testData.channel.general, testData.guild.general).then(x => x.channelKState)),
-		Object.assign({}, testData.room.general, {
-			"m.room.guest_access/": {guest_access: "forbidden"},
-			"m.room.join_rules/": {join_rule: "public"},
-			"m.room.history_visibility/": {history_visibility: "world_readable"}
-		})
-	)
-})
-
-test("channel2room: linkable privacy room", async t => {
-	db.prepare("UPDATE guild_space SET privacy_level = 1").run()
-	t.deepEqual(
-		kstateStripConditionals(await channelToKState(testData.channel.general, testData.guild.general).then(x => x.channelKState)),
-		Object.assign({}, testData.room.general, {
-			"m.room.guest_access/": {guest_access: "forbidden"},
-			"m.room.join_rules/": {join_rule: "public"}
-		})
-	)
-})
-
-test("channel2room: invite-only privacy room", async t => {
-	db.prepare("UPDATE guild_space SET privacy_level = 0").run()
-	t.deepEqual(
-		kstateStripConditionals(await channelToKState(testData.channel.general, testData.guild.general).then(x => x.channelKState)),
-		testData.room.general
-	)
-})
-
-test("convertNameAndTopic: custom name and topic", t => {
-	t.deepEqual(
-		_convertNameAndTopic({id: "123", name: "the-twilight-zone", topic: "Spooky stuff here. :ghost:", type: 0}, {id: "456"}, "hauntings"),
-		["hauntings", "#the-twilight-zone | Spooky stuff here. :ghost:\n\nChannel ID: 123\nGuild ID: 456"]
-	)
-})
-
-test("convertNameAndTopic: custom name, no topic", t => {
-	t.deepEqual(
-		_convertNameAndTopic({id: "123", name: "the-twilight-zone", type: 0}, {id: "456"}, "hauntings"),
-		["hauntings", "#the-twilight-zone\n\nChannel ID: 123\nGuild ID: 456"]
-	)
-})
-
-test("convertNameAndTopic: original name and topic", t => {
-	t.deepEqual(
-		_convertNameAndTopic({id: "123", name: "the-twilight-zone", topic: "Spooky stuff here. :ghost:", type: 0}, {id: "456"}, null),
-		["the-twilight-zone", "Spooky stuff here. :ghost:\n\nChannel ID: 123\nGuild ID: 456"]
-	)
-})
-
-test("convertNameAndTopic: original name, no topic", t => {
-	t.deepEqual(
-		_convertNameAndTopic({id: "123", name: "the-twilight-zone", type: 0}, {id: "456"}, null),
-		["the-twilight-zone", "Channel ID: 123\nGuild ID: 456"]
-	)
-})
-
-test("convertNameAndTopic: public thread icon", t => {
-	t.deepEqual(
-		_convertNameAndTopic({id: "123", name: "the-twilight-zone", topic: "Spooky stuff here. :ghost:", type: 11}, {id: "456"}, null),
-		["[⛓️] the-twilight-zone", "Spooky stuff here. :ghost:\n\nChannel ID: 123\nGuild ID: 456"]
-	)
-})
-
-test("convertNameAndTopic: private thread icon", t => {
-	t.deepEqual(
-		_convertNameAndTopic({id: "123", name: "the-twilight-zone", topic: "Spooky stuff here. :ghost:", type: 12}, {id: "456"}, null),
-		["[🔒⛓️] the-twilight-zone", "Spooky stuff here. :ghost:\n\nChannel ID: 123\nGuild ID: 456"]
-	)
-})
-
-test("convertNameAndTopic: voice channel icon", t => {
-	t.deepEqual(
-		_convertNameAndTopic({id: "123", name: "the-twilight-zone", topic: "Spooky stuff here. :ghost:", type: 2}, {id: "456"}, null),
-		["[🔊] the-twilight-zone", "Spooky stuff here. :ghost:\n\nChannel ID: 123\nGuild ID: 456"]
-	)
-})

d2m/actions/delete-message.js

@@ -1,23 +0,0 @@
-// @ts-check
-
-const passthrough = require("../../passthrough")
-const {sync, db, select} = passthrough
-/** @type {import("../../matrix/api")} */
-const api = sync.require("../../matrix/api")
-
-/**
- * @param {import("discord-api-types/v10").GatewayMessageDeleteDispatchData} data
- */
-async function deleteMessage(data) {
-	const roomID = select("channel_room", "room_id", {channel_id: data.channel_id}).pluck().get()
-	if (!roomID) return
-
-	const eventsToRedact = select("event_message", "event_id", {message_id: data.id}).pluck().all()
-	for (const eventID of eventsToRedact) {
-		// Unfortunately, we can't specify a sender to do the redaction as, unless we find out that info via the audit logs
-		await api.redactEvent(roomID, eventID)
-		db.prepare("DELETE FROM event_message WHERE event_id = ?").run(eventID)
-	}
-}
-
-module.exports.deleteMessage = deleteMessage

d2m/actions/register-user.js

@@ -1,185 +0,0 @@
-// @ts-check
-
-const assert = require("assert")
-const reg = require("../../matrix/read-registration")
-
-const passthrough = require("../../passthrough")
-const {discord, sync, db, select} = passthrough
-/** @type {import("../../matrix/api")} */
-const api = sync.require("../../matrix/api")
-/** @type {import("../../matrix/file")} */
-const file = sync.require("../../matrix/file")
-/** @type {import("../converters/user-to-mxid")} */
-const userToMxid = sync.require("../converters/user-to-mxid")
-/** @type {import("xxhash-wasm").XXHashAPI} */ // @ts-ignore
-let hasher = null
-// @ts-ignore
-require("xxhash-wasm")().then(h => hasher = h)
-
-/**
- * A sim is an account that is being simulated by the bridge to copy events from the other side.
- * @param {import("discord-api-types/v10").APIUser} user
- * @returns mxid
- */
-async function createSim(user) {
-	// Choose sim name
-	const simName = userToMxid.userToSimName(user)
-	const localpart = reg.ooye.namespace_prefix + simName
-	const mxid = `@${localpart}:${reg.ooye.server_name}`
-
-	// Save chosen name in the database forever
-	// Making this database change right away so that in a concurrent registration, the 2nd registration will already have generated a different localpart because it can see this row when it generates
-	db.prepare("INSERT INTO sim (user_id, sim_name, localpart, mxid) VALUES (?, ?, ?, ?)").run(user.id, simName, localpart, mxid)
-
-	// Register matrix user with that name
-	try {
-		await api.register(localpart)
-	} catch (e) {
-		// If user creation fails, manually undo the database change. Still isn't perfect, but should help.
-		// (A transaction would be preferable, but I don't think it's safe to leave transaction open across event loop ticks.)
-		db.prepare("DELETE FROM sim WHERE user_id = ?").run(user.id)
-		throw e
-	}
-	return mxid
-}
-
-/**
- * Ensure a sim is registered for the user.
- * If there is already a sim, use that one. If there isn't one yet, register a new sim.
- * @param {import("discord-api-types/v10").APIUser} user
- * @returns {Promise<string>} mxid
- */
-async function ensureSim(user) {
-	let mxid = null
-	const existing = select("sim", "mxid", {user_id: user.id}).pluck().get()
-	if (existing) {
-		mxid = existing
-	} else {
-		mxid = await createSim(user)
-	}
-	return mxid
-}
-
-/**
- * Ensure a sim is registered for the user and is joined to the room.
- * @param {import("discord-api-types/v10").APIUser} user
- * @param {string} roomID
- * @returns {Promise<string>} mxid
- */
-async function ensureSimJoined(user, roomID) {
-	// Ensure room ID is really an ID, not an alias
-	assert.ok(roomID[0] === "!")
-
-	// Ensure user
-	const mxid = await ensureSim(user)
-
-	// Ensure joined
-	const existing = select("sim_member", "mxid", {room_id: roomID, mxid}).pluck().get()
-	if (!existing) {
-		try {
-			await api.inviteToRoom(roomID, mxid)
-			await api.joinRoom(roomID, mxid)
-		} catch (e) {
-			if (e.message.includes("is already in the room.")) {
-				// Sweet!
-			} else {
-				throw e
-			}
-		}
-		db.prepare("INSERT OR IGNORE INTO sim_member (room_id, mxid) VALUES (?, ?)").run(roomID, mxid)
-	}
-	return mxid
-}
-
-/**
- * @param {import("discord-api-types/v10").APIUser} user
- * @param {Omit<import("discord-api-types/v10").APIGuildMember, "user">} member
- */
-async function memberToStateContent(user, member, guildID) {
-	let displayname = user.username
-	if (user.global_name) displayname = user.global_name
-	if (member.nick) displayname = member.nick
-
-	const content = {
-		displayname,
-		membership: "join",
-		"moe.cadence.ooye.member": {
-		},
-		"uk.half-shot.discord.member": {
-			bot: !!user.bot,
-			displayColor: user.accent_color,
-			id: user.id,
-			username: user.discriminator.length === 4 ? `${user.username}#${user.discriminator}` : `@${user.username}`
-		}
-	}
-
-	if (member.avatar || user.avatar) {
-		// const avatarPath = file.userAvatar(user) // the user avatar only
-		const avatarPath = file.memberAvatar(guildID, user, member) // the member avatar or the user avatar
-		content["moe.cadence.ooye.member"].avatar = avatarPath
-		content.avatar_url = await file.uploadDiscordFileToMxc(avatarPath)
-	}
-
-	return content
-}
-
-function hashProfileContent(content) {
-	const unsignedHash = hasher.h64(`${content.displayname}\u0000${content.avatar_url}`)
-	const signedHash = unsignedHash - 0x8000000000000000n // shifting down to signed 64-bit range
-	return signedHash
-}
-
-/**
- * Sync profile data for a sim user. This function follows the following process:
- * 1. Join the sim to the room if needed
- * 2. Make an object of what the new room member state content would be, including uploading the profile picture if it hasn't been done before
- * 3. Compare against the previously known state content, which is helpfully stored in the database
- * 4. If the state content has changed, send it to Matrix and update it in the database for next time
- * @param {import("discord-api-types/v10").APIUser} user
- * @param {Omit<import("discord-api-types/v10").APIGuildMember, "user">} member
- * @returns {Promise<string>} mxid of the updated sim
- */
-async function syncUser(user, member, guildID, roomID) {
-	const mxid = await ensureSimJoined(user, roomID)
-	const content = await memberToStateContent(user, member, guildID)
-	const currentHash = hashProfileContent(content)
-	const existingHash = select("sim_member", "hashed_profile_content", {room_id: roomID, mxid}).safeIntegers().pluck().get()
-	// only do the actual sync if the hash has changed since we last looked
-	if (existingHash !== currentHash) {
-		await api.sendState(roomID, "m.room.member", mxid, content, mxid)
-		db.prepare("UPDATE sim_member SET hashed_profile_content = ? WHERE room_id = ? AND mxid = ?").run(currentHash, roomID, mxid)
-	}
-	return mxid
-}
-
-async function syncAllUsersInRoom(roomID) {
-	const mxids = select("sim_member", "mxid", {room_id: roomID}).pluck().all()
-
-	const channelID = select("channel_room", "channel_id", {room_id: roomID}).pluck().get()
-	assert.ok(typeof channelID === "string")
-
-	/** @ts-ignore @type {import("discord-api-types/v10").APIGuildChannel} */
-	const channel = discord.channels.get(channelID)
-	const guildID = channel.guild_id
-	assert.ok(typeof guildID === "string")
-
-	for (const mxid of mxids) {
-		const userID = select("sim", "user_id", {mxid}).pluck().get()
-		assert.ok(typeof userID === "string")
-
-		/** @ts-ignore @type {Required<import("discord-api-types/v10").APIGuildMember>} */
-		const member = await discord.snow.guild.getGuildMember(guildID, userID)
-		/** @ts-ignore @type {Required<import("discord-api-types/v10").APIUser>} user */
-		const user = member.user
-		assert.ok(user)
-
-		console.log(`[user sync] to matrix: ${user.username} in ${channel.name}`)
-		await syncUser(user, member, guildID, roomID)
-	}
-}
-
-module.exports._memberToStateContent = memberToStateContent
-module.exports.ensureSim = ensureSim
-module.exports.ensureSimJoined = ensureSimJoined
-module.exports.syncUser = syncUser
-module.exports.syncAllUsersInRoom = syncAllUsersInRoom

d2m/actions/register-user.test.js

@@ -1,63 +0,0 @@
-const {_memberToStateContent} = require("./register-user")
-const {test} = require("supertape")
-const testData = require("../../test/data")
-
-test("member2state: without member nick or avatar", async t => {
-	t.deepEqual(
-		await _memberToStateContent(testData.member.kumaccino.user, testData.member.kumaccino, testData.guild.general.id),
-		{
-			avatar_url: "mxc://cadence.moe/UpAeIqeclhKfeiZNdIWNcXXL",
-			displayname: "kumaccino",
-			membership: "join",
-			"moe.cadence.ooye.member": {
-				avatar: "/avatars/113340068197859328/b48302623a12bc7c59a71328f72ccb39.png?size=1024"
-			},
-			"uk.half-shot.discord.member": {
-				bot: false,
-				displayColor: 10206929,
-				id: "113340068197859328",
-				username: "@kumaccino"
-			}
-		}
-	)
-})
-
-test("member2state: with global name, without member nick or avatar", async t => {
-	t.deepEqual(
-		await _memberToStateContent(testData.member.papiophidian.user, testData.member.papiophidian, testData.guild.general.id),
-		{
-			avatar_url: "mxc://cadence.moe/JPzSmALLirnIprlSMKohSSoX",
-			displayname: "PapiOphidian",
-			membership: "join",
-			"moe.cadence.ooye.member": {
-				avatar: "/avatars/320067006521147393/5fc4ad85c1ea876709e9a7d3374a78a1.png?size=1024"
-			},
-			"uk.half-shot.discord.member": {
-				bot: false,
-				displayColor: 1579292,
-				id: "320067006521147393",
-				username: "@papiophidian"
-			}
-		}
-	)
-})
-
-test("member2state: with member nick and avatar", async t => {
-	t.deepEqual(
-		await _memberToStateContent(testData.member.sheep.user, testData.member.sheep, testData.guild.general.id),
-		{
-			avatar_url: "mxc://cadence.moe/rfemHmAtcprjLEiPiEuzPhpl",
-			displayname: "The Expert's Submarine",
-			membership: "join",
-			"moe.cadence.ooye.member": {
-				avatar: "/guilds/112760669178241024/users/134826546694193153/avatars/38dd359aa12bcd52dd3164126c587f8c.png?size=1024"
-			},
-			"uk.half-shot.discord.member": {
-				bot: false,
-				displayColor: null,
-				id: "134826546694193153",
-				username: "@aprilsong"
-			}
-		}
-	)
-})

d2m/actions/send-message.js

@@ -1,67 +0,0 @@
-// @ts-check
-
-const assert = require("assert")
-
-const passthrough = require("../../passthrough")
-const { discord, sync, db } = passthrough
-/** @type {import("../converters/message-to-event")} */
-const messageToEvent = sync.require("../converters/message-to-event")
-/** @type {import("../../matrix/api")} */
-const api = sync.require("../../matrix/api")
-/** @type {import("./register-user")} */
-const registerUser = sync.require("./register-user")
-/** @type {import("../actions/create-room")} */
-const createRoom = sync.require("../actions/create-room")
-/** @type {import("../../discord/utils")} */
-const dUtils = sync.require("../../discord/utils")
-
-/**
- * @param {import("discord-api-types/v10").GatewayMessageCreateDispatchData} message
- * @param {import("discord-api-types/v10").APIGuild} guild
- */
-async function sendMessage(message, guild) {
-	const roomID = await createRoom.ensureRoom(message.channel_id)
-
-	let senderMxid = null
-	if (!dUtils.isWebhookMessage(message)) {
-		if (message.member) { // available on a gateway message create event
-			senderMxid = await registerUser.syncUser(message.author, message.member, message.guild_id, roomID)
-		} else { // well, good enough...
-			senderMxid = await registerUser.ensureSimJoined(message.author, roomID)
-		}
-	}
-
-	const events = await messageToEvent.messageToEvent(message, guild, {}, {api})
-	const eventIDs = []
-	if (events.length) {
-		db.prepare("REPLACE INTO message_channel (message_id, channel_id) VALUES (?, ?)").run(message.id, message.channel_id)
-		if (senderMxid) api.sendTyping(roomID, false, senderMxid)
-	}
-	for (const event of events) {
-		const part = event === events[0] ? 0 : 1
-		const reactionPart = event === events[events.length - 1] ? 0 : 1
-
-		const eventType = event.$type
-		if ("$sender" in event) senderMxid = event.$sender
-		/** @type {Pick<typeof event, Exclude<keyof event, "$type" | "$sender">> & { $type?: string, $sender?: string }} */
-		const eventWithoutType = {...event}
-		delete eventWithoutType.$type
-		delete eventWithoutType.$sender
-
-		const useTimestamp = message["backfill"] ? new Date(message.timestamp).getTime() : undefined
-		const eventID = await api.sendEvent(roomID, eventType, eventWithoutType, senderMxid, useTimestamp)
-		db.prepare("INSERT INTO event_message (event_id, event_type, event_subtype, message_id, part, reaction_part, source) VALUES (?, ?, ?, ?, ?, ?, 1)").run(eventID, eventType, event.msgtype || null, message.id, part, reactionPart) // source 1 = discord
-
-		// The primary event is part = 0 and has the most important and distinct information. It is used to provide reply previews, be pinned, and possibly future uses.
-		// The first event is chosen to be the primary part because it is usually the message text content and is more likely to be distinct.
-		// For example, "Reply to 'this meme made me think of you'" is more useful than "Replied to image".
-
-		// The last event gets reaction_part = 0. Reactions are managed there because reactions are supposed to appear at the bottom.
-
-		eventIDs.push(eventID)
-	}
-
-	return eventIDs
-}
-
-module.exports.sendMessage = sendMessage

d2m/actions/update-pins.js

@@ -1,22 +0,0 @@
-// @ts-check
-
-const passthrough = require("../../passthrough")
-const {discord, sync} = passthrough
-/** @type {import("../converters/pins-to-list")} */
-const pinsToList = sync.require("../converters/pins-to-list")
-/** @type {import("../../matrix/api")} */
-const api = sync.require("../../matrix/api")
-
-/**
- * @param {string} channelID
- * @param {string} roomID
- */
-async function updatePins(channelID, roomID) {
-	const pins = await discord.snow.channel.getChannelPinnedMessages(channelID)
-	const eventIDs = pinsToList.pinsToList(pins)
-	await api.sendState(roomID, "m.room.pinned_events", "", {
-		pinned: eventIDs
-	})
-}
-
-module.exports.updatePins = updatePins

d2m/converters/edit-to-changes.js

@@ -1,153 +0,0 @@
-// @ts-check
-
-const assert = require("assert").strict
-
-const passthrough = require("../../passthrough")
-const {discord, sync, db, select, from} = passthrough
-/** @type {import("./message-to-event")} */
-const messageToEvent = sync.require("../converters/message-to-event")
-/** @type {import("../actions/register-user")} */
-const registerUser = sync.require("../actions/register-user")
-/** @type {import("../actions/create-room")} */
-const createRoom = sync.require("../actions/create-room")
-
-/**
- * @param {import("discord-api-types/v10").GatewayMessageCreateDispatchData} message
- * IMPORTANT: This may not have all the normal fields! The API documentation doesn't provide possible types, just says it's all optional!
- * Since I don't have a spec, I will have to capture some real traffic and add it as test cases... I hope they don't change anything later...
- * @param {import("discord-api-types/v10").APIGuild} guild
- * @param {import("../../matrix/api")} api simple-as-nails dependency injection for the matrix API
- */
-async function editToChanges(message, guild, api) {
-	// Figure out what events we will be replacing
-
-	const roomID = select("channel_room", "room_id", {channel_id: message.channel_id}).pluck().get()
-	assert(roomID)
-	/** @type {string?} Null if we don't have a sender in the room, which will happen if it's a webhook's message. The bridge bot will do the edit instead. */
-	const senderMxid = from("sim").join("sim_member", "mxid").where({user_id: message.author.id, room_id: roomID}).pluck("mxid").get() || null
-
-	const oldEventRows = select("event_message", ["event_id", "event_type", "event_subtype", "part", "reaction_part"], {message_id: message.id}).all()
-
-	// Figure out what we will be replacing them with
-
-	const newFallbackContent = await messageToEvent.messageToEvent(message, guild, {includeEditFallbackStar: true}, {api})
-	const newInnerContent = await messageToEvent.messageToEvent(message, guild, {includeReplyFallback: false}, {api})
-	assert.ok(newFallbackContent.length === newInnerContent.length)
-
-	// Match the new events to the old events
-
-	/*
-		Rules:
-			+ The events must have the same type.
-			+ The events must have the same subtype.
-		Events will therefore be divided into four categories:
-	*/
-	/** 1. Events that are matched, and should be edited by sending another m.replace event */
-	let eventsToReplace = []
-	/** 2. Events that are present in the old version only, and should be blanked or redacted */
-	let eventsToRedact = []
-	/** 3. Events that are present in the new version only, and should be sent as new, with references back to the context */
-	let eventsToSend = []
-	//  4. Events that are matched and have definitely not changed, so they don't need to be edited or replaced at all. This is represented as nothing.
-
-	function shift() {
-		newFallbackContent.shift()
-		newInnerContent.shift()
-	}
-
-	// For each old event...
-	outer: while (newFallbackContent.length) {
-		const newe = newFallbackContent[0]
-		// Find a new event to pair it with...
-		for (let i = 0; i < oldEventRows.length; i++) {
-			const olde = oldEventRows[i]
-			if (olde.event_type === newe.$type && olde.event_subtype === (newe.msgtype || null)) { // The spec does allow subtypes to change, so I can change this condition later if I want to
-				// Found one!
-				// Set up the pairing
-				eventsToReplace.push({
-					old: olde,
-					newFallbackContent: newFallbackContent[0],
-					newInnerContent: newInnerContent[0]
-				})
-				// These events have been handled now, so remove them from the source arrays
-				shift()
-				oldEventRows.splice(i, 1)
-				// Go all the way back to the start of the next iteration of the outer loop
-				continue outer
-			}
-		}
-		// If we got this far, we could not pair it to an existing event, so it'll have to be a new one
-		eventsToSend.push(newInnerContent[0])
-		shift()
-	}
-	// Anything remaining in oldEventRows is present in the old version only and should be redacted.
-	eventsToRedact = oldEventRows
-
-	// We want to maintain exactly one part = 0 and one reaction_part = 0 database row at all times.
-	/** @type {({column: string, eventID: string} | {column: string, nextEvent: true})[]} */
-	const promotions = []
-	for (const column of ["part", "reaction_part"]) {
-		// If no events with part = 0 exist (or will exist), we need to do some management.
-		if (!eventsToReplace.some(e => e.old[column] === 0)) {
-			if (eventsToReplace.length) {
-				// We can choose an existing event to promote. Bigger order is better.
-				const order = e => 2*+(e.event_type === "m.room.message") + 1*+(e.event_subtype === "m.text")
-				eventsToReplace.sort((a, b) => order(b) - order(a))
-				promotions.push({column, eventID: eventsToReplace[0].old.event_id})
-			} else {
-				// No existing events to promote, but new events are being sent. Whatever gets sent will be the next part = 0.
-				promotions.push({column, nextEvent: true})
-			}
-		}
-	}
-
-	// Now, everything in eventsToSend and eventsToRedact is a real change, but everything in eventsToReplace might not have actually changed!
-	// (Example: a MESSAGE_UPDATE for a text+image message - Discord does not allow the image to be changed, but the text might have been.)
-	// So we'll remove entries from eventsToReplace that *definitely* cannot have changed. (This is category 4 mentioned above.) Everything remaining *may* have changed.
-	eventsToReplace = eventsToReplace.filter(ev => {
-		// Discord does not allow files, images, attachments, or videos to be edited.
-		if (ev.old.event_type === "m.room.message" && ev.old.event_subtype !== "m.text" && ev.old.event_subtype !== "m.emote" && ev.old.event_subtype !== "m.notice") {
-			return false
-		}
-		// Discord does not allow stickers to be edited.
-		if (ev.old.event_type === "m.sticker") {
-			return false
-		}
-		// Anything else is fair game.
-		return true
-	})
-
-	// Removing unnecessary properties before returning
-	eventsToRedact = eventsToRedact.map(e => e.event_id)
-	eventsToReplace = eventsToReplace.map(e => ({oldID: e.old.event_id, newContent: makeReplacementEventContent(e.old.event_id, e.newFallbackContent, e.newInnerContent)}))
-
-	return {roomID, eventsToReplace, eventsToRedact, eventsToSend, senderMxid, promotions}
-}
-
-/**
- * @template T
- * @param {string} oldID
- * @param {T} newFallbackContent
- * @param {T} newInnerContent
- * @returns {import("../../types").Event.ReplacementContent<T>} content
- */
-function makeReplacementEventContent(oldID, newFallbackContent, newInnerContent) {
-	const content = {
-		...newFallbackContent,
-		"m.mentions": {},
-		"m.new_content": {
-			...newInnerContent
-		},
-		"m.relates_to": {
-			rel_type: "m.replace",
-			event_id: oldID
-		}
-	}
-	delete content["m.new_content"]["$type"]
-	// Client-Server API spec 11.37.3: Any m.relates_to property within m.new_content is ignored.
-	delete content["m.new_content"]["m.relates_to"]
-	return content
-}
-
-module.exports.editToChanges = editToChanges
-module.exports.makeReplacementEventContent = makeReplacementEventContent

d2m/converters/edit-to-changes.test.js

@@ -1,177 +0,0 @@
-const {test} = require("supertape")
-const {editToChanges} = require("./edit-to-changes")
-const data = require("../../test/data")
-const Ty = require("../../types")
-
-test("edit2changes: edit by webhook", async t => {
-	const {senderMxid, eventsToRedact, eventsToReplace, eventsToSend, promotions} = await editToChanges(data.message_update.edit_by_webhook, data.guild.general, {})
-	t.deepEqual(eventsToRedact, [])
-	t.deepEqual(eventsToSend, [])
-	t.deepEqual(eventsToReplace, [{
-		oldID: "$zXSlyI78DQqQwwfPUSzZ1b-nXzbUrCDljJgnGDdoI10",
-		newContent: {
-			$type: "m.room.message",
-			msgtype: "m.text",
-			body: "* test 2",
-			"m.mentions": {},
-			"m.new_content": {
-				// *** Replaced With: ***
-				msgtype: "m.text",
-				body: "test 2",
-				"m.mentions": {}
-			},
-			"m.relates_to": {
-				rel_type: "m.replace",
-				event_id: "$zXSlyI78DQqQwwfPUSzZ1b-nXzbUrCDljJgnGDdoI10"
-			}
-		}
-	}])
-	t.equal(senderMxid, null)
-	t.deepEqual(promotions, [])
-})
-
-test("edit2changes: bot response", async t => {
-	const {senderMxid, eventsToRedact, eventsToReplace, eventsToSend, promotions} = await editToChanges(data.message_update.bot_response, data.guild.general, {
-		async getJoinedMembers(roomID) {
-			t.equal(roomID, "!hYnGGlPHlbujVVfktC:cadence.moe")
-			return new Promise(resolve => {
-				setTimeout(() => {
-					resolve({
-						joined: {
-							"@cadence:cadence.moe": {
-								displayname: "cadence [they]",
-								avatar_url: "whatever"
-							},
-							"@_ooye_botrac4r:cadence.moe": {
-								displayname: "botrac4r",
-								avatar_url: "whatever"
-							}
-						}
-					})
-				})
-			})
-		}
-	})
-	t.deepEqual(eventsToRedact, [])
-	t.deepEqual(eventsToSend, [])
-	t.deepEqual(eventsToReplace, [{
-		oldID: "$fdD9OZ55xg3EAsfvLZza5tMhtjUO91Wg3Otuo96TplY",
-		newContent: {
-			$type: "m.room.message",
-			msgtype: "m.text",
-			body: "* :ae_botrac4r: @cadence asked ``­``, I respond: Stop drinking paint. (No)\n\nHit :bn_re: to reroll.",
-			format: "org.matrix.custom.html",
-			formatted_body: '* <img data-mx-emoticon height="32" src="mxc://cadence.moe/skqfuItqxNmBYekzmVKyoLzs" title=":ae_botrac4r:" alt=":ae_botrac4r:"> @cadence asked <code>­</code>, I respond: Stop drinking paint. (No)<br><br>Hit <img data-mx-emoticon height="32" src="mxc://cadence.moe/OIpqpfxTnHKokcsYqDusxkBT" title=":bn_re:" alt=":bn_re:"> to reroll.',
-			"m.mentions": {
-				// Client-Server API spec 11.37.7: Copy Discord's behaviour by not re-notifying anyone that an *edit occurred*
-			},
-			// *** Replaced With: ***
-			"m.new_content": {
-				msgtype: "m.text",
-				body: ":ae_botrac4r: @cadence asked ``­``, I respond: Stop drinking paint. (No)\n\nHit :bn_re: to reroll.",
-				format: "org.matrix.custom.html",
-				formatted_body: '<img data-mx-emoticon height="32" src="mxc://cadence.moe/skqfuItqxNmBYekzmVKyoLzs" title=":ae_botrac4r:" alt=":ae_botrac4r:"> @cadence asked <code>­</code>, I respond: Stop drinking paint. (No)<br><br>Hit <img data-mx-emoticon height="32" src="mxc://cadence.moe/OIpqpfxTnHKokcsYqDusxkBT" title=":bn_re:" alt=":bn_re:"> to reroll.',
-				"m.mentions": {
-					// Client-Server API spec 11.37.7: This should contain the mentions for the final version of the event
-					"user_ids": ["@cadence:cadence.moe"]
-				}
-			},
-			"m.relates_to": {
-				rel_type: "m.replace",
-				event_id: "$fdD9OZ55xg3EAsfvLZza5tMhtjUO91Wg3Otuo96TplY"
-			}
-		}
-	}])
-	t.equal(senderMxid, "@_ooye_bojack_horseman:cadence.moe")
-	t.deepEqual(promotions, [])
-})
-
-test("edit2changes: remove caption from image", async t => {
-	const {eventsToRedact, eventsToReplace, eventsToSend, promotions} = await editToChanges(data.message_update.removed_caption_from_image, data.guild.general, {})
-	t.deepEqual(eventsToRedact, ["$mtR8cJqM4fKno1bVsm8F4wUVqSntt2sq6jav1lyavuA"])
-	t.deepEqual(eventsToSend, [])
-	t.deepEqual(eventsToReplace, [])
-	t.deepEqual(promotions, [{column: "part", eventID: "$51f4yqHinwnSbPEQ9dCgoyy4qiIJSX0QYYVUnvwyTCI"}])
-})
-
-test("edit2changes: change file type", async t => {
-	const {eventsToRedact, eventsToReplace, eventsToSend, promotions} = await editToChanges(data.message_update.changed_file_type, data.guild.general, {})
-	t.deepEqual(eventsToRedact, ["$51f4yqHinwnSbPEQ9dCgoyy4qiIJSX0QYYVUnvwyTCJ"])
-	t.deepEqual(eventsToSend, [{
-		$type: "m.room.message",
-		body: "📝 Uploaded file: https://cdn.discordapp.com/attachments/112760669178241024/1141501302497615912/gaze_into_my_dark_mind.txt (20 MB)",
-		format: "org.matrix.custom.html",
-		formatted_body: "📝 Uploaded file: <a href=\"https://cdn.discordapp.com/attachments/112760669178241024/1141501302497615912/gaze_into_my_dark_mind.txt\">gaze_into_my_dark_mind.txt</a> (20 MB)",
-		"m.mentions": {},
-		msgtype: "m.text"
-	}])
-	t.deepEqual(eventsToReplace, [])
-	t.deepEqual(promotions, [{column: "part", nextEvent: true}, {column: "reaction_part", nextEvent: true}])
-})
-
-test("edit2changes: add caption back to that image", async t => {
-	const {eventsToRedact, eventsToReplace, eventsToSend, promotions} = await editToChanges(data.message_update.added_caption_to_image, data.guild.general, {})
-	t.deepEqual(eventsToRedact, [])
-	t.deepEqual(eventsToSend, [{
-		$type: "m.room.message",
-		msgtype: "m.text",
-		body: "some text",
-		"m.mentions": {}
-	}])
-	t.deepEqual(eventsToReplace, [])
-	t.deepEqual(promotions, [])
-})
-
-test("edit2changes: stickers and attachments are not changed, only the content can be edited", async t => {
-	const {eventsToRedact, eventsToReplace, eventsToSend} = await editToChanges(data.message_update.edited_content_with_sticker_and_attachments, data.guild.general, {})
-	t.deepEqual(eventsToRedact, [])
-	t.deepEqual(eventsToSend, [])
-	t.deepEqual(eventsToReplace, [{
-		oldID: "$lnAF9IosAECTnlv9p2e18FG8rHn-JgYKHEHIh5qdFv4",
-		newContent: {
-			$type: "m.room.message",
-			msgtype: "m.text",
-			body: "* only the content can be edited",
-			"m.mentions": {},
-			// *** Replaced With: ***
-			"m.new_content": {
-				msgtype: "m.text",
-				body: "only the content can be edited",
-				"m.mentions": {}
-			},
-			"m.relates_to": {
-				rel_type: "m.replace",
-				event_id: "$lnAF9IosAECTnlv9p2e18FG8rHn-JgYKHEHIh5qdFv4"
-			}
-		}
-	}])
-})
-
-test("edit2changes: edit of reply to skull webp attachment with content", async t => {
-	const {eventsToRedact, eventsToReplace, eventsToSend} = await editToChanges(data.message_update.edit_of_reply_to_skull_webp_attachment_with_content, data.guild.general, {})
-	t.deepEqual(eventsToRedact, [])
-	t.deepEqual(eventsToSend, [])
-	t.deepEqual(eventsToReplace, [{
-		oldID: "$vgTKOR5ZTYNMKaS7XvgEIDaOWZtVCEyzLLi5Pc5Gz4M",
-		newContent: {
-			$type: "m.room.message",
-			msgtype: "m.text",
-			body: "> Extremity: Image\n\n* Edit",
-			format: "org.matrix.custom.html",
-			formatted_body:
-				'<mx-reply><blockquote><a href="https://matrix.to/#/!kLRqKKUQXcibIMtOpl:cadence.moe/$oLyUTyZ_7e_SUzGNWZKz880ll9amLZvXGbArJCKai2Q">In reply to</a> Extremity'
-				+ '<br>Image</blockquote></mx-reply>'
-				+ '* Edit',
-			"m.mentions": {},
-			"m.new_content": {
-				msgtype: "m.text",
-				body: "Edit",
-				"m.mentions": {}
-			},
-			"m.relates_to": {
-				rel_type: "m.replace",
-				event_id: "$vgTKOR5ZTYNMKaS7XvgEIDaOWZtVCEyzLLi5Pc5Gz4M"
-			}
-		}
-	}])
-})

d2m/converters/message-to-event.embeds.test.js

@@ -1,101 +0,0 @@
-const {test} = require("supertape")
-const {messageToEvent} = require("./message-to-event")
-const data = require("../../test/data")
-const Ty = require("../../types")
-
-/**
- * @param {string} roomID
- * @param {string} eventID
- * @returns {(roomID: string, eventID: string) => Promise<Ty.Event.Outer<Ty.Event.M_Room_Message>>}
- */
-function mockGetEvent(t, roomID_in, eventID_in, outer) {
-	return async function(roomID, eventID) {
-		t.equal(roomID, roomID_in)
-		t.equal(eventID, eventID_in)
-		return new Promise(resolve => {
-			setTimeout(() => {
-				resolve({
-					event_id: eventID_in,
-					room_id: roomID_in,
-					origin_server_ts: 1680000000000,
-					unsigned: {
-						age: 2245,
-						transaction_id: "$local.whatever"
-					},
-					...outer
-				})
-			})
-		})
-	}
-}
-
-test("message2event embeds: nothing but a field", async t => {
-	const events = await messageToEvent(data.message_with_embeds.nothing_but_a_field, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.notice",
-		body: "> **Amanda 🎵#2192 :online:"
-			+ "\n> willow tree, branch 0**"
-			+ "\n> **❯ Uptime:**\n> 3m 55s\n> **❯ Memory:**\n> 64.45MB",
-		format: "org.matrix.custom.html",
-		formatted_body: '<blockquote><strong>Amanda 🎵#2192 <img data-mx-emoticon height=\"32\" src=\"mxc://cadence.moe/LCEqjStXCxvRQccEkuslXEyZ\" title=\":online:\" alt=\":online:\">'
-			+ '<br>willow tree, branch 0</strong>'
-			+ '<br><strong>❯ Uptime:</strong><br>3m 55s'
-			+ '<br><strong>❯ Memory:</strong><br>64.45MB</blockquote>'
-	}])
-})
-
-test("message2event embeds: reply with just an embed", async t => {
-	const events = await messageToEvent(data.message_with_embeds.reply_with_only_embed, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		msgtype: "m.notice",
-		"m.mentions": {},
-		body: "> [**⏺️ dynastic (@dynastic)**](https://twitter.com/i/user/719631291747078145)"
-			+ "\n> \n> **https://twitter.com/i/status/1707484191963648161**"
-			+ "\n> \n> does anyone know where to find that one video of the really mysterious yam-like object being held up to a bunch of random objects, like clocks, and they have unexplained impossible reactions to it?"
-			+ "\n> \n> **Retweets**"
-			+ "\n> 119"
-			+ "\n> \n> **Likes**"
-			+ "\n> 5581"
-			+ "\n> \n> — Twitter",
-		format: "org.matrix.custom.html",
-		formatted_body: '<blockquote><a href="https://twitter.com/i/user/719631291747078145"><strong>⏺️ dynastic (@dynastic)</strong></a>'
-			+ '<br><br><strong><a href="https://twitter.com/i/status/1707484191963648161">https://twitter.com/i/status/1707484191963648161</a></strong>'
-			+ '<br><br>does anyone know where to find that one video of the really mysterious yam-like object being held up to a bunch of random objects, like clocks, and they have unexplained impossible reactions to it?'
-			+ '<br><br><strong>Retweets</strong><br>119<br><br><strong>Likes</strong><br>5581<br><br>— Twitter</blockquote>'
-	}])
-})
-
-test("message2event embeds: image embed and attachment", async t => {
-	const events = await messageToEvent(data.message_with_embeds.image_embed_and_attachment, data.guild.general, {}, {
-		api: {
-			async getJoinedMembers(roomID) {
-				return {joined: []}
-			}
-		}
-	})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		msgtype: "m.text",
-		body: "https://tootsuite.net/Warp-Gate2.gif\ntanget: @ monster spawner",
-		format: "org.matrix.custom.html",
-		formatted_body: '<a href="https://tootsuite.net/Warp-Gate2.gif">https://tootsuite.net/Warp-Gate2.gif</a><br>tanget: @ monster spawner',
-		"m.mentions": {}
-	}, {
-		$type: "m.room.message",
-		msgtype: "m.image",
-		url: "mxc://cadence.moe/zAXdQriaJuLZohDDmacwWWDR",
-		body: "Screenshot_20231001_034036.jpg",
-		external_url: "https://cdn.discordapp.com/attachments/176333891320283136/1157854643037163610/Screenshot_20231001_034036.jpg?ex=651a1faa&is=6518ce2a&hm=eb5ca80a3fa7add8765bf404aea2028a28a2341e4a62435986bcdcf058da82f3&",
-		filename: "Screenshot_20231001_034036.jpg",
-		info: {
-			h: 1170,
-			w: 1080,
-			size: 51981,
-			mimetype: "image/jpeg"
-		},
-		"m.mentions": {}
-	}])
-})

d2m/converters/message-to-event.js

@@ -1,481 +0,0 @@
-// @ts-check
-
-const assert = require("assert").strict
-const markdown = require("discord-markdown")
-const pb = require("prettier-bytes")
-const DiscordTypes = require("discord-api-types/v10")
-
-const passthrough = require("../../passthrough")
-const {sync, db, discord, select, from} = passthrough
-/** @type {import("../../matrix/file")} */
-const file = sync.require("../../matrix/file")
-/** @type {import("./emoji-to-key")} */
-const emojiToKey = sync.require("./emoji-to-key")
-/** @type {import("./lottie")} */
-const lottie = sync.require("./lottie")
-const reg = require("../../matrix/read-registration")
-
-const userRegex = reg.namespaces.users.map(u => new RegExp(u.regex))
-
-/**
- * @param {DiscordTypes.APIMessage} message
- * @param {DiscordTypes.APIGuild} guild
- * @param {boolean} useHTML
- */
-function getDiscordParseCallbacks(message, guild, useHTML) {
-	return {
-		/** @param {{id: string, type: "discordUser"}} node */
-		user: node => {
-			const mxid = select("sim", "mxid", {user_id: node.id}).pluck().get()
-			const username = message.mentions.find(ment => ment.id === node.id)?.username || node.id
-			if (mxid && useHTML) {
-				return `<a href="https://matrix.to/#/${mxid}">@${username}</a>`
-			} else {
-				return `@${username}:`
-			}
-		},
-		/** @param {{id: string, type: "discordChannel"}} node */
-		channel: node => {
-			const row = select("channel_room", ["room_id", "name", "nick"], {channel_id: node.id}).get()
-			if (!row) {
-				return `<#${node.id}>` // fallback for when this channel is not bridged
-			} else if (useHTML) {
-				return `<a href="https://matrix.to/#/${row.room_id}">#${row.nick || row.name}</a>`
-			} else {
-				return `#${row.nick || row.name}`
-			}
-		},
-		/** @param {{animated: boolean, name: string, id: string, type: "discordEmoji"}} node */
-		emoji: node => {
-			if (useHTML) {
-				const mxc = select("emoji", "mxc_url", {emoji_id: node.id}).pluck().get()
-				if (mxc) {
-					return `<img data-mx-emoticon height="32" src="${mxc}" title=":${node.name}:" alt=":${node.name}:">`
-				} else { // We shouldn't get here since all emojis should have been added ahead of time in the messageToEvent function.
-					return `<img src="mxc://cadence.moe/${node.id}" data-mx-emoticon alt=":${node.name}:" title=":${node.name}:" height="24">`
-				}
-			} else {
-				return `:${node.name}:`
-			}
-		},
-		role: node => {
-			const role = guild.roles.find(r => r.id === node.id)
-			if (!role) {
-				return "@&" + node.id // fallback for if the cache breaks. if this happens, fix discord-packets.js to store the role info.
-			} else if (useHTML && role.color) {
-				return `<font color="#${role.color.toString(16)}">@${role.name}</font>`
-			} else if (useHTML) {
-				return `<span data-mx-color="#ffffff" data-mx-bg-color="#414eef">@${role.name}</span>`
-			} else {
-				return `@${role.name}:`
-			}
-		},
-		everyone: node =>
-			"@room",
-		here: node =>
-			"@here"
-	}
-}
-
-/**
- * @param {import("discord-api-types/v10").APIMessage} message
- * @param {import("discord-api-types/v10").APIGuild} guild
- * @param {{includeReplyFallback?: boolean, includeEditFallbackStar?: boolean}} options default values:
- * - includeReplyFallback: true
- * - includeEditFallbackStar: false
- * @param {{api: import("../../matrix/api")}} di simple-as-nails dependency injection for the matrix API
- */
-async function messageToEvent(message, guild, options = {}, di) {
-	const events = []
-
-	if (message.type === DiscordTypes.MessageType.ThreadCreated) {
-		// This is the kind of message that appears when somebody makes a thread which isn't close enough to the message it's based off.
-		// It lacks the lines and the pill, so it looks kind of like a member join message, and it says:
-		// [#] NICKNAME started a thread: __THREAD NAME__. __See all threads__
-		// We're already bridging the THREAD_CREATED gateway event to make a comparable message, so drop this one.
-		return []
-	}
-
-	if (message.type === DiscordTypes.MessageType.ThreadStarterMessage) {
-		// This is the message that appears at the top of a thread when the thread was based off an existing message.
-		// It's just a message reference, no content.
-		const ref = message.message_reference
-		assert(ref)
-		assert(ref.message_id)
-		const eventID = select("event_message", "event_id", {message_id: ref.message_id}).pluck().get()
-		const roomID = select("channel_room", "room_id", {channel_id: ref.channel_id}).pluck().get()
-		if (!eventID || !roomID) return []
-		const event = await di.api.getEvent(roomID, eventID)
-		return [{
-			...event.content,
-			$type: event.type,
-			$sender: null
-		}]
-	}
-
-	/**
-	   @type {{room?: boolean, user_ids?: string[]}}
-		We should consider the following scenarios for mentions:
-		1. A discord user rich-replies to a matrix user with a text post
-			+ The matrix user needs to be m.mentioned in the text event
-			+ The matrix user needs to have their name/mxid/link in the text event (notification fallback)
-				- So prepend their `@name:` to the start of the plaintext body
-		2. A discord user rich-replies to a matrix user with an image event only
-			+ The matrix user needs to be m.mentioned in the image event
-			+ TODO The matrix user needs to have their name/mxid in the image event's body field, alongside the filename (notification fallback)
-				- So append their name to the filename body, I guess!!!
-		3. A discord user `@`s a matrix user in the text body of their text box
-			+ The matrix user needs to be m.mentioned in the text event
-			+ No change needed to the text event content: it already has their name
-				- So make sure we don't do anything in this case.
-	*/
-	const mentions = {}
-	let repliedToEventRow = null
-	let repliedToEventSenderMxid = null
-
-	function addMention(mxid) {
-		if (!mentions.user_ids) mentions.user_ids = []
-		if (!mentions.user_ids.includes(mxid)) mentions.user_ids.push(mxid)
-	}
-
-	// Mentions scenarios 1 and 2, part A. i.e. translate relevant message.mentions to m.mentions
-	// (Still need to do scenarios 1 and 2 part B, and scenario 3.)
-	if (message.type === DiscordTypes.MessageType.Reply && message.message_reference?.message_id) {
-		const row = from("event_message").join("message_channel", "message_id").join("channel_room", "channel_id").select("event_id", "room_id", "source").and("WHERE message_id = ? AND part = 0").get(message.message_reference.message_id)
-		if (row) {
-			repliedToEventRow = row
-		}
-	}
-	if (repliedToEventRow && repliedToEventRow.source === 0) { // reply was originally from Matrix
-		// Need to figure out who sent that event...
-		const event = await di.api.getEvent(repliedToEventRow.room_id, repliedToEventRow.event_id)
-		repliedToEventSenderMxid = event.sender
-		// Need to add the sender to m.mentions
-		addMention(repliedToEventSenderMxid)
-	}
-
-	async function addTextEvent(content, msgtype, {scanMentions}) {
-		content = content.replace(/https:\/\/(?:ptb\.|canary\.|www\.)?discord(?:app)?\.com\/channels\/([0-9]+)\/([0-9]+)\/([0-9]+)/, (whole, guildID, channelID, messageID) => {
-			const eventID = select("event_message", "event_id", {message_id: messageID}).pluck().get()
-			const roomID = select("channel_room", "room_id", {channel_id: channelID}).pluck().get()
-			if (eventID && roomID) {
-				return `https://matrix.to/#/${roomID}/${eventID}`
-			} else {
-				return `${whole} [event not found]`
-			}
-		})
-
-		// Handling emojis that we don't know about. The emoji has to be present in the DB for it to be picked up in the emoji markdown converter.
-		// So we scan the message ahead of time for all its emojis and ensure they are in the DB.
-		const emojiMatches = [...content.matchAll(/<(a?):([^:>]{2,64}):([0-9]+)>/g)]
-		await Promise.all(emojiMatches.map(match => {
-			const id = match[3]
-			const name = match[2]
-			const animated = match[1]
-			return emojiToKey.emojiToKey({id, name, animated}) // Register the custom emoji if needed
-		}))
-
-		let html = markdown.toHTML(content, {
-			discordCallback: getDiscordParseCallbacks(message, guild, true)
-		}, null, null)
-
-		let body = markdown.toHTML(content, {
-			discordCallback: getDiscordParseCallbacks(message, guild, false),
-			discordOnly: true,
-			escapeHTML: false,
-		}, null, null)
-
-		// Mentions scenario 3: scan the message content for written @mentions of matrix users. Allows for up to one space between @ and mention.
-		if (scanMentions) {
-			const matches = [...content.matchAll(/@ ?([a-z0-9._]+)\b/gi)]
-			if (matches.length && matches.some(m => m[1].match(/[a-z]/i))) {
-				const writtenMentionsText = matches.map(m => m[1].toLowerCase())
-				const roomID = select("channel_room", "room_id", {channel_id: message.channel_id}).pluck().get()
-				assert(roomID)
-				const {joined} = await di.api.getJoinedMembers(roomID)
-				for (const [mxid, member] of Object.entries(joined)) {
-					if (!userRegex.some(rx => mxid.match(rx))) {
-						const localpart = mxid.match(/@([^:]*)/)
-						assert(localpart)
-						const displayName = member.display_name || localpart[1]
-						if (writtenMentionsText.includes(localpart[1].toLowerCase()) || writtenMentionsText.includes(displayName.toLowerCase())) addMention(mxid)
-					}
-				}
-			}
-		}
-
-		// Star * prefix for fallback edits
-		if (options.includeEditFallbackStar) {
-			body = "* " + body
-			html = "* " + html
-		}
-
-		const flags = message.flags || 0
-		if (flags & 2) {
-			body = `[🔀 ${message.author.username}]\n` + body
-			html = `🔀 <strong>${message.author.username}</strong><br>` + html
-		}
-
-		// Fallback body/formatted_body for replies
-		// This branch is optional - do NOT change anything apart from the reply fallback, since it may not be run
-		if (repliedToEventRow && options.includeReplyFallback !== false) {
-			let repliedToDisplayName
-			let repliedToUserHtml
-			if (repliedToEventRow?.source === 0 && repliedToEventSenderMxid) {
-				const match = repliedToEventSenderMxid.match(/^@([^:]*)/)
-				assert(match)
-				repliedToDisplayName = match[1] || "a Matrix user" // grab the localpart as the display name, whatever
-				repliedToUserHtml = `<a href="https://matrix.to/#/${repliedToEventSenderMxid}">${repliedToDisplayName}</a>`
-			} else {
-				repliedToDisplayName = message.referenced_message?.author.global_name || message.referenced_message?.author.username || "a Discord user"
-				repliedToUserHtml = repliedToDisplayName
-			}
-			let repliedToContent = message.referenced_message?.content
-			if (repliedToContent?.startsWith("> <:L1:")) {
-				// If the Discord user is replying to a Matrix user's reply, the fallback is going to contain the emojis and stuff from the bridged rep of the Matrix user's reply quote.
-				// Need to remove that previous reply rep from this fallback body. The fallbody body should only contain the Matrix user's actual message.
-				repliedToContent = repliedToContent.split("\n").slice(2).join("\n")
-			}
-			if (repliedToContent == "") repliedToContent = "[Media]"
-			else if (!repliedToContent) repliedToContent = "[Replied-to message content wasn't provided by Discord]"
-			const repliedToHtml = markdown.toHTML(repliedToContent, {
-				discordCallback: getDiscordParseCallbacks(message, guild, true)
-			}, null, null)
-			const repliedToBody = markdown.toHTML(repliedToContent, {
-				discordCallback: getDiscordParseCallbacks(message, guild, false),
-				discordOnly: true,
-				escapeHTML: false,
-			}, null, null)
-			html = `<mx-reply><blockquote><a href="https://matrix.to/#/${repliedToEventRow.room_id}/${repliedToEventRow.event_id}">In reply to</a> ${repliedToUserHtml}`
-				+ `<br>${repliedToHtml}</blockquote></mx-reply>`
-				+ html
-			body = (`${repliedToDisplayName}: ` // scenario 1 part B for mentions
-				+ repliedToBody).split("\n").map(line => "> " + line).join("\n")
-				+ "\n\n" + body
-		}
-
-		const newTextMessageEvent = {
-			$type: "m.room.message",
-			"m.mentions": mentions,
-			msgtype,
-			body: body
-		}
-
-		const isPlaintext = body === html
-
-		if (!isPlaintext) {
-			Object.assign(newTextMessageEvent, {
-				format: "org.matrix.custom.html",
-				formatted_body: html
-			})
-		}
-
-		events.push(newTextMessageEvent)
-	}
-
-
-	let msgtype = "m.text"
-	// Handle message type 4, channel name changed
-	if (message.type === DiscordTypes.MessageType.ChannelNameChange) {
-		msgtype = "m.emote"
-		message.content = "changed the channel name to **" + message.content + "**"
-	}
-
-	// Text content appears first
-	if (message.content) {
-		await addTextEvent(message.content, msgtype, {scanMentions: true})
-	}
-
-	// Then attachments
-	const attachmentEvents = await Promise.all(message.attachments.map(async attachment => {
-		const emoji =
-			attachment.content_type?.startsWith("image/jp") ? "📸"
-			: attachment.content_type?.startsWith("image/") ? "🖼️"
-			: attachment.content_type?.startsWith("video/") ? "🎞️"
-			: attachment.content_type?.startsWith("text/") ? "📝"
-			: attachment.content_type?.startsWith("audio/") ? "🎶"
-			: "📄"
-		// no native media spoilers in Element, so we'll post a link instead, forcing it to not preview using a blockquote
-		if (attachment.filename.startsWith("SPOILER_")) {
-			return {
-				$type: "m.room.message",
-				"m.mentions": mentions,
-				msgtype: "m.text",
-				body: `${emoji} Uploaded SPOILER file: ${attachment.url} (${pb(attachment.size)})`,
-				format: "org.matrix.custom.html",
-				formatted_body: `<blockquote>${emoji} Uploaded SPOILER file: <span data-mx-spoiler><a href="${attachment.url}">View</a></span> (${pb(attachment.size)})</blockquote>`
-			}
-		}
-		// for large files, always link them instead of uploading so I don't use up all the space in the content repo
-		else if (attachment.size > reg.ooye.max_file_size) {
-			return {
-				$type: "m.room.message",
-				"m.mentions": mentions,
-				msgtype: "m.text",
-				body: `${emoji} Uploaded file: ${attachment.url} (${pb(attachment.size)})`,
-				format: "org.matrix.custom.html",
-				formatted_body: `${emoji} Uploaded file: <a href="${attachment.url}">${attachment.filename}</a> (${pb(attachment.size)})`
-			}
-		} else if (attachment.content_type?.startsWith("image/") && attachment.width && attachment.height) {
-			return {
-				$type: "m.room.message",
-				"m.mentions": mentions,
-				msgtype: "m.image",
-				url: await file.uploadDiscordFileToMxc(attachment.url),
-				external_url: attachment.url,
-				body: attachment.filename,
-				filename: attachment.filename,
-				info: {
-					mimetype: attachment.content_type,
-					w: attachment.width,
-					h: attachment.height,
-					size: attachment.size
-				}
-			}
-		} else if (attachment.content_type?.startsWith("video/") && attachment.width && attachment.height) {
-			return {
-				$type: "m.room.message",
-				"m.mentions": mentions,
-				msgtype: "m.video",
-				url: await file.uploadDiscordFileToMxc(attachment.url),
-				external_url: attachment.url,
-				body: attachment.description || attachment.filename,
-				filename: attachment.filename,
-				info: {
-					mimetype: attachment.content_type,
-					w: attachment.width,
-					h: attachment.height,
-					size: attachment.size
-				}
-			}
-		} else if (attachment.content_type?.startsWith("audio/")) {
-			return {
-				$type: "m.room.message",
-				"m.mentions": mentions,
-				msgtype: "m.audio",
-				url: await file.uploadDiscordFileToMxc(attachment.url),
-				external_url: attachment.url,
-				body: attachment.description || attachment.filename,
-				filename: attachment.filename,
-				info: {
-					mimetype: attachment.content_type,
-					size: attachment.size,
-					duration: attachment.duration_secs ? attachment.duration_secs * 1000 : undefined
-				}
-			}
-		} else {
-			return {
-				$type: "m.room.message",
-				"m.mentions": mentions,
-				msgtype: "m.file",
-				url: await file.uploadDiscordFileToMxc(attachment.url),
-				external_url: attachment.url,
-				body: attachment.filename,
-				filename: attachment.filename,
-				info: {
-					mimetype: attachment.content_type,
-					size: attachment.size
-				}
-			}
-		}
-	}))
-	events.push(...attachmentEvents)
-
-	// Then embeds
-	for (const embed of message.embeds || []) {
-		if (embed.type === "image") {
-			continue // Matrix already does a fine enough job of providing image embeds.
-		}
-
-		// Start building up a replica ("rep") of the embed in Discord-markdown format, which we will convert into both plaintext and formatted body at once
-		let repParagraphs = []
-		const makeUrlTitle = (text, url) =>
-			( text && url ? `[**${text}**](${url})`
-			: text ? `**${text}**`
-			: url ? `**${url}**`
-			: "")
-
-		let authorNameText = embed.author?.name || ""
-		if (authorNameText && embed.author?.icon_url) authorNameText = `⏺️ ${authorNameText}` // not using the real image
-		let authorTitle = makeUrlTitle(authorNameText, embed.author?.url)
-		if (authorTitle) repParagraphs.push(authorTitle)
-
-		let title = makeUrlTitle(embed.title, embed.url)
-		if (title) repParagraphs.push(title)
-
-		if (embed.image?.url) repParagraphs.push(`📸 ${embed.image.url}`)
-		if (embed.video?.url) repParagraphs.push(`🎞️ ${embed.video.url}`)
-
-		if (embed.description) repParagraphs.push(embed.description)
-		for (const field of embed.fields || []) {
-			repParagraphs.push(`**${field.name}**\n${field.value}`)
-		}
-		if (embed.footer?.text) repParagraphs.push(`— ${embed.footer.text}`)
-		const repContent = repParagraphs.join("\n\n")
-		const repContentQuoted = repContent.split("\n").map(l => "> " + l).join("\n")
-
-		// Send as m.notice to apply the usual automated/subtle appearance, showing this wasn't actually typed by the person
-		await addTextEvent(repContentQuoted, "m.notice", {scanMentions: false})
-	}
-
-	// Then stickers
-	if (message.sticker_items) {
-		const stickerEvents = await Promise.all(message.sticker_items.map(async stickerItem => {
-			const format = file.stickerFormat.get(stickerItem.format_type)
-			if (format?.mime === "lottie") {
-				try {
-					const {mxc_url, info} = await lottie.convert(stickerItem)
-					return {
-						$type: "m.sticker",
-						"m.mentions": mentions,
-						body: stickerItem.name,
-						info,
-						url: mxc_url
-					}
-				} catch (e) {
-					return {
-						$type: "m.room.message",
-						"m.mentions": mentions,
-						msgtype: "m.notice",
-						body: `Failed to convert Lottie sticker:\n${e.toString()}\n${e.stack}`
-					}
-				}
-			} else if (format?.mime) {
-				let body = stickerItem.name
-				const sticker = guild.stickers.find(sticker => sticker.id === stickerItem.id)
-				if (sticker && sticker.description) body += ` - ${sticker.description}`
-				return {
-					$type: "m.sticker",
-					"m.mentions": mentions,
-					body,
-					info: {
-						mimetype: format.mime
-					},
-					url: await file.uploadDiscordFileToMxc(file.sticker(stickerItem))
-				}
-			}
-			return {
-				$type: "m.room.message",
-				"m.mentions": mentions,
-				msgtype: "m.notice",
-				body: `Unsupported sticker format ${format?.mime}. Name: ${stickerItem.name}`
-			}
-		}))
-		events.push(...stickerEvents)
-	}
-
-	// Rich replies
-	if (repliedToEventRow) {
-		Object.assign(events[0], {
-			"m.relates_to": {
-				"m.in_reply_to": {
-					event_id: repliedToEventRow.event_id
-				}
-			}
-		})
-	}
-
-	return events
-}
-
-module.exports.messageToEvent = messageToEvent

d2m/converters/message-to-event.test.js

@@ -1,556 +0,0 @@
-const {test} = require("supertape")
-const {messageToEvent} = require("./message-to-event")
-const data = require("../../test/data")
-const Ty = require("../../types")
-
-/**
- * @param {string} roomID
- * @param {string} eventID
- * @returns {(roomID: string, eventID: string) => Promise<Ty.Event.Outer<Ty.Event.M_Room_Message>>}
- */
-function mockGetEvent(t, roomID_in, eventID_in, outer) {
-	return async function(roomID, eventID) {
-		t.equal(roomID, roomID_in)
-		t.equal(eventID, eventID_in)
-		return new Promise(resolve => {
-			setTimeout(() => {
-				resolve({
-					event_id: eventID_in,
-					room_id: roomID_in,
-					origin_server_ts: 1680000000000,
-					unsigned: {
-						age: 2245,
-						transaction_id: "$local.whatever"
-					},
-					...outer
-				})
-			})
-		})
-	}
-}
-
-test("message2event: simple plaintext", async t => {
-	const events = await messageToEvent(data.message.simple_plaintext, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: "ayy lmao"
-	}])
-})
-
-test("message2event: simple plaintext with quotes", async t => {
-	const events = await messageToEvent(data.message.simple_plaintext_with_quotes, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: `then he said, "you and her aren't allowed in here!"`
-	}])
-})
-
-test("message2event: simple user mention", async t => {
-	const events = await messageToEvent(data.message.simple_user_mention, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: "@crunch god: Tell me about Phil, renowned martial arts master and creator of the Chin Trick",
-		format: "org.matrix.custom.html",
-		formatted_body: '<a href="https://matrix.to/#/@_ooye_crunch_god:cadence.moe">@crunch god</a> Tell me about Phil, renowned martial arts master and creator of the Chin Trick'
-	}])
-})
-
-test("message2event: simple room mention", async t => {
-	const events = await messageToEvent(data.message.simple_room_mention, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: "#main",
-		format: "org.matrix.custom.html",
-		formatted_body: '<a href="https://matrix.to/#/!kLRqKKUQXcibIMtOpl:cadence.moe">#main</a>'
-	}])
-})
-
-test("message2event: simple role mentions", async t => {
-	const events = await messageToEvent(data.message.simple_role_mentions, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: "I'm just @!!DLCS!!: testing a few role pings @Master Wonder Mage: don't mind me",
-		format: "org.matrix.custom.html",
-		formatted_body: `I'm just <font color="#a901ff">@!!DLCS!!</font> testing a few role pings <span data-mx-color="#ffffff" data-mx-bg-color="#414eef">@Master Wonder Mage</span> don't mind me`
-	}])
-})
-
-test("message2event: simple message link", async t => {
-	const events = await messageToEvent(data.message.simple_message_link, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: "https://matrix.to/#/!kLRqKKUQXcibIMtOpl:cadence.moe/$X16nfVks1wsrhq4E9SSLiqrf2N8KD0erD0scZG7U5xg",
-		format: "org.matrix.custom.html",
-		formatted_body: '<a href="https://matrix.to/#/!kLRqKKUQXcibIMtOpl:cadence.moe/$X16nfVks1wsrhq4E9SSLiqrf2N8KD0erD0scZG7U5xg">https://matrix.to/#/!kLRqKKUQXcibIMtOpl:cadence.moe/$X16nfVks1wsrhq4E9SSLiqrf2N8KD0erD0scZG7U5xg</a>'
-	}])
-})
-
-test("message2event: attachment with no content", async t => {
-	const events = await messageToEvent(data.message.attachment_no_content, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.image",
-		url: "mxc://cadence.moe/qXoZktDqNtEGuOCZEADAMvhM",
-		body: "image.png",
-		external_url: "https://cdn.discordapp.com/attachments/497161332244742154/1124628646431297546/image.png",
-		filename: "image.png",
-		info: {
-			mimetype: "image/png",
-			w: 466,
-			h: 85,
-			size: 12919,
-		},
-	}])
-})
-
-test("message2event: spoiler attachment", async t => {
-	const events = await messageToEvent(data.message.spoiler_attachment, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: "📄 Uploaded SPOILER file: https://cdn.discordapp.com/attachments/1100319550446252084/1147465564307079258/SPOILER_69-GNDP-CADENCE.nfs.gci (74 KB)",
-		format: "org.matrix.custom.html",
-		formatted_body: "<blockquote>📄 Uploaded SPOILER file: <span data-mx-spoiler><a href=\"https://cdn.discordapp.com/attachments/1100319550446252084/1147465564307079258/SPOILER_69-GNDP-CADENCE.nfs.gci\">View</a></span> (74 KB)</blockquote>"
-	}])
-})
-
-test("message2event: stickers", async t => {
-	const events = await messageToEvent(data.message.sticker, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: "can have attachments too"
-	}, {
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.image",
-		url: "mxc://cadence.moe/ZDCNYnkPszxGKgObUIFmvjus",
-		body: "image.png",
-		external_url: "https://cdn.discordapp.com/attachments/122155380120748034/1106366167486038016/image.png",
-		filename: "image.png",
-		info: {
-			mimetype: "image/png",
-			w: 333,
-			h: 287,
-			size: 127373,
-		},
-	}, {
-		$type: "m.sticker",
-		"m.mentions": {},
-		body: "pomu puff - damn that tiny lil bitch really chuffing. puffing that fat ass dart",
-		info: {
-			mimetype: "image/png"
-			// thumbnail_url
-			// thumbnail_info
-		},
-		url: "mxc://cadence.moe/UuUaLwXhkxFRwwWCXipDlBHn"
-	}])
-})
-
-test("message2event: skull webp attachment with content", async t => {
-	const events = await messageToEvent(data.message.skull_webp_attachment_with_content, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: "Image"
-	}, {
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.image",
-		body: "skull.webp",
-		info: {
-			w: 1200,
-			h: 628,
-			mimetype: "image/webp",
-			size: 74290
-		},
-		external_url: "https://cdn.discordapp.com/attachments/112760669178241024/1128084747910918195/skull.webp",
-		filename: "skull.webp",
-		url: "mxc://cadence.moe/sDxWmDErBhYBxtDcJQgBETes"
-	}])
-})
-
-test("message2event: reply to skull webp attachment with content", async t => {
-	const events = await messageToEvent(data.message.reply_to_skull_webp_attachment_with_content, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.relates_to": {
-			"m.in_reply_to": {
-				event_id: "$oLyUTyZ_7e_SUzGNWZKz880ll9amLZvXGbArJCKai2Q"
-			}
-		},
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: "> Extremity: Image\n\nReply",
-		format: "org.matrix.custom.html",
-		formatted_body:
-			'<mx-reply><blockquote><a href="https://matrix.to/#/!kLRqKKUQXcibIMtOpl:cadence.moe/$oLyUTyZ_7e_SUzGNWZKz880ll9amLZvXGbArJCKai2Q">In reply to</a> Extremity'
-			+ '<br>Image</blockquote></mx-reply>'
-			+ 'Reply'
-	}, {
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.image",
-		body: "RDT_20230704_0936184915846675925224905.jpg",
-		info: {
-			w: 2048,
-			h: 1536,
-			mimetype: "image/jpeg",
-			size: 85906
-		},
-		external_url: "https://cdn.discordapp.com/attachments/112760669178241024/1128084851023675515/RDT_20230704_0936184915846675925224905.jpg",
-		filename: "RDT_20230704_0936184915846675925224905.jpg",
-		url: "mxc://cadence.moe/WlAbFSiNRIHPDEwKdyPeGywa"
-	}])
-})
-
-test("message2event: simple reply to matrix user", async t => {
-	const events = await messageToEvent(data.message.simple_reply_to_matrix_user, data.guild.general, {}, {
-		api: {
-			getEvent: mockGetEvent(t, "!kLRqKKUQXcibIMtOpl:cadence.moe", "$Ij3qo7NxMA4VPexlAiIx2CB9JbsiGhJeyt-2OvkAUe4", {
-				type: "m.room.message",
-				content: {
-					msgtype: "m.text",
-					body: "so can you reply to my webhook uwu"
-				},
-				sender: "@cadence:cadence.moe"
-			})
-		}
-	})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.relates_to": {
-			"m.in_reply_to": {
-				event_id: "$Ij3qo7NxMA4VPexlAiIx2CB9JbsiGhJeyt-2OvkAUe4"
-			}
-		},
-		"m.mentions": {
-			user_ids: [
-				"@cadence:cadence.moe"
-			]
-		},
-		msgtype: "m.text",
-		body: "> cadence: so can you reply to my webhook uwu\n\nReply",
-		format: "org.matrix.custom.html",
-		formatted_body:
-			'<mx-reply><blockquote><a href="https://matrix.to/#/!kLRqKKUQXcibIMtOpl:cadence.moe/$Ij3qo7NxMA4VPexlAiIx2CB9JbsiGhJeyt-2OvkAUe4">In reply to</a> <a href="https://matrix.to/#/@cadence:cadence.moe">cadence</a>'
-			+ '<br>so can you reply to my webhook uwu</blockquote></mx-reply>'
-			+ 'Reply'
-	}])
-})
-
-test("message2event: simple reply to matrix user, reply fallbacks disabled", async t => {
-	const events = await messageToEvent(data.message.simple_reply_to_matrix_user, data.guild.general, {includeReplyFallback: false}, {
-		api: {
-			getEvent: mockGetEvent(t, "!kLRqKKUQXcibIMtOpl:cadence.moe", "$Ij3qo7NxMA4VPexlAiIx2CB9JbsiGhJeyt-2OvkAUe4", {
-				type: "m.room.message",
-				content: {
-					msgtype: "m.text",
-					body: "so can you reply to my webhook uwu"
-				},
-				sender: "@cadence:cadence.moe"
-			})
-		}
-	})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.relates_to": {
-			"m.in_reply_to": {
-				event_id: "$Ij3qo7NxMA4VPexlAiIx2CB9JbsiGhJeyt-2OvkAUe4"
-			}
-		},
-		"m.mentions": {
-			user_ids: [
-				"@cadence:cadence.moe"
-			]
-		},
-		msgtype: "m.text",
-		body: "Reply"
-	}])
-})
-
-test("message2event: simple reply in thread to a matrix user's reply", async t => {
-	const events = await messageToEvent(data.message.simple_reply_to_reply_in_thread, data.guild.general, {}, {
-		api: {
-			getEvent: mockGetEvent(t, "!FuDZhlOAtqswlyxzeR:cadence.moe", "$nUM-ABBF8KdnvrhXwLlYAE9dgDl_tskOvvcNIBrtsVo", {
-				type: "m.room.message",
-				sender: "@cadence:cadence.moe",
-				content: {
-					msgtype: "m.text",
-					body: "> <@_ooye_cadence:cadence.moe> So what I'm wondering is about replies.\n\nWhat about them?",
-					format: "org.matrix.custom.html",
-					formatted_body: "<mx-reply><blockquote><a href=\"https://matrix.to/#/!FuDZhlOAtqswlyxzeR:cadence.moe/$fWQT8uOrzLzAXNVXz88VkGx7Oo724iS5uD8Qn5KUy9w?via=cadence.moe\">In reply to</a> <a href=\"https://matrix.to/#/@_ooye_cadence:cadence.moe\">@_ooye_cadence:cadence.moe</a><br>So what I&#39;m wondering is about replies.</blockquote></mx-reply>What about them?",
-					"m.relates_to": {
-						"m.in_reply_to": {
-							event_id: "$fWQT8uOrzLzAXNVXz88VkGx7Oo724iS5uD8Qn5KUy9w"
-						}
-					}
-				},
-				event_id: "$nUM-ABBF8KdnvrhXwLlYAE9dgDl_tskOvvcNIBrtsVo",
-				room_id: "!FuDZhlOAtqswlyxzeR:cadence.moe"
-			})
-		}
-	})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.relates_to": {
-			"m.in_reply_to": {
-				event_id: "$nUM-ABBF8KdnvrhXwLlYAE9dgDl_tskOvvcNIBrtsVo"
-			}
-		},
-		"m.mentions": {
-			user_ids: ["@cadence:cadence.moe"]
-		},
-		msgtype: "m.text",
-      body: "> cadence: What about them?\n\nWell, they don't seem to...",
-      format: "org.matrix.custom.html",
-      formatted_body: "<mx-reply><blockquote><a href=\"https://matrix.to/#/!FuDZhlOAtqswlyxzeR:cadence.moe/$nUM-ABBF8KdnvrhXwLlYAE9dgDl_tskOvvcNIBrtsVo\">In reply to</a> <a href=\"https://matrix.to/#/@cadence:cadence.moe\">cadence</a><br>What about them?</blockquote></mx-reply>Well, they don't seem to...",
-	}])
-})
-
-test("message2event: simple written @mention for matrix user", async t => {
-	const events = await messageToEvent(data.message.simple_written_at_mention_for_matrix, data.guild.general, {}, {
-		api: {
-			async getJoinedMembers(roomID) {
-				t.equal(roomID, "!rEOspnYqdOalaIFniV:cadence.moe")
-				return new Promise(resolve => {
-					setTimeout(() => {
-						resolve({
-							joined: {
-								"@she_who_brings_destruction:matrix.org": {
-									avatar_url: "mxc://matrix.org/FKcfnfFZlEhspeMsERfYtCuO",
-									display_name: "ash (Old)"
-								},
-								"@tomskeleton:cadence.moe": {
-									avatar_url: "mxc://cadence.moe/OvYYicuOwfAACKaXKJCUPbVz",
-									display_name: "tomskeleton"
-								},
-								"@she_who_brings_destruction:cadence.moe": {
-									avatar_url: "mxc://cadence.moe/XDXLMbkieETPrjFupoeiwyyq",
-									display_name: "ash"
-								},
-								"@_ooye_bot:cadence.moe": {
-									avatar_url: "mxc://cadence.moe/jlrgFjYQHzfBvORedOmYqXVz",
-									display_name: "Out Of Your Element"
-								},
-								"@cadence:cadence.moe": {
-									avatar_url: "mxc://cadence.moe/GJDPWiryxIhyRBNJzRNYzAlh",
-									display_name: "cadence [they]"
-								},
-								"@_ooye_tomskeleton:cadence.moe": {
-									avatar_url: "mxc://cadence.moe/SdSrjjsrNVdyPTAKEGQUhKUK",
-									display_name: "tomskeleton"
-								},
-								"@_ooye_queergasm:cadence.moe": {
-									avatar_url: "mxc://cadence.moe/KqXYGbUqhPPJKifLmfpoLnmB",
-									display_name: "queergasm"
-								},
-								"@_ooye_.subtext:cadence.moe": {
-									avatar_url: "mxc://cadence.moe/heoCvaUmfCdpxdzaChwwkpEp",
-									display_name: ".subtext"
-								}
-							}
-						})
-					})
-				})
-			}
-		}
-	})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {
-			user_ids: [
-				"@she_who_brings_destruction:cadence.moe"
-			]
-		},
-		msgtype: "m.text",
-		body: "@ash do you need anything from the store btw as I'm heading there after gym"
-	}])
-})
-
-test("message2event: advanced written @mentions for matrix users", async t => {
-	let called = 0
-	const events = await messageToEvent(data.message.advanced_written_at_mention_for_matrix, data.guild.general, {}, {
-		api: {
-			async getJoinedMembers(roomID) {
-				called++
-				t.equal(roomID, "!kLRqKKUQXcibIMtOpl:cadence.moe")
-				return new Promise(resolve => {
-					setTimeout(() => {
-						resolve({
-							joined: {
-								"@cadence:cadence.moe": {
-									display_name: "cadence [they]",
-									avatar_url: "whatever"
-								},
-								"@huckleton:cadence.moe": {
-									display_name: "huck",
-									avatar_url: "whatever"
-								},
-								"@_ooye_botrac4r:cadence.moe": {
-									display_name: "botrac4r",
-									avatar_url: "whatever"
-								},
-								"@_ooye_bot:cadence.moe": {
-									display_name: "Out Of Your Element",
-									avatar_url: "whatever"
-								}
-							}
-						})
-					})
-				})
-			}
-		}
-	})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {
-			user_ids: [
-				"@cadence:cadence.moe",
-				"@huckleton:cadence.moe"
-			]
-		},
-		msgtype: "m.text",
-		body: "@Cadence, tell me about @Phil, the creator of the Chin Trick, who has become ever more powerful under the mentorship of @botrac4r and @huck"
-	}])
-	t.equal(called, 1, "should only look up the member list once")
-})
-
-test("message2event: very large attachment is linked instead of being uploaded", async t => {
-	const events = await messageToEvent({
-		content: "hey",
-		attachments: [{
-			filename: "hey.jpg",
-			url: "https://discord.com/404/hey.jpg",
-			content_type: "application/i-made-it-up",
-			size: 100e6
-		}]
-	})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: "hey"
-	}, {
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: "📄 Uploaded file: https://discord.com/404/hey.jpg (100 MB)",
-		format: "org.matrix.custom.html",
-		formatted_body: '📄 Uploaded file: <a href="https://discord.com/404/hey.jpg">hey.jpg</a> (100 MB)'
-	}])
-})
-
-test("message2event: type 4 channel name change", async t => {
-	const events = await messageToEvent(data.special_message.thread_name_change, data.guild.general)
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.emote",
-		body: "changed the channel name to **worming**",
-		format: "org.matrix.custom.html",
-		formatted_body: "changed the channel name to <strong>worming</strong>"
-	}])
-})
-
-test("message2event: thread start message reference", async t => {
-	const events = await messageToEvent(data.special_message.thread_start_context, data.guild.general, {}, {
-		api: {
-			getEvent: mockGetEvent(t, "!BnKuBPCvyfOkhcUjEu:cadence.moe", "$FchUVylsOfmmbj-VwEs5Z9kY49_dt2zd0vWfylzy5Yo", {
-				"type": "m.room.message",
-				"sender": "@_ooye_kyuugryphon:cadence.moe",
-				"content": {
-					"m.mentions": {},
-					"msgtype": "m.text",
-					"body": "layer 4"
-				}
-			})
-		}
-	})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		$sender: null,
-		msgtype: "m.text",
-		body: "layer 4",
-		"m.mentions": {}
-	}])
-})
-
-test("message2event: single large bridged emoji", async t => {
-	const events = await messageToEvent(data.message.single_emoji, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: ":hippo:",
-		format: "org.matrix.custom.html",
-		formatted_body: '<img data-mx-emoticon height="32" src="mxc://cadence.moe/qWmbXeRspZRLPcjseyLmeyXC" title=":hippo:" alt=":hippo:">'
-	}])
-})
-
-test("message2event: mid-message small bridged emoji", async t => {
-	const events = await messageToEvent(data.message.surrounded_emoji, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: "h is for :hippo:!",
-		format: "org.matrix.custom.html",
-		formatted_body: 'h is for <img data-mx-emoticon height="32" src="mxc://cadence.moe/qWmbXeRspZRLPcjseyLmeyXC" title=":hippo:" alt=":hippo:">!'
-	}])
-})
-
-test("message2event: emoji that hasn't been registered yet", async t => {
-	const events = await messageToEvent(data.message.not_been_registered_emoji, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: ":Yeah:",
-		format: "org.matrix.custom.html",
-		formatted_body: '<img data-mx-emoticon height="32" src="mxc://cadence.moe/pgdGTxAyEltccRgZKxdqzHHP" title=":Yeah:" alt=":Yeah:">'
-	}])
-})
-
-test("message2event: emoji triple long name", async t => {
-	const events = await messageToEvent(data.message.emoji_triple_long_name, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: ":brillillillilliant_move::brillillillilliant_move::brillillillilliant_move:",
-		format: "org.matrix.custom.html",
-		formatted_body:
-			  '<img data-mx-emoticon height="32" src="mxc://cadence.moe/scfRIDOGKWFDEBjVXocWYQHik" title=":brillillillilliant_move:" alt=":brillillillilliant_move:">'
-			+ '<img data-mx-emoticon height="32" src="mxc://cadence.moe/scfRIDOGKWFDEBjVXocWYQHik" title=":brillillillilliant_move:" alt=":brillillillilliant_move:">'
-			+ '<img data-mx-emoticon height="32" src="mxc://cadence.moe/scfRIDOGKWFDEBjVXocWYQHik" title=":brillillillilliant_move:" alt=":brillillillilliant_move:">'
-	}])
-})
-
-test("message2event: crossposted announcements say where they are crossposted from", async t => {
-	const events = await messageToEvent(data.special_message.crosspost_announcement, data.guild.general, {})
-	t.deepEqual(events, [{
-		$type: "m.room.message",
-		"m.mentions": {},
-		msgtype: "m.text",
-		body: "[🔀 Chewey Bot Official Server #announcements]\nAll text based commands are now inactive on Chewey Bot\nTo continue using commands you'll need to use them as slash commands",
-		format: "org.matrix.custom.html",
-		formatted_body: "🔀 <strong>Chewey Bot Official Server #announcements</strong><br>All text based commands are now inactive on Chewey Bot<br>To continue using commands you'll need to use them as slash commands"
-	}])
-})

d2m/converters/pins-to-list.js

@@ -1,18 +0,0 @@
-// @ts-check
-
-const {select} = require("../../passthrough")
-
-/**
- * @param {import("discord-api-types/v10").RESTGetAPIChannelPinsResult} pins
- */
-function pinsToList(pins) {
-	/** @type {string[]} */
-	const result = []
-	for (const message of pins) {
-		const eventID = select("event_message", "event_id", {message_id: message.id, part: 0}).pluck().get()
-		if (eventID) result.push(eventID)
-	}
-	return result
-}
-
-module.exports.pinsToList = pinsToList

d2m/converters/pins-to-list.test.js

@@ -1,12 +0,0 @@
-const {test} = require("supertape")
-const data = require("../../test/data")
-const {pinsToList} = require("./pins-to-list")
-
-test("pins2list: converts known IDs, ignores unknown IDs", t => {
-	const result = pinsToList(data.pins.faked)
-	t.deepEqual(result, [
-		"$X16nfVks1wsrhq4E9SSLiqrf2N8KD0erD0scZG7U5xg",
-		"$mtR8cJqM4fKno1bVsm8F4wUVqSntt2sq6jav1lyavuA",
-		"$lnAF9IosAECTnlv9p2e18FG8rHn-JgYKHEHIh5qdFv4"
-	])
-})

d2m/converters/user-to-mxid.js

@@ -1,76 +0,0 @@
-// @ts-check
-
-const assert = require("assert")
-
-const passthrough = require("../../passthrough")
-const {select} = passthrough
-
-/**
- * Downcased and stripped username. Can only include a basic set of characters.
- * https://spec.matrix.org/v1.6/appendices/#user-identifiers
- * @param {import("discord-api-types/v10").APIUser} user
- * @returns {string} localpart
- */
-function downcaseUsername(user) {
-	// First, try to convert the username to the set of allowed characters
-	let downcased = user.username.toLowerCase()
-		// spaces to underscores...
-		.replace(/ /g, "_")
-		// remove disallowed characters...
-		.replace(/[^a-z0-9._=/-]*/g, "")
-		// remove leading and trailing dashes and underscores...
-		.replace(/(?:^[_-]*|[_-]*$)/g, "")
-	// The new length must be at least 2 characters (in other words, it should have some content)
-	if (downcased.length < 2) {
-		downcased = user.id
-	}
-	return downcased
-}
-
-/** @param {string[]} preferences */
-function* generateLocalpartAlternatives(preferences) {
-	const best = preferences[0]
-	assert.ok(best)
-	// First, suggest the preferences...
-	for (const localpart of preferences) {
-		yield localpart
-	}
-	// ...then fall back to generating number suffixes...
-	let i = 2
-	while (true) {
-		yield best + (i++)
-		/* c8 ignore next */
-	}
-}
-
-/**
- * Whole process for checking the database and generating the right sim name.
- * It is very important this is not an async function: once the name has been chosen, the calling function should be able to immediately claim that name into the database in the same event loop tick.
- * @param {import("discord-api-types/v10").APIUser} user
- * @returns {string}
- */
-function userToSimName(user) {
-	assert.notEqual(user.discriminator, "0000", "cannot create user for a webhook")
-
-	// 1. Is sim user already registered?
-	const existing = select("sim", "sim_name", {user_id: user.id}).pluck().get()
-	if (existing) return existing
-
-	// 2. Register based on username (could be new or old format)
-	const downcased = downcaseUsername(user)
-	const preferences = [downcased]
-	if (user.discriminator.length === 4) { // Old style tag? If user.username is unavailable, try the full tag next
-		preferences.push(downcased + user.discriminator)
-	}
-
-	// Check for conflicts with already registered sims
-	const matches = select("sim", "sim_name", {}, "WHERE sim_name LIKE ? ESCAPE '@'").pluck().all(downcased + "%")
-	// Keep generating until we get a suggestion that doesn't conflict
-	for (const suggestion of generateLocalpartAlternatives(preferences)) {
-		if (!matches.includes(suggestion)) return suggestion
-	}
-	/* c8 ignore next */
-	throw new Error(`Ran out of suggestions when generating sim name. downcased: "${downcased}"`)
-}
-
-module.exports.userToSimName = userToSimName

d2m/discord-client.js

@@ -1,54 +0,0 @@
-// @ts-check
-
-const { SnowTransfer } = require("snowtransfer")
-const { Client: CloudStorm } = require("cloudstorm")
-
-const passthrough = require("../passthrough")
-const { sync } = passthrough
-
-/** @type {typeof import("./discord-packets")} */
-const discordPackets = sync.require("./discord-packets")
-
-class DiscordClient {
-	/**
-	 * @param {string} discordToken
-	 * @param {string} listen "full", "half", "no" - whether to set up the event listeners for OOYE to operate
-	 */
-	constructor(discordToken, listen = "full") {
-		this.discordToken = discordToken
-		this.snow = new SnowTransfer(discordToken)
-		this.cloud = new CloudStorm(discordToken, {
-			shards: [0],
-			reconnect: true,
-			snowtransferInstance: this.snow,
-			intents: [
-				"DIRECT_MESSAGES", "DIRECT_MESSAGE_REACTIONS", "DIRECT_MESSAGE_TYPING",
-				"GUILDS", "GUILD_EMOJIS_AND_STICKERS", "GUILD_MESSAGES", "GUILD_MESSAGE_REACTIONS", "GUILD_MESSAGE_TYPING", "GUILD_WEBHOOKS",
-				"MESSAGE_CONTENT"
-			],
-			ws: {
-				compress: false,
-				encoding: "json"
-			}
-		})
-		this.ready = false
-		/** @type {import("discord-api-types/v10").APIUser} */
-		// @ts-ignore avoid setting as or null because we know we need to wait for ready anyways
-		this.user = null
-		/** @type {Pick<import("discord-api-types/v10").APIApplication, "id" | "flags">} */
-		// @ts-ignore
-		this.application = null
-		/** @type {Map<string, import("discord-api-types/v10").APIChannel>} */
-		this.channels = new Map()
-		/** @type {Map<string, import("discord-api-types/v10").APIGuild>} */
-		this.guilds = new Map()
-		/** @type {Map<string, Array<string>>} */
-		this.guildChannelMap = new Map()
-		if (listen !== "no") {
-			this.cloud.on("event", message => discordPackets.onPacket(this, message, listen))
-		}
-		this.cloud.on("error", console.error)
-	}
-}
-
-module.exports = DiscordClient

d2m/event-dispatcher.js

@@ -1,267 +0,0 @@
-const assert = require("assert").strict
-const DiscordTypes = require("discord-api-types/v10")
-const util = require("util")
-const {sync, db, select, from} = require("../passthrough")
-
-/** @type {import("./actions/send-message")}) */
-const sendMessage = sync.require("./actions/send-message")
-/** @type {import("./actions/edit-message")}) */
-const editMessage = sync.require("./actions/edit-message")
-/** @type {import("./actions/delete-message")}) */
-const deleteMessage = sync.require("./actions/delete-message")
-/** @type {import("./actions/add-reaction")}) */
-const addReaction = sync.require("./actions/add-reaction")
-/** @type {import("./actions/remove-reaction")}) */
-const removeReaction = sync.require("./actions/remove-reaction")
-/** @type {import("./actions/announce-thread")}) */
-const announceThread = sync.require("./actions/announce-thread")
-/** @type {import("./actions/create-room")}) */
-const createRoom = sync.require("./actions/create-room")
-/** @type {import("./actions/create-space")}) */
-const createSpace = sync.require("./actions/create-space")
-/** @type {import("./actions/update-pins")}) */
-const updatePins = sync.require("./actions/update-pins")
-/** @type {import("../matrix/api")}) */
-const api = sync.require("../matrix/api")
-/** @type {import("../discord/discord-command-handler")}) */
-const discordCommandHandler = sync.require("../discord/discord-command-handler")
-
-let lastReportedEvent = 0
-
-// Grab Discord events we care about for the bridge, check them, and pass them on
-
-module.exports = {
-	/**
-	 * @param {import("./discord-client")} client
-	 * @param {Error} e
-	 * @param {import("cloudstorm").IGatewayMessage} gatewayMessage
-	 */
-	onError(client, e, gatewayMessage) {
-		console.error("hit event-dispatcher's error handler with this exception:")
-		console.error(e) // TODO: also log errors into a file or into the database, maybe use a library for this? or just wing it? definitely need to be able to store the formatted event body to load back in later
-		console.error(`while handling this ${gatewayMessage.t} gateway event:`)
-		console.dir(gatewayMessage.d, {depth: null})
-
-		if (gatewayMessage.t === "TYPING_START") return
-
-		if (Date.now() - lastReportedEvent < 5000) return
-		lastReportedEvent = Date.now()
-
-		const channelID = gatewayMessage.d.channel_id
-		if (!channelID) return
-		const roomID = select("channel_room", "room_id", {channel_id: channelID}).pluck().get()
-		if (!roomID) return
-
-		let stackLines = e.stack.split("\n")
-		let cloudstormLine = stackLines.findIndex(l => l.includes("/node_modules/cloudstorm/"))
-		if (cloudstormLine !== -1) {
-			stackLines = stackLines.slice(0, cloudstormLine - 2)
-		}
-		api.sendEvent(roomID, "m.room.message", {
-			msgtype: "m.text",
-			body: "\u26a0 Bridged event from Discord not delivered. See formatted content for full details.",
-			format: "org.matrix.custom.html",
-			formatted_body: "\u26a0 <strong>Bridged event from Discord not delivered</strong>"
-				+ `<br>Gateway event: ${gatewayMessage.t}`
-				+ `<br>${e.toString()}`
-				+ `<br><details><summary>Error trace</summary>`
-				+ `<pre>${stackLines.join("\n")}</pre></details>`
-				+ `<details><summary>Original payload</summary>`
-				+ `<pre>${util.inspect(gatewayMessage.d, false, 4, false)}</pre></details>`,
-			"moe.cadence.ooye.error": {
-				source: "discord",
-				payload: gatewayMessage
-			},
-			"m.mentions": {
-				user_ids: ["@cadence:cadence.moe"]
-			}
-		})
-	},
-
-	/**
-	 * When logging back in, check if we missed any conversations in any channels. Bridge up to 49 missed messages per channel.
-	 * If more messages were missed, only the latest missed message will be posted. TODO: Consider bridging more, or post a warning when skipping history?
-	 * This can ONLY detect new messages, not any other kind of event. Any missed edits, deletes, reactions, etc will not be bridged.
-	 * @param {import("./discord-client")} client
-	 * @param {DiscordTypes.GatewayGuildCreateDispatchData} guild
-	 */
-	async checkMissedMessages(client, guild) {
-		if (guild.unavailable) return
-		const bridgedChannels = select("channel_room", "channel_id").pluck().all()
-		const prepared = select("event_message", "event_id", {}, "WHERE message_id = ?").pluck()
-		for (const channel of guild.channels.concat(guild.threads)) {
-			if (!bridgedChannels.includes(channel.id)) continue
-			if (!channel.last_message_id) continue
-			const latestWasBridged = prepared.get(channel.last_message_id)
-			if (latestWasBridged) continue
-
-			/** More recent messages come first. */
-			// console.log(`[check missed messages] in ${channel.id} (${guild.name} / ${channel.name}) because its last message ${channel.last_message_id} is not in the database`)
-			let messages
-			try {
-				messages = await client.snow.channel.getChannelMessages(channel.id, {limit: 50})
-			} catch (e) {
-				if (e.message === `{"message": "Missing Access", "code": 50001}`) { // pathetic error handling from SnowTransfer
-					console.log(`[check missed messages] no permissions to look back in channel ${channel.name} (${channel.id})`)
-					continue // Sucks.
-				} else {
-					throw e // Sucks more.
-				}
-			}
-			let latestBridgedMessageIndex = messages.findIndex(m => {
-				return prepared.get(m.id)
-			})
-			// console.log(`[check missed messages] got ${messages.length} messages; last message that IS bridged is at position ${latestBridgedMessageIndex} in the channel`)
-			if (latestBridgedMessageIndex === -1) latestBridgedMessageIndex = 1 // rather than crawling the ENTIRE channel history, let's just bridge the most recent 1 message to make it up to date.
-			for (let i = Math.min(messages.length, latestBridgedMessageIndex)-1; i >= 0; i--) {
-				const simulatedGatewayDispatchData = {
-					guild_id: guild.id,
-					mentions: [],
-					backfill: true,
-					...messages[i]
-				}
-				await module.exports.onMessageCreate(client, simulatedGatewayDispatchData)
-			}
-		}
-	},
-
-	/**
-	 * Announces to the parent room that the thread room has been created.
-	 * See notes.md, "Ignore MESSAGE_UPDATE and bridge THREAD_CREATE as the announcement"
-	 * @param {import("./discord-client")} client
-	 * @param {DiscordTypes.APIThreadChannel} thread
-	 */
-	async onThreadCreate(client, thread) {
-		const parentRoomID = select("channel_room", "room_id", {channel_id: thread.parent_id}).pluck().get()
-		if (!parentRoomID) return // Not interested in a thread if we aren't interested in its wider channel
-		const threadRoomID = await createRoom.syncRoom(thread.id) // Create room (will share the same inflight as the initial message to the thread)
-		await announceThread.announceThread(parentRoomID, threadRoomID, thread)
-	},
-
-	/**
-	 * @param {import("./discord-client")} client
-	 * @param {DiscordTypes.GatewayGuildUpdateDispatchData} guild
-	 */
-	async onGuildUpdate(client, guild) {
-		const spaceID = select("guild_space", "space_id", {guild_id: guild.id}).pluck().get()
-		if (!spaceID) return
-		await createSpace.syncSpace(guild)
-	},
-
-	/**
-	 * @param {import("./discord-client")} client
-	 * @param {DiscordTypes.GatewayChannelUpdateDispatchData} channelOrThread
-	 * @param {boolean} isThread
-	 */
-	async onChannelOrThreadUpdate(client, channelOrThread, isThread) {
-		const roomID = select("channel_room", "room_id", {channel_id: channelOrThread.id}).pluck().get()
-		if (!roomID) return // No target room to update the data on
-		await createRoom.syncRoom(channelOrThread.id)
-	},
-
-	/**
-	 * @param {import("./discord-client")} client
-	 * @param {DiscordTypes.GatewayChannelPinsUpdateDispatchData} data
-	 */
-	async onChannelPinsUpdate(client, data) {
-		const roomID = select("channel_room", "room_id", {channel_id: data.channel_id}).pluck().get()
-		if (!roomID) return // No target room to update pins in
-		await updatePins.updatePins(data.channel_id, roomID)
-	},
-
-	/**
-	 * @param {import("./discord-client")} client
-	 * @param {DiscordTypes.GatewayMessageCreateDispatchData} message
-	 */
-	async onMessageCreate(client, message) {
-		if (message.author.username === "Deleted User") return // Nothing we can do for deleted users.
-		if (message.webhook_id) {
-			const row = select("webhook", "webhook_id", {webhook_id: message.webhook_id}).pluck().get()
-			if (row) {
-				// The message was sent by the bridge's own webhook on discord. We don't want to reflect this back, so just drop it.
-				return
-			}
-		}
-		/** @type {DiscordTypes.APIGuildChannel} */
-		const channel = client.channels.get(message.channel_id)
-		if (!channel.guild_id) return // Nothing we can do in direct messages.
-		const guild = client.guilds.get(channel.guild_id)
-
-		await sendMessage.sendMessage(message, guild),
-		await discordCommandHandler.execute(message, channel, guild)
-	},
-
-	/**
-	 * @param {import("./discord-client")} client
-	 * @param {DiscordTypes.GatewayMessageUpdateDispatchData} data
-	 */
-	async onMessageUpdate(client, data) {
-		if (data.webhook_id) {
-			const row = select("webhook", "webhook_id", {webhook_id: data.webhook_id}).pluck().get()
-			if (row) {
-				// The update was sent by the bridge's own webhook on discord. We don't want to reflect this back, so just drop it.
-				return
-			}
-		}
-		// Based on looking at data they've sent me over the gateway, this is the best way to check for meaningful changes.
-		// If the message content is a string then it includes all interesting fields and is meaningful.
-		if (typeof data.content === "string") {
-			/** @type {DiscordTypes.GatewayMessageCreateDispatchData} */
-			const message = data
-			/** @type {DiscordTypes.APIGuildChannel} */
-			const channel = client.channels.get(message.channel_id)
-			if (!channel.guild_id) return // Nothing we can do in direct messages.
-			const guild = client.guilds.get(channel.guild_id)
-			await editMessage.editMessage(message, guild)
-		}
-	},
-
-	/**
-	 * @param {import("./discord-client")} client
-	 * @param {DiscordTypes.GatewayMessageReactionAddDispatchData} data
-	 */
-	async onReactionAdd(client, data) {
-		if (data.user_id === client.user.id) return // m2d reactions are added by the discord bot user - do not reflect them back to matrix.
-		discordCommandHandler.onReactionAdd(data)
-		await addReaction.addReaction(data)
-	},
-
-	/**
-	 * @param {import("./discord-client")} client
-	 * @param {DiscordTypes.GatewayMessageReactionRemoveDispatchData | DiscordTypes.GatewayMessageReactionRemoveEmojiDispatchData | DiscordTypes.GatewayMessageReactionRemoveAllDispatchData} data
-	 */
-	async onSomeReactionsRemoved(client, data) {
-		await removeReaction.removeSomeReactions(data)
-	},
-
-	/**
-	 * @param {import("./discord-client")} client
-	 * @param {DiscordTypes.GatewayMessageDeleteDispatchData} data
-	 */
-	async onMessageDelete(client, data) {
-		await deleteMessage.deleteMessage(data)
-	},
-
-	/**
-	 * @param {import("./discord-client")} client
-	 * @param {DiscordTypes.GatewayTypingStartDispatchData} data
-	 */
-	async onTypingStart(client, data) {
-		const roomID = select("channel_room", "room_id", {channel_id: data.channel_id}).pluck().get()
-		if (!roomID) return
-		const mxid = from("sim").join("sim_member", "mxid").where({user_id: data.user_id, room_id: roomID}).pluck("mxid").get()
-		if (!mxid) return
-		// Each Discord user triggers the notification every 8 seconds as long as they remain typing.
-		// Discord does not send typing stopped events, so typing only stops if the timeout is reached or if the user sends their message.
-		// (We have to manually stop typing on Matrix-side when the message is sent. This is part of the send action.)
-		await api.sendTyping(roomID, true, mxid, 10000)
-	},
-
-	/**
-	 * @param {import("./discord-client")} client
-	 * @param {DiscordTypes.GatewayGuildEmojisUpdateDispatchData | DiscordTypes.GatewayGuildStickersUpdateDispatchData} data
-	 */
-	async onExpressionsUpdate(client, data) {
-		await createSpace.syncSpaceExpressions(data)
-	}
-}

db/orm-defs.d.ts

@@ -1,98 +0,0 @@
-export type Models = {
-	channel_room: {
-		channel_id: string
-		room_id: string
-		name: string
-		nick: string | null
-		thread_parent: string | null
-		custom_avatar: string | null
-	}
-
-	event_message: {
-		event_id: string
-		message_id: string
-		event_type: string | null
-		event_subtype: string | null
-		part: number
-		reaction_part: number
-		source: number
-	}
-
-	file: {
-		discord_url: string
-		mxc_url: string
-	}
-
-	guild_space: {
-		guild_id: string
-		space_id: string
-		privacy_level: number
-	}
-
-	lottie: {
-		sticker_id: string
-		mxc_url: string
-	}
-
-	member_cache: {
-		room_id: string
-		mxid: string
-		displayname: string | null
-		avatar_url: string | null
-	}
-
-	message_channel: {
-		message_id: string
-		channel_id: string
-	}
-
-	sim: {
-		user_id: string
-		sim_name: string
-		localpart: string
-		mxid: string
-	}
-
-	sim_member: {
-		mxid: string
-		room_id: string
-		hashed_profile_content: number
-	}
-
-	webhook: {
-		channel_id: string
-		webhook_id: string
-		webhook_token: string
-	}
-
-	emoji: {
-		emoji_id: string
-		name: string
-		animated: number
-		mxc_url: string
-	}
-
-	reaction: {
-		hashed_event_id: number
-		message_id: string
-		encoded_emoji: string
-	}
-
-	auto_emoji: {
-		name: string
-		emoji_id: string
-		guild_id: string
-	}
-}
-
-export type Prepared<Row> = {
-	pluck: () => Prepared<Row[keyof Row]>
-	safeIntegers: () => Prepared<{[K in keyof Row]: Row[K] extends number ? BigInt : Row[K]}>
-	raw: () => Prepared<Row[keyof Row][]>
-	all: (..._: any[]) => Row[]
-	get: (..._: any[]) => Row | null
-}
-
-export type AllKeys<U> = U extends any ? keyof U : never
-export type PickTypeOf<T, K extends AllKeys<T>> = T extends { [k in K]?: any } ? T[K] : never
-export type Merge<U> = {[x in AllKeys<U>]: PickTypeOf<U, x>}

db/orm.test.js

@@ -1,46 +0,0 @@
-// @ts-check
-
-const {test} = require("supertape")
-const data = require("../test/data")
-
-const {db, select, from} = require("../passthrough")
-
-test("orm: select: get works", t => {
-	const row = select("guild_space", "guild_id", {}, "WHERE space_id = ?").get("!jjWAGMeQdNrVZSSfvz:cadence.moe")
-	t.equal(row?.guild_id, data.guild.general.id)
-})
-
-test("orm: from: get works", t => {
-	const row = from("guild_space").select("guild_id").and("WHERE space_id = ?").get("!jjWAGMeQdNrVZSSfvz:cadence.moe")
-	t.equal(row?.guild_id, data.guild.general.id)
-})
-
-test("orm: select: get pluck works", t => {
-	const guildID = select("guild_space", "guild_id", {}, "WHERE space_id = ?").pluck().get("!jjWAGMeQdNrVZSSfvz:cadence.moe")
-	t.equal(guildID, data.guild.general.id)
-})
-
-test("orm: select: get, where and pluck works", t => {
-	const channelID = select("message_channel", "channel_id", {message_id: "1128118177155526666"}).pluck().get()
-	t.equal(channelID, "112760669178241024")
-})
-
-test("orm: select: all, where and pluck works on multiple columns", t => {
-	const names = select("member_cache", "displayname", {room_id: "!kLRqKKUQXcibIMtOpl:cadence.moe", mxid: "@cadence:cadence.moe"}).pluck().all()
-	t.deepEqual(names, ["cadence [they]"])
-})
-
-test("orm: from: get pluck works", t => {
-	const guildID = from("guild_space").pluck("guild_id").and("WHERE space_id = ?").get("!jjWAGMeQdNrVZSSfvz:cadence.moe")
-	t.equal(guildID, data.guild.general.id)
-})
-
-test("orm: from: join and pluck works", t => {
-	const mxid = from("sim").join("sim_member", "mxid").and("WHERE user_id = ? AND room_id = ?").pluck("mxid").get("771520384671416320", "!hYnGGlPHlbujVVfktC:cadence.moe")
-	t.equal(mxid, "@_ooye_bojack_horseman:cadence.moe")
-})
-
-test("orm: from: where and pluck works", t => {
-	const subtypes = from("event_message").where({message_id: "1141501302736695316"}).pluck("event_subtype").all()
-	t.deepEqual(subtypes.sort(), ["m.image", "m.text"])
-})

discord/discord-command-handler.js

@@ -1,273 +0,0 @@
-// @ts-check
-
-const assert = require("assert").strict
-const util = require("util")
-const DiscordTypes = require("discord-api-types/v10")
-const reg = require("../matrix/read-registration")
-const {addbot} = require("../addbot")
-
-const {discord, sync, db, select} = require("../passthrough")
-/** @type {import("../matrix/api")}) */
-const api = sync.require("../matrix/api")
-/** @type {import("../matrix/file")} */
-const file = sync.require("../matrix/file")
-/** @type {import("../d2m/actions/create-space")} */
-const createSpace = sync.require("../d2m/actions/create-space")
-/** @type {import("./utils")} */
-const utils = sync.require("./utils")
-
-const PREFIX = "//"
-
-let buttons = []
-
-/**
- * @param {string} channelID where to add the button
- * @param {string} messageID where to add the button
- * @param {string} emoji emoji to add as a button
- * @param {string} userID only listen for responses from this user
- * @returns {Promise<import("discord-api-types/v10").GatewayMessageReactionAddDispatchData>}
- */
-async function addButton(channelID, messageID, emoji, userID) {
-	await discord.snow.channel.createReaction(channelID, messageID, emoji)
-	return new Promise(resolve => {
-		buttons.push({channelID, messageID, userID, resolve, created: Date.now()})
-	})
-}
-
-// Clear out old buttons every so often to free memory
-setInterval(() => {
-	const now = Date.now()
-	buttons = buttons.filter(b => now - b.created < 2*60*60*1000)
-}, 10*60*1000)
-
-/** @param {import("discord-api-types/v10").GatewayMessageReactionAddDispatchData} data */
-function onReactionAdd(data) {
-	const button = buttons.find(b => b.channelID === data.channel_id && b.messageID === data.message_id && b.userID === data.user_id)
-	if (button) {
-		buttons = buttons.filter(b => b !== button) // remove button data so it can't be clicked again
-		button.resolve(data)
-	}
-}
-
-/**
- * @callback CommandExecute
- * @param {DiscordTypes.GatewayMessageCreateDispatchData} message
- * @param {DiscordTypes.APIGuildTextChannel} channel
- * @param {DiscordTypes.APIGuild} guild
- * @param {Partial<DiscordTypes.RESTPostAPIChannelMessageJSONBody>} [ctx]
- */
-
-/**
- * @typedef Command
- * @property {string[]} aliases
- * @property {(message: DiscordTypes.GatewayMessageCreateDispatchData, channel: DiscordTypes.APIGuildTextChannel, guild: DiscordTypes.APIGuild) => Promise<any>} execute
- */
-
-/** @param {CommandExecute} execute */
-function replyctx(execute) {
-	/** @type {CommandExecute} */
-	return function(message, channel, guild, ctx = {}) {
-		ctx.message_reference = {
-			message_id: message.id,
-			channel_id: channel.id,
-			guild_id: guild.id,
-			fail_if_not_exists: false
-		}
-		return execute(message, channel, guild, ctx)
-	}
-}
-
-/** @type {Command[]} */
-const commands = [{
-	aliases: ["icon", "avatar", "roomicon", "roomavatar", "channelicon", "channelavatar"],
-	execute: replyctx(
-		async (message, channel, guild, ctx) => {
-			// Guard
-			const roomID = select("channel_room", "room_id", {channel_id: channel.id}).pluck().get()
-			if (!roomID) return discord.snow.channel.createMessage(channel.id, {
-				...ctx,
-				content: "This channel isn't bridged to the other side."
-			})
-
-			// Current avatar
-			const avatarEvent = await api.getStateEvent(roomID, "m.room.avatar", "")
-			const avatarURLParts = avatarEvent?.url.match(/^mxc:\/\/([^/]+)\/(\w+)$/)
-			let currentAvatarMessage =
-				( avatarURLParts ? `Current room-specific avatar: ${reg.ooye.server_origin}/_matrix/media/r0/download/${avatarURLParts[1]}/${avatarURLParts[2]}`
-				: "No avatar. Now's your time to strike. Use `//icon` again with a link or upload to set the room-specific avatar.")
-
-			// Next potential avatar
-			const nextAvatarURL = message.attachments.find(a => a.content_type?.startsWith("image/"))?.url || message.content.match(/https?:\/\/[^ ]+\.[^ ]+\.(?:png|jpg|jpeg|webp)\b/)?.[0]
-			let nextAvatarMessage =
-				( nextAvatarURL ? `\nYou want to set it to: ${nextAvatarURL}\nHit ✅ to make it happen.`
-				: "")
-
-			const sent = await discord.snow.channel.createMessage(channel.id, {
-				...ctx,
-				content: currentAvatarMessage + nextAvatarMessage
-			})
-
-			if (nextAvatarURL) {
-				addButton(channel.id, sent.id, "✅", message.author.id).then(async data => {
-					const mxcUrl = await file.uploadDiscordFileToMxc(nextAvatarURL)
-					await api.sendState(roomID, "m.room.avatar", "", {
-						url: mxcUrl
-					})
-					db.prepare("UPDATE channel_room SET custom_avatar = ? WHERE channel_id = ?").run(mxcUrl, channel.id)
-					await discord.snow.channel.createMessage(channel.id, {
-						...ctx,
-						content: "Your creation is unleashed. Any complaints will be redirected to Grelbo."
-					})
-				})
-			}
-		}
-	)
-}, {
-	aliases: ["invite"],
-	execute: replyctx(
-		async (message, channel, guild, ctx) => {
-			// Check guild is bridged
-			const spaceID = select("guild_space", "space_id", {guild_id: guild.id}).pluck().get()
-			const roomID = select("channel_room", "room_id", {channel_id: channel.id}).pluck().get()
-			if (!spaceID || !roomID) return discord.snow.channel.createMessage(channel.id, {
-				...ctx,
-				content: "This server isn't bridged to Matrix, so you can't invite Matrix users."
-			})
-
-			// Check CREATE_INSTANT_INVITE permission
-			assert(message.member)
-			const guildPermissions = utils.getPermissions(message.member.roles, guild.roles)
-			if (!(guildPermissions & BigInt(1))) {
-				return discord.snow.channel.createMessage(channel.id, {
-					...ctx,
-					content: "You don't have permission to invite people to this Discord server."
-				})
-			}
-
-			// Guard against accidental mentions instead of the MXID
-			if (message.content.match(/<[@#:].*>/)) return discord.snow.channel.createMessage(channel.id, {
-				...ctx,
-				content: "You have to say the Matrix ID of the person you want to invite, but you mentioned a Discord user in your message.\nOne way to fix this is by writing `` ` `` backticks `` ` `` around the Matrix ID."
-			})
-
-			// Get named MXID
-			const mxid = message.content.match(/@([^:]+):([a-z0-9:-]+\.[a-z0-9.:-]+)/)?.[0]
-			if (!mxid) return discord.snow.channel.createMessage(channel.id, {
-				...ctx,
-				content: "You have to say the Matrix ID of the person you want to invite. Matrix IDs look like this: `@username:example.org`"
-			})
-
-			// Check for existing invite to the space
-			let spaceMember
-			try {
-				spaceMember = await api.getStateEvent(spaceID, "m.room.member", mxid)
-			} catch (e) {}
-			if (spaceMember && spaceMember.membership === "invite") {
-				return discord.snow.channel.createMessage(channel.id, {
-					...ctx,
-					content: `\`${mxid}\` already has an invite, which they haven't accepted yet.`
-				})
-			}
-
-			// Invite Matrix user if not in space
-			if (!spaceMember || spaceMember.membership !== "join") {
-				await api.inviteToRoom(spaceID, mxid)
-				return discord.snow.channel.createMessage(channel.id, {
-					...ctx,
-					content: `You invited \`${mxid}\` to the server.`
-				})
-			}
-
-			// The Matrix user *is* in the space, maybe we want to invite them to this channel?
-			let roomMember
-			try {
-				roomMember = await api.getStateEvent(roomID, "m.room.member", mxid)
-			} catch (e) {}
-			if (!roomMember || (roomMember.membership !== "join" && roomMember.membership !== "invite")) {
-				const sent = await discord.snow.channel.createMessage(channel.id, {
-					...ctx,
-					content: `\`${mxid}\` is already in this server. Would you like to additionally invite them to this specific channel?\nHit ✅ to make it happen.`
-				})
-				return addButton(channel.id, sent.id, "✅", message.author.id).then(async data => {
-					await api.inviteToRoom(roomID, mxid)
-					await discord.snow.channel.createMessage(channel.id, {
-						...ctx,
-						content: `You invited \`${mxid}\` to the channel.`
-					})
-				})
-			}
-
-			// The Matrix user *is* in the space and in the channel.
-			await discord.snow.channel.createMessage(channel.id, {
-				...ctx,
-				content: `\`${mxid}\` is already in this server and this channel.`
-			})
-		}
-	)
-}, {
-	aliases: ["addbot"],
-	execute: replyctx(
-		async (message, channel, guild, ctx) => {
-			return discord.snow.channel.createMessage(channel.id, {
-				...ctx,
-				content: addbot()
-			})
-		}
-	)
-}, {
-	aliases: ["privacy", "discoverable", "publish", "published"],
-	execute: replyctx(
-		async (message, channel, guild, ctx) => {
-			const current = select("guild_space", "privacy_level", {guild_id: guild.id}).pluck().get()
-			if (current == null) {
-				return discord.snow.channel.createMessage(channel.id, {
-					...ctx,
-					content: "This server isn't bridged to the other side."
-				})
-			}
-
-			const levels = ["invite", "link", "directory"]
-			const level = levels.findIndex(x => message.content.includes(x))
-			if (level === -1) {
-				return discord.snow.channel.createMessage(channel.id, {
-					...ctx,
-					content: "**Usage: `//privacy <level>`**. This will set who can join the space on Matrix-side. There are three levels:"
-						+ "\n`invite`: Can only join with a direct in-app invite from another Matrix user, or the //invite command."
-						+ "\n`link`: Matrix links can be created and shared like Discord's invite links. `invite` features also work."
-						+ "\n`directory`: Publishes to the Matrix in-app directory, like Server Discovery. Preview enabled. `invite` and `link` also work."
-						+ `\n**Current privacy level: \`${levels[current]}\`**`
-				})
-			}
-
-			assert(message.member)
-			const guildPermissions = utils.getPermissions(message.member.roles, guild.roles)
-			if (guild.owner_id !== message.author.id && !(guildPermissions & BigInt(0x28))) { // MANAGE_GUILD | ADMINISTRATOR
-				return discord.snow.channel.createMessage(channel.id, {
-					...ctx,
-					content: "You don't have permission to change the privacy level. You need Manage Server or Administrator."
-				})
-			}
-
-			db.prepare("UPDATE guild_space SET privacy_level = ? WHERE guild_id = ?").run(level, guild.id)
-			discord.snow.channel.createMessage(channel.id, {
-				...ctx,
-				content: `Privacy level updated to \`${levels[level]}\`. Changes will apply shortly.`
-			})
-			await createSpace.syncSpaceFully(guild.id)
-		}
-	)
-}]
-
-/** @type {CommandExecute} */
-async function execute(message, channel, guild) {
-	if (!message.content.startsWith(PREFIX)) return
-	const words = message.content.slice(PREFIX.length).split(" ")
-	const commandName = words[0]
-	const command = commands.find(c => c.aliases.includes(commandName))
-	if (!command) return
-
-	await command.execute(message, channel, guild)
-}
-
-module.exports.execute = execute
-module.exports.onReactionAdd = onReactionAdd

discord/utils.js

@@ -1,60 +0,0 @@
-// @ts-check
-
-const DiscordTypes = require("discord-api-types/v10")
-
-/**
- * @param {string[]} userRoles
- * @param {DiscordTypes.APIGuild["roles"]} guildRoles
- * @param {string} [userID]
- * @param {DiscordTypes.APIGuildChannel["permission_overwrites"]} [channelOverwrites]
- */
-function getPermissions(userRoles, guildRoles, userID, channelOverwrites) {
-	let allowed = BigInt(0)
-	let everyoneID
-	// Guild allows
-	for (const role of guildRoles) {
-		if (role.name === "@everyone") {
-			allowed |= BigInt(role.permissions)
-			everyoneID = role.id
-		}
-		if (userRoles.includes(role.id)) {
-			allowed |= BigInt(role.permissions)
-		}
-	}
-
-	if (channelOverwrites) {
-		/** @type {((overwrite: Required<DiscordTypes.APIGuildChannel>["permission_overwrites"][0]) => any)[]} */
-		const actions = [
-			// Channel @everyone deny
-			overwrite => overwrite.id === everyoneID && (allowed &= ~BigInt(overwrite.deny)),
-			// Channel @everyone allow
-			overwrite => overwrite.id === everyoneID && (allowed |= BigInt(overwrite.allow)),
-			// Role deny
-			overwrite => userRoles.includes(overwrite.id) && (allowed &= ~BigInt(overwrite.deny)),
-			// Role allow
-			overwrite => userRoles.includes(overwrite.id) && (allowed |= ~BigInt(overwrite.allow)),
-			// User deny
-			overwrite => overwrite.id === userID && (allowed &= ~BigInt(overwrite.deny)),
-			// User allow
-			overwrite => overwrite.id === userID && (allowed |= BigInt(overwrite.allow))
-		]
-		for (let i = 0; i < actions.length; i++) {
-			for (const overwrite of channelOverwrites) {
-				actions[i](overwrite)
-			}
-		}
-	}
-	return allowed
-}
-
-/**
- * Command interaction responses have a webhook_id for some reason, but still have real author info of a real bot user in the server.
- * @param {DiscordTypes.APIMessage} message
- */
-function isWebhookMessage(message) {
-	const isInteractionResponse = message.type === 20
-	return message.webhook_id && !isInteractionResponse
-}
-
-module.exports.getPermissions = getPermissions
-module.exports.isWebhookMessage = isWebhookMessage

docs/api.md

@@ -0,0 +1,52 @@
+# API
+
+There is a web API for getting information about things that are bridged with Out Of Your Element.
+
+The base URL is the URL of the particular OOYE instance, for example, https://bridge.cadence.moe.
+
+No authentication is required.
+
+I'm happy to add more endpoints, just ask for them.
+
+## Endpoint: GET /api/message
+
+|Query parameter|Type|Description|
+|---------------|----|-----------|
+|`message_id`|regexp `/^[0-9]+$/`|Discord message ID to look up information for|
+
+Response:
+
+```typescript
+{
+  source: "matrix" | "discord"                // Which platform the message originated on
+  matrix_author?: {                             // Only for Matrix messages; should be up-to-date rather than historical data
+    displayname: string,                        // Matrix user's current display name
+    avatar_url: string | null,                  // Absolute HTTP(S) URL to download the Matrix user's current avatar
+    mxid: string                                // Matrix user ID, can never change
+  },
+  events: [                                   // Data about each individual event
+    {
+      metadata: {                               // Data from OOYE's database about how bridging was performed
+        sender: string,                           // Same as matrix user ID
+        event_id: string,                         // Unique ID of the event on Matrix, can never change
+        event_type: "m.room.message" | string,    // Event type
+        event_subtype: "m.text" | string | null,  // For m.room.message events, this is the msgtype property
+        part: 0 | 1,                              // For multi-event messages, 0 if this is the first part
+        reaction_part: 0 | 1,                     // For multi-event messages, 0 if this is the last part
+        room_id: string,                          // Room ID that the event was sent in, linked to the Discord channel
+        source: number
+      },
+      raw: {                                    // Raw historical event data from the Matrix API. Contains at least these properties:
+        content: any,                             // The only non-metadata property, entirely client-generated
+        type: string,
+        room_id: string,
+        sender: string,
+        origin_server_ts: number,
+        unsigned?: any,
+        event_id: string,
+        user_id: string
+      }
+    }
+  ]
+}
+```

docs/developer-orientation.md

@@ -0,0 +1,129 @@
+# Development setup
+
+* Install development dependencies with `npm install --save-dev` so you can run the tests.
+* Most files you change, such as actions, converters, and web, will automatically be reloaded.
+* If developing on a different computer to the one running the homeserver, use SSH port forwarding so that Synapse can connect on its `localhost:6693` to reach the running bridge on your computer. Example: `ssh -T -v -R 6693:localhost:6693 me@matrix.cadence.moe`
+* I recommend developing in Visual Studio Code so that the JSDoc x TypeScript annotation comments just work automatically. I don't know which other editors or language servers support annotations and type inference.
+
+# Efficiency details
+
+Using WeatherStack as a thin layer between the bridge application and the Discord API lets us control exactly what data is cached in memory. Only necessary information is cached. For example, member data, user data, message content, and past edits are never stored in memory. This keeps the memory usage low and also prevents it ballooning in size over the bridge's runtime.
+
+The bridge uses a small SQLite database to store relationships like which Discord messages correspond to which Matrix messages. This is so the bridge knows what to edit when some message is edited on Discord. Using `without rowid` on the database tables stores the index and the data in the same B-tree. Since Matrix and Discord's internal IDs are quite long, this vastly reduces storage space because those IDs do not have to be stored twice separately. Some event IDs and URLs are actually stored as xxhash integers to reduce storage requirements even more. On my personal instance of OOYE, every 300,000 messages (representing a year of conversations) requires 40.6 MB of storage space in the SQLite database.
+
+Only necessary data and columns are queried from the database. We only contact the homeserver API if the database doesn't contain what we need.
+
+File uploads (like avatars from bridged members) are checked locally and deduplicated. Only brand new files are uploaded to the homeserver. This saves loads of space in the homeserver's media repo, especially for Synapse.
+
+Switching to [WAL mode](https://www.sqlite.org/wal.html) could improve your database access speed even more. Run `node scripts/wal.js` if you want to switch to WAL mode. (This will also enable `synchronous = NORMAL`.)
+
+
+# Repository structure
+
+    .
+    * Runtime configuration, like tokens and user info:
+    ├── registration.yaml
+    * You are here! :)
+    ├── readme.md
+    * The bridge's SQLite database is stored here:
+    ├── ooye.db*
+    * Source code
+    └── src
+        * Database schema:
+        ├── db
+        │   ├── orm.js, orm-defs.d.ts
+        │   * Migrations change the database schema when you update to a newer version of OOYE:
+        │   ├── migrate.js
+        │   └── migrations
+        │       └── *.sql, *.js
+        * Discord-to-Matrix bridging:
+        ├── d2m
+        │   * Execute actions through the whole flow, like sending a Discord message to Matrix:
+        │   ├── actions
+        │   │   └── *.js
+        │   * Convert data from one form to another without depending on bridge state. Called by actions:
+        │   ├── converters
+        │   │   └── *.js
+        │   * Making Discord work:
+        │   ├── discord-*.js
+        │   * Listening to events from Discord and dispatching them to the correct `action`:
+        │   └── event-dispatcher.js
+        * Discord bot commands and menus:
+        ├── discord
+        │   ├── interactions
+        │   │   └── *.js
+        │   └── discord-command-handler.js
+        * Matrix-to-Discord bridging:
+        ├── m2d
+        │   * Execute actions through the whole flow, like sending a Matrix message to Discord:
+        │   ├── actions
+        │   │   └── *.js
+        │   * Convert data from one form to another without depending on bridge state. Called by actions:
+        │   ├── converters
+        │   │   └── *.js
+        │   * Listening to events from Matrix and dispatching them to the correct `action`:
+        │   └── event-dispatcher.js
+        * We aren't using the matrix-js-sdk, so here are all the functions for the Matrix C-S and Appservice APIs:
+        ├── matrix
+        │   └── *.js
+        * Various files you can run once if you need them.
+        └── scripts
+            * First time running a new bridge? Run this file to set up prerequisites on the Matrix server:
+            ├── setup.js
+            * Hopefully you won't need the rest of these. Code quality varies wildly.
+            └── *.js
+
+# Read next
+
+If you haven't set up Out Of Your Element yet, you might find [Simplified homeserver setup](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs/simplified-homeserver-setup.md) helpful.
+
+If you don't know what the Matrix event JSON generally looks like, turn on developer tools in your client (Element has pretty good ones). Right click a couple of messages and see what they look like on the inside.
+
+I recommend first reading [How to add a new event type](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs/how-to-add-a-new-event-type.md) as this will fill you in on key information in how the codebase is organised, which data structures are important, and what level of abstraction we're working on.
+
+If you haven't seen the [Discord API documentation](https://discord.com/developers/docs/) before, have a quick look at one of the pages on there. Same with the [Matrix Client-Server APIs](https://spec.matrix.org/latest/client-server-api/). You don't need to know these inside out, they're primarily references, not stories. But it is useful to have an idea of what a couple of the API endpoints look like, the kind of data they tend to accept, and the kind of data they tend to return.
+
+Then you might like to peruse the other files in the docs folder. Most of these were written stream-of-thought style as I try to work through a problem and find the best way to implement it. You might enjoy getting inside my head and seeing me invent and evaluate ways to solve the problem.
+
+Whether you read those or not, I'm more than happy to help you 1-on-1 with coding your dream feature. Join the chatroom [#out-of-your-element:cadence.moe](https://matrix.to/#/#out-of-your-element:cadence.moe) or PM me [@cadence:cadence.moe](https://matrix.to/#/@cadence:cadence.moe) and ask away.
+
+# Dependency justification
+
+Total transitive production dependencies: 134
+
+### <font size="+2">🦕</font>
+
+* (31) better-sqlite3: SQLite is the best database, and this is the best library for it.
+* (27) @cloudrac3r/pug: Language for dynamic web pages. This is my fork. (I released code that hadn't made it to npm, and removed the heavy pug-filters feature.)
+* (16) stream-mime-type@1: This seems like the best option. Version 1 is used because version 2 is ESM-only.
+* (9) h3: Web server. OOYE needs this for the appservice listener, authmedia proxy, self-service, and more.
+* (11) sharp: Image resizing and compositing. OOYE needs this for the emoji sprite sheets.
+
+### <font size="-1">🪱</font>
+
+* (0) @chriscdn/promise-semaphore: It does what I want.
+* (1) @cloudrac3r/discord-markdown: This is my fork.
+* (0) @cloudrac3r/giframe: This is my fork.
+* (1) @cloudrac3r/html-template-tag: This is my fork.
+* (0) @cloudrac3r/in-your-element: This is my Matrix Appservice API library. It depends on h3 and zod, which are already pulled in by OOYE.
+* (0) @cloudrac3r/mixin-deep: This is my fork. (It fixes a bug in regular mixin-deep.)
+* (0) @cloudrac3r/pngjs: Lottie stickers are converted to bitmaps with the vendored Rlottie WASM build, then the bitmaps are converted to PNG with pngjs.
+* (0) @cloudrac3r/turndown: This HTML-to-Markdown converter looked the most suitable. I forked it to change the escaping logic to match the way Discord works.
+* (3) @stackoverflow/stacks: Stack Overflow design language and icons.
+* (0) ansi-colors: Helps with interactive prompting for the initial setup, and it's already pulled in by enquirer.
+* (1) chunk-text: It does what I want.
+* (0) cloudstorm: Discord gateway library with bring-your-own-caching that I trust.
+* (0) discord-api-types: Bitfields needed at runtime and types needed for development.
+* (0) domino: DOM implementation that's already pulled in by turndown.
+* (1) enquirer: Interactive prompting for the initial setup rather than forcing users to edit YAML non-interactively.
+* (0) entities: Looks fine. No dependencies.
+* (0) get-relative-path: Looks fine. No dependencies.
+* (1) heatsync: Module hot-reloader that I trust.
+* (0) lru-cache: For holding unused nonce in memory and letting them be overwritten later if never used.
+* (0) mime-type: File extension to mime type mapping that's already pulled in by stream-mime-type.
+* (0) prettier-bytes: It does what I want and has no dependencies.
+* (0) snowtransfer: Discord API library with bring-your-own-caching that I trust.
+* (0) try-to-catch: Not strictly necessary, but it's already pulled in by supertape, so I may as well.
+* (0) uqr: QR code SVG generator. Used on the website to scan in an invite link.
+* (0) xxhash-wasm: Used where cryptographically secure hashing is not required.
+* (0) zod: Input validation for the web server. It's popular and easy to use.

docs/docker.md

@@ -0,0 +1,76 @@
+# Docker policy
+
+**Out Of Your Element has no official support for Docker. There are no official files or images. If you choose to run Out Of Your Element in Docker, you must disclose this when asking for support. I may refuse to provide support/advice at any time. I may refuse to acknowledge issue reports.**
+
+This also goes for Podman, Nix, and other similar technology that upends a program's understanding of what it's running on.
+
+## What I recommend
+
+I recommend [following the official setup guide,](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs/get-started.md) which does not use Docker.
+
+Ultimately, though, do what makes you happy. I can't stop you from doing what you want. As long as you read this page and understand my perspective, that's good enough for me.
+
+## Why I advise against Docker
+
+When misconfigured, Docker has terrible impacts. It can cause messages to go missing or even permanent data loss. These have happened to people.
+
+Docker also makes it much harder for me to advise on debugging because it puts barriers between you and useful debugging tools, such as stdin, the database file, a shell, and the inspector. It's also not clear which version of the source code is running in the container, as there are many pieces of Docker (builder, container, image) that can cache old data, often making it so you didn't actually update when you thought you did. This has happened to people.
+
+## Why I don't provide a good configuration myself
+
+It is not possible for Docker to be correctly configured by default. The defaults are broken and will cause data loss.
+
+It is also not possible for me to provide a correct configuration for everyone. Even if I provided a correct image, the YAMLs and command-line arguments must be written by individual end users. Incorrect YAMLs and command-line arguments may cause connection issues or permanent data loss.
+
+## Why I don't provide assistance if you run OOYE in Docker
+
+Problems you encounter, especially with the initial setup, are much more likely to be caused by nuances in your Docker setup than problems in my code. Therefore, my code is not responsible for the problem. The cause of the problem is different code that I can't advise on.
+
+Also, if you reported an issue and I asked for additional information to help find the cause, you might be unable to provide it because of the debugging barriers discussed above.
+
+## Why I don't provide Docker resources
+
+I create OOYE unpaid in my spare time because I enjoy the process. I find great enjoyment in creating code and none at all in creating infrastructure.
+
+## Why you're probably fine without Docker
+
+### If you care about system footprint
+
+OOYE was designed to be simple and courteous:
+
+* It only creates files in its working directory
+* It does not require any other processes to be running (e.g., no dependency on a Postgres process)
+* It only requires node/npm executables in PATH, which you can store in any folder if you don't want to use your package manager
+
+### If you care about ease of setup
+
+In my opinion, the [official setup process](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs/get-started.md) is straightforward. After installing prerequisites (Node.js and the repo clone), the rest of the process interactively guides you through providing necessary information. Your input is checked for correctness so the bridge will definitely work when you run it.
+
+I find this easier than the usual Docker workflow of pasting values into a YAML and rolling the dice on whether it will start up or not.
+
+### If you care about security in the case of compromise/RCE
+
+There are no known vulnerabilities in dependencies. I [carefully selected simple, light dependencies](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs/developer-orientation.md#dependency-justification) to reduce attack surface area.
+
+For defense in depth, I suggest running OOYE as a different user.
+
+### If you want to see all the processes when you run docker ps
+
+Well, you got me there.
+
+## Unofficial, independent, community-provided container setups
+
+I acknowledge the demand for using OOYE in a container, so I will still point you in the right direction.
+
+I had no hand in creating these and have not used or tested them whatsoever. I make no assurance that these will work reliably, or even at all. If you use these, you must do so with the understanding that if you run into any problems, **you must ask for support from the author of that setup, not from me, because you're running their code, not mine.**
+
+***The following list is distributed for your information, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.***
+
+- by melody: https://git.shork.ch/docker-images/out-of-your-element
+- by sim2kid: https://github.com/sim2kid/ooye-docker
+- by Katharos Technology: https://github.com/katharostech/docker_ooye
+- by Emma: https://cgit.rory.gay/nix/OOYE-module.git/tree
+
+## Making your own Docker setup
+
+If you decide to make your own, I may provide advice or indicate problems at my discretion. You acknowledge that I am not required to provide evidence of problems I indicate, nor solutions to them. You acknowledge that it is not possible for me to exhaustively indicate every problem, so I cannot indicate correctness. Even if I have provided advice to an unofficial, independent, community-provided setup, I do not endorse it.

docs/foreign-keys.md

@@ -0,0 +1,98 @@
+# Foreign keys in the Out Of Your Element database
+
+Historically, Out Of Your Element did not use foreign keys in the database, but since I found a need for them, I have decided to add them. Referential integrity is probably valuable as well.
+
+The need is that unlinking a channel and room using the web interface should clear up all related entries from `message_channel`, `event_message`, `reaction`, etc. Without foreign keys, this requires multiple DELETEs with tricky queries. With foreign keys and ON DELETE CASCADE, this just works.
+
+## Quirks
+
+* **REPLACE INTO** internally causes a DELETE followed by an INSERT, and the DELETE part **will trigger any ON DELETE CASCADE** foreign key conditions on the table, even when the primary key being replaced is the same.
+	* ```sql
+		CREATE TABLE discord_channel (channel_id TEXT NOT NULL, name TEXT NOT NULL, PRIMARY KEY (channel_id));
+		CREATE TABLE discord_message (message_id TEXT NOT NULL, channel_id TEXT NOT NULL, PRIMARY KEY (message_id),
+		  FOREIGN KEY (channel_id) REFERENCES discord_channel (channel_id) ON DELETE CASCADE);
+		INSERT INTO discord_channel (channel_id, name) VALUES ("c_1", "place");
+		INSERT INTO discord_message (message_id, channel_id) VALUES ("m_2", "c_1"); -- i love my message
+		REPLACE INTO discord_channel (channel_id, name) VALUES ("c_1", "new place"); -- replace into time
+		-- i love my message
+		SELECT * FROM discord_message; -- where is my message
+		```
+* In SQLite, `pragma foreign_keys = on` must be set **for each connection** after it's established. I've added this at the start of `migrate.js`, which is called by all database connections.
+  * Pragma? Pragma keys
+* Whenever a child row is inserted, SQLite will look up a row from the parent table to ensure referential integrity. This means **the parent table should be sufficiently keyed or indexed on columns referenced by foreign keys**, or SQLite won't let you do it, with a cryptic error message later on during DML. Due to normal forms, foreign keys naturally tend to reference the parent table's primary key, which is indexed, so that's okay. But still keep this in mind, since many of OOYE's tables effectively have two primary keys, for the Discord and Matrix IDs. A composite primary key doesn't count, even when it's the first column. A unique index counts.
+
+## Where keys
+
+Here are some tables that could potentially have foreign keys added between them, and my thought process of whether foreign keys would be a good idea:
+
+* `guild_active` <--(PK guild_id FK)-- `channel_room` ✅
+	* Could be good for referential integrity.
+	* Linking to guild_space would be pretty scary in case the guild was being relinked to a different space - since rooms aren't tied to a space, this wouldn't actually disturb anything. So I pick guild_active instead.
+* `channel_room` <--(PK channel_id FK)-- `message_channel` ✅
+	* Seems useful as we want message records to be deleted when a channel is unlinked.
+* `message_channel` <--(PK message_id PK)-- `event_message` ✅
+	* Seems useful as we want event information to be deleted when a channel is unlinked.
+* `guild_active` <--(PK guild_id PK)-- `guild_space` ✅
+	* All bridged guilds should have a corresponding guild_active entry, so referential integrity would be useful here to make sure we haven't got any weird states.
+* `channel_room` <--(**C** room_id PK)-- `member_cache` ✅
+	* Seems useful as we want to clear the member cache when a channel is unlinked.
+	* There is no index on `channel_room.room_id` right now. It would be good to create this index. Will just make it UNIQUE in the table definition.
+* `message_channel` <--(PK message_id FK)-- `reaction` ✅
+	* Seems useful as we want to clear the reactions cache when a channel is unlinked.
+* `sim` <--(**C** mxid FK)-- `sim_member`
+	* OOYE inner joins on this.
+	* Sims are never deleted so if this was added it would only be used for enforcing referential integrity.
+	* The storage cost of the additional index on `sim` would not be worth the benefits.
+* `channel_room` <--(**C** room_id PK)-- `sim_member`
+	* If a room is being permanently unlinked, it may be useful to see a populated member list. If it's about to be relinked to another channel, we want to keep the sims in the room for more speed and to avoid spamming state events into the timeline.
+	* Either way, the sims could remain in the room even after it's been unlinked. So no referential integrity is desirable here.
+* `sim` <--(PK user_id PK)-- `sim_proxy`
+	* OOYE left joins on this. In normal operation, this relationship might not exist.
+* `channel_room` <--(PK channel_id PK)-- `webhook` ✅
+	* Seems useful. Webhooks should be deleted from Discord just before the channel is unlinked. That should be mirrored in the database too.
+
+## Occurrences of REPLACE INTO/DELETE FROM
+
+* `edit-message.js` — `REPLACE INTO message_channel`
+	* Scary! Changed to INSERT OR IGNORE
+* `send-message.js` — `REPLACE INTO message_channel`
+	* Changed to INSERT OR IGNORE
+* `add-reaction.js` — `REPLACE INTO reaction`
+* `channel-webhook.js` — `REPLACE INTO webhook`
+* `send-event.js` — `REPLACE INTO message_channel`
+	* Seems incorrect? Maybe?? Originally added in fcbb045. Changed to INSERT
+* `event-to-message.js` — `REPLACE INTO member_cache`
+* `oauth.js` — `REPLACE INTO guild_active`
+	* Very scary!! Changed to INSERT .. ON CONFLICT DO UPDATE
+* `create-room.js` — `DELETE FROM channel_room`
+	* Please cascade
+* `delete-message.js`
+	* Removed redundant DELETEs
+* `edit-message.js` — `DELETE FROM event_message`
+* `register-pk-user.js` — `DELETE FROM sim`
+	* It's a failsafe during creation
+* `register-user.js` — `DELETE FROM sim`
+	* It's a failsafe during creation
+* `remove-reaction.js` — `DELETE FROM reaction`
+* `event-dispatcher.js` — `DELETE FROM member_cache`
+* `redact.js` — `DELETE FROM event_message`
+	* Removed this redundant DELETE
+* `send-event.js` — `DELETE FROM event_message`
+	* Removed this redundant DELETE
+
+## How keys
+
+SQLite does not have a complete ALTER TABLE command, so I have to DROP and CREATE. According to [the docs](https://www.sqlite.org/lang_altertable.html), the correct strategy is:
+
+1. (Not applicable) *If foreign key constraints are enabled, disable them using PRAGMA foreign_keys=OFF.*
+2. Start a transaction.
+3. (Not applicable) *Remember the format of all indexes, triggers, and views associated with table X. This information will be needed in step 8 below. One way to do this is to run a query like the following: SELECT type, sql FROM sqlite_schema WHERE tbl_name='X'.*
+4. Use CREATE TABLE to construct a new table "new_X" that is in the desired revised format of table X. Make sure that the name "new_X" does not collide with any existing table name, of course.
+5. Transfer content from X into new_X using a statement like: INSERT INTO new_X SELECT ... FROM X.
+6. Drop the old table X: DROP TABLE X.
+7. Change the name of new_X to X using: ALTER TABLE new_X RENAME TO X.
+8. (Not applicable) *Use CREATE INDEX, CREATE TRIGGER, and CREATE VIEW to reconstruct indexes, triggers, and views associated with table X. Perhaps use the old format of the triggers, indexes, and views saved from step 3 above as a guide, making changes as appropriate for the alteration.*
+9. (Not applicable) *If any views refer to table X in a way that is affected by the schema change, then drop those views using DROP VIEW and recreate them with whatever changes are necessary to accommodate the schema change using CREATE VIEW.*
+10. If foreign key constraints were originally enabled then run PRAGMA foreign_key_check to verify that the schema change did not break any foreign key constraints.
+11. Commit the transaction started in step 2.
+12. (Not applicable) *If foreign keys constraints were originally enabled, reenable them now.*

docs/get-started.md

@@ -0,0 +1,116 @@
+# Setup
+
+If you want Docker, [please read this first.](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs/docker.md)
+
+If you get stuck, you're welcome to message [#out-of-your-element:cadence.moe](https://matrix.to/#/#out-of-your-element:cadence.moe) or [@cadence:cadence.moe](https://matrix.to/#/@cadence:cadence.moe) to ask for help setting up OOYE!
+
+You'll need:
+
+* Administrative access to a homeserver
+* Discord bot
+* Domain name for the bridge's website - [more info](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs/why-does-the-bridge-have-a-website.md)
+* Reverse proxy for that domain - an interactive process will help you set this up in step 5!
+
+Follow these steps:
+
+1. [Get Node.js version 22 or later](https://nodejs.org/en/download/prebuilt-installer). If you're on Linux, you may prefer to install through system's package manager, though Debian and Ubuntu have hopelessly out of date packages.
+
+1. Switch to a normal user account. (i.e. do not run any of the following commands as root or sudo.)
+
+1. Clone this repo and checkout a specific tag. (Development happens on main. Stable versions are tagged.)
+	* The latest release tag is ![](https://img.shields.io/gitea/v/release/cadence/out-of-your-element?gitea_url=https%3A%2F%2Fgitdab.com&style=flat-square&label=%20&color=black).
+
+1. Install dependencies: `npm install`
+
+1. Run `npm run setup` to check your setup and set the bot's initial state. You only need to run this once ever. This command will guide you precisely through the following steps:
+
+	* First, you'll be asked for information like your homeserver URL.
+
+	* Then you'll be prompted to set up a reverse proxy pointing from your domain to the bridge's web server. Sample configurations can be found at the end of this guide. It will check that the reverse proxy works before you continue.
+
+	* Then you'll need to provide information about your Discord bot, and you'll be asked to change some of its settings.
+
+	* Finally, a registration.yaml file will be generated, which you need to give to your homeserver. You'll be told how to do this. It will check that it's done properly.
+
+1. Start the bridge: `npm run start`
+
+## Update
+
+New versions are announced in [#updates](https://matrix.to/#/#ooye-updates:cadence.moe) and listed on [releases](https://gitdab.com/cadence/out-of-your-element/releases). Here's how to update:
+
+1. Fetch the repo and checkout the latest release tag.
+
+1. Install dependencies: `npm install`
+
+1. Restart the bridge: Stop the currently running process, and then start the new one with `npm run start`
+
+# Get Started
+
+Visit the website on the domain name you set up, and click the button to add the bot to your Discord server.
+
+* If you click the Easy Mode button, it will automatically create a Matrix room corresponding to each Discord channel. This happens next time a message is sent on Discord (so that your Matrix-side isn't immediately cluttered with lots of inactive rooms).
+
+* If you click the Self Service button, it won't create anything for you. You'll have to provide your own Matrix space and rooms. After you click, you'll be prompted through the process. Use this if you're migrating from another bridge!
+
+After that, to get into the rooms on your Matrix account, use the invite form on the website, or the `/invite [your mxid here]` command on Discord.
+
+I hope you enjoy Out Of Your Element!
+
+----
+<br><br><br><br><br>
+
+# Appendix
+
+## Example reverse proxy for nginx, dedicated domain name
+
+Replace `bridge.cadence.moe` with the hostname you're using.
+
+```nix
+server {
+	listen 80;
+	listen [::]:80;
+	server_name bridge.cadence.moe;
+
+	return 301 https://bridge.cadence.moe$request_uri;
+}
+
+server {
+	listen 443 ssl http2;
+	listen [::]:443 ssl http2;
+	server_name bridge.cadence.moe;
+
+	# ssl parameters here...
+	client_max_body_size 5M;
+
+	location / {
+		add_header Strict-Transport-Security "max-age=63072000; includeSubDomains" always;
+		proxy_pass http://127.0.0.1:6693;
+	}
+}
+```
+
+## Example reverse proxy for nginx, sharing a domain name
+
+Same as above, but change the following:
+
+- `location / {` -> `location /ooye/ {` (any sub-path you want; you MUST use a trailing slash or it won't work)
+- `proxy_pass http://127.0.0.1:6693;` -> `proxy_pass http://127.0.0.1:6693/;` (you MUST use a trailing slash on this too or it won't work)
+
+## Example reverse proxy for Caddy, dedicated domain name
+
+```nix
+bridge.cadence.moe {
+	log {
+		output file /var/log/caddy/access.log
+		format console
+	}
+	encode gzip
+	reverse_proxy 127.0.0.1:6693
+}
+```
+
+## Example reverse proxy for traefik
+
+Note: Out Of Your Element has no official Docker support. This guide is for using traefik when OOYE is ***not*** in a container.
+
+See [third-party/reverse-proxy-traefik.md](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs/third-party/reverse-proxy-traefik.md)

docs/how-to-add-a-new-event-type.md

@@ -32,13 +32,13 @@ What does it look like on Discord-side?
 
 This is an API request to get the pinned messages. To update this, an API request will pin or unpin any specific message, adding or removing it from the list.
 
-## What will the converter look like?
+## What will the converter do?
 
 The converter will be very different in both directions.
 
-For d2m, we will get the list of pinned messages, we will convert each message ID into the ID of an event we already have, and then we will set the entire `m.room.pinned_events` state to that list.
+**For d2m, we will get the list of pinned messages, we will convert each message ID into the ID of an event we already have, and then we will set the entire `m.room.pinned_events` state to that list.**
 
-For m2d, we will have to diff the list of pinned messages against the previous version of the list, and for each event that was pinned or unpinned, we will send an API request to Discord to change its state.
+**For m2d, we will have to diff the list of pinned messages against the previous version of the list, and for each event that was pinned or unpinned, we will send an API request to Discord to change its st**ate.
 
 ## Missing messages
 
@@ -53,7 +53,7 @@ In this situation we need to stop and think about the possible paths forward we
 
 The latter method would still make the message appear at the bottom of the timeline for most Matrix clients, since for most the timestamp doesn't determine the actual _order._ It would then be confusing why an odd message suddenly appeared, because a pins change isn't that noticable in the room.
 
-To avoid this problem, I'll just go with the former method and ignore the message, so Matrix will only have some of the pins that Discord has. We will need to watch out if a Matrix user edits this list of partial pins, because if we _only_ pinned things on Discord that were pinned on Matrix, those partial pins Discord would be lost from Discord side.
+To avoid this problem, I'll just go with the former method and ignore the message, so Matrix will only have some of the pins that Discord has. We will need to watch out if a Matrix user edits this list of partial pins, because if we _only_ pinned things on Discord that were pinned on Matrix, then pins Matrix doesn't know about would be lost from Discord side.
 
 In this situation I will prefer to keep the pins list inconsistent between both sides and only bridge _changes_ to the list.
 
@@ -61,7 +61,9 @@ If you were implementing this for real, you might have made different decisions
 
 ## Test data for the d2m converter
 
-Let's start writing the d2m converter. It's helpful to write unit tests for Out Of Your Element, since this lets you check if it worked without having to start up a local copy of the bridge or play around with the interface.
+Let's start writing the d2m converter. It's helpful to write automated tests for Out Of Your Element, since this lets you check if it worked without having to start up a local copy of the bridge or mess around with the interface.
+
+To test the Discord-to-Matrix pin converter, we'll need some samples of Discord message objects. Then we can put these sample message objects through the converter and check what comes out the other side.
 
 Normally for getting test data, I would `curl` the Discord API to grab some real data and put it into `data.js` (and possibly also `ooye-test-data.sql`. But this time, I'll fabricate some test data. Here it is:
 
@@ -74,7 +76,7 @@ Normally for getting test data, I would `curl` the Discord API to grab some real
 ]
 ```
 
-"These aren't message objects!" I hear you cry. Correct. I already know that my implementation is not going to care about any properties on these message object other than the IDs, so I'm just making a list of IDs to save time.
+"These aren't message objects!" I hear you cry. Correct. I already know that my implementation is not going to care about any properties on these message object other than the IDs, so to save time, I'm just making a list of IDs.
 
 These IDs were carefully chosen. The first three are already in `ooye-test-data.sql` and are associated with event IDs. This is great, because in our test case, the Discord IDs will be converted to those event IDs. The fourth ID doesn't exist on Matrix-side. This is to test that partial pins are handled as expected, like I wrote in the previous section.
 
@@ -104,7 +106,7 @@ index c36f252..4919beb 100644
 
 ## Writing the d2m converter
 
-We can write a function that operates on this data to convert it to events. This is a _converter,_ not an _action._ it won't _do_ anything by itself. So it goes in the converters folder. The actual function is pretty simple since I've already planned what to do:
+We can write a function that operates on this data to convert it to events. This is a _converter,_ not an _action._ It won't _do_ anything by itself. So it goes in the converters folder. I've already planned (in the "What will the converter do?" section) what to do, so writing the function is pretty simple:
 
 ```diff
 diff --git a/d2m/converters/pins-to-list.js b/d2m/converters/pins-to-list.js
@@ -133,9 +135,36 @@ index 0000000..e4107be
 +module.exports.pinsToList = pinsToList
 ```
 
+### Explaining the code
+
+All converters have a `function` which does the work, and the function is added to `module.exports` so that other files can use it.
+
+Importing `select` from `passthrough` lets us do database access. Calling the `select` function can select from OOYE's own SQLite database. If you want to see what's in the database, look at `ooye-test-data.sql` for test data, or open `ooye.db` for real data from your own bridge.
+
+The comments `// @ts-check`, `/** @type ... */`, and `/** @param ... */` provide type-based autosuggestions when editing in Visual Studio Code.
+
+Here's the code I haven't yet discussed:
+
+```js
+function pinsToList(pins) {
+	const result = []
+	for (const message of pins) {
+		const eventID = select("event_message", "event_id", {message_id: message.id}).pluck().get()
+		if (eventID) result.push(eventID)
+	}
+	return result
+}
+```
+
+It will go through each `message` in `pins`. For each message, it will look up the corresponding Matrix event in the database, and if found, it will add it to `result`.
+
+The `select` line will run this SQL: `SELECT event_id FROM event_message WHERE message_id = {the message ID}` and will return the event ID as a string or null.
+
+For any database experts worried about an SQL query inside a loop, the N+1 problem does not apply to SQLite because the queries are executed in the same process rather than crossing a process (and network) boundary. https://www.sqlite.org/np1queryprob.html
+
 ## Test case for the d2m converter
 
-There's not much room for bugs in this function. A single manual test that it works would be good enough for me. But since this is an example of how you can add your own, let's add a test case for this. We'll take the data we just prepared and process it through the function we just wrote:
+There's not much room for bugs in this function. A single manual test that it works would be good enough for me. But since this is an example of how you can add your own, let's add a test case for this. The testing code will take the data we just prepared and process it through the `pinsToList` function we just wrote. Then, it will check the result is what we expected.
 
 ```diff
 diff --git a/d2m/converters/pins-to-list.test.js b/d2m/converters/pins-to-list.test.js
@@ -177,6 +206,18 @@ index 5cc851e..280503d 100644
 
 Good to go.
 
+### Explaining the code
+
+`require("supertape")` is a library that helps with testing and printing test results. `data = require("../../test/data")` is the file we edited earlier in the "Test data for the d2m converter" section. `require("./pins-to-list")` is the function we want to test.
+
+Here is how you declare a test: `test("pins2list: converts known IDs, ignores unknown IDs", t => {` The string describes what you are trying to test and it will be displayed if the test fails.
+
+`result = pinsToList(data.pins.faked)` is calling the implementation function we wrote.
+
+`t.deepEqual(actual, expected)` will check whether the `actual` result value is the same as our `expected` result value. If it's not, it'll mark that as a failed test.
+
+### Run the test!
+
 ```
 ><> $ npm t
 
@@ -201,15 +242,19 @@ Good to go.
       at module.exports (out-of-your-element/node_modules/try-to-catch/lib/try-to-catch.js:7:29)
 ```
 
-Oh, this was actually an accident, I didn't make it fail for demonstration purposes! Let's see what this bug is. It's returning the right number of IDs, but 2 out of the 3 are incorrect. The green `-` lines are "expected" and the red `+` lines are "actual". I should check where that wrong ID `$51f...` got taken from.
+Oh no! (I promise I didn't make it fail for demonstration purposes, this was actually an accident!) Let's see what this bug is. It's returning the right number of IDs, but 2 out of the 3 are incorrect. The green `-` lines are "expected" and the red `+` lines are "actual". The wrong ID `$51f...` must have been taken from _somewhere_ in the test data, so I'll first search the codebase and find where it came from:
 
-```
+```sql
-  - snip - ooye-test-data.sql
+-- snipped from ooye-test-data.sql
 ('$mtR8cJqM4fKno1bVsm8F4wUVqSntt2sq6jav1lyavuA', 'm.room.message', 'm.text', '1141501302736695316', 0, 1),
 ('$51f4yqHinwnSbPEQ9dCgoyy4qiIJSX0QYYVUnvwyTCI', 'm.room.message', 'm.image', '1141501302736695316', 1, 1),
 ```
 
-Context: This Discord message `1141501302736695316` is actually part of 2 different Matrix events, `$mtR...` and `$51f...`. This often happens when a Discord user uploads an image with a caption. Matrix doesn't support combined image+text events, so the image and the text have to be bridged to separate events. We should consider the text to be the primary part, and pin that, and consider the image to be the secondary part, and not pin that.
+Explanation: This Discord message `1141501302736695316` is actually part of 2 different Matrix events, `$mtR...` and `$51f...`. This often happens when a Discord user uploads an image with a caption. Matrix doesn't support combined image+text events, so the image and the text have to be bridged to separate events.
+
+In the current code, `pinsToList` is picking ALL the associated event IDs, and then `.get` is forcing it to limit that list to 1. It doesn't care which, so it's essentially random which event it wants to pin.
+
+We should make a decision on which event is more important. You can make whatever decision you want - you could even make it pin every event associated with a message - but I've decided that the text should be the primary part and be pinned, and the image should be considered a secondary part and left unpinned.
 
 We already have a column `part` in the `event_message` table for this reason! When `part = 0`, that's the primary part. I'll edit the converter to actually use that column:
 
@@ -229,6 +274,8 @@ index e4107be..f401de2 100644
         return result
 ```
 
+As long as the database is consistent, this new `select` will return at most 1 event, always choosing the primary part.
+
 ```
 ><> $ npm t
 
@@ -269,7 +316,7 @@ index 83c31cd..4de84d9 100644
                                         await eventDispatcher.onThreadCreate(client, message.d)
 ```
 
-`event-dispatcher.js` will now check if the event seems reasonable and is allowed in this context. For example, we can only update pins if the channel is actually bridged somewhere. This should be another quick check which passes to an action to do the API calls:
+`event-dispatcher.js` will now check if the event seems reasonable and is allowed in this context. For example, we can only update pins if the channel is actually bridged somewhere. After the check, we'll call the action:
 
 ```diff
 diff --git a/d2m/event-dispatcher.js b/d2m/event-dispatcher.js
@@ -304,7 +351,7 @@ index 0f9f1e6..6e91e9e 100644
          * @param {DiscordTypes.GatewayMessageCreateDispatchData} message
 ```
 
-And now I can create the `update-pins.js` action:
+And now I can write the `update-pins.js` action:
 
 ```diff
 diff --git a/d2m/actions/update-pins.js b/d2m/actions/update-pins.js
@@ -339,6 +386,76 @@ index 0000000..40cc358
 
 I try to keep as much logic as possible out of the actions and in the converters. This should mean I *never have to unit test the actions themselves.* The actions will be tested manually with the real bot.
 
+## See if it works
+
+Since the automated tests pass, let's start up the bridge and run our nice new code:
+
+```
+node start.js
+```
+
+We can try these things and see if they are bridged to Matrix:
+
+- Pin a recent message on Discord-side
+- Pin an old message on Discord-side
+- Unpin a message on Discord-side
+
+It works like I'd expect!
+
+## Order of pinned messages
+
+I expected that to be the end of the guide, but after some time, I noticed a new problem: The pins are in reverse order. How could this happen?
+
+[After some investigation,](https://gitdab.com/cadence/out-of-your-element/issues/16) it turns out Discord puts the most recently pinned message at the start of the array and displays the array in forwards order, while Matrix puts the most recently pinned message at the end of the array and displays the array in reverse order.
+
+We can fix this by reversing the order of the list of pins before we store it. The converter can do this:
+
+```diff
+diff --git a/d2m/converters/pins-to-list.js b/d2m/converters/pins-to-list.js
+index f401de2..047bb9f 100644
+--- a/d2m/converters/pins-to-list.js
++++ b/d2m/converters/pins-to-list.js
+@@ -12,6 +12,7 @@ function pinsToList(pins) {
+                const eventID = select("event_message", "event_id", {message_id: message.id, part: 0}).pluck().get()
+                if (eventID) result.push(eventID)
+        }
++       result.reverse()
+        return result
+ }
+```
+
+Since the results have changed, I'll need to update the test so it expects the new result:
+
+```diff
+diff --git a/d2m/converters/pins-to-list.test.js b/d2m/converters/pins-to-list.test.js
+index c2e3774..92e5678 100644
+--- a/d2m/converters/pins-to-list.test.js
++++ b/d2m/converters/pins-to-list.test.js
+@@ -5,8 +5,8 @@ const {pinsToList} = require("./pins-to-list")
+ test("pins2list: converts known IDs, ignores unknown IDs", t => {
+        const result = pinsToList(data.pins.faked)
+        t.deepEqual(result, [
+-               "$X16nfVks1wsrhq4E9SSLiqrf2N8KD0erD0scZG7U5xg",
+-               "$mtR8cJqM4fKno1bVsm8F4wUVqSntt2sq6jav1lyavuA",
+-               "$lnAF9IosAECTnlv9p2e18FG8rHn-JgYKHEHIh5qdFv4"
++               "$lnAF9IosAECTnlv9p2e18FG8rHn-JgYKHEHIh5qdFv4",
++               "$mtR8cJqM4fKno1bVsm8F4wUVqSntt2sq6jav1lyavuA",
++               "$X16nfVks1wsrhq4E9SSLiqrf2N8KD0erD0scZG7U5xg"
+        ])
+ })
+```
+
+```
+><> $ npm t
+
+  144 tests
+  232 passed
+
+  Pass!
+```
+
+Next time a message is pinned or unpinned on Discord, OOYE should update the order of all the pins on Matrix.
+
 ## Notes on missed events
 
 Note that this will only sync pins _when the pins change._ Existing pins from Discord will not be backfilled to Matrix rooms. If I wanted, there's a couple of ways I could address this:
@@ -346,4 +463,4 @@ Note that this will only sync pins _when the pins change._ Existing pins from Di
 * I could create a one-shot script in `scripts/update-pins.js` which will sync pins for _all_ Discord channels right away. I can run this after finishing the feature, or if the bot has been offline for some time.
 * I could create a database table that holds the timestamp of the most recently detected pin for each channel - the `last_pin_timestamp` field from the gateway. Every time the bot starts, it would automatically compare the database table against every channel, and if the pins have changed since it last looked, it could automatically update them.
 
-I already have a mechanism for backfilling missed messages when the bridge starts up. Option 2 there would add a similar feature for backfilling missed pins. That could be worth considering, but it's less important and more complex. Perhaps we'll come back to it.
+I already have code to backfill missed messages when the bridge starts up. The second option above would add a similar feature for backfilling missed pins. It would be worth considering.

docs/pluralkit-notetaking.md

@@ -0,0 +1,98 @@
+## What is PluralKit
+
+PluralKit is a Discord bot. After a Discord user registers with PK, PK will delete and repost their messages. The reposted messages will be sent by a webhook with a custom display name and avatar. This effectively lets a person assume a custom display name and avatar at will on a per-message basis. People use this for roleplaying and/or dissociative-identity-disorder things. PK is extremely popular.
+
+## PK terminology
+
+- **Proxying:** The act of deleting and reposting messages.
+- **Member:** Identity that messages will be posted by.
+- **System:** Systems contain members. A system is usually controlled by one Discord account, but it's also possible to have multiple accounts be part of the same system.
+
+## PK API schema
+
+https://pluralkit.me/api/models/
+
+## Experience on OOYE without special PK handling
+
+1. Message is sent by Discord user and copied to Matrix-side.
+1. The message is immediately deleted by PK and deleted from Matrix-side.
+1. The message is resent by the PK webhook and copied to Matrix-side (by @_ooye_bot) with limited authorship information.
+
+## Experience on Half-Shot's bridge without special PK handling
+
+1. Message is sent by Discord user and copied to Matrix-side.
+1. The message is immediately deleted by PK and deleted from Matrix-side.
+1. The message is resent by the PK webhook and copied to Matrix-side _by a dedicated sim user for that webhook's username._
+
+If a PK system member changes their display name, the webhook display name will change too. But Half-Shot's bridge can't keep track of webhook message authorship. It uses the webhook's display name to determine whether to reuse the previous sim user account. This makes Half-Shot's bridge create a brand new sim user for the same system member, and causes the Matrix-side member list to eventually fill up with lots of abandoned sim users named @_discord_NUMBERS_NUMBERS_GARBLED_NAME.
+
+## Goals of special PK handling
+
+1. Avoid bridging the send-delete-send dance (solution: the speedbump)
+2. Attribute message authorship to the actual PK system member (solution: system member mapping)
+3. Avoid creating too many sim users (solution: OOYE sending other webhook messages as @_ooye_bot)
+
+## What is the speedbump (goal 1)
+
+When a Discord user sends a message, we can't know whether or not it's about to be deleted by PK.
+
+If PK doesn't plan to delete the message, we should deliver it straight away to Matrix-side.
+
+But if PK does plan to delete the message, we shouldn't bridge it at all. We should wait until the PK webhook sends the replacement message, then deliver _that_ message to Matrix-side.
+
+Unfortunately, we can't see into the future. We don't know if PK will delete the message or not.
+
+My solution is the speedbump. In speedbump-enabled channels, OOYE will wait a few seconds before delivering the message. The **purpose of the speedbump is to avoid the send-delete-send dance** by not bridging a message until we know it's supposed to stay.
+
+## Configuring the speedbump
+
+Nuh-uh. Offering configuration creates an opportunity for misconfiguration. OOYE wants to act in the best possible way with the default settings. In general, everything in OOYE should work in an intelligent, predictable way without having to think about it.
+
+Since it slows down messages, the speedbump has a negative impact on user experience if it's not needed. So OOYE will automatically activate and deactivate the speedbump if it's necessary. Here's how it works.
+
+When a message is deleted in a channel, the following logic is triggered:
+
+1. Discord API: Get the list of webhooks in this channel.
+1. If there is a webhook owned by PK, speedbump mode is now ON. Otherwise, speedbump mode is now OFF.
+
+This check is only done every so often to avoid encountering the Discord API's rate limits.
+
+## PK system member mapping (goal 2)
+
+PK system members need to be mapped to individual Matrix sim users, so we need to map the member data to all the fields of a Matrix profile. (This will replace the existing logic of `userToSimName`.) I'll map them in this way:
+
+- **Matrix ID:** `@_ooye_pk_[FIVE_CHAR_ID].example.org`
+- **Display name:** `[NAME] [[PRONOUNS]]`
+- **Avatar:** webhook_avatar_url ?? avatar_url
+
+I'll get this data by calling the PK API for each message: https://api.pluralkit.me/v2/messages/[PK_WEBHOOK_MESSAGE_ID]
+
+## Special code paths for PK users
+
+When a message is deleted, re-evaluate speedbump mode if necessary, and store who the PK webhook is for this channel if exists.
+
+When a message is received and the speedbump is enabled, put it into a queue to be sent a few seconds later.
+
+When a message is deleted, remove it from the queue.
+
+When a message is received, if it's from a webhook, and the webhook is in the "speedbump_webhook" table, and the webhook user ID is the public PK instance, then look up member details in the PK API, and use a different MXID mapping algorithm based on those details.
+
+### Edits should Just Work without any special code paths
+
+Proxied messages are edited by sending "pk;edit blah blah" as a reply to the message to edit. PK will delete the edit command and use the webhook edit endpoint to update the message.
+
+OOYE's speedbump will prevent the edit command appearing at all on Matrix-side, and OOYE already understands how to do webhook edits.
+
+## Database schema
+
+* channel_room
+	+ speedbump_id - the ID of the webhook that may be proxying in this channel
+	+ speedbump_checked - time in unix seconds when the webhooks were last queried
+
+## Unsolved problems
+
+- Improve the contents of PK's reply embeds to be the actual reply text, not the OOYE context preamble
+- Possibly change OOYE's reply context to be an embed (for visual consistency with replies from PK users)
+- Possibly extract information from OOYE's reply embed and transform it into an mx-reply structure for Matrix users
+- Unused or removed system members should be removed from the member list too.
+- When a Discord user leaves a server, all their system members should leave the member list too. (I also have to solve this for regular non-PK users.)

docs/room-upgrades.md

@@ -0,0 +1,80 @@
+# Room upgrades
+
+"Upgrading" a room is supposed to create a new room and then tries to set it up exactly like the old one. So it copies name, topic, power levels, space membership, etc. The old room is marked as old with an `m.room.tombstone` event, its power levels are adjusted to make it harder to send messages, and a hyperlink to the new room is added.
+
+## What happens?
+
+A room upgrade is triggered by a POST request to `/_matrix/client/v3/rooms/{roomId}/upgrade`. The upgrade process is done by the server, and involves multiple events across multiple rooms. Since this is server-specific, what will _actually_ happen depends on the server's implementation, but the spec says it does this:
+
+1. Checks that the user has permission to send `m.room.tombstone` events in the room.
+2. Creates a replacement room with a `m.room.create` event containing a predecessor field, the applicable `room_version`, and a `type` field which is copied from the predecessor room. If no `type` is set on the previous room, no `type` is specified on the new room’s create event either.
+3. Replicates transferable state events to the new room. The exact details for what is transferred is left as an implementation detail, however the recommended state events to transfer are:
+	* `m.room.server_acl`
+	* `m.room.encryption`
+	* `m.room.name`
+	* `m.room.avatar`
+	* `m.room.topic`
+	* `m.room.guest_access`
+	* `m.room.history_visibility`
+	* `m.room.join_rules`
+	* `m.room.power_levels`
+
+	(Membership can't be transferred by the server.)
+
+4. Moves any local aliases to the new room.
+5. Sends a `m.room.tombstone` event to the old room to indicate that it is not intended to be used any further.
+6. If possible, the power levels in the old room should also be modified to prevent sending of events and inviting new users. For example, setting `events_default` and `invite` to the greater of `50` and `users_default + 1`.
+
+### Synapse additionally:
+
+1. Copies its `m.space.child` events (if it was a space).
+	* This is good for OOYE, because it automatically tries to join new rooms when they're added to a registered space.
+2. Copies bans.
+3. Un/publishes to the public room directory as applicable.
+4. Copies user tags and push rules.
+
+Conduwuit does not do those!
+
+### Element additionally:
+
+1. May invite all users from the old room to the new room, depending on if the checkbox is checked in the dialog.
+2. Update parent spaces to remove the old room and add the new room.
+
+Cinny does not do those! The new room is totally detached! The hyperlink from the old room (and the moved alias by server) is the only way to find it!
+
+* This is probably still okay for OOYE? Since the join rules are preserved, and if they were `restricted`, OOYE is able to join via the tombstone hyperlink. Then, after it joins, it's already PL 100 since the power levels are preserved. It's very bad if the join rules were `invite`, but OOYE never sets this join rule - it's either `restricted` or `public`.
+
+### Other clients
+
+Nheko doesn't support room upgrades at all. Cinyy, NeoChat and FluffyChat just call the API and don't do anything. FluffyChat invites all joined/invited users to the new room if the join rule is restricted.
+
+### Notable things that don't happen at all:
+
+* Add `m.space.parent` pointing to the space it was in (if it was a room in a space).
+
+## What should OOYE do?
+
+### Ideal case (Element, Synapse)
+
+The new room is added to the space and OOYE autojoins it. It already has the correct power levels and join rules.
+
+OOYE still needs to do this:
+
+1. Un/set `m.room.parent` in the rooms.
+2. Update `channel_room` and `historical_channel_room` tables.
+
+### Not ideal case (everyone else)
+
+OOYE should:
+
+1. Join the room by following the hyperlink from the tombstone, if able
+	* If not able, somebody messed with the join rules. Send a PM to the user who upgraded - the new room's creator - asking for an invite.
+2. Wait for join.
+3. Un/set `m.space.child` events on the space.
+4. Un/set `m.room.parent` in the rooms.
+5. Update `channel_room` and `historical_channel_room` tables.
+6. Un/publish to the room directory.
+
+### It's actually fine to do all the steps always
+
+Even by blindly following the entire list, each step is a no-op or atomic, so it doesn't matter if Element is also trying to do them.

docs/self-service-room-creation-rules.md

@@ -0,0 +1,77 @@
+# Self-service room creation rules
+
+Before version 3 of Out Of Your Element, new Matrix rooms would be created on-demand when a Discord channel is spoken in for the first time. This has worked pretty well.
+
+This is done through functions like ensureRoom and ensureSpace in actions:
+
+```js
+async function sendMessage(message, channel, guild, row) {
+	const roomID = await createRoom.ensureRoom(message.channel_id)
+	...
+}
+
+/**
+ * Ensures the room exists. If it doesn't, creates the room with an accurate initial state.
+ * @param {string} channelID
+ * @returns {Promise<string>} Matrix room ID
+ */
+function ensureRoom(channelID) {
+	return _syncRoom(channelID, /* shouldActuallySync */ false) /* calls ensureSpace */
+}
+
+/**
+ * Ensures the space exists. If it doesn't, creates the space with an accurate initial state.
+ * @param {DiscordTypes.APIGuild} guild
+ * @returns {Promise<string>} Matrix space ID
+ */
+function ensureSpace(guild) {
+	return _syncSpace(guild, /* shouldActuallySync */ false)
+}
+```
+
+With the introduction of self-service mode, we still want to retain this as a possible mode of operation, since some people prefer to have OOYE handle this administrative work. However, other people prefer to manage the links between channels and rooms themselves, and have control over what new rooms get linked up to.
+
+Visibly, this is managed through the web interface. The web interface lets moderators enable/disable auto-creation of new rooms, as well as set which channels and rooms are linked together.
+
+There is a small complication. Not only are Matrix rooms created automatically, their Matrix spaces are also created automatically during room sync: ensureRoom calls ensureSpace. If a user opts in to self-service mode by clicking the specific button in the web portal, we must ensure the _space is not created automatically either,_ because the Matrix user will provide a space to link to.
+
+To solve this, we need a way to suppress specific guilds from having auto-created spaces. The natural way to represent this is a column on guild_space, but that doesn't work, because each guild_space row requires a guild and space to be linked, and we _don't want_ them to be linked.
+
+So, internally, OOYE keeps track of this through a new table:
+
+```sql
+CREATE TABLE "guild_active" (
+	"guild_id"	TEXT NOT NULL, -- only guilds that are bridged are present in this table
+	"autocreate"	INTEGER NOT NULL, -- 0 or 1
+	PRIMARY KEY("guild_id")
+) WITHOUT ROWID;
+```
+
+There is one more complication. When adding a Discord bot through web oauth with a redirect_uri, Discord adds the bot to the server normally, _then_ redirects back to OOYE, and only then does OOYE know which guild the bot was just added to. So, for a short time between the bot being added and the user being redirected, OOYE might receive Discord events in the server before it has the chance to create the guild_active database row.
+
+So to prevent this, self-service behaviour needs to be an implicit default, and users must firmly choose one system or another to begin using OOYE. It is important for me to design this in a way that doesn't force users to do any extra work or make a choice they don't understand to keep the pre-v3 behaviour.
+
+So there will be 3 states of whether a guild is self-service or not. At first, it could be absent from the table, in which case events for it will be dropped. Or it could be in the table with autocomplete = 0, in which case only rooms that already exist in channel_room will have messages bridged. Or it could have autocomplete = 1, in which case Matrix rooms will be created as needed, as per the pre-v3 behaviour.
+
+| Auto-create | Meaning                  |
+| --          | ------------             |
+| 😶‍🌫️         | Unbridged - waiting      |
+| ❌         | Bridged - self-service   |
+| ✅         | Bridged - auto-create    |
+
+Pressing buttons on web or using the /invite command on a guild will insert a row into guild_active, allowing it to be bridged.
+
+So here's all the technical changes needed to support self-service in v3:
+
+- New guild_active table showing whether, and how, a guild is bridged.
+- When /invite command is used, INSERT OR IGNORE INTO state 1 and ensureRoom + ensureSpace.
+- When bot is added through "easy mode" web button, REPLACE INTO state 1 and ensureSpace.
+- When bot is added through "self-service" web button, REPLACE INTO state 0.
+- Event dispatcher will only ensureRoom if the guild_active state is 1.
+- createRoom will only create other dependencies if the guild is autocreate.
+
+## Enough with your theory. How do rooms actually get bridged now?
+
+After clicking the easy mode button on web and adding the bot to a server, it will create new Matrix rooms on-demand when any invite features are used (web or command) OR just when any message is sent on Discord.
+
+Alternatively, pressing the self-service mode button and adding the bot to a server will prompt the web user to link it with a space. After doing so, they'll be on the standard guild management page where they can invite to the space and manually link rooms. Nothing will be autocreated.

docs/third-party/reverse-proxy-traefik.md

@@ -0,0 +1,113 @@
+> This guide was written by @bgtlover:stealthy.club, a community contributor. The author of Out Of Your Element hopes it will be useful, but cannot say whether the information is accurate or complete.
+
+## Example reverse proxy configuration with traefik
+
+Note: This guide describes setting up the reverse proxy configuration when OOYE is ***not*** in a Docker container.
+
+Because traefik is generally used in Docker, this guide assumes the user already has it configured properly. However, given that Docker is very complex and the smallest mistakes can cascade in catastrophic, not immediately observable, and unpredictable ways, a fairly complete setup will be reproduced. Therefore, system administrators are advised to diff this sample setup against theirs rather than copy it wholesale.
+
+### Note on variable substitution
+
+Variables will be denoted as `{{var}}`. This syntax has been chosen because that's also how YAML substitution works. The values that fit each variable will be explained after the code block containing the placeholder.
+
+### Base compose configuration for traefik
+
+This file defines the traefik service stack. It's responsible for mounting volumes correctly, declaring ports that should be opened on the host side, and the external traefik network (created manually).
+
+In compose.yml, put the following:
+
+```yaml
+services:
+  traefik:
+    image: "traefik:latest"
+    restart: always
+    command:
+      - "--configFile=/etc/traefik/static_config.yml"
+    ports:
+      - "80:80"   #http
+      - "443:443" #https
+    networks:
+      - traefik
+    volumes:
+      - ./letsencrypt:/letsencrypt
+      - /etc/localtime:/etc/localtime:ro
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+      - ./static_config.yml:/etc/traefik/static_config.yml
+      - ./config:/etc/traefik/config
+networks:
+  traefik:
+    external: true
+```
+
+### Static traefik configuration
+
+The static traefik configuration is used to define base traefik behavior, for example entry points, access and runtime logs, a file or directory for per-service configuration, etc.
+
+In static_config.yml, put the following:
+
+```yaml
+api:
+  dashboard: true
+
+providers:
+  docker:
+    endpoint: "unix:///var/run/docker.sock"
+    exposedByDefault: false
+    network: "traefik"
+  file:
+    directory: /etc/traefik/config/
+    watch: true
+
+entryPoints:
+  web-secure:
+    address: ":443"
+    asDefault: true
+    http3: {}
+    http:
+      tls:
+        certResolver: default
+  web:
+    address: ":80"
+    http:
+      redirections:
+        entryPoint:
+          to: web-secure
+
+certificatesResolvers:
+  default:
+    acme:
+      email: {{email}}
+      storage: "/letsencrypt/acme.json"
+      tlsChallenge: {}
+
+```
+
+Replace `{{email}}` with a valid email address.
+
+### Out of your element traefik dynamic configuration
+
+Traefik's dynamic configuration files configure proxy behaviors on a per-application level.
+
+In config/out-of-your-element.yml, put the following:
+
+```yaml
+http:
+  routers:
+    out-of-your-element:
+      rule: Host(`bridge.stealthy.club`)
+      service: out-of-your-element-service
+  services:
+    out-of-your-element-service:
+      loadBalancer:
+        servers:
+          - url: "http://{{ip}}:{{port}}"
+
+```
+
+The `{{port}}` is 6693 unless you changed it during Out Of Your Element's first time setup.
+
+Replace `{{ip}}` with the ***external*** IP of your server.
+
+Make sure the port is allowed through your firewall if applicable.
+
+For context, the external IP is required because of Docker networking. Because Docker modifies the host-side iptables firewall and creates virtual interfaces for its networks, and because the networking inside containers is configured such that localhost points to the IP of the container instead of the actual host, placing localhost in the url field above would make the traefik container establish an HTTP connection to itself, which would cause a bad gateway error.

docs/why-does-the-bridge-have-a-website.md

@@ -0,0 +1,55 @@
+# Why does the bridge have a website?
+
+## It's essential for making images work
+
+Matrix has a feature called [Authenticated Media](https://matrix.org/blog/2024/06/26/sunsetting-unauthenticated-media/), where uploaded media (like user avatars and uploaded files) is restricted to Matrix users only. This means Discord users wouldn't be able to see important parts of the conversation.
+
+To keep things working for Discord users, OOYE's web server can act as a proxy files that were uploaded on Matrix-side. This will automatically take effect when needed, so Discord users shouldn't notice any issues.
+
+## Why now?
+
+I knew a web interface had a lot of potential, but I was reluctant to add one because it would make the initial setup more complicated. However, when authenticated media forced my hand, I saw an opportunity to introduce new useful features. Hopefully you'll agree that it's worth it!
+
+# What else does it do?
+
+## Makes it easy to invite the bot
+
+The home page of the website has buttons to add the bridge bot to a Discord server. If you are primarly a Matrix user and you want somebody else (who may be less technical) to add the bot to their own Discord server, this should make it a lot more intuitive for them.
+
+## Makes it easy to invite yourself or others
+
+After your hypothetical less-technical friend adds the bot to their Discord server, you need to generate an invite for your Matrix account on Matrix-side. Without the website, you might need to guide them through running a /invite command with your user ID. With the website, they don't have to do anything extra. You can use your phone to scan the QR code on their screen, which lets you invite your user ID in your own time.
+
+You can also set the person's permissions when you invite them, so you can easily bootstrap the Matrix side with your trusted ones as moderators.
+
+## To link channels and rooms
+
+Without a website, to link Discord channels to existing Matrix rooms, you'd need to run a /link command with the internal IDs of each room. This is tedious and error-prone, especially if you want to set up a lot of channels. With the web interface, you can see a list of all the available rooms and click them to link them together.
+
+## To change settings
+
+Important settings, like whether the Matrix rooms should be private or publicly accessible, can be configured by clicking buttons rather than memorising commands. Changes take effect immediately.
+
+# Permissions
+
+## Bot invites
+
+Anybody who can access the home page can use the buttons to add your bot - but even without the website, they can already do this by manually constructing a URL. If you want to make it so _only you_ can add your bot to servers, you need to edit [your Discord application](https://discord.com/developers/applications), go to the Bot section, and turn off the switch that says Public Bot.
+
+## Server settings
+
+If you have either the Administrator or Manage Server permissions in a Discord server, you can use the website to manage that server, including linking channels and changing settings.
+
+# Initial setup
+
+The website is built in to OOYE and is always running as part of the bridge. For authenticated media proxy to work, you'll need to make the web server accessible on the public internet over HTTPS, presumably using a reverse proxy.
+
+When you use `npm run setup` as part of OOYE's initial setup, it will guide you through this process, and it will do a thorough self-test to make sure it's configured correctly. If you get stuck or want a configuration template, check the notes below.
+
+## Reverse proxy
+
+When OOYE is running, the web server runs on port 6693. (To use a different port or a UNIX socket, edit registration.yaml's `socket` setting and restart.)
+
+It doesn't have to have its own dedicated domain name, you can also use a sub-path on an existing domain, like the domain of your Matrix homeserver. You are likely already using a reverse proxy to run your homeserver, so this should just be a configuration change.
+
+[See here for sample configurations!](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs/get-started.md#appendix)

jsconfig.json

@@ -0,0 +1,10 @@
+{
+	"compilerOptions": {
+		"target": "es2024",
+		"module": "nodenext",
+		"lib": ["ESNext"],
+		"strict": true,
+		"noImplicitAny": false,
+		"useUnknownInCatchVariables": false
+	}
+}

m2d/actions/add-reaction.js

@@ -1,31 +0,0 @@
-// @ts-check
-
-const assert = require("assert").strict
-const Ty = require("../../types")
-
-const passthrough = require("../../passthrough")
-const {discord, sync, db, select} = passthrough
-/** @type {import("../converters/utils")} */
-const utils = sync.require("../converters/utils")
-/** @type {import("../converters/emoji")} */
-const emoji = sync.require("../converters/emoji")
-
-/**
- * @param {Ty.Event.Outer<Ty.Event.M_Reaction>} event
- */
-async function addReaction(event) {
-	const channelID = select("channel_room", "channel_id", {room_id: event.room_id}).pluck().get()
-	if (!channelID) return // We just assume the bridge has already been created
-	const messageID = select("event_message", "message_id", {event_id: event.content["m.relates_to"].event_id}, "ORDER BY reaction_part").pluck().get()
-	if (!messageID) return // Nothing can be done if the parent message was never bridged.
-
-	const key = event.content["m.relates_to"].key
-	const discordPreferredEncoding = emoji.encodeEmoji(key, event.content.shortcode)
-	if (!discordPreferredEncoding) return
-
-	await discord.snow.channel.createReaction(channelID, messageID, discordPreferredEncoding) // acting as the discord bot itself
-
-	db.prepare("REPLACE INTO reaction (hashed_event_id, message_id, encoded_emoji) VALUES (?, ?, ?)").run(utils.getEventIDHash(event.event_id), messageID, discordPreferredEncoding)
-}
-
-module.exports.addReaction = addReaction

m2d/actions/redact.js

@@ -1,42 +0,0 @@
-// @ts-check
-
-const assert = require("assert").strict
-const Ty = require("../../types")
-
-const passthrough = require("../../passthrough")
-const {discord, sync, db, select, from} = passthrough
-/** @type {import("../converters/utils")} */
-const utils = sync.require("../converters/utils")
-
-/**
- * @param {Ty.Event.Outer_M_Room_Redaction} event
- */
-async function deleteMessage(event) {
-	const rows = from("event_message").join("message_channel", "message_id").select("channel_id", "message_id").where({event_id: event.redacts}).all()
-	for (const row of rows) {
-		discord.snow.channel.deleteMessage(row.channel_id, row.message_id, event.content.reason)
-	}
-}
-
-/**
- * @param {Ty.Event.Outer_M_Room_Redaction} event
- */
-async function removeReaction(event) {
-	const hash = utils.getEventIDHash(event.redacts)
-	// TODO: this works but fix the type
-	const row = from("reaction").join("message_channel", "message_id").select("channel_id", "message_id", "encoded_emoji").where({hashed_event_id: hash}).get()
-	if (!row) return
-	await discord.snow.channel.deleteReactionSelf(row.channel_id, row.message_id, row.encoded_emoji)
-	db.prepare("DELETE FROM reaction WHERE hashed_event_id = ?").run(hash)
-}
-
-/**
- * Try everything that could possibly be redacted.
- * @param {Ty.Event.Outer_M_Room_Redaction} event
- */
-async function handle(event) {
-	await deleteMessage(event)
-	await removeReaction(event)
-}
-
-module.exports.handle = handle

m2d/actions/send-event.js

@@ -1,113 +0,0 @@
-// @ts-check
-
-const Ty = require("../../types")
-const DiscordTypes = require("discord-api-types/v10")
-const {Readable} = require("stream")
-const assert = require("assert").strict
-const crypto = require("crypto")
-const fetch = require("node-fetch").default
-const passthrough = require("../../passthrough")
-const {sync, discord, db, select} = passthrough
-
-/** @type {import("./channel-webhook")} */
-const channelWebhook = sync.require("./channel-webhook")
-/** @type {import("../converters/event-to-message")} */
-const eventToMessage = sync.require("../converters/event-to-message")
-/** @type {import("../../matrix/api")}) */
-const api = sync.require("../../matrix/api")
-
-/**
- * @param {DiscordTypes.RESTPostAPIWebhookWithTokenJSONBody & {files?: {name: string, file: Buffer | Readable}[], pendingFiles?: ({name: string, url: string} | {name: string, url: string, key: string, iv: string} | {name: string, buffer: Buffer | Readable})[]}} message
- * @returns {Promise<DiscordTypes.RESTPostAPIWebhookWithTokenJSONBody & {files?: {name: string, file: Buffer | Readable}[]}>}
- */
-async function resolvePendingFiles(message) {
-	if (!message.pendingFiles) return message
-	const files = await Promise.all(message.pendingFiles.map(async p => {
-		if ("buffer" in p) {
-			return {
-				name: p.name,
-				file: p.buffer
-			}
-		}
-		if ("key" in p) {
-			// Encrypted file
-			const d = crypto.createDecipheriv("aes-256-ctr", Buffer.from(p.key, "base64url"), Buffer.from(p.iv, "base64url"))
-			// @ts-ignore
-			fetch(p.url).then(res => res.body.pipe(d))
-			return {
-				name: p.name,
-				file: d
-			}
-		} else {
-			// Unencrypted file
-			/** @type {Readable} */ // @ts-ignore
-			const body = await fetch(p.url).then(res => res.body)
-			return {
-				name: p.name,
-				file: body
-			}
-		}
-	}))
-	const newMessage = {
-		...message,
-		files: files.concat(message.files || [])
-	}
-	delete newMessage.pendingFiles
-	return newMessage
-}
-
-/** @param {Ty.Event.Outer_M_Room_Message | Ty.Event.Outer_M_Room_Message_File | Ty.Event.Outer_M_Sticker} event */
-async function sendEvent(event) {
-	const row = select("channel_room", ["channel_id", "thread_parent"], {room_id: event.room_id}).get()
-	if (!row) return // allow the bot to exist in unbridged rooms, just don't do anything with it
-	let channelID = row.channel_id
-	let threadID = undefined
-	if (row.thread_parent) {
-		threadID = channelID
-		channelID = row.thread_parent // it's the thread's parent... get with the times...
-	}
-	// @ts-ignore
-	const guildID = discord.channels.get(channelID).guild_id
-	const guild = discord.guilds.get(guildID)
-	assert(guild)
-
-	// no need to sync the matrix member to the other side. but if I did need to, this is where I'd do it
-
-	let {messagesToEdit, messagesToSend, messagesToDelete} = await eventToMessage.eventToMessage(event, guild, {api})
-
-	messagesToEdit = await Promise.all(messagesToEdit.map(async e => {
-		e.message = await resolvePendingFiles(e.message)
-		return e
-	}))
-	messagesToSend = await Promise.all(messagesToSend.map(message => {
-		return resolvePendingFiles(message)
-	}))
-
-	let eventPart = 0 // 0 is primary, 1 is supporting
-
-	/** @type {DiscordTypes.APIMessage[]} */
-	const messageResponses = []
-	for (const data of messagesToEdit) {
-		const messageResponse = await channelWebhook.editMessageWithWebhook(channelID, data.id, data.message, threadID)
-		eventPart = 1
-		messageResponses.push(messageResponse)
-	}
-
-	for (const id of messagesToDelete) {
-		await channelWebhook.deleteMessageWithWebhook(channelID, id, threadID)
-	}
-
-	for (const message of messagesToSend) {
-		const reactionPart = messagesToEdit.length === 0 && message === messagesToSend[messagesToSend.length - 1] ? 0 : 1
-		const messageResponse = await channelWebhook.sendMessageWithWebhook(channelID, message, threadID)
-		db.prepare("REPLACE INTO message_channel (message_id, channel_id) VALUES (?, ?)").run(messageResponse.id, threadID || channelID)
-		db.prepare("INSERT INTO event_message (event_id, event_type, event_subtype, message_id, part, reaction_part, source) VALUES (?, ?, ?, ?, ?, ?, 0)").run(event.event_id, event.type, event.content["msgtype"] || null, messageResponse.id, eventPart, reactionPart) // source 0 = matrix
-
-		eventPart = 1
-		messageResponses.push(messageResponse)
-	}
-
-	return messageResponses
-}
-
-module.exports.sendEvent = sendEvent

m2d/converters/emoji-sheet.js

@@ -1,104 +0,0 @@
-// @ts-check
-
-const assert = require("assert").strict
-const {pipeline} = require("stream").promises
-const sharp = require("sharp")
-const {GIFrame} = require("giframe")
-const utils = require("./utils")
-const fetch = require("node-fetch").default
-const streamMimeType = require("stream-mime-type")
-
-const SIZE = 48
-const RESULT_WIDTH = 400
-const IMAGES_ACROSS = Math.floor(RESULT_WIDTH / SIZE)
-
-/**
- * Composite a bunch of Matrix emojis into a kind of spritesheet image to upload to Discord.
- * @param {string[]} mxcs mxc URLs, in order
- * @returns {Promise<Buffer>} PNG image
- */
-async function compositeMatrixEmojis(mxcs) {
-	let buffers = await Promise.all(mxcs.map(async mxc => {
-		const abortController = new AbortController()
-
-		try {
-			const url = utils.getPublicUrlForMxc(mxc)
-			assert(url)
-
-			/** @type {import("node-fetch").Response} res */
-			// If it turns out to be a GIF, we want to abandon the connection without downloading the whole thing.
-			// If we were using connection pooling, we would be forced to download the entire GIF.
-			// So we set no agent to ensure we are not connection pooling.
-			// @ts-ignore the signal is slightly different from the type it wants (still works fine)
-			const res = await fetch(url, {agent: false, signal: abortController.signal})
-			const {stream, mime} = await streamMimeType.getMimeType(res.body)
-
-			if (mime === "image/png" || mime === "image/jpeg" || mime === "image/webp") {
-				/** @type {{info: sharp.OutputInfo, buffer: Buffer}} */
-				const result = await new Promise((resolve, reject) => {
-					const transformer = sharp()
-						.resize(SIZE, SIZE, {fit: "contain", background: {r: 0, g: 0, b: 0, alpha: 0}})
-						.png({compressionLevel: 0})
-						.toBuffer((err, buffer, info) => {
-							/* c8 ignore next */
-							if (err) return reject(err)
-							resolve({info, buffer})
-						})
-					pipeline(
-						stream,
-						transformer
-					)
-				})
-				return result.buffer
-
-			} else if (mime === "image/gif") {
-				const giframe = new GIFrame(0)
-				stream.on("data", chunk => {
-					giframe.feed(chunk)
-				})
-				const frame = await giframe.getFrame()
-
-				const buffer = await sharp(frame.pixels, {raw: {width: frame.width, height: frame.height, channels: 4}})
-					.resize(SIZE, SIZE, {fit: "contain", background: {r: 0, g: 0, b: 0, alpha: 0}})
-					.png({compressionLevel: 0})
-					.toBuffer({resolveWithObject: true})
-				return buffer.data
-
-			} else {
-				// unsupported mime type
-				console.error(`I don't know what a ${mime} emoji is.`)
-				return null
-			}
-		} finally {
-			abortController.abort()
-		}
-	}))
-
-	// Calculate the size of the final composited image
-	const totalWidth = Math.min(buffers.length, IMAGES_ACROSS) * SIZE
-	const imagesDown = Math.ceil(buffers.length / IMAGES_ACROSS)
-	const totalHeight = imagesDown * SIZE
-	const comp = []
-	let left = 0, top = 0
-	for (const buffer of buffers) {
-		if (Buffer.isBuffer(buffer)) {
-			// Composite the current buffer into the sprite sheet
-			comp.push({left, top, input: buffer})
-			// The next buffer should be placed one slot to the right
-			left += SIZE
-			// If we're out of space to fit the entire next buffer there, wrap to the next line
-			if (left + SIZE > RESULT_WIDTH) {
-				left = 0
-				top += SIZE
-			}
-		}
-	}
-
-	const output = await sharp({create: {width: totalWidth, height: totalHeight, channels: 4, background: {r: 0, g: 0, b: 0, alpha: 0}}})
-		.composite(comp)
-		.png()
-		.toBuffer({resolveWithObject: true})
-	return output.data
-}
-
-module.exports.compositeMatrixEmojis = compositeMatrixEmojis

m2d/converters/emoji.js

@@ -1,55 +0,0 @@
-// @ts-check
-
-const assert = require("assert").strict
-const Ty = require("../../types")
-
-const passthrough = require("../../passthrough")
-const {sync, select} = passthrough
-
-/**
- * @param {string} input
- * @param {string | null | undefined} shortcode
- * @returns {string?}
- */
-function encodeEmoji(input, shortcode) {
-	let discordPreferredEncoding
-	if (input.startsWith("mxc://")) {
-		// Custom emoji
-		let row = select("emoji", ["emoji_id", "name"], {mxc_url: input}).get()
-		if (!row && shortcode) {
-			// Use the name to try to find a known emoji with the same name.
-			const name = shortcode.replace(/^:|:$/g, "")
-			row = select("emoji", ["emoji_id", "name"], {name: name}).get()
-		}
-		if (!row) {
-			// We don't have this emoji and there's no realistic way to just-in-time upload a new emoji somewhere.
-			// Sucks!
-			return null
-		}
-		// Cool, we got an exact or a candidate emoji.
-		discordPreferredEncoding = encodeURIComponent(`${row.name}:${row.emoji_id}`)
-	} else {
-		// Default emoji
-		// https://github.com/discord/discord-api-docs/issues/2723#issuecomment-807022205 ????????????
-		const encoded = encodeURIComponent(input)
-		const encodedTrimmed = encoded.replace(/%EF%B8%8F/g, "")
-
-		const forceTrimmedList = [
-			"%F0%9F%91%8D", // 👍
-			"%F0%9F%91%8E", // 👎️
-			"%E2%AD%90", // ⭐
-			"%F0%9F%90%88", // 🐈
-			"%E2%9D%93", // ❓
-		]
-
-		discordPreferredEncoding =
-			( forceTrimmedList.includes(encodedTrimmed) ? encodedTrimmed
-			: encodedTrimmed !== encoded && [...input].length === 2 ? encoded
-			: encodedTrimmed)
-
-		console.log("add reaction from matrix:", input, encoded, encodedTrimmed, "chosen:", discordPreferredEncoding)
-	}
-	return discordPreferredEncoding
-}
-
-module.exports.encodeEmoji = encodeEmoji

m2d/converters/event-to-message.js

@@ -1,528 +0,0 @@
-// @ts-check
-
-const Ty = require("../../types")
-const DiscordTypes = require("discord-api-types/v10")
-const {Readable} = require("stream")
-const chunk = require("chunk-text")
-const TurndownService = require("turndown")
-const assert = require("assert").strict
-const entities = require("entities")
-
-const passthrough = require("../../passthrough")
-const {sync, db, discord, select, from} = passthrough
-/** @type {import("../converters/utils")} */
-const utils = sync.require("../converters/utils")
-/** @type {import("./emoji-sheet")} */
-const emojiSheet = sync.require("./emoji-sheet")
-
-/** @type {[RegExp, string][]} */
-const markdownEscapes = [
-	[/\\/g, '\\\\'],
-	[/\*/g, '\\*'],
-	[/^-/g, '\\-'],
-	[/^\+ /g, '\\+ '],
-	[/^(=+)/g, '\\$1'],
-	[/^(#{1,6}) /g, '\\$1 '],
-	[/`/g, '\\`'],
-	[/^~~~/g, '\\~~~'],
-	[/\[/g, '\\['],
-	[/\]/g, '\\]'],
-	[/^>/g, '\\>'],
-	[/_/g, '\\_'],
-	[/^(\d+)\. /g, '$1\\. ']
- ]
-
-const turndownService = new TurndownService({
-	hr: "----",
-	headingStyle: "atx",
-	preformattedCode: true,
-	codeBlockStyle: "fenced",
-})
-
-/**
- * Markdown characters in the HTML content need to be escaped, though take care not to escape the middle of bare links
- * @param {string} string
- */
-// @ts-ignore bad type from turndown
-turndownService.escape = function (string) {
-	const escapedWords = string.split(" ").map(word => {
-		if (word.match(/^https?:\/\//)) {
-			return word
-		} else {
-			return markdownEscapes.reduce(function (accumulator, escape) {
-				return accumulator.replace(escape[0], escape[1])
-		 	}, word)
-		}
-	})
-	return escapedWords.join(" ")
-}
-
-turndownService.remove("mx-reply")
-
-turndownService.addRule("strikethrough", {
-	filter: ["del", "s"],
-	replacement: function (content) {
-		return "~~" + content + "~~"
-	}
-})
-
-turndownService.addRule("underline", {
-	filter: ["u"],
-	replacement: function (content) {
-		return "__" + content + "__"
-	}
-})
-
-turndownService.addRule("blockquote", {
-	filter: "blockquote",
-	replacement: function (content) {
-		content = content.replace(/^\n+|\n+$/g, "")
-		content = content.replace(/^/gm, "> ")
-		return content
-	}
-})
-
-turndownService.addRule("spoiler", {
-	filter: function (node, options) {
-		return node.hasAttribute("data-mx-spoiler")
-	},
-
-	replacement: function (content, node) {
-		return "||" + content + "||"
-	}
-})
-
-turndownService.addRule("inlineLink", {
-	filter: function (node, options) {
-		return (
-			node.nodeName === "A" &&
-			node.getAttribute("href")
-		)
-	},
-
-	replacement: function (content, node) {
-		if (node.getAttribute("data-user-id")) return `<@${node.getAttribute("data-user-id")}>`
-		if (node.getAttribute("data-channel-id")) return `<#${node.getAttribute("data-channel-id")}>`
-		const href = node.getAttribute("href")
-		let brackets = ["", ""]
-		if (href.startsWith("https://matrix.to")) brackets = ["<", ">"]
-		return "[" + content + "](" + brackets[0] + href + brackets[1] + ")"
-	}
-})
-
-/** @type {string[]} SPRITE SHEET EMOJIS FEATURE: mxc urls for the currently processing message */
-let endOfMessageEmojis = []
-turndownService.addRule("emoji", {
-	filter: function (node, options) {
-		if (node.nodeName !== "IMG" || !node.hasAttribute("data-mx-emoticon") || !node.getAttribute("src") || !node.getAttribute("title")) return false
-		return true
-	},
-
-	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")}](${utils.getPublicUrlForMxc(mxcUrl)})`
-		}
-	}
-})
-
-turndownService.addRule("fencedCodeBlock", {
-	filter: function (node, options) {
-		return (
-			options.codeBlockStyle === "fenced" &&
-			node.nodeName === "PRE" &&
-			node.firstChild &&
-			node.firstChild.nodeName === "CODE"
-		)
-	},
-	replacement: function (content, node, options) {
-		const className = node.firstChild.getAttribute("class") || ""
-		const language = (className.match(/language-(\S+)/) || [null, ""])[1]
-		const code = node.firstChild
-		const visibleCode = code.childNodes.map(c => c.nodeName === "BR" ? "\n" : c.textContent).join("").replace(/\n*$/g, "")
-
-		var fence = "```"
-
-		return (
-			fence + language + "\n" +
-			visibleCode +
-			"\n" + fence
-		)
-	}
-})
-
-/**
- * @param {string} roomID
- * @param {string} mxid
- * @returns {Promise<{displayname?: string?, avatar_url?: string?}>}
- */
-async function getMemberFromCacheOrHomeserver(roomID, mxid, api) {
-	const row = select("member_cache", ["displayname", "avatar_url"], {room_id: roomID, mxid}).get()
-	if (row) return row
-	return api.getStateEvent(roomID, "m.room.member", mxid).then(event => {
-		db.prepare("REPLACE INTO member_cache (room_id, mxid, displayname, avatar_url) VALUES (?, ?, ?, ?)").run(roomID, mxid, event?.displayname || null, event?.avatar_url || null)
-		return event
-	}).catch(() => {
-		return {displayname: null, avatar_url: null}
-	})
-}
-
-/**
- * Splits a display name into one chunk containing <=80 characters, and another chunk containing the rest of the characters. Splits on
- * whitespace if possible.
- * These chunks, respectively, go in the display name, and at the top of the message.
- * If the second part isn't empty, it'll also contain boldening markdown and a line break at the end, so that regardless of its value it
- * can be prepended to the message content as-is.
- * @summary Splits too-long Matrix names into a display name chunk and a message content chunk.
- * @param  {string} displayName - The Matrix side display name to chop up.
- * @returns {[string, string]} [shortened display name, display name runoff]
- */
-function splitDisplayName(displayName) {
-	/** @type {string[]} */
-	let displayNameChunks = chunk(displayName, 80)
-
-	if (displayNameChunks.length === 1) {
-		return [displayName, ""]
-	} else {
-		const displayNamePreRunoff = displayNameChunks[0]
-		// displayNameRunoff is a slice of the original rather than a concatenation of the rest of the chunks in order to preserve whatever whitespace it was broken on.
-		const displayNameRunoff = `**${displayName.slice(displayNamePreRunoff.length + 1)}**\n`
-
-		return [displayNamePreRunoff, displayNameRunoff]
-	}
-}
-
-/**
- * At the time of this executing, we know what the end of message emojis are, and we know that at least one of them is unknown.
- * This function will strip them from the content and generate the correct pending file of the sprite sheet.
- * @param {string} content
- * @param {{id: string, name: string}[]} attachments
- * @param {({name: string, url: string} | {name: string, url: string, key: string, iv: string} | {name: string, buffer: Buffer})[]} pendingFiles
- */
-async function uploadEndOfMessageSpriteSheet(content, attachments, pendingFiles) {
-	if (!content.includes("<::>")) return content // No unknown emojis, nothing to do
-	// Remove known and unknown emojis from the end of the message
-	const r = /<a?:[a-zA-Z0-9_]*:[0-9]*>\s*$/
-	while (content.match(r)) {
-		content = content.replace(r, "")
-	}
-	// Create a sprite sheet of known and unknown emojis from the end of the message
-	const buffer = await emojiSheet.compositeMatrixEmojis(endOfMessageEmojis)
-	// Attach it
-	const name = "emojis.png"
-	attachments.push({id: "0", name})
-	pendingFiles.push({name, buffer})
-	return content
-}
-
-/**
- * @param {Ty.Event.Outer_M_Room_Message | Ty.Event.Outer_M_Room_Message_File | Ty.Event.Outer_M_Sticker | Ty.Event.Outer_M_Room_Message_Encrypted_File} event
- * @param {import("discord-api-types/v10").APIGuild} guild
- * @param {{api: import("../../matrix/api")}} di simple-as-nails dependency injection for the matrix API
- */
-async function eventToMessage(event, guild, di) {
-	/** @type {(DiscordTypes.RESTPostAPIWebhookWithTokenJSONBody & {files?: {name: string, file: Buffer | Readable}[]})[]} */
-	let messages = []
-
-	let displayName = event.sender
-	let avatarURL = undefined
-	/** @type {string[]} */
-	let messageIDsToEdit = []
-	let replyLine = ""
-	// Extract a basic display name from the sender
-	const match = event.sender.match(/^@(.*?):/)
-	if (match) displayName = match[1]
-	// Try to extract an accurate display name and avatar URL from the member event
-	const member = await getMemberFromCacheOrHomeserver(event.room_id, event.sender, di?.api)
-	if (member.displayname) displayName = member.displayname
-	if (member.avatar_url) avatarURL = utils.getPublicUrlForMxc(member.avatar_url) || undefined
-	// If the display name is too long to be put into the webhook (80 characters is the maximum),
-	// put the excess characters into displayNameRunoff, later to be put at the top of the message
-	let [displayNameShortened, displayNameRunoff] = splitDisplayName(displayName)
-	// If the message type is m.emote, the full name is already included at the start of the message, so remove any runoff
-	if (event.type === "m.room.message" && event.content.msgtype === "m.emote") {
-		displayNameRunoff = ""
-	}
-
-	let content = event.content.body // ultimate fallback
-	const attachments = []
-	/** @type {({name: string, url: string} | {name: string, url: string, key: string, iv: string} | {name: string, buffer: Buffer})[]} */
-	const pendingFiles = []
-
-	// Convert content depending on what the message is
-	if (event.type === "m.room.message" && (event.content.msgtype === "m.text" || event.content.msgtype === "m.emote")) {
-		// Handling edits. If the edit was an edit of a reply, edits do not include the reply reference, so we need to fetch up to 2 more events.
-		// this event ---is an edit of--> original event ---is a reply to--> past event
-		await (async () => {
-			if (!event.content["m.new_content"]) return
-			const relatesTo = event.content["m.relates_to"]
-			if (!relatesTo) return
-			// Check if we have a pointer to what was edited
-			const relType = relatesTo.rel_type
-			if (relType !== "m.replace") return
-			const originalEventId = relatesTo.event_id
-			if (!originalEventId) return
-			messageIDsToEdit = select("event_message", "message_id", {event_id: originalEventId}, "ORDER BY part").pluck().all()
-			if (!messageIDsToEdit.length) return
-
-			// Ok, it's an edit.
-			event.content = event.content["m.new_content"]
-
-			// Is it editing a reply? We need special handling if it is.
-			// Get the original event, then check if it was a reply
-			const originalEvent = await di.api.getEvent(event.room_id, originalEventId)
-			if (!originalEvent) return
-			const repliedToEventId = originalEvent.content["m.relates_to"]?.["m.in_reply_to"]?.event_id
-			if (!repliedToEventId) return
-
-			// After all that, it's an edit of a reply.
-			// We'll be sneaky and prepare the message data so that the next steps can handle it just like original messages.
-			Object.assign(event.content, {
-				"m.relates_to": {
-					"m.in_reply_to": {
-						event_id: repliedToEventId
-					}
-				}
-			})
-		})()
-
-		// Handling replies. We'll look up the data of the replied-to event from the Matrix homeserver.
-		// Note that an <mx-reply> element is not guaranteed because this might be m.new_content.
-		await (async () => {
-			const repliedToEventId = event.content["m.relates_to"]?.["m.in_reply_to"]?.event_id
-			if (!repliedToEventId) return
-			let repliedToEvent = await di.api.getEvent(event.room_id, repliedToEventId)
-			if (!repliedToEvent) return
-			// @ts-ignore
-			const autoEmoji = new Map(select("auto_emoji", ["name", "emoji_id"], {}, "WHERE name = 'L1' OR name = 'L2'").raw().all())
-			replyLine = `<:L1:${autoEmoji.get("L1")}><:L2:${autoEmoji.get("L2")}>`
-			const row = from("event_message").join("message_channel", "message_id").select("channel_id", "message_id").where({event_id: repliedToEventId}).and("ORDER BY part").get()
-			if (row) {
-				replyLine += `https://discord.com/channels/${guild.id}/${row.channel_id}/${row.message_id} `
-			}
-			const sender = repliedToEvent.sender
-			const authorID = select("sim", "user_id", {mxid: repliedToEvent.sender}).pluck().get()
-			if (authorID) {
-				replyLine += `<@${authorID}>`
-			} else {
-				let senderName = select("member_cache", "displayname", {mxid: repliedToEvent.sender}).pluck().get()
-				if (!senderName) senderName = sender.match(/@([^:]*)/)?.[1] || sender
-				replyLine += `Ⓜ️**${senderName}**`
-			}
-			// If the event has been edited, the homeserver will include the relation in `unsigned`.
-			if (repliedToEvent.unsigned?.["m.relations"]?.["m.replace"]?.content?.["m.new_content"]) {
-				repliedToEvent = repliedToEvent.unsigned["m.relations"]["m.replace"] // Note: this changes which event_id is in repliedToEvent.
-				repliedToEvent.content = repliedToEvent.content["m.new_content"]
-			}
-			let contentPreview
-			const fileReplyContentAlternative =
-				( repliedToEvent.content.msgtype === "m.image" ? "🖼️"
-				: repliedToEvent.content.msgtype === "m.video" ? "🎞️"
-				: repliedToEvent.content.msgtype === "m.audio" ? "🎶"
-				: repliedToEvent.content.msgtype === "m.file" ? "📄"
-				: null)
-			if (fileReplyContentAlternative) {
-				contentPreview = " " + fileReplyContentAlternative
-			} else {
-				const repliedToContent = repliedToEvent.content.formatted_body || repliedToEvent.content.body
-				const contentPreviewChunks = chunk(
-					entities.decodeHTML5Strict( // Remove entities like &amp; &quot;
-						repliedToContent.replace(/.*<\/mx-reply>/, "") // Remove everything before replies, so just use the actual message body
-						.replace(/^\s*<blockquote>.*?<\/blockquote>(.....)/s, "$1") // If the message starts with a blockquote, don't count it and use the message body afterwards
-						.replace(/(?:\n|<br>)+/g, " ") // Should all be on one line
-						.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.)
-						.replace(/<[^>]+>/g, "") // Completely strip all HTML tags and formatting.
-					), 50)
-				contentPreview = ":\n> "
-				contentPreview += contentPreviewChunks.length > 1 ? contentPreviewChunks[0] + "..." : contentPreviewChunks[0]
-			}
-			replyLine = `> ${replyLine}${contentPreview}\n`
-		})()
-
-		if (event.content.format === "org.matrix.custom.html" && event.content.formatted_body) {
-			let input = event.content.formatted_body
-			if (event.content.msgtype === "m.emote") {
-				input = `* ${displayName} ${input}`
-			}
-
-			// Handling mentions of Discord users
-			input = input.replace(/("https:\/\/matrix.to\/#\/(@[^"]+)")>/g, (whole, attributeValue, mxid) => {
-				if (!utils.eventSenderIsFromDiscord(mxid)) return whole
-				const userID = select("sim", "user_id", {mxid: mxid}).pluck().get()
-				if (!userID) return whole
-				return `${attributeValue} data-user-id="${userID}">`
-			})
-
-			// Handling mentions of Discord rooms
-			input = input.replace(/("https:\/\/matrix.to\/#\/(![^"]+)")>/g, (whole, attributeValue, roomID) => {
-				const channelID = select("channel_room", "channel_id", {room_id: roomID}).pluck().get()
-				if (!channelID) return whole
-				return `${attributeValue} data-channel-id="${channelID}">`
-			})
-
-			// Element adds a bunch of <br> before </blockquote> but doesn't render them. I can't figure out how this even works in the browser, so let's just delete those.
-			input = input.replace(/(?:\n|<br ?\/?>\s*)*<\/blockquote>/g, "</blockquote>")
-
-			// The matrix spec hasn't decided whether \n counts as a newline or not, but I'm going to count it, because if it's in the data it's there for a reason.
-			// But I should not count it if it's between block elements.
-			input = input.replace(/(<\/?([^ >]+)[^>]*>)?\n(<\/?([^ >]+)[^>]*>)?/g, (whole, beforeContext, beforeTag, afterContext, afterTag) => {
-				// console.error(beforeContext, beforeTag, afterContext, afterTag)
-				if (typeof beforeTag !== "string" && typeof afterTag !== "string") {
-					return "<br>"
-				}
-				beforeContext = beforeContext || ""
-				beforeTag = beforeTag || ""
-				afterContext = afterContext || ""
-				afterTag = afterTag || ""
-				if (!utils.BLOCK_ELEMENTS.includes(beforeTag.toUpperCase()) && !utils.BLOCK_ELEMENTS.includes(afterTag.toUpperCase())) {
-					return beforeContext + "<br>" + afterContext
-				} else {
-					return whole
-				}
-			})
-
-			// Note: Element's renderers on Web and Android currently collapse whitespace, like the browser does. Turndown also collapses whitespace which is good for me.
-			// If later I'm using a client that doesn't collapse whitespace and I want turndown to follow suit, uncomment the following line of code, and it Just Works:
-			// input = input.replace(/ /g, "&nbsp;")
-			// There is also a corresponding test to uncomment, named "event2message: whitespace is retained"
-
-			// SPRITE SHEET EMOJIS FEATURE: Emojis at the end of the message that we don't know about will be reuploaded as a sprite sheet.
-			// First we need to determine which emojis are at the end.
-			endOfMessageEmojis = []
-			let match
-			let last = input.length
-			while ((match = input.slice(0, last).match(/<img [^>]*>\s*$/))) {
-				if (!match[0].includes("data-mx-emoticon")) break
-				const mxcUrl = match[0].match(/\bsrc="(mxc:\/\/[^"]+)"/)
-				if (mxcUrl) endOfMessageEmojis.unshift(mxcUrl[1])
-				if (typeof match.index !== "number") break
-				last = match.index
-			}
-
-			// @ts-ignore bad type from turndown
-			content = turndownService.turndown(input)
-
-			// It's designed for commonmark, we need to replace the space-space-newline with just newline
-			content = content.replace(/  \n/g, "\n")
-
-			// SPRITE SHEET EMOJIS FEATURE:
-			content = await uploadEndOfMessageSpriteSheet(content, attachments, pendingFiles)
-		} else {
-			// Looks like we're using the plaintext body!
-			content = event.content.body
-
-			if (event.content.msgtype === "m.emote") {
-				content = `* ${displayName} ${content}`
-			}
-
-			// Markdown needs to be escaped, though take care not to escape the middle of links
-			// @ts-ignore bad type from turndown
-			content = turndownService.escape(content)
-		}
-	} else if (event.type === "m.room.message" && (event.content.msgtype === "m.file" || event.content.msgtype === "m.video" || event.content.msgtype === "m.audio" || event.content.msgtype === "m.image")) {
-		content = ""
-		const filename = event.content.body
-		if ("url" in event.content) {
-			// Unencrypted
-			const url = utils.getPublicUrlForMxc(event.content.url)
-			assert(url)
-			attachments.push({id: "0", filename})
-			pendingFiles.push({name: filename, url})
-		} else {
-			// Encrypted
-			const url = utils.getPublicUrlForMxc(event.content.file.url)
-			assert(url)
-			assert.equal(event.content.file.key.alg, "A256CTR")
-			attachments.push({id: "0", filename})
-			pendingFiles.push({name: filename, url, key: event.content.file.key.k, iv: event.content.file.iv})
-		}
-	} else if (event.type === "m.sticker") {
-		content = ""
-		const url = utils.getPublicUrlForMxc(event.content.url)
-		assert(url)
-		let filename = event.content.body
-		if (event.type === "m.sticker") {
-			let mimetype
-			if (event.content.info?.mimetype?.includes("/")) {
-				mimetype = event.content.info.mimetype
-			} else {
-				const res = await fetch(url, {method: "HEAD"})
-				mimetype = res.headers.get("content-type") || "image/webp"
-			}
-			filename += "." + mimetype.split("/")[1]
-		}
-		attachments.push({id: "0", filename})
-		pendingFiles.push({name: filename, url})
-	}
-
-	content = displayNameRunoff + replyLine + content
-
-	// Split into 2000 character chunks
-	const chunks = chunk(content, 2000)
-	messages = messages.concat(chunks.map(content => ({
-		content,
-		username: displayNameShortened,
-		avatar_url: avatarURL
-	})))
-
-	if (attachments.length) {
-		// If content is empty (should be the case when uploading a file) then chunk-text will create 0 messages.
-		// There needs to be a message to add attachments to.
-		if (!messages.length) messages.push({
-			content,
-			username: displayNameShortened,
-			avatar_url: avatarURL
-		})
-		messages[0].attachments = attachments
-		// @ts-ignore these will be converted to real files when the message is about to be sent
-		messages[0].pendingFiles = pendingFiles
-	}
-
-	const messagesToEdit = []
-	const messagesToSend = []
-	for (let i = 0; i < messages.length; i++) {
-		const next = messageIDsToEdit[0]
-		if (next) {
-			messagesToEdit.push({id: next, message: messages[i]})
-			messageIDsToEdit.shift()
-		} else {
-			messagesToSend.push(messages[i])
-		}
-	}
-
-	// Ensure there is code coverage for adding, editing, and deleting
-	if (messagesToSend.length) void 0
-	if (messagesToEdit.length) void 0
-	if (messageIDsToEdit.length) void 0
-
-	return {
-		messagesToEdit,
-		messagesToSend,
-		messagesToDelete: messageIDsToEdit
-	}
-}
-
-module.exports.eventToMessage = eventToMessage

m2d/converters/utils.js

@@ -1,69 +0,0 @@
-// @ts-check
-
-const reg = require("../../matrix/read-registration")
-const userRegex = reg.namespaces.users.map(u => new RegExp(u.regex))
-const assert = require("assert").strict
-/** @type {import("xxhash-wasm").XXHashAPI} */ // @ts-ignore
-let hasher = null
-// @ts-ignore
-require("xxhash-wasm")().then(h => hasher = h)
-
-const BLOCK_ELEMENTS = [
-	"ADDRESS", "ARTICLE", "ASIDE", "AUDIO", "BLOCKQUOTE", "BODY", "CANVAS",
-	"CENTER", "DD", "DETAILS", "DIR", "DIV", "DL", "DT", "FIELDSET", "FIGCAPTION", "FIGURE",
-	"FOOTER", "FORM", "FRAMESET", "H1", "H2", "H3", "H4", "H5", "H6", "HEADER",
-	"HGROUP", "HR", "HTML", "ISINDEX", "LI", "MAIN", "MENU", "NAV", "NOFRAMES",
-	"NOSCRIPT", "OL", "OUTPUT", "P", "PRE", "SECTION", "SUMMARY", "TABLE", "TBODY", "TD",
-	"TFOOT", "TH", "THEAD", "TR", "UL"
-]
-
-/**
- * Determine whether an event is the bridged representation of a discord message.
- * Such messages shouldn't be bridged again.
- * @param {string} sender
- */
-function eventSenderIsFromDiscord(sender) {
-	// If it's from a user in the bridge's namespace, then it originated from discord
-	// This includes messages sent by the appservice's bot user, because that is what's used for webhooks
-	// TODO: It would be nice if bridge system messages wouldn't trigger this check and could be bridged from matrix to discord, while webhook reflections would remain ignored...
-	// TODO that only applies to the above todo: But you'd have to watch out for the /icon command, where the bridge bot would set the room avatar, and that shouldn't be reflected into the room a second time.
-	if (userRegex.some(x => sender.match(x))) {
-		return true
-	}
-
-	return false
-}
-
-/**
- * @param {string} mxc
- * @returns {string?}
- */
-function getPublicUrlForMxc(mxc) {
-	const avatarURLParts = mxc?.match(/^mxc:\/\/([^/]+)\/(\w+)$/)
-	if (avatarURLParts) return `${reg.ooye.server_origin}/_matrix/media/r0/download/${avatarURLParts[1]}/${avatarURLParts[2]}`
-	else return null
-}
-
-/**
- * Event IDs are really big and have more entropy than we need.
- * If we want to store the event ID in the database, we can store a more compact version by hashing it with this.
- * I choose a 64-bit non-cryptographic hash as only a 32-bit hash will see birthday collisions unreasonably frequently: https://en.wikipedia.org/wiki/Birthday_attack#Mathematics
- * xxhash outputs an unsigned 64-bit integer.
- * Converting to a signed 64-bit integer with no bit loss so that it can be stored in an SQLite integer field as-is: https://www.sqlite.org/fileformat2.html#record_format
- * This should give very efficient storage with sufficient entropy.
- * @param {string} eventID
- */
-function getEventIDHash(eventID) {
-	assert(hasher, "xxhash is not ready yet")
-	if (eventID[0] === "$" && eventID.length >= 13) {
-		eventID = eventID.slice(1) // increase entropy per character to potentially help xxhash
-	}
-	const unsignedHash = hasher.h64(eventID)
-	const signedHash = unsignedHash - 0x8000000000000000n // shifting down to signed 64-bit range
-	return signedHash
-}
-
-module.exports.BLOCK_ELEMENTS = BLOCK_ELEMENTS
-module.exports.eventSenderIsFromDiscord = eventSenderIsFromDiscord
-module.exports.getPublicUrlForMxc = getPublicUrlForMxc
-module.exports.getEventIDHash = getEventIDHash

m2d/converters/utils.test.js

@@ -1,25 +0,0 @@
-// @ts-check
-
-const {test} = require("supertape")
-const {eventSenderIsFromDiscord, getEventIDHash} = require("./utils")
-
-test("sender type: matrix user", t => {
-	t.notOk(eventSenderIsFromDiscord("@cadence:cadence.moe"))
-})
-
-test("sender type: ooye bot", t => {
-	t.ok(eventSenderIsFromDiscord("@_ooye_bot:cadence.moe"))
-})
-
-test("sender type: ooye puppet", t => {
-	t.ok(eventSenderIsFromDiscord("@_ooye_sheep:cadence.moe"))
-})
-
-test("event hash: hash is the same each time", t => {
-	const eventID = "$example"
-	t.equal(getEventIDHash(eventID), getEventIDHash(eventID))
-})
-
-test("event hash: hash is different for different inputs", t => {
-	t.notEqual(getEventIDHash("$Ij3qo7NxMA4VPexlAiIx2CB9JbsiGhJeyt-2OvkAUe1"), getEventIDHash("$Ij3qo7NxMA4VPexlAiIx2CB9JbsiGhJeyt-2OvkAUe2"))
-})

m2d/event-dispatcher.js

@@ -1,152 +0,0 @@
-// @ts-check
-
-/*
- * Grab Matrix events we care about, check them, and bridge them.
- */
-
-const util = require("util")
-const Ty = require("../types")
-const {discord, db, sync, as} = require("../passthrough")
-
-/** @type {import("./actions/send-event")} */
-const sendEvent = sync.require("./actions/send-event")
-/** @type {import("./actions/add-reaction")} */
-const addReaction = sync.require("./actions/add-reaction")
-/** @type {import("./actions/redact")} */
-const redact = sync.require("./actions/redact")
-/** @type {import("../matrix/matrix-command-handler")} */
-const matrixCommandHandler = sync.require("../matrix/matrix-command-handler")
-/** @type {import("./converters/utils")} */
-const utils = sync.require("./converters/utils")
-/** @type {import("../matrix/api")}) */
-const api = sync.require("../matrix/api")
-/** @type {import("../matrix/read-registration")}) */
-const reg = sync.require("../matrix/read-registration")
-
-let lastReportedEvent = 0
-
-function guard(type, fn) {
-	return async function(event, ...args) {
-		try {
-			return await fn(event, ...args)
-		} catch (e) {
-			console.error("hit event-dispatcher's error handler with this exception:")
-			console.error(e) // TODO: also log errors into a file or into the database, maybe use a library for this? or just wing it?
-			console.error(`while handling this ${type} gateway event:`)
-			console.dir(event, {depth: null})
-
-			if (Date.now() - lastReportedEvent < 5000) return
-			lastReportedEvent = Date.now()
-
-			let stackLines = e.stack.split("\n")
-			api.sendEvent(event.room_id, "m.room.message", {
-				msgtype: "m.text",
-				body: "\u26a0 Matrix event not delivered to Discord. See formatted content for full details.",
-				format: "org.matrix.custom.html",
-				formatted_body: "\u26a0 <strong>Matrix event not delivered to Discord</strong>"
-					+ `<br>Event type: ${type}`
-					+ `<br>${e.toString()}`
-					+ `<br><details><summary>Error trace</summary>`
-					+ `<pre>${stackLines.join("\n")}</pre></details>`
-					+ `<details><summary>Original payload</summary>`
-					+ `<pre>${util.inspect(event, false, 4, false)}</pre></details>`,
-				"moe.cadence.ooye.error": {
-					source: "matrix",
-					payload: event
-				},
-				"m.mentions": {
-					user_ids: ["@cadence:cadence.moe"]
-				}
-			})
-		}
-	}
-}
-
-async function retry(roomID, eventID) {
-	const event = await api.getEvent(roomID, eventID)
-	const error = event.content["moe.cadence.ooye.error"]
-	if (event.sender !== `@${reg.sender_localpart}:${reg.ooye.server_name}` || !error) return
-	if (error.source === "matrix") {
-		as.emit("type:" + error.payload.type, error.payload)
-	} else if (error.source === "discord") {
-		discord.cloud.emit("event", error.payload)
-	}
-}
-
-sync.addTemporaryListener(as, "type:m.room.message", guard("m.room.message",
-/**
- * @param {Ty.Event.Outer_M_Room_Message | Ty.Event.Outer_M_Room_Message_File} event it is a m.room.message because that's what this listener is filtering for
- */
-async event => {
-	if (utils.eventSenderIsFromDiscord(event.sender)) return
-	const messageResponses = await sendEvent.sendEvent(event)
-	if (event.type === "m.room.message" && event.content.msgtype === "m.text") {
-		// @ts-ignore
-		await matrixCommandHandler.execute(event)
-	}
-}))
-
-sync.addTemporaryListener(as, "type:m.sticker", guard("m.sticker",
-/**
- * @param {Ty.Event.Outer_M_Sticker} event it is a m.sticker because that's what this listener is filtering for
- */
-async event => {
-	if (utils.eventSenderIsFromDiscord(event.sender)) return
-	const messageResponses = await sendEvent.sendEvent(event)
-}))
-
-sync.addTemporaryListener(as, "type:m.reaction", guard("m.reaction",
-/**
- * @param {Ty.Event.Outer<Ty.Event.M_Reaction>} event it is a m.reaction because that's what this listener is filtering for
- */
-async event => {
-	if (utils.eventSenderIsFromDiscord(event.sender)) return
-	if (event.content["m.relates_to"].key === "🔁") {
-		// Try to bridge a failed event again?
-		await retry(event.room_id, event.content["m.relates_to"].event_id)
-	} else {
-		matrixCommandHandler.onReactionAdd(event)
-		await addReaction.addReaction(event)
-	}
-}))
-
-sync.addTemporaryListener(as, "type:m.room.redaction", guard("m.room.redaction",
-/**
- * @param {Ty.Event.Outer_M_Room_Redaction} event it is a m.room.redaction because that's what this listener is filtering for
- */
-async event => {
-	if (utils.eventSenderIsFromDiscord(event.sender)) return
-	await redact.handle(event)
-}))
-
-sync.addTemporaryListener(as, "type:m.room.avatar", guard("m.room.avatar",
-/**
- * @param {Ty.Event.StateOuter<Ty.Event.M_Room_Avatar>} event
- */
-async event => {
-	if (event.state_key !== "") return
-	if (utils.eventSenderIsFromDiscord(event.sender)) return
-	const url = event.content.url || null
-	db.prepare("UPDATE channel_room SET custom_avatar = ? WHERE room_id = ?").run(url, event.room_id)
-}))
-
-sync.addTemporaryListener(as, "type:m.room.name", guard("m.room.name",
-/**
- * @param {Ty.Event.StateOuter<Ty.Event.M_Room_Name>} event
- */
-async event => {
-	if (event.state_key !== "") return
-	if (utils.eventSenderIsFromDiscord(event.sender)) return
-	const name = event.content.name || null
-	db.prepare("UPDATE channel_room SET nick = ? WHERE room_id = ?").run(name, event.room_id)
-}))
-
-sync.addTemporaryListener(as, "type:m.room.member", guard("m.room.member",
-/**
- * @param {Ty.Event.StateOuter<Ty.Event.M_Room_Member>} event
- */
-async event => {
-	if (event.state_key[0] !== "@") return
-	if (utils.eventSenderIsFromDiscord(event.state_key)) return
-	db.prepare("REPLACE INTO member_cache (room_id, mxid, displayname, avatar_url) VALUES (?, ?, ?, ?)").run(event.room_id, event.state_key, event.content.displayname || null, event.content.avatar_url || null)
-}))

matrix/api.js

@@ -1,236 +0,0 @@
-// @ts-check
-
-const Ty = require("../types")
-const assert = require("assert").strict
-
-const passthrough = require("../passthrough")
-const { discord, sync, db } = passthrough
-/** @type {import("./mreq")} */
-const mreq = sync.require("./mreq")
-/** @type {import("./file")} */
-const file = sync.require("./file")
-/** @type {import("./txnid")} */
-const makeTxnId = sync.require("./txnid")
-
-/**
- * @param {string} p endpoint to access
- * @param {string?} [mxid] optional: user to act as, for the ?user_id parameter
- * @param {{[x: string]: any}} [otherParams] optional: any other query parameters to add
- * @returns {string} the new endpoint
- */
-function path(p, mxid, otherParams = {}) {
-	if (!mxid) return p
-	const u = new URL(p, "http://localhost")
-	u.searchParams.set("user_id", mxid)
-	for (const entry of Object.entries(otherParams)) {
-		if (entry[1] != undefined) {
-			u.searchParams.set(entry[0], entry[1])
-		}
-	}
-	return u.pathname + "?" + u.searchParams.toString()
-}
-
-/**
- * @param {string} username
- * @returns {Promise<Ty.R.Registered>}
- */
-function register(username) {
-	console.log(`[api] register: ${username}`)
-	return mreq.mreq("POST", "/client/v3/register", {
-		type: "m.login.application_service",
-		username
-	})
-}
-
-/**
- * @returns {Promise<string>} room ID
- */
-async function createRoom(content) {
-	console.log(`[api] create room:`, content)
-	/** @type {Ty.R.RoomCreated} */
-	const root = await mreq.mreq("POST", "/client/v3/createRoom", content)
-	return root.room_id
-}
-
-/**
- * @returns {Promise<string>} room ID
- */
-async function joinRoom(roomIDOrAlias, mxid) {
-	/** @type {Ty.R.RoomJoined} */
-	const root = await mreq.mreq("POST", path(`/client/v3/join/${roomIDOrAlias}`, mxid))
-	return root.room_id
-}
-
-async function inviteToRoom(roomID, mxidToInvite, mxid) {
-	await mreq.mreq("POST", path(`/client/v3/rooms/${roomID}/invite`, mxid), {
-		user_id: mxidToInvite
-	})
-}
-
-async function leaveRoom(roomID, mxid) {
-	await mreq.mreq("POST", path(`/client/v3/rooms/${roomID}/leave`, mxid), {})
-}
-
-/**
- * @param {string} roomID
- * @param {string} eventID
- * @template T
- */
-async function getEvent(roomID, eventID) {
-	/** @type {Ty.Event.Outer<T>} */
-	const root = await mreq.mreq("GET", `/client/v3/rooms/${roomID}/event/${eventID}`)
-	return root
-}
-
-/**
- * @param {string} roomID
- * @returns {Promise<Ty.Event.BaseStateEvent[]>}
- */
-function getAllState(roomID) {
-	return mreq.mreq("GET", `/client/v3/rooms/${roomID}/state`)
-}
-
-/**
- * @param {string} roomID
- * @param {string} type
- * @param {string} key
- * @returns the *content* of the state event
- */
-function getStateEvent(roomID, type, key) {
-	return mreq.mreq("GET", `/client/v3/rooms/${roomID}/state/${type}/${key}`)
-}
-
-/**
- * "Any of the AS's users must be in the room. This API is primarily for Application Services and should be faster to respond than /members as it can be implemented more efficiently on the server."
- * @param {string} roomID
- * @returns {Promise<{joined: {[mxid: string]: {avatar_url?: string, display_name?: string}}}>}
- */
-function getJoinedMembers(roomID) {
-	return mreq.mreq("GET", `/client/v3/rooms/${roomID}/joined_members`)
-}
-
-/**
- * @param {string} roomID
- * @param {string} eventID
- * @param {{from?: string, limit?: any}} pagination
- * @param {string?} [relType]
- * @returns {Promise<Ty.Pagination<Ty.Event.Outer<any>>>}
- */
-function getRelations(roomID, eventID, pagination, relType) {
-	let path = `/client/v1/rooms/${roomID}/relations/${eventID}`
-	if (relType) path += `/${relType}`
-	if (!pagination.from) delete pagination.from
-	if (!pagination.limit) pagination.limit = 50 // get a little more consistency between homeservers
-	path += `?${new URLSearchParams(pagination)}`
-	return mreq.mreq("GET", path)
-}
-
-/**
- * @param {string} roomID
- * @param {string} type
- * @param {string} stateKey
- * @param {string} [mxid]
- * @returns {Promise<string>} event ID
- */
-async function sendState(roomID, type, stateKey, content, mxid) {
-	console.log(`[api] state: ${roomID}: ${type}/${stateKey}`)
-	assert.ok(type)
-	assert.ok(typeof stateKey === "string")
-	/** @type {Ty.R.EventSent} */
-	// encodeURIComponent is necessary because state key can contain some special characters like / but you must encode them so they fit in a single component of the URI
-	const root = await mreq.mreq("PUT", path(`/client/v3/rooms/${roomID}/state/${type}/${encodeURIComponent(stateKey)}`, mxid), content)
-	return root.event_id
-}
-
-/**
- * @param {string} roomID
- * @param {string} type
- * @param {any} content
- * @param {string?} [mxid]
- * @param {number} [timestamp] timestamp of the newly created event, in unix milliseconds
- */
-async function sendEvent(roomID, type, content, mxid, timestamp) {
-	if (!["m.room.message", "m.reaction", "m.sticker"].includes(type)) {
-		console.log(`[api] event ${type} to ${roomID} as ${mxid || "default sim"}`)
-	}
-	/** @type {Ty.R.EventSent} */
-	const root = await mreq.mreq("PUT", path(`/client/v3/rooms/${roomID}/send/${type}/${makeTxnId.makeTxnId()}`, mxid, {ts: timestamp}), content)
-	return root.event_id
-}
-
-/**
- * @param {string} roomID
- * @param {string} eventID
- * @param {string?} [mxid]
- * @returns {Promise<string>} event ID
- */
-async function redactEvent(roomID, eventID, mxid) {
-	/** @type {Ty.R.EventRedacted} */
-	const root = await mreq.mreq("PUT", path(`/client/v3/rooms/${roomID}/redact/${eventID}/${makeTxnId.makeTxnId()}`, mxid), {})
-	return root.event_id
-}
-
-/**
- * @param {string} roomID
- * @param {boolean} isTyping
- * @param {string} mxid
- * @param {number} [duration] milliseconds
- */
-async function sendTyping(roomID, isTyping, mxid, duration) {
-	await mreq.mreq("PUT", path(`/client/v3/rooms/${roomID}/typing/${mxid}`, mxid), {
-		typing: isTyping,
-		timeout: duration
-	})
-}
-
-async function profileSetDisplayname(mxid, displayname) {
-	await mreq.mreq("PUT", path(`/client/v3/profile/${mxid}/displayname`, mxid), {
-		displayname
-	})
-}
-
-async function profileSetAvatarUrl(mxid, avatar_url) {
-	await mreq.mreq("PUT", path(`/client/v3/profile/${mxid}/avatar_url`, mxid), {
-		avatar_url
-	})
-}
-
-/**
- * Set a user's power level within a room.
- * @param {string} roomID
- * @param {string} mxid
- * @param {number} power
- */
-async function setUserPower(roomID, mxid, power) {
-	assert(roomID[0] === "!")
-	assert(mxid[0] === "@")
-	// Yes there's no shortcut https://github.com/matrix-org/matrix-appservice-bridge/blob/2334b0bae28a285a767fe7244dad59f5a5963037/src/components/intent.ts#L352
-	const powerLevels = await getStateEvent(roomID, "m.room.power_levels", "")
-	powerLevels.users = powerLevels.users || {}
-	if (power != null) {
-		powerLevels.users[mxid] = power
-	} else {
-		delete powerLevels.users[mxid]
-	}
-	await sendState(roomID, "m.room.power_levels", "", powerLevels)
-	return powerLevels
-}
-
-module.exports.path = path
-module.exports.register = register
-module.exports.createRoom = createRoom
-module.exports.joinRoom = joinRoom
-module.exports.inviteToRoom = inviteToRoom
-module.exports.leaveRoom = leaveRoom
-module.exports.getEvent = getEvent
-module.exports.getAllState = getAllState
-module.exports.getStateEvent = getStateEvent
-module.exports.getJoinedMembers = getJoinedMembers
-module.exports.getRelations = getRelations
-module.exports.sendState = sendState
-module.exports.sendEvent = sendEvent
-module.exports.redactEvent = redactEvent
-module.exports.sendTyping = sendTyping
-module.exports.profileSetDisplayname = profileSetDisplayname
-module.exports.profileSetAvatarUrl = profileSetAvatarUrl
-module.exports.setUserPower = setUserPower

matrix/appservice.js

@@ -1,8 +0,0 @@
-const reg = require("../matrix/read-registration")
-const AppService = require("matrix-appservice").AppService
-const as = new AppService({
-	homeserverToken: reg.hs_token
-})
-as.listen(+(new URL(reg.url).port))
-
-module.exports = as

matrix/kstate.js

@@ -1,82 +0,0 @@
-// @ts-check
-
-const assert = require("assert").strict
-const mixin = require("mixin-deep")
-
-/** Mutates the input. */
-function kstateStripConditionals(kstate) {
-	for (const [k, content] of Object.entries(kstate)) {
-		// conditional for whether a key is even part of the kstate (doing this declaratively on json is hard, so represent it as a property instead.)
-		if ("$if" in content) {
-			if (content.$if) delete content.$if
-			else delete kstate[k]
-		}
-	}
-	return kstate
-}
-
-function kstateToState(kstate) {
-	const events = []
-	kstateStripConditionals(kstate)
-	for (const [k, content] of Object.entries(kstate)) {
-		const slashIndex = k.indexOf("/")
-		assert(slashIndex > 0)
-		const type = k.slice(0, slashIndex)
-		const state_key = k.slice(slashIndex + 1)
-		events.push({type, state_key, content})
-	}
-	return events
-}
-
-/**
- * @param {import("../types").Event.BaseStateEvent[]} events
- * @returns {any}
- */
-function stateToKState(events) {
-	const kstate = {}
-	for (const event of events) {
-		kstate[event.type + "/" + event.state_key] = event.content
-	}
-	return kstate
-}
-
-function diffKState(actual, target) {
-	const diff = {}
-	// go through each key that it should have
-	for (const key of Object.keys(target)) {
-		if (!key.includes("/")) throw new Error(`target kstate's key "${key}" does not contain a slash separator; if a blank state_key was intended, add a trailing slash to the kstate key.\ncontext: ${JSON.stringify(target)}`)
-
-		if (key === "m.room.power_levels/") {
-			// Special handling for power levels, we want to deep merge the actual and target into the final state.
-			if (!(key in actual)) throw new Error(`want to apply a power levels diff, but original power level data is missing\nstarted with:  ${JSON.stringify(actual)}\nwant to apply: ${JSON.stringify(target)}`)
-			const temp = mixin({}, actual[key], target[key])
-			try {
-				assert.deepEqual(actual[key], temp)
-			} catch (e) {
-				// they differ. use the newly prepared object as the diff.
-				diff[key] = temp
-			}
-
-		} else if (key in actual) {
-			// diff
-			try {
-				assert.deepEqual(actual[key], target[key])
-			} catch (e) {
-				// they differ. use the target as the diff.
-				diff[key] = target[key]
-			}
-
-		} else {
-			// not present, needs to be added
-			diff[key] = target[key]
-		}
-
-		// keys that are missing in "actual" will not be deleted on "target" (no action)
-	}
-	return diff
-}
-
-module.exports.kstateStripConditionals = kstateStripConditionals
-module.exports.kstateToState = kstateToState
-module.exports.stateToKState = stateToKState
-module.exports.diffKState = diffKState

matrix/kstate.test.js

@@ -1,164 +0,0 @@
-const {kstateToState, stateToKState, diffKState, kstateStripConditionals} = require("./kstate")
-const {test} = require("supertape")
-
-test("kstate strip: strips false conditions", t => {
-	t.deepEqual(kstateStripConditionals({
-		a: {$if: false, value: 2},
-		b: {value: 4}
-	}), {
-		b: {value: 4}
-	})
-})
-
-test("kstate strip: keeps true conditions while removing $if", t => {
-	t.deepEqual(kstateStripConditionals({
-		a: {$if: true, value: 2},
-		b: {value: 4}
-	}), {
-		a: {value: 2},
-		b: {value: 4}
-	})
-})
-
-test("kstate2state: general", t => {
-	t.deepEqual(kstateToState({
-		"m.room.name/": {name: "test name"},
-		"m.room.member/@cadence:cadence.moe": {membership: "join"},
-		"uk.half-shot.bridge/org.matrix.appservice-irc://irc/epicord.net/#general": {creator: "@cadence:cadence.moe"}
-	}), [
-		{
-			type: "m.room.name",
-			state_key: "",
-			content: {
-				name: "test name"
-			}
-		},
-		{
-			type: "m.room.member",
-			state_key: "@cadence:cadence.moe",
-			content: {
-				membership: "join"
-			}
-		},
-		{
-			type: "uk.half-shot.bridge",
-			state_key: "org.matrix.appservice-irc://irc/epicord.net/#general",
-			content: {
-				creator: "@cadence:cadence.moe"
-			}
-		}
-	])
-})
-
-test("state2kstate: general", t => {
-	t.deepEqual(stateToKState([
-		{
-			type: "m.room.name",
-			state_key: "",
-			content: {
-				name: "test name"
-			}
-		},
-		{
-			type: "m.room.member",
-			state_key: "@cadence:cadence.moe",
-			content: {
-				membership: "join"
-			}
-		},
-		{
-			type: "uk.half-shot.bridge",
-			state_key: "org.matrix.appservice-irc://irc/epicord.net/#general",
-			content: {
-				creator: "@cadence:cadence.moe"
-			}
-		}
-	]), {
-		"m.room.name/": {name: "test name"},
-		"m.room.member/@cadence:cadence.moe": {membership: "join"},
-		"uk.half-shot.bridge/org.matrix.appservice-irc://irc/epicord.net/#general": {creator: "@cadence:cadence.moe"}
-	})
-})
-
-test("diffKState: detects edits", t => {
-	t.deepEqual(
-		diffKState({
-			"m.room.name/": {name: "test name"},
-			"same/": {a: 2}
-		}, {
-			"m.room.name/": {name: "edited name"},
-			"same/": {a: 2}
-		}),
-		{
-			"m.room.name/": {name: "edited name"}
-		}
-	)
-})
-
-test("diffKState: detects new properties", t => {
-	t.deepEqual(
-		diffKState({
-			"m.room.name/": {name: "test name"},
-		}, {
-			"m.room.name/": {name: "test name"},
-			"new/": {a: 2}
-		}),
-		{
-			"new/": {a: 2}
-		}
-	)
-})
-
-test("diffKState: power levels are mixed together", t => {
-	const original = {
-		"m.room.power_levels/": {
-			"ban": 50,
-			"events": {
-				"m.room.name": 100,
-				"m.room.power_levels": 100
-			},
-			"events_default": 0,
-			"invite": 50,
-			"kick": 50,
-			"notifications": {
-				"room": 20
-			},
-			"redact": 50,
-			"state_default": 50,
-			"users": {
-				"@example:localhost": 100
-			},
-			"users_default": 0
-		}
-	}
-	const result = diffKState(original, {
-		"m.room.power_levels/": {
-			"events": {
-				"m.room.avatar": 0
-			}
-		}
-	})
-	t.deepEqual(result, {
-		"m.room.power_levels/": {
-			"ban": 50,
-			"events": {
-				"m.room.name": 100,
-				"m.room.power_levels": 100,
-				"m.room.avatar": 0
-			},
-			"events_default": 0,
-			"invite": 50,
-			"kick": 50,
-			"notifications": {
-				"room": 20
-			},
-			"redact": 50,
-			"state_default": 50,
-			"users": {
-				"@example:localhost": 100
-			},
-			"users_default": 0
-		}
-	})
-	t.notDeepEqual(original, result)
-})

matrix/mreq.js

@@ -1,66 +0,0 @@
-// @ts-check
-
-const fetch = require("node-fetch").default
-const mixin = require("mixin-deep")
-
-const passthrough = require("../passthrough")
-const { sync } = passthrough
-/** @type {import("./read-registration")} */
-const reg = sync.require("./read-registration.js")
-
-const baseUrl = `${reg.ooye.server_origin}/_matrix`
-
-class MatrixServerError extends Error {
-	constructor(data, opts) {
-		super(data.error || data.errcode)
-		this.data = data
-		/** @type {string} */
-		this.errcode = data.errcode
-		this.opts = opts
-	}
-}
-
-/**
- * @param {string} method
- * @param {string} url
- * @param {any} [body]
- * @param {any} [extra]
- */
-async function mreq(method, url, body, extra = {}) {
-	const opts = mixin({
-		method,
-		body: (body == undefined || Object.is(body.constructor, Object)) ? JSON.stringify(body) : body,
-		headers: {
-			Authorization: `Bearer ${reg.as_token}`
-		}
-	}, extra)
-
-	// console.log(baseUrl + url, opts)
-	const res = await fetch(baseUrl + url, opts)
-	const root = await res.json()
-
-	if (!res.ok || root.errcode) throw new MatrixServerError(root, opts)
-	return root
-}
-
-/**
- * JavaScript doesn't have Racket-like parameters with dynamic scoping, so
- * do NOT do anything else at the same time as this.
- * @template T
- * @param {string} token
- * @param {(...arg: any[]) => Promise<T>} callback
- * @returns {Promise<T>}
- */
-async function withAccessToken(token, callback) {
-	const prevToken = reg.as_token
-	reg.as_token = token
-	try {
-		return await callback()
-	} finally {
-		reg.as_token = prevToken
-	}
-}
-
-module.exports.MatrixServerError = MatrixServerError
-module.exports.mreq = mreq
-module.exports.withAccessToken = withAccessToken

matrix/read-registration.js

@@ -1,14 +0,0 @@
-// @ts-check
-
-const fs = require("fs")
-const assert = require("assert").strict
-const yaml = require("js-yaml")
-
-/** @ts-ignore @type {import("../types").AppServiceRegistrationConfig} */
-const reg = yaml.load(fs.readFileSync("registration.yaml", "utf8"))
-reg["ooye"].invite = (reg.ooye.invite || []).filter(mxid => mxid.endsWith(`:${reg.ooye.server_name}`)) // one day I will understand why typescript disagrees with dot notation on this line
-assert(reg.ooye.max_file_size)
-assert(reg.ooye.namespace_prefix)
-assert(reg.ooye.server_name)
-
-module.exports = reg

matrix/read-registration.test.js

@@ -1,10 +0,0 @@
-const {test} = require("supertape")
-const reg = require("./read-registration")
-
-test("reg: has necessary parameters", t => {
-	const propertiesToCheck = ["sender_localpart", "id", "as_token", "ooye"]
-	t.deepEqual(
-		propertiesToCheck.filter(p => p in reg),
-		propertiesToCheck
-	)
-})

package.json

@@ -1,6 +1,6 @@
 {
   "name": "out-of-your-element",
-  "version": "1.1.1",
+  "version": "3.4.0",
   "description": "A bridge between Matrix and Discord",
   "main": "index.js",
   "repository": {
@@ -12,44 +12,61 @@
     "discord",
     "bridge"
   ],
-  "author": "Cadence, PapiOphidian",
+  "author": "Cadence",
   "license": "AGPL-3.0-or-later",
+  "engines": {
+    "node": ">=22"
+  },
   "dependencies": {
-    "@chriscdn/promise-semaphore": "^2.0.1",
+    "@chriscdn/promise-semaphore": "^3.0.1",
-    "better-sqlite3": "^9.0.0",
+    "@cloudrac3r/discord-markdown": "^2.6.10",
+    "@cloudrac3r/giframe": "^0.4.3",
+    "@cloudrac3r/html-template-tag": "^5.0.1",
+    "@cloudrac3r/in-your-element": "^1.1.1",
+    "@cloudrac3r/mixin-deep": "^3.0.1",
+    "@cloudrac3r/pngjs": "^7.0.3",
+    "@cloudrac3r/pug": "^4.0.4",
+    "@cloudrac3r/turndown": "^7.1.4",
+    "@stackoverflow/stacks": "^2.5.4",
+    "@stackoverflow/stacks-icons": "^6.0.2",
+    "ansi-colors": "^4.1.3",
+    "better-sqlite3": "^12.2.0",
     "chunk-text": "^2.0.1",
-    "cloudstorm": "^0.9.0",
+    "cloudstorm": "^0.15.2",
-    "discord-markdown": "git+https://git.sr.ht/~cadence/nodejs-discord-markdown#abc56d544072a1dc5624adfea455b0e902adf7b3",
+    "discord-api-types": "^0.38.38",
-    "entities": "^4.5.0",
+    "domino": "^2.1.6",
-    "giframe": "github:cloudrac3r/giframe#v0.4.1",
+    "enquirer": "^2.4.1",
-    "heatsync": "^2.4.1",
+    "entities": "^5.0.0",
-    "js-yaml": "^4.1.0",
+    "get-relative-path": "^1.0.2",
-    "matrix-appservice": "^2.0.0",
+    "h3": "^1.15.1",
-    "minimist": "^1.2.8",
+    "heatsync": "^2.7.2",
-    "mixin-deep": "github:cloudrac3r/mixin-deep#v3.0.0",
+    "htmx.org": "^2.0.4",
-    "node-fetch": "^2.6.7",
+    "lru-cache": "^11.0.2",
-    "pngjs": "^7.0.0",
+    "mime-types": "^2.1.35",
     "prettier-bytes": "^1.0.4",
-    "sharp": "^0.32.6",
+    "sharp": "^0.34.5",
-    "snowtransfer": "^0.9.0",
+    "snowtransfer": "^0.17.1",
     "stream-mime-type": "^1.0.2",
     "try-to-catch": "^3.0.1",
-    "turndown": "^7.1.2",
+    "uqr": "^0.1.2",
-    "xxhash-wasm": "^1.0.2"
+    "xxhash-wasm": "^1.0.2",
+    "zod": "^4.0.17"
+  },
+  "overrides": {
+    "glob@<11.1": "^12"
   },
   "devDependencies": {
-    "@types/node": "^18.16.0",
+    "@cloudrac3r/tap-dot": "^2.0.3",
-    "@types/node-fetch": "^2.6.3",
+    "@types/node": "^22.17.1",
-    "c8": "^8.0.1",
+    "c8": "^10.1.2",
     "cross-env": "^7.0.3",
-    "discord-api-types": "^0.37.60",
+    "supertape": "^12.0.12"
-    "supertape": "^8.3.0",
-    "tap-dot": "github:cloudrac3r/tap-dot#9dd7750ececeae3a96afba91905be812b6b2cc2d"
   },
   "scripts": {
+    "start": "node --enable-source-maps start.js",
+    "setup": "node --enable-source-maps scripts/setup.js",
     "addbot": "node addbot.js",
-    "test": "cross-env FORCE_COLOR=true supertape --no-check-assertions-count --format tap test/test.js | tap-dot",
+    "test": "cross-env FORCE_COLOR=true supertape --no-check-assertions-count --format tap --no-worker test/test.js | tap-dot",
-    "test-slow": "cross-env FORCE_COLOR=true supertape --no-check-assertions-count --format tap test/test.js -- --slow | tap-dot",
+    "cover": "c8 -o test/coverage --skip-full -x db/migrations -x src/m2d/event-dispatcher.js -x src/matrix/file.js -x src/matrix/api.js -x src/d2m/converters/rlottie-wasm.js -r html -r text supertape --no-check-assertions-count --format fail --no-worker test/test.js -- --slow"
-    "cover": "c8 --skip-full -x db/migrations -x matrix/file.js -x matrix/api.js -x matrix/mreq.js -r html -r text supertape --no-check-assertions-count --format fail test/test.js -- --slow"
   }
 }

readme.md

@@ -2,176 +2,44 @@
 
 <img src="docs/img/icon.png" height="128" width="128">
 
-Modern Matrix-to-Discord appservice bridge.
+Modern Matrix-to-Discord appservice bridge, created by [@cadence:cadence.moe](https://matrix.to/#/@cadence:cadence.moe)
 
-Created by [@cadence:cadence.moe](https://matrix.to/#/@cadence:cadence.moe) // Discuss in [#out-of-your-element:cadence.moe](https://matrix.to/#/#out-of-your-element:cadence.moe)
+[![Releases](https://img.shields.io/gitea/v/release/cadence/out-of-your-element?gitea_url=https%3A%2F%2Fgitdab.com&style=plastic&color=green)](https://gitdab.com/cadence/out-of-your-element/releases) [![Discuss on Matrix](https://img.shields.io/badge/discuss-%23out--of--your--element-white?style=plastic)](https://matrix.to/#/#out-of-your-element:cadence.moe)
 
-## Docs
+![](https://cadence.moe/i/f42a3f)
-
-This readme has the most important info. The rest is [in the docs folder.](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs)
 
 ## Why a new bridge?
 
 * Modern: Supports new Discord features like replies, threads and stickers, and new Matrix features like edits, spaces and space membership.
-* Efficient: Special attention has been given to memory usage, database indexes, disk footprint, runtime algorithms, and queries to the homeserver.
+* Efficient: Special attention has been given to memory usage, database indexes, disk footprint, runtime algorithms, and queries to the homeserver. [Efficiency details.](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs/developer-orientation.md)
-* Reliable: Any errors on either side are notified on Matrix and can be retried.
+* Reliable: Any errors on either side are notified on Matrix and can be retried. Messages sent during bridge downtime will still be bridged after it comes back up.
-* Tested: A test suite and code coverage make sure all the core logic works.
+* Tested: A test suite and code coverage make sure all the logic and special cases work.
 * Simple development: No build step (it's JavaScript, not TypeScript), minimal/lightweight dependencies, and abstraction only where necessary so that less background knowledge is required. No need to learn about Intents or library functions.
 * No locking algorithm: Other bridges use a locking algorithm which is a source of frequent bugs. This bridge avoids the need for one.
 * Latest API: Being on the latest Discord API version lets it access all features, without the risk of deprecated API versions being removed.
 
 ## What works?
 
-Most features you'd expect in both directions, plus a little extra spice:
+Most features you'd expect in both directions: messages, edits, deletions, formatting (including spoilers), reactions, custom emojis, custom emoji reactions, mentions, channel mentions, replies, threads, stickers (all formats: PNG, APNG, GIF, Lottie), attachments, spoiler attachments (compatible with most clients), embeds, URL previews, presence, discord.com hyperlinks, and more.
 
-* Messages
+Metadata is also synced: people's names, avatars, usernames; channel names, icons, topics; spaces containing rooms; custom emoji lists. Syncing Matrix rooms, room icons, and topics is optional: you can keep them different from the Discord ones if you prefer.
-* Edits
+
-* Deletions
+I've also added some interesting features that I haven't seen in any other bridge:
-* Text formatting, including spoilers
+
-* Reactions
+* Members using the PluralKit bot each get their own persistent accounts
-* Mentions
+* Replies from PluralKit members are restyled into native Matrix replies
-* Replies
+* Simulated user accounts are named @the_persons_username rather than @112233445566778899
-* Threads
+* Matrix custom emojis from private rooms are still visible on Discord as a sprite sheet
-* Stickers (all formats: PNG, APNG, GIF, and Lottie)
+* To save space, larger files from Discord are linked instead of reuploaded to Matrix (links don't expire)
-* Attachments
-* Spoiler attachments
-* Embeds
-* Guild-Space details syncing
-* Channel-Room details syncing
-* Custom emoji list syncing
-* Custom emojis in messages
-* Custom room names/avatars can be applied on Matrix-side
-* Larger files from Discord are linked instead of reuploaded to Matrix
 
 For more information about features, [see the user guide.](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs/user-guide.md)
 
 ## Caveats
 
 * This bridge is not designed for puppetting.
-* Direct Messaging is not supported yet.
+* Direct Messaging is not supported until I figure out a good way of doing it.
+* Encrypted messages are not supported. Decryption is often unreliable on Matrix, and your messages end up in plaintext on Discord anyway, so there's not much advantage.
 
-## Efficiency details
+## Get started!
 
-Using WeatherStack as a thin layer between the bridge application and the Discord API lets us control exactly what data is cached. Only necessary information is cached. For example, member data, user data, message content, and past edits are never stored in memory. This keeps the memory usage low and also prevents it ballooning in size over the bridge's runtime.
+[Read the installation instructions →](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs/get-started.md)
-
-The bridge uses a small SQLite database to store relationships like which Discord messages correspond to which Matrix messages. This is so the bridge knows what to edit when some message is edited on Discord. Using `without rowid` on the database tables stores the index and the data in the same B-tree. Since Matrix and Discord's internal IDs are quite long, this vastly reduces storage space because those IDs do not have to be stored twice separately. Some event IDs are actually stored as xxhash integers to reduce storage requirements even more. On my personal instance of OOYE, every 100,000 messages require 16.1 MB of storage space in the SQLite database.
-
-Only necessary data and columns are queried from the database. We only contact the homeserver API if the database doesn't contain what we need.
-
-File uploads (like avatars from bridged members) are checked locally and deduplicated. Only brand new files are uploaded to the homeserver. This saves loads of space in the homeserver's media repo, especially for Synapse.
-
-Switching to [WAL mode](https://www.sqlite.org/wal.html) could improve your database access speed even more. Run `node scripts/wal.js` if you want to switch to WAL mode.
-
-# Setup
-
-If you get stuck, you're welcome to message @cadence:cadence.moe to ask for help setting up OOYE!
-
-You'll need:
-
-* Administrative access to a homeserver
-* Discord bot
-
-Follow these steps:
-
-1. [Get Node.js version 18 or later](https://nodejs.org/en/download/releases) (the version is required by the better-sqlite3 and matrix-appservice dependencies)
-
-1. Clone this repo and checkout a specific tag. (Development happens on main. Stabler versions are tagged.)
-
-1. Install dependencies: `npm install --save-dev` (omit --save-dev if you will not run the automated tests)
-
-1. Copy `config.example.js` to `config.js` and fill in Discord token.
-
-1. Copy `registration.example.yaml` to `registration.yaml` and fill in bracketed values. You could generate each hex string with `dd if=/dev/urandom bs=32 count=1 2> /dev/null | basenc --base16 | dd conv=lcase 2> /dev/null`. Register the registration in Synapse's `homeserver.yaml` through the usual appservice installation process, then restart Synapse.
-
-1. Run `node scripts/seed.js` to check your setup and set the bot's initial state. You only need to run this once ever.
-1. Make sure the tests work by running `npm t`
-
-1. Start the bridge: `node start.js`
-
-1. Add the bot to a server - use any *one* of the following commands for an invite link:
-	* (in the REPL) `addbot`
-	* (in a chat) `//addbot`
-	* $ `node addbot.js`
-	* $ `npm run addbot`
-	* $ `./addbot.sh`
-
-# Development setup
-
-* Be sure to install dependencies with `--save-dev` so you can run the tests.
-* Any files you change will automatically be reloaded, except for `stdin.js` and `d2m/discord-*.js`.
-* If developing on a different computer to the one running the homeserver, use SSH port forwarding so that Synapse can connect on its `localhost:6693` to reach the running bridge on your computer. Example: `ssh -T -v -R 6693:localhost:6693 me@matrix.cadence.moe`
-* I recommend developing in Visual Studio Code so that the JSDoc x TypeScript annotation comments work. I don't know which other editors or language servers support annotations and type inference.
-
-## Repository structure
-
-    .
-    * Run this to start the bridge:
-    ├── start.js
-    * Runtime configuration, like tokens and user info:
-    ├── config.js
-    ├── registration.yaml
-    * The bridge's SQLite database is stored here:
-    ├── db
-    │   ├── *.sql, *.db
-    │   * Migrations change the database schema when you update to a newer version of OOYE:
-    │   └── migrations
-    │       └── *.sql, *.js
-    * Discord-to-Matrix bridging:
-    ├── d2m
-    │   * Execute actions through the whole flow, like sending a Discord message to Matrix:
-    │   ├── actions
-    │   │   └── *.js
-    │   * Convert data from one form to another without depending on bridge state. Called by actions:
-    │   ├── converters
-    │   │   └── *.js
-    │   * Making Discord work:
-    │   ├── discord-*.js
-    │   * Listening to events from Discord and dispatching them to the correct `action`:
-    │   └── event-dispatcher.js
-    ├── discord
-    │   └── discord-command-handler.js
-    * Matrix-to-Discord bridging:
-    ├── m2d
-    │   * Execute actions through the whole flow, like sending a Matrix message to Discord:
-    │   ├── actions
-    │   │   └── *.js
-    │   * Convert data from one form to another without depending on bridge state. Called by actions:
-    │   ├── converters
-    │   │   └── *.js
-    │   * Listening to events from Matrix and dispatching them to the correct `action`:
-    │   └── event-dispatcher.js
-    * We aren't using the matrix-js-sdk, so here are all the functions for the Matrix C-S and Appservice APIs:
-    ├── matrix
-    │   └── *.js
-    * Various files you can run once if you need them.
-    ├── scripts
-    │   * First time running a new bridge? Run this file to plant a seed, which will flourish into state for the bridge:
-    │   ├── seed.js
-    │   * Hopefully you won't need the rest of these. Code quality varies wildly.
-    │   └── *.js
-    * You are here! :)
-    └── readme.md
-
-## Dependency justification
-
-(deduped transitive dependency count) dependency name: explanation
-
-* (0) @chriscdn/promise-semaphore: It does what I want! I like it!
-* (42) better-sqlite3: SQLite3 is the best database, and this is the best library for it. Really! I love it.
-* (1) chunk-text: It does what I want.
-* (0) cloudstorm: Discord gateway library with bring-your-own-caching that I trust.
-* (8) snowtransfer: Discord API library with bring-your-own-caching that I trust.
-* (1) discord-markdown: This is my fork! I make sure it does what I want.
-* (0) giframe: This is my fork! It should do what I want.
-* (1) heatsync: Module hot-reloader that I trust.
-* (0) entities: Looks fine. No dependencies.
-* (1) js-yaml: It seems to do what I want, and it's already pulled in by matrix-appservice.
-* (70) matrix-appservice: I wish it didn't pull in express :(
-* (0) minimist: It's already pulled in by better-sqlite3->prebuild-install
-* (0) mixin-deep: This is my fork! It fixes a bug in regular mixin-deep.
-* (3) node-fetch@2: I like it and it does what I want.
-* (0) pngjs: Lottie stickers are converted to bitmaps with the vendored Rlottie WASM build, then the bitmaps are converted to PNG with pngjs.
-* (0) prettier-bytes: It does what I want and has no dependencies.
-* (51) sharp: Jimp has fewer dependencies, but sharp is faster.
-* (0) try-to-catch: Not strictly necessary, but it does what I want and has no dependencies.
-* (1) turndown: I need an HTML-to-Markdown converter and this one looked suitable enough. It has some bugs that I've worked around, so I might switch away from it later.

registration.example.yaml

@@ -1,23 +0,0 @@
-id: de8c56117637cb5d9f4ac216f612dc2adb1de4c09ae8d13553f28c33a28147c7
-hs_token: [a unique 64 character hex string]
-as_token: [a unique 64 character hex string]
-url: http://localhost:6693
-sender_localpart: _ooye_bot
-protocols:
-  - discord
-namespaces:
-  users:
-    - exclusive: true
-      regex: '@_ooye_.*'
-  aliases:
-    - exclusive: true
-      regex: '#_ooye_.*'
-rate_limited: false
-ooye:
-  namespace_prefix: _ooye_
-  max_file_size: 5000000
-  server_name: [the part after the colon in your matrix id, like cadence.moe]
-  server_origin: [the full protocol and domain of your actual matrix server's location, with no trailing slash, like https://matrix.cadence.moe]
-  invite:
-    # uncomment this to auto-invite the named user to newly created spaces and mark them as admin (PL 100) everywhere
-    # - @cadence:cadence.moe

scripts/backfill.js

@@ -0,0 +1,82 @@
+#!/usr/bin/env node
+// @ts-check
+
+console.log("-=- This script is experimental. It WILL mess up the room history on Matrix. -=-")
+console.log()
+
+const {channel: channelID} = require("minimist")(process.argv.slice(2), {string: ["channel"]})
+if (!channelID) {
+	console.error("Usage: ./scripts/backfill.js --channel=<channel id here>")
+	process.exit(1)
+}
+
+const assert = require("assert/strict")
+const sqlite = require("better-sqlite3")
+const backfill = new sqlite("scripts/backfill.db")
+backfill.prepare("CREATE TABLE IF NOT EXISTS backfill (channel_id TEXT NOT NULL, message_id INTEGER NOT NULL, PRIMARY KEY (channel_id, message_id))").run()
+
+const HeatSync = require("heatsync")
+
+const {reg} = require("../src/matrix/read-registration")
+const passthrough = require("../src/passthrough")
+
+const sync = new HeatSync({watchFS: false})
+const db = new sqlite("ooye.db")
+Object.assign(passthrough, {sync, db})
+
+const DiscordClient = require("../src/d2m/discord-client")
+
+const discord = new DiscordClient(reg.ooye.discord_token, "half")
+passthrough.discord = discord
+
+const {as} = require("../src/matrix/appservice")
+passthrough.as = as
+
+const orm = sync.require("../src/db/orm")
+passthrough.from = orm.from
+passthrough.select = orm.select
+
+/** @type {import("../src/d2m/event-dispatcher")}*/
+const eventDispatcher = sync.require("../src/d2m/event-dispatcher")
+
+const roomID = passthrough.select("channel_room", "room_id", {channel_id: channelID}).pluck().get()
+if (!roomID) {
+	console.error("Please choose a channel that's already bridged.")
+	process.exit(1)
+}
+
+;(async () => {
+	await discord.cloud.connect()
+	console.log("Connected, waiting for data about requested channel...")
+
+	discord.cloud.on("event", event)
+})()
+
+const preparedInsert = backfill.prepare("INSERT INTO backfill (channel_id, message_id) VALUES (?, ?)")
+
+async function event(event) {
+	if (event.t !== "GUILD_CREATE") return
+	const channel = event.d.channels.find(c => c.id === channelID)
+	if (!channel) return
+	const guild_id = event.d.id
+
+	let last = backfill.prepare("SELECT cast(max(message_id) as TEXT) FROM backfill WHERE channel_id = ?").pluck().get(channelID) || "0"
+	console.log(`OK, processing messages for #${channel.name}, continuing from ${last}`)
+
+	while (last) {
+		const messages = await discord.snow.channel.getChannelMessages(channelID, {limit: 50, after: String(last)})
+		messages.reverse() // More recent messages come first -> More recent messages come last
+		for (const message of messages) {
+			const simulatedGatewayDispatchData = {
+				guild_id,
+				backfill: true,
+				...message
+			}
+			await eventDispatcher.MESSAGE_CREATE(discord, simulatedGatewayDispatchData)
+			preparedInsert.run(channelID, message.id)
+		}
+		last = messages.at(-1)?.id
+	}
+
+	process.exit()
+}

scripts/capture-message-update-events.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 // @ts-check
 
 // ****
@@ -16,16 +17,16 @@ function fieldToPresenceValue(field) {
 const sqlite = require("better-sqlite3")
 const HeatSync = require("heatsync")
 
-const config = require("../config")
+const {reg} = require("../src/matrix/read-registration")
-const passthrough = require("../passthrough")
+const passthrough = require("../src/passthrough")
 
 const sync = new HeatSync({watchFS: false})
 
-Object.assign(passthrough, {config, sync})
+Object.assign(passthrough, {sync})
 
-const DiscordClient = require("../d2m/discord-client")
+const DiscordClient = require("../src/d2m/discord-client")
 
-const discord = new DiscordClient(config.discordToken, "no")
+const discord = new DiscordClient(reg.ooye.discord_token, "no")
 passthrough.discord = discord
 
 ;(async () => {
@@ -37,7 +38,7 @@ passthrough.discord = discord
 })()
 
 const events = new sqlite("scripts/events.db")
-const sql = "INSERT INTO \"update\" (json, " + interestingFields.join(", ") + ") VALUES (" + "?".repeat(interestingFields.length + 1).split("").join(", ") + ")"
+const sql = "INSERT INTO update_event (json, " + interestingFields.join(", ") + ") VALUES (" + "?".repeat(interestingFields.length + 1).split("").join(", ") + ")"
 console.log(sql)
 const prepared = events.prepare(sql)
 

scripts/check-migrate.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 // @ts-check
 
 // Trigger the database migration flow and exit after committing.
@@ -5,11 +6,10 @@
 
 const sqlite = require("better-sqlite3")
 
-const config = require("../config")
+const passthrough = require("../src/passthrough")
-const passthrough = require("../passthrough")
+const db = new sqlite("ooye.db")
-const db = new sqlite("db/ooye.db")
+const migrate = require("../src/db/migrate")
-const migrate = require("../db/migrate")
 
-Object.assign(passthrough, {config, db })
+Object.assign(passthrough, {db})
 
 migrate.migrate(db)

scripts/emoji-surrogates-statistics.js

@@ -0,0 +1,77 @@
+// @ts-check
+
+const fs = require("fs")
+const {join} = require("path")
+const s = fs.readFileSync(join(__dirname, "..", "src", "m2d", "converters", "emojis.txt"), "utf8").split("\n").map(x => encodeURIComponent(x))
+const searchPattern = "%EF%B8%8F"
+
+/**
+ * adapted from es.map.group-by.js in core-js
+ * @template K,V
+ * @param {V[]} items
+ * @param {(item: V) => K} fn
+ * @returns {Map<K, V[]>}
+ */
+function groupBy(items, fn) {
+	var map = new Map();
+	for (const value of items) {
+		var key = fn(value);
+		if (!map.has(key)) map.set(key, [value]);
+		else map.get(key).push(value);
+	}
+	return map;
+}
+
+/**
+ * @param {number[]} items
+ * @param {number} width
+ */
+function xhistogram(items, width) {
+	const chars = " ▏▎▍▌▋▊▉"
+	const max = items.reduce((a, c) => c > a ? c : a, 0)
+	return items.map(v => {
+		const p = v / max * (width-1)
+		return (
+			Array(Math.floor(p)).fill("█").join("") /* whole part */
+			+ chars[Math.ceil((p % 1) * (chars.length-1))] /* decimal part */
+		).padEnd(width)
+	})
+}
+
+/**
+ * @param {number[]} items
+ * @param {[number, number]} xrange
+ */
+function yhistogram(items, xrange, printHeader = false) {
+	const chars = "░▁_▂▃▄▅▆▇█"
+	const ones = "₀₁₂₃₄₅₆₇₈₉"
+	const tens = "0123456789"
+	const xy = []
+	let max = 0
+	/** value (x) -> frequency (y) */
+	const grouped = groupBy(items, x => x)
+	for (let i = xrange[0]; i <= xrange[1]; i++) {
+		if (printHeader) {
+			if (i === -1) process.stdout.write("-")
+			else if (i.toString().at(-1) === "0") process.stdout.write(tens[i/10])
+			else process.stdout.write(ones[i%10])
+		}
+		const y = grouped.get(i)?.length ?? 0
+		if (y > max) max = y
+		xy.push(y)
+	}
+	if (printHeader) console.log()
+	return xy.map(y => chars[Math.ceil(y / max * (chars.length-1))]).join("")
+}
+
+const grouped = groupBy(s, x => x.length)
+const sortedGroups = [...grouped.entries()].sort((a, b) => b[0] - a[0])
+let length = 0
+const lengthHistogram = xhistogram(sortedGroups.map(v => v[1].length), 10)
+for (let i = 0; i < sortedGroups.length; i++) {
+	const [k, v] = sortedGroups[i]
+	const l = lengthHistogram[i]
+	const h = yhistogram(v.map(x => x.indexOf(searchPattern)), [-1, k - searchPattern.length], i === 0)
+	if (i === 0) length = h.length + 1
+	console.log(`${h.padEnd(length, i % 2 === 0 ? "⸱" : " ")}length ${k.toString().padEnd(3)} ${l} ${v.length}`)
+}

scripts/estimate-size.js

@@ -0,0 +1,65 @@
+// @ts-check
+
+const pb = require("prettier-bytes")
+const sqlite = require("better-sqlite3")
+const HeatSync = require("heatsync")
+
+const {reg} = require("../src/matrix/read-registration")
+const passthrough = require("../src/passthrough")
+
+const sync = new HeatSync({watchFS: false})
+Object.assign(passthrough, {reg, sync})
+
+const DiscordClient = require("../src/d2m/discord-client")
+
+const discord = new DiscordClient(reg.ooye.discord_token, "no")
+passthrough.discord = discord
+
+const db = new sqlite("ooye.db")
+passthrough.db = db
+
+const api = require("../src/matrix/api")
+
+const {room: roomID} = require("minimist")(process.argv.slice(2), {string: ["room"]})
+if (!roomID) {
+	console.error("Usage: ./scripts/estimate-size.js --room=<!room id here>")
+	process.exit(1)
+}
+
+const {channel_id, guild_id} = db.prepare("SELECT channel_id, guild_id FROM channel_room WHERE room_id = ?").get(roomID)
+
+const max = 1000
+
+;(async () => {
+	let total = 0
+	let size = 0
+	let from
+
+	while (total < max) {
+		const events = await api.getEvents(roomID, "b", {limit: 1000, from})
+		total += events.chunk.length
+		from = events.end
+		console.log(`Fetched ${total} events so far`)
+
+		for (const e of events.chunk) {
+			if (e.content?.info?.size) {
+				size += e.content.info.size
+			}
+		}
+
+		if (events.chunk.length === 0 || !events.end) break
+	}
+
+	console.log(`Total size of uploads: ${pb(size)}`)
+
+	const searchResults = await discord.snow.requestHandler.request(`/guilds/${guild_id}/messages/search`, {
+		channel_id,
+		offset: "0",
+		limit: "1"
+	}, "get", "json")
+
+	const totalAllTime = searchResults.total_results
+	const fractionCounted = total / totalAllTime
+	console.log(`That counts for ${(fractionCounted*100).toFixed(2)}% of the history on Discord (${totalAllTime.toLocaleString()} messages)`)
+	console.log(`The size of uploads for the whole history would be approx: ${pb(Math.floor(size/total*totalAllTime))}`)
+})()

scripts/migrate-from-old-bridge.js

@@ -1,24 +1,22 @@
+#!/usr/bin/env node
 // @ts-check
 
 const assert = require("assert").strict
-/** @type {any} */ // @ts-ignore bad types from semaphore
+const {Semaphore} = require("@chriscdn/promise-semaphore")
-const Semaphore = require("@chriscdn/promise-semaphore")
 const sqlite = require("better-sqlite3")
 const HeatSync = require("heatsync")
 
-const config = require("../config")
+const passthrough = require("../src/passthrough")
-const passthrough = require("../passthrough")
 
 const sync = new HeatSync({watchFS: false})
 
-/** @type {import("../matrix/read-registration")} */
+const {reg} = require("../src/matrix/read-registration")
-const reg = sync.require("../matrix/read-registration")
 assert(reg.old_bridge)
 const oldAT = reg.old_bridge.as_token
 const newAT = reg.as_token
 
 const oldDB = new sqlite(reg.old_bridge.database)
-const db = new sqlite("db/ooye.db")
+const db = new sqlite("ooye.db")
 
 db.exec(`CREATE TABLE IF NOT EXISTS half_shot_migration (
 	discord_channel	TEXT NOT NULL,
@@ -26,20 +24,22 @@ db.exec(`CREATE TABLE IF NOT EXISTS half_shot_migration (
 	PRIMARY KEY("discord_channel")
 ) WITHOUT ROWID;`)
 
-Object.assign(passthrough, {config, sync, db})
+Object.assign(passthrough, {sync, db})
 
-const DiscordClient = require("../d2m/discord-client")
+const DiscordClient = require("../src/d2m/discord-client")
-const discord = new DiscordClient(config.discordToken, "half")
+const discord = new DiscordClient(reg.ooye.discord_token, "half")
 passthrough.discord = discord
 
-/** @type {import("../d2m/actions/create-space")} */
+/** @type {import("../src/d2m/actions/create-space")} */
 const createSpace = sync.require("../d2m/actions/create-space")
-/** @type {import("../d2m/actions/create-room")} */
+/** @type {import("../src/d2m/actions/create-room")} */
 const createRoom = sync.require("../d2m/actions/create-room")
-/** @type {import("../matrix/mreq")} */
+/** @type {import("../src/matrix/mreq")} */
 const mreq = sync.require("../matrix/mreq")
-/** @type {import("../matrix/api")} */
+/** @type {import("../src/matrix/api")} */
-const api = sync.require("../matrix/api")
+const api = sync.require("../src/matrix/api")
+/** @type {import("../src/matrix/utils")} */
+const utils = sync.require("../src/matrix/utils")
 
 const sema = new Semaphore()
 
@@ -82,16 +82,8 @@ async function migrateGuild(guild) {
 		// Step 2: (Using old bridge access token) Join the new bridge to the old rooms and give it PL 100
 		console.log(`-- Joining channel ${channel.name}...`)
 		await mreq.withAccessToken(oldAT, async () => {
-			try {
+			await api.inviteToRoom(roomID, newBridgeMxid)
-				await api.inviteToRoom(roomID, newBridgeMxid)
+			await utils.setUserPower(roomID, newBridgeMxid, 100, api)
-			} catch (e) {
-				if (e.message.includes("is already in the room")) {
-					// Great!
-				} else {
-					throw e
-				}
-			}
-			await api.setUserPower(roomID, newBridgeMxid, 100)
 		})
 		await api.joinRoom(roomID)
 
@@ -116,7 +108,7 @@ async function migrateGuild(guild) {
 			// (By the way, thread_parent is always null here because thread rooms would never be migrated because they are not in the old bridge.)
 			db.transaction(() => {
 				db.prepare("DELETE FROM channel_room WHERE channel_id = ?").run(channel.id)
-				db.prepare("INSERT INTO channel_room (channel_id, room_id, name, nick, custom_avatar) VALUES (?, ?, ?, ?, ?)").run(channel.id, row.matrix_id, channel.name, preMigrationRow.nick, preMigrationRow.custom_avatar)
+				db.prepare("INSERT INTO channel_room (channel_id, room_id, name, nick, custom_avatar, guild_id) VALUES (?, ?, ?, ?, ?, ?)").run(channel.id, row.matrix_id, channel.name, preMigrationRow.nick, preMigrationRow.custom_avatar, guild.id)
 				console.log(`-- -- Added to database (transferred properties from previous OOYE room)`)
 			})()
 		} else {

scripts/register.js

@@ -1,22 +0,0 @@
-// @ts-check
-
-const { AppServiceRegistration } = require("matrix-appservice");
-
-let id = AppServiceRegistration.generateToken()
-try {
-	const reg = require("../matrix/read-registration")
-	if (reg.id) id = reg.id
-} catch (e) {}
-
-// creating registration files
-const newReg = new AppServiceRegistration(null);
-newReg.setAppServiceUrl("http://localhost:6693");
-newReg.setId(id);
-newReg.setHomeserverToken(AppServiceRegistration.generateToken());
-newReg.setAppServiceToken(AppServiceRegistration.generateToken());
-newReg.setSenderLocalpart("_ooye_bot");
-newReg.addRegexPattern("users", "@_ooye_.*", true);
-newReg.addRegexPattern("aliases", "#_ooye_.*", true);
-newReg.setProtocols(["discord"]); // For 3PID lookups
-newReg.setRateLimited(false);
-newReg.outputAsYaml("registration.yaml");

scripts/remove-old-bridged-users.js

@@ -0,0 +1,40 @@
+// @ts-check
+
+const HeatSync = require("heatsync")
+const sync = new HeatSync({watchFS: false})
+
+const sqlite = require("better-sqlite3")
+const db = new sqlite("db/ooye.db")
+
+const passthrough = require("../src/passthrough")
+Object.assign(passthrough, {db, sync})
+
+const api = require("../src/matrix/api")
+const utils = require("../src/matrix/utils")
+const mreq = require("../src/matrix/mreq")
+
+const rooms = db.prepare("select room_id from channel_room").pluck().all()
+
+;(async () => {
+	// Step 5: Kick users starting with @_discord_
+	await mreq.withAccessToken("baby", async () => {
+		for (const roomID of rooms) {
+			try {
+				const members = await api.getJoinedMembers(roomID)
+				for (const mxid of Object.keys(members.joined)) {
+					if (mxid.startsWith("@_discord_") && !mxid.startsWith("@_discord_bot")) {
+						await api.leaveRoom(roomID, mxid)
+					}
+				}
+				await utils.setUserPower(roomID, "@_discord_bot:cadence.moe", 0, api)
+				await api.leaveRoom(roomID)
+			} catch (e) {
+				if (e.message.includes("Appservice not in room")) {
+					// ok
+				} else {
+					throw e
+				}
+			}
+		}
+	})
+})()

scripts/reset-web-password.js

@@ -0,0 +1,17 @@
+// @ts-check
+
+const {reg, writeRegistration, registrationFilePath} = require("../src/matrix/read-registration")
+const {prompt} = require("enquirer")
+
+;(async () => {
+	/** @type {{web_password: string}} */
+	const passwordResponse = await prompt({
+		type: "text",
+		name: "web_password",
+		message: "Choose a simple password (optional)"
+	})
+
+	reg.ooye.web_password = passwordResponse.web_password
+	writeRegistration(reg)
+	console.log("Saved. Restart Out Of Your Element to apply this change.")
+})()

scripts/save-channel-names-to-db.js

@@ -1,19 +1,20 @@
+#!/usr/bin/env node
 // @ts-check
 
 const sqlite = require("better-sqlite3")
 const HeatSync = require("heatsync")
 
-const config = require("../config")
+const {reg} = require("../src/matrix/read-registration")
-const passthrough = require("../passthrough")
+const passthrough = require("../src/passthrough")
-const db = new sqlite("db/ooye.db")
+const db = new sqlite("ooye.db")
 
 const sync = new HeatSync({watchFS: false})
 
-Object.assign(passthrough, {config, sync, db})
+Object.assign(passthrough, {sync, db})
 
-const DiscordClient = require("../d2m/discord-client")
+const DiscordClient = require("../src/d2m/discord-client")
 
-const discord = new DiscordClient(config.discordToken, "no")
+const discord = new DiscordClient(reg.ooye.discord_token, "no")
 passthrough.discord = discord
 
 ;(async () => {

scripts/save-event-types-to-db.js

@@ -1,16 +1,17 @@
+#!/usr/bin/env node
 // @ts-check
 
 const sqlite = require("better-sqlite3")
 const HeatSync = require("heatsync")
 
-const passthrough = require("../passthrough")
+const passthrough = require("../src/passthrough")
-const db = new sqlite("db/ooye.db")
+const db = new sqlite("ooye.db")
 
 const sync = new HeatSync({watchFS: false})
 
 Object.assign(passthrough, {sync, db})
 
-const api = require("../matrix/api")
+const api = require("../src/matrix/api")
 
 /** @type {{event_id: string, room_id: string, event_type: string}[]} */ // @ts-ignore
 const rows = db.prepare("SELECT event_id, room_id, event_type FROM event_message INNER JOIN message_channel USING (message_id) INNER JOIN channel_room USING (channel_id)").all()

scripts/seed.js

@@ -1,125 +0,0 @@
-// @ts-check
-
-console.log("This could take up to 30 seconds. Please be patient.")
-
-const assert = require("assert").strict
-const fs = require("fs")
-const sqlite = require("better-sqlite3")
-const HeatSync = require("heatsync")
-
-const args = require("minimist")(process.argv.slice(2), {string: ["emoji-guild"]})
-
-const config = require("../config")
-const passthrough = require("../passthrough")
-const db = new sqlite("db/ooye.db")
-const migrate = require("../db/migrate")
-
-const sync = new HeatSync({watchFS: false})
-
-Object.assign(passthrough, { sync, config, db })
-
-const orm = sync.require("../db/orm")
-passthrough.from = orm.from
-passthrough.select = orm.select
-
-const DiscordClient = require("../d2m/discord-client")
-const discord = new DiscordClient(config.discordToken, "no")
-passthrough.discord = discord
-
-const api = require("../matrix/api")
-const file = require("../matrix/file")
-const reg = require("../matrix/read-registration")
-const utils = require("../m2d/converters/utils")
-
-function die(message) {
-	console.error(message)
-	process.exit(1)
-}
-
-async function uploadAutoEmoji(guild, name, filename) {
-	let emoji = guild.emojis.find(e => e.name === name)
-	if (!emoji) {
-		console.log(`   Uploading ${name}...`)
-		const data = fs.readFileSync(filename, null)
-		emoji = await discord.snow.guildAssets.createEmoji(guild.id, {name, image: "data:image/png;base64," + data.toString("base64")})
-	} else {
-		console.log(`   Reusing ${name}...`)
-	}
-	db.prepare("REPLACE INTO auto_emoji (name, emoji_id, guild_id) VALUES (?, ?, ?)").run(emoji.name, emoji.id, guild.id)
-	return emoji
-}
-
-;(async () => {
-	const mxid = `@${reg.sender_localpart}:${reg.ooye.server_name}`
-
-	// ensure registration is correctly set...
-	assert(reg.sender_localpart.startsWith(reg.ooye.namespace_prefix)) // appservice's localpart must be in the namespace it controls
-	assert(utils.eventSenderIsFromDiscord(mxid)) // appservice's mxid must be in the namespace it controls
-	assert(reg.ooye.server_origin.match(/^https?:\/\//)) // must start with http or https
-	assert.notEqual(reg.ooye.server_origin.slice(-1), "/") // must not end in slash
-	console.log("✅ Configuration looks good...")
-
-	// database ddl...
-	await migrate.migrate(db)
-
-	// add initial rows to database, like adding the bot to sim...
-	db.prepare("INSERT OR IGNORE INTO sim (user_id, sim_name, localpart, mxid) VALUES (?, ?, ?, ?)").run("0", reg.sender_localpart.slice(reg.ooye.namespace_prefix.length), reg.sender_localpart, mxid)
-
-	console.log("✅ Database is ready...")
-
-	// upload the L1 L2 emojis to some guild
-	const emojis = db.prepare("SELECT name FROM auto_emoji WHERE name = 'L1' OR name = 'L2'").pluck().all()
-	if (emojis.length !== 2) {
-		// If an argument was supplied, always use that one
-		let guild = null
-		if (args["emoji-guild"]) {
-			if (typeof args["emoji-guild"] === "string") {
-				guild = await discord.snow.guild.getGuild(args["emoji-guild"])
-			}
-			if (!guild) return die(`Error: You asked emojis to be uploaded to guild ID ${args["emoji-guild"]}, but the bot isn't in that guild.`)
-		}
-		// Otherwise, check if we have already registered an auto emoji guild
-		if (!guild) {
-			const guildID = passthrough.select("auto_emoji", "guild_id", {name: "_"}).pluck().get()
-			if (guildID) {
-				guild = await discord.snow.guild.getGuild(guildID, false)
-			}
-		}
-		// Otherwise, check if we should create a new guild
-		if (!guild) {
-			const guilds = await discord.snow.user.getGuilds({limit: 11, with_counts: false})
-			if (guilds.length < 10) {
-				console.log("   Creating a guild for emojis...")
-				guild = await discord.snow.guild.createGuild({name: "OOYE Emojis"})
-			}
-		}
-		// Otherwise, it's the user's problem
-		if (!guild) {
-			return die(`Error: The bot needs to upload some emojis. Please say where to upload them to. Run seed.js again with --emoji-guild=GUILD_ID`)
-		}
-		// Upload those emojis to the chosen location
-		db.prepare("REPLACE INTO auto_emoji (name, emoji_id, guild_id) VALUES ('_', '_', ?)").run(guild.id)
-		await uploadAutoEmoji(guild, "L1", "docs/img/L1.png")
-		await uploadAutoEmoji(guild, "L2", "docs/img/L2.png")
-	}
-	console.log("✅ Emojis are ready...")
-
-	// ensure homeserver well-known is valid and returns reg.ooye.server_name...
-
-	// upload initial images...
-	const avatarUrl = await file.uploadDiscordFileToMxc("https://cadence.moe/friends/out_of_your_element.png")
-
-	// set profile data on discord...
-	const avatarImageBuffer = await fetch("https://cadence.moe/friends/out_of_your_element.png").then(res => res.arrayBuffer())
-	await discord.snow.user.updateSelf({avatar: "data:image/png;base64," + Buffer.from(avatarImageBuffer).toString("base64")})
-	await discord.snow.requestHandler.request(`/applications/@me`, {}, "patch", "json", {description: "Powered by **Out Of Your Element**\nhttps://gitdab.com/cadence/out-of-your-element"})
-	console.log("✅ Discord profile updated...")
-
-	// set profile data on homeserver...
-	await api.profileSetDisplayname(mxid, "Out Of Your Element")
-	await api.profileSetAvatarUrl(mxid, avatarUrl)
-	console.log("✅ Matrix profile updated...")
-
-	console.log("Good to go. I hope you enjoy Out Of Your Element.")
-	process.exit()
-})()

scripts/setup.js

@@ -0,0 +1,373 @@
+#!/usr/bin/env node
+// @ts-check
+
+const Ty = require("../src/types")
+const assert = require("assert").strict
+const fs = require("fs")
+const sqlite = require("better-sqlite3")
+const {scheduler} = require("timers/promises")
+const {isDeepStrictEqual} = require("util")
+const {createServer} = require("http")
+const {join} = require("path")
+
+const {prompt} = require("enquirer")
+const Input = require("enquirer/lib/prompts/input")
+const {magenta, bold, cyan} = require("ansi-colors")
+const HeatSync = require("heatsync")
+const {SnowTransfer} = require("snowtransfer")
+const DiscordTypes = require("discord-api-types/v10")
+const {createApp, defineEventHandler, toNodeListener} = require("h3")
+
+const passthrough = require("../src/passthrough")
+const db = new sqlite("ooye.db")
+const migrate = require("../src/db/migrate")
+
+const sync = new HeatSync({watchFS: false})
+
+Object.assign(passthrough, {sync, db})
+
+const orm = sync.require("../src/db/orm")
+passthrough.from = orm.from
+passthrough.select = orm.select
+
+let registration = require("../src/matrix/read-registration")
+let {reg, getTemplateRegistration, writeRegistration, readRegistration, checkRegistration, registrationFilePath} = registration
+
+const {setupEmojis} = require("../src/m2d/actions/setup-emojis")
+
+async function suggestWellKnown(serverUrlPrompt, url, otherwise) {
+	try {
+		var json = await fetch(`${url}/.well-known/matrix/client`).then(res => res.json())
+		let baseURL = json["m.homeserver"].base_url.replace(/\/$/, "")
+		if (baseURL && baseURL !== url) {
+			serverUrlPrompt.initial = baseURL
+			return `Did you mean: ${bold(baseURL)}? (Enter to accept)`
+		}
+	} catch (e) {}
+	return otherwise
+}
+
+async function validateHomeserverOrigin(serverUrlPrompt, url) {
+	if (!url.match(/^https?:\/\//)) return "Must be a URL"
+	if (url.match(/\/$/)) return "Must not end with a slash"
+	process.stdout.write(magenta(" checking, please wait..."))
+	try {
+		var res = await fetch(`${url}/_matrix/client/versions`)
+		if (res.status !== 200) {
+			return suggestWellKnown(serverUrlPrompt, url, `There is no Matrix server at that URL (${url}/_matrix/client/versions returned ${res.status})`)
+		}
+	} catch (e) {
+		return e.message
+	}
+	try {
+		/** @type {any} */
+		var json = await res.json()
+		if (!Array.isArray(json?.versions) || !json.versions.includes("v1.11")) {
+			return `OOYE needs Matrix version v1.11, but ${url} doesn't support this`
+		}
+	} catch (e) {
+		return suggestWellKnown(serverUrlPrompt, url, `There is no Matrix server at that URL (${url}/_matrix/client/versions is not JSON)`)
+	}
+	return true
+}
+
+function defineEchoHandler() {
+	return defineEventHandler(event => {
+		return "Out Of Your Element is listening.\n" +
+			`Received a ${event.method} request on path ${event.path}\n`
+	})
+}
+
+;(async () => {
+	// create registration file with prompts...
+	if (!reg) {
+		console.log("What is the name of your homeserver? This is the part after : in your username.")
+		/** @type {{server_name: string}} */
+		const serverNameResponse = await prompt({
+			type: "input",
+			name: "server_name",
+			message: "Homeserver name",
+			validate: serverName => !!serverName.match(/[a-z0-9][.a-z0-9-]+[a-z]/)
+		})
+
+		console.log("What is the URL of your homeserver?")
+		const serverOriginPrompt = new Input({
+			type: "input",
+			name: "server_origin",
+			message: "Homeserver URL",
+			initial: () => `https://${serverNameResponse.server_name}`,
+			validate: url => validateHomeserverOrigin(serverOriginPrompt, url)
+		})
+		/** @type {string} */ // @ts-ignore
+		const serverOrigin = await serverOriginPrompt.run()
+
+		console.log("OOYE has its own web server. It needs to be accessible on the public internet.")
+		console.log("What port would you like OOYE to use? You can connect your reverse proxy to this port later.")
+		/** @type {{socket: string | number}} */
+		const portResponse = await prompt({
+			type: "input",
+			name: "socket",
+			message: "Web server port",
+			initial: "6693"
+		})
+		portResponse.socket = +portResponse.socket || portResponse.socket // convert to number if numeric
+
+		const app = createApp()
+		app.use(defineEchoHandler())
+		const server = createServer(toNodeListener(app))
+		await server.listen(portResponse.socket)
+
+		console.log("Now you need to enter a public URL that OOYE's web server will live on.")
+		console.log("Set up your reverse proxy so that this URL accesses OOYE.")
+		console.log("Examples: https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs/get-started.md#appendix")
+		if (typeof portResponse.socket === "number") {
+			console.log(`Now listening on http://localhost:${portResponse.socket}. Feel free to send some test requests.`)
+		}
+		/** @type {{bridge_origin: string}} */
+		const bridgeOriginResponse = await prompt({
+			type: "input",
+			name: "bridge_origin",
+			message: "URL to reach OOYE",
+			initial: () => `https://bridge.${serverNameResponse.server_name}`,
+			validate: async url => {
+				process.stdout.write(magenta(" checking, please wait..."))
+				try {
+					const res = await fetch(url)
+					if (res.status !== 200) return `Server returned status code ${res.status}`
+					const text = await res.text()
+					if (!text.startsWith("Out Of Your Element is listening.")) return `Server does not point to OOYE`
+					return true
+				} catch (e) {
+					return e.message
+				}
+			}
+		})
+		bridgeOriginResponse.bridge_origin = bridgeOriginResponse.bridge_origin.replace(/\/+$/, "") // remove trailing slash
+
+		await server.close()
+
+		console.log("What is your Discord bot token?")
+		console.log("Go to https://discord.com/developers, create or pick an app, go to the Bot section, and reset the token.")
+		/** @type {SnowTransfer} */ // @ts-ignore
+		let snow = null
+		/** @type {{id: string, flags: number, redirect_uris: string[], description: string}} */ // @ts-ignore
+		let client = null
+		/** @type {{discord_token: string}} */
+		const discordTokenResponse = await prompt({
+			type: "input",
+			name: "discord_token",
+			message: "Bot token",
+			validate: async token => {
+				process.stdout.write(magenta(" checking, please wait..."))
+				try {
+					snow = new SnowTransfer(token)
+					client = await snow.requestHandler.request(`/applications/@me`, {}, "get", "json")
+					return true
+				} catch (e) {
+					return e.message
+				}
+			}
+		})
+
+		const intentFlagPossibilities = [
+			DiscordTypes.ApplicationFlags.GatewayMessageContent | DiscordTypes.ApplicationFlags.GatewayPresence | DiscordTypes.ApplicationFlags.GatewayGuildMembers,
+			DiscordTypes.ApplicationFlags.GatewayMessageContentLimited | DiscordTypes.ApplicationFlags.GatewayPresenceLimited | DiscordTypes.ApplicationFlags.GatewayGuildMembersLimited
+		]
+		const intentFlagMask = intentFlagPossibilities.reduce((a, c) => a | c, 0)
+		if (!intentFlagPossibilities.includes(client.flags & intentFlagMask)) {
+			console.log(`On that same page, scroll down to Privileged Gateway Intents and enable all switches.`)
+			await prompt({
+				type: "invisible",
+				name: "intents",
+				message: "Press Enter when you've enabled them",
+				validate: async () => {
+					process.stdout.write(magenta("checking, please wait..."))
+					client = await snow.requestHandler.request(`/applications/@me`, {}, "get", "json")
+					if (intentFlagPossibilities.includes(client.flags & intentFlagMask)) {
+						return true
+					} else {
+						return "Switches have not been enabled yet"
+					}
+				}
+			})
+		}
+
+		console.log("Would you like to require a password to add your bot to servers? This will discourage others from using your bridge.")
+		console.log("Important: To make it truly private, you MUST ALSO disable Public Bot in the Discord bot configuration page.")
+		/** @type {{web_password: string}} */
+		const passwordResponse = await prompt({
+			type: "text",
+			name: "web_password",
+			message: "Choose a simple password (optional)"
+		})
+
+		console.log("To fulfill license obligations, I recommend mentioning Out Of Your Element in your Discord bot's profile.")
+		console.log("On the Discord bot configuration page, go to General and add something like this to the description:")
+		console.log(cyan("Powered by **Out Of Your Element**"))
+		console.log(cyan("https://gitdab.com/cadence/out-of-your-element"))
+		await prompt({
+			type: "invisible",
+			name: "description",
+			message: "Press Enter to acknowledge",
+			validate: async () => {
+				process.stdout.write(magenta("checking, please wait..."))
+				client = await snow.requestHandler.request(`/applications/@me`, {}, "get", "json")
+				if (client.description?.match(/out.of.your.element/i)) {
+					return true
+				} else {
+					return "Description must name or link Out Of Your Element"
+				}
+			}
+		})
+
+		console.log("What is your Discord client secret?")
+		console.log(`You can find it in the application's OAuth2 section: https://discord.com/developers/applications/${client.id}/oauth2`)
+		/** @type {{discord_client_secret: string}} */
+		const clientSecretResponse = await prompt({
+			type: "input",
+			name: "discord_client_secret",
+			message: "Client secret",
+			validate: secret => !!secret
+		})
+
+		const expectedUri = `${bridgeOriginResponse.bridge_origin}/oauth`
+		if (!client.redirect_uris.includes(expectedUri)) {
+			console.log(`On that same page, scroll down to Redirects and add this URI: ${cyan(expectedUri)}`)
+			await prompt({
+				type: "invisible",
+				name: "redirect_uri",
+				message: "Press Enter when you've added it",
+				validate: async () => {
+					process.stdout.write(magenta("checking, please wait..."))
+					client = await snow.requestHandler.request(`/applications/@me`, {}, "get", "json")
+					if (client.redirect_uris.includes(expectedUri)) {
+						return true
+					} else {
+						return "Redirect URI has not been added yet"
+					}
+				}
+			})
+		}
+
+		const template = getTemplateRegistration(serverNameResponse.server_name)
+		reg = {
+			...template,
+			url: bridgeOriginResponse.bridge_origin,
+			...portResponse,
+			ooye: {
+				...template.ooye,
+				...bridgeOriginResponse,
+				server_origin: serverOrigin,
+				...discordTokenResponse,
+				...clientSecretResponse,
+				...passwordResponse
+			}
+		}
+		registration.reg = reg
+		checkRegistration(reg)
+		writeRegistration(reg)
+		console.log(`✅ Your responses have been saved as ${registrationFilePath}`)
+	} else {
+		try {
+			checkRegistration(reg)
+			console.log(`✅ Skipped questions - reusing data from ${registrationFilePath}`)
+		} catch (e) {
+			console.log(`❌ Failed to reuse data from ${registrationFilePath}`)
+			console.log("Consider deleting this file. You can re-run setup to safely make a new one.")
+			console.log("")
+			console.log(e.toString().replace(/^ *\n/gm, ""))
+			process.exit(1)
+		}
+	}
+	console.log(`  In ${cyan("Synapse")}, you need to reference that file in your homeserver.yaml and ${cyan("restart Synapse")}.`)
+	console.log("    https://element-hq.github.io/synapse/latest/application_services.html")
+	console.log(`  In ${cyan("Conduit")}, you need to send the file contents to the #admins room.`)
+	console.log("    https://docs.conduit.rs/appservices.html")
+	console.log()
+
+	// Done with user prompts, reg is now guaranteed to be valid
+	const mreq = require("../src/matrix/mreq")
+	const api = require("../src/matrix/api")
+	const DiscordClient = require("../src/d2m/discord-client")
+	const discord = new DiscordClient(reg.ooye.discord_token, "no")
+	passthrough.discord = discord
+
+	const {as} = require("../src/matrix/appservice")
+	as.router.use("/**", defineEchoHandler())
+	await as.listen()
+
+	console.log("⏳ Waiting for you to register the file with your homeserver... (Ctrl+C to cancel)")
+	process.once("SIGINT", () => {
+		console.log("(Ctrl+C) Quit early. Please re-run setup later and allow it to complete.")
+		process.exit(1)
+	})
+
+	let itWorks = false
+	let lastError = null
+	do {
+		const result = await api.ping().catch(e => ({ok: false, status: "net", root: e.message}))
+		// If it didn't work, log details and retry after some time
+		itWorks = result.ok
+		if (!itWorks) {
+			// Log the full error data if the error is different to last time
+			if (!isDeepStrictEqual(lastError, result.root)) {
+				if (typeof result.root === "string") {
+					console.log(`\nCannot reach homeserver: ${result.root}`)
+				} else if (result.root.error) {
+					console.log(`\nHomeserver said: [${result.status}] ${result.root.error}`)
+				} else {
+					console.log(`\nHomeserver said: [${result.status}] ${JSON.stringify(result.root)}`)
+				}
+				lastError = result.root
+			} else {
+				process.stderr.write(".")
+			}
+			await scheduler.wait(5000)
+		}
+	} while (!itWorks)
+	console.log("")
+
+	as.close().catch(() => {})
+
+	const mxid = `@${reg.sender_localpart}:${reg.ooye.server_name}`
+
+	// database ddl...
+	await migrate.migrate(db)
+
+	// add initial rows to database, like adding the bot to sim...
+	const client = await discord.snow.user.getSelf()
+	db.prepare("INSERT INTO sim (user_id, username, sim_name, mxid) VALUES (?, ?, ?, ?) ON CONFLICT DO NOTHING").run(client.id, client.username, reg.sender_localpart.slice(reg.ooye.namespace_prefix.length), mxid)
+
+	console.log("✅ Database is ready...")
+
+	// ensure appservice bot user is registered...
+	await api.register(reg.sender_localpart)
+
+	// upload initial images...
+	const avatarBuffer = await fs.promises.readFile(join(__dirname, "..", "docs", "img", "icon.png"), null)
+	/** @type {Ty.R.FileUploaded} */
+	const root = await mreq.mreq("POST", "/media/v3/upload", avatarBuffer, {
+		headers: {"Content-Type": "image/png"}
+	})
+	const avatarUrl = root.content_uri
+	assert(avatarUrl)
+
+	console.log("✅ Matrix appservice login works...")
+
+	// upload the L1 L2 emojis to user emojis
+	await setupEmojis()
+	console.log("✅ Emojis are ready...")
+
+	// set profile data on discord...
+	await discord.snow.user.updateSelf({avatar: "data:image/png;base64," + avatarBuffer.toString("base64")})
+	console.log("✅ Discord profile updated...")
+
+	// set profile data on homeserver...
+	console.log("⏩ Updating Matrix profile... (If you've joined lots of rooms, this is slow. Please allow at least 30 seconds.)")
+	await api.profileSetDisplayname(mxid, "Out Of Your Element")
+	await api.profileSetAvatarUrl(mxid, avatarUrl)
+	console.log("✅ Matrix profile updated...")
+
+	console.log("Good to go. I hope you enjoy Out Of Your Element.")
+	process.exit()
+})()

scripts/start-server.js

@@ -0,0 +1,42 @@
+#!/usr/bin/env node
+// @ts-check
+
+const {createServer} = require("http")
+const EventEmitter = require("events")
+const {createApp, createRouter, toNodeListener} = require("h3")
+const sqlite = require("better-sqlite3")
+const migrate = require("../src/db/migrate")
+const HeatSync = require("heatsync")
+
+const {reg} = require("../src/matrix/read-registration")
+const passthrough = require("../src/passthrough")
+const db = new sqlite("ooye.db")
+
+const sync = new HeatSync()
+
+Object.assign(passthrough, {sync, db})
+
+const DiscordClient = require("../src/d2m/discord-client")
+
+const discord = new DiscordClient(reg.ooye.discord_token, "half")
+passthrough.discord = discord
+
+const {as} = require("../src/matrix/appservice")
+passthrough.as = as
+
+const orm = sync.require("../src/db/orm")
+passthrough.from = orm.from
+passthrough.select = orm.select
+
+;(async () => {
+	await migrate.migrate(db)
+	await discord.cloud.connect()
+	console.log("Discord gateway started")
+	sync.require("../src/web/server")
+
+	discord.cloud.once("ready", () => {
+		as.listen()
+	})
+
+	require("../src/stdin")
+})()

scripts/text-probability.js

@@ -0,0 +1,65 @@
+// @ts-check
+
+const Ty = require("../src/types")
+const fs = require("fs")
+const domino = require("domino")
+const repl = require("repl")
+
+const pres = (() => {
+	const pres = []
+	for (const file of process.argv.slice(2)) {
+		const data = JSON.parse(fs.readFileSync(file, "utf8"))
+		/** @type {Ty.Event.Outer<{msgtype?: string}>[]} */
+		const events = data.messages
+		for (const event of events) {
+			if (event.type !== "m.room.message" || event.content.msgtype !== "m.text") continue
+			/** @type {Ty.Event.M_Room_Message} */ // @ts-ignore
+			const content = event.content
+			if (content.format !== "org.matrix.custom.html") continue
+			if (!content.formatted_body) continue
+
+			const document = domino.createDocument(content.formatted_body)
+			// @ts-ignore
+			for (const pre of document.querySelectorAll("pre").cache) {
+				const content = pre.textContent
+				if (content.length < 100) continue
+				pres.push(content)
+			}
+		}
+	}
+	return pres
+})()
+
+// @ts-ignore
+global.gc()
+
+/** @param {string} text */
+function probablyFixedWidthIntended(text) {
+	// if internal spaces are used, seems like they want a fixed-width font
+	if (text.match(/[^ ] {3,}[^ ]/)) return true
+	// if characters from Unicode General_Category "Symbol, other" are used, seems like they're doing ascii art and they want a fixed-width font
+	if (text.match(/\p{So}/v)) return true
+	// check start of line indentation
+	let indents = new Set()
+	for (const line of text.trimEnd().split("\n")) {
+		indents.add(line.match(/^ */)?.[0].length || 0)
+		// if there are more than 3 different indents (counting 0) then it's code
+		if (indents.size >= 3) return true
+	}
+	// if everything is indented then it's code
+	if (!indents.has(0)) return true
+	// if there is a high proportion of symbols then it's code (this filter works remarkably well on its own)
+	if ([...text.matchAll(/[\\`~;+|<>%$@*&"'=(){}[\]_^]|\.[a-zA-Z]|[a-z][A-Z]/g)].length / text.length >= 0.04) return true
+	return false
+}
+
+Object.assign(repl.start().context, {pres, probablyFixedWidthIntended})
+
+/*
+if it has a lot of symbols then it's code
+if it has >=3 levels of indentation then it's code
+if it is all indented then it's code
+if it has many spaces in a row in the middle then it's ascii art
+if it has many non-latin characters then it's language
+-> except if they are ascii art characters e.g. ⣿⣿⡇⢸⣿⠃ then it's ascii art
+*/

scripts/wal.js

@@ -1,6 +1,7 @@
+#!/usr/bin/env node
 // @ts-check
 
 const sqlite = require("better-sqlite3")
-const db = new sqlite("db/ooye.db", {fileMustExist: true})
+const db = new sqlite("ooye.db", {fileMustExist: true})
 db.pragma("journal_mode = wal")
 db.close()

src/d2m/actions/add-reaction.js

@@ -21,11 +21,11 @@ async function addReaction(data) {
 	const user = data.member?.user
 	assert.ok(user && user.username)
 
-	const parentID = select("event_message", "event_id", {message_id: data.message_id, reaction_part: 0}).pluck().get()
+	const parentID = select("event_message", "event_id", {message_id: data.message_id}, "ORDER BY reaction_part").pluck().get()
 	if (!parentID) return // Nothing can be done if the parent message was never bridged.
 	assert.equal(typeof parentID, "string")
 
-	const key = await emojiToKey.emojiToKey(data.emoji)
+	const key = await emojiToKey.emojiToKey(data.emoji, data.message_id)
 	const shortcode = key.startsWith("mxc://") ? `:${data.emoji.name}:` : undefined
 
 	const roomID = await createRoom.ensureRoom(data.channel_id)

src/d2m/actions/announce-thread.js

@@ -1,6 +1,6 @@
 // @ts-check
 
-const assert = require("assert")
+const assert = require("assert").strict
 
 const passthrough = require("../../passthrough")
 const {discord, sync, db, select} = passthrough
@@ -8,6 +8,8 @@ const {discord, sync, db, select} = passthrough
 const threadToAnnouncement = sync.require("../converters/thread-to-announcement")
 /** @type {import("../../matrix/api")} */
 const api = sync.require("../../matrix/api")
+/** @type {import("./register-user")} */
+const registerUser = sync.require("./register-user")
 
 /**
  * @param {string} parentRoomID
@@ -15,10 +17,10 @@ const api = sync.require("../../matrix/api")
  * @param {import("discord-api-types/v10").APIThreadChannel} thread
  */
 async function announceThread(parentRoomID, threadRoomID, thread) {
-	const creatorMxid = select("sim", "mxid", {user_id: thread.owner_id}).pluck().get()
+	assert(thread.owner_id)
-
+	// @ts-ignore
-   const content = await threadToAnnouncement.threadToAnnouncement(parentRoomID, threadRoomID, creatorMxid, thread, {api})
+	const creatorMxid = await registerUser.ensureSimJoined({id: thread.owner_id}, parentRoomID)
-
+	const content = await threadToAnnouncement.threadToAnnouncement(parentRoomID, threadRoomID, creatorMxid, thread, {api})
 	await api.sendEvent(parentRoomID, "m.room.message", content, creatorMxid)
 }
 

src/d2m/actions/create-room.js

@@ -0,0 +1,585 @@
+// @ts-check
+
+const assert = require("assert").strict
+const DiscordTypes = require("discord-api-types/v10")
+const Ty = require("../../types")
+const {reg} = require("../../matrix/read-registration")
+
+const passthrough = require("../../passthrough")
+const {discord, sync, db, select, from} = passthrough
+/** @type {import("../../matrix/file")} */
+const file = sync.require("../../matrix/file")
+/** @type {import("../../matrix/api")} */
+const api = sync.require("../../matrix/api")
+/** @type {import("../../matrix/mreq")} */
+const mreq = sync.require("../../matrix/mreq")
+/** @type {import("../../matrix/kstate")} */
+const ks = sync.require("../../matrix/kstate")
+/** @type {import("../../discord/utils")} */
+const dUtils = sync.require("../../discord/utils")
+/** @type {import("../../matrix/utils")} */
+const mUtils = sync.require("../../matrix/utils")
+/** @type {import("./create-space")} */
+const createSpace = sync.require("./create-space")
+
+/**
+ * There are 3 levels of room privacy:
+ * 0: Room is invite-only.
+ * 1: Anybody can use a link to join.
+ * 2: Room is published in room directory.
+ */
+const PRIVACY_ENUMS = {
+	PRESET: ["private_chat", "public_chat", "public_chat"],
+	VISIBILITY: ["private", "private", "private"],
+	SPACE_HISTORY_VISIBILITY: ["invited", "world_readable", "world_readable"], // copying from element client
+	ROOM_HISTORY_VISIBILITY: ["shared", "shared", "world_readable"], // any events sent after <value> are visible, but for world_readable anybody can read without even joining
+	GUEST_ACCESS: ["can_join", "forbidden", "forbidden"], // whether guests can join space if other conditions are met
+	SPACE_JOIN_RULES: ["invite", "public", "public"],
+	ROOM_JOIN_RULES: ["restricted", "public", "public"]
+}
+
+const DEFAULT_PRIVACY_LEVEL = 0
+
+const READ_ONLY_ROOM_EVENTS_DEFAULT_POWER = 50
+
+/** @type {Map<string, Promise<string>>} channel ID -> Promise<room ID> */
+const inflightRoomCreate = new Map()
+
+/**
+ * @param {{id: string, name: string, topic?: string?, type: number, parent_id?: string?}} channel
+ * @param {{id: string}} guild
+ * @param {string | null | undefined} customName
+ */
+function convertNameAndTopic(channel, guild, customName) {
+	// @ts-ignore
+	const parentChannel = discord.channels.get(channel.parent_id)
+	let channelPrefix =
+		( parentChannel?.type === DiscordTypes.ChannelType.GuildForum ? ""
+		: channel.type === DiscordTypes.ChannelType.PublicThread ? "[⛓️] "
+		: channel.type === DiscordTypes.ChannelType.AnnouncementThread ? "[⛓️] "
+		: channel.type === DiscordTypes.ChannelType.PrivateThread ? "[🔒⛓️] "
+		: channel.type === DiscordTypes.ChannelType.GuildVoice ? "[🔊] "
+		: "")
+	const chosenName = customName || (channelPrefix + channel.name);
+	const maybeTopicWithPipe = channel.topic ? ` | ${channel.topic}` : '';
+	const maybeTopicWithNewlines = channel.topic ? `${channel.topic}\n\n` : '';
+	const channelIDPart = `Channel ID: ${channel.id}`;
+	const guildIDPart = `Guild ID: ${guild.id}`;
+
+	const convertedTopic = customName
+		 ? `#${channel.name}${maybeTopicWithPipe}\n\n${channelIDPart}\n${guildIDPart}`
+		 : `${maybeTopicWithNewlines}${channelIDPart}\n${guildIDPart}`;
+
+	return [chosenName, convertedTopic];
+}
+
+/**
+ * Async because it may create the guild and/or upload the guild icon to mxc.
+ * @param {DiscordTypes.APIGuildTextChannel | DiscordTypes.APIThreadChannel} channel
+ * @param {DiscordTypes.APIGuild} guild
+ * @param {{api: {getStateEvent: typeof api.getStateEvent, getStateEventOuter: typeof api.getStateEventOuter}}} di simple-as-nails dependency injection for the matrix API
+ */
+async function channelToKState(channel, guild, di) {
+	// @ts-ignore
+	const parentChannel = discord.channels.get(channel.parent_id)
+
+	/** Used for membership/permission checks. */
+	const guildSpaceID = await createSpace.ensureSpace(guild)
+	/** Used as the literal parent on Matrix, for categorisation. Will be the same as `guildSpaceID` unless it's a forum channel's thread, in which case a different space is used to group those threads. */
+	let parentSpaceID = guildSpaceID
+	if (parentChannel?.type === DiscordTypes.ChannelType.GuildForum) {
+		parentSpaceID = await ensureRoom(channel.parent_id)
+		assert(typeof parentSpaceID === "string")
+	}
+
+	const channelRow = select("channel_room", ["nick", "custom_avatar", "custom_topic"], {channel_id: channel.id}).get()
+	const customName = channelRow?.nick
+	const customAvatar = channelRow?.custom_avatar
+	const hasCustomTopic = channelRow?.custom_topic
+	const [convertedName, convertedTopic] = convertNameAndTopic(channel, guild, customName)
+
+	const avatarEventContent = {}
+	if (customAvatar) {
+		avatarEventContent.url = customAvatar
+	} else if (guild.icon) {
+		avatarEventContent.url = {$url: file.guildIcon(guild)}
+	}
+
+	const privacyLevel = select("guild_space", "privacy_level", {guild_id: guild.id}).pluck().get()
+	assert(privacyLevel != null) // already ensured the space exists
+	let history_visibility = PRIVACY_ENUMS.ROOM_HISTORY_VISIBILITY[privacyLevel]
+	if (channel["thread_metadata"]) history_visibility = "world_readable"
+
+	/** @type {{join_rule: string, allow?: any}} */
+	let join_rules = {
+		join_rule: "restricted",
+		allow: [{
+			type: "m.room_membership",
+			room_id: guildSpaceID
+		}]
+	}
+	if (PRIVACY_ENUMS.ROOM_JOIN_RULES[privacyLevel] !== "restricted") {
+		join_rules = {join_rule: PRIVACY_ENUMS.ROOM_JOIN_RULES[privacyLevel]}
+	}
+
+	const everyonePermissions = dUtils.getPermissions(guild.id, [], guild.roles, undefined, channel.permission_overwrites)
+	const everyoneCanSend = dUtils.hasPermission(everyonePermissions, DiscordTypes.PermissionFlagsBits.SendMessages)
+	const everyoneCanMentionEveryone = dUtils.hasPermission(everyonePermissions, DiscordTypes.PermissionFlagsBits.MentionEveryone)
+
+	const pollStartPowerLevel = {}
+	const everyoneCanCreatePolls = dUtils.hasPermission(everyonePermissions, DiscordTypes.PermissionFlagsBits.SendPolls)
+	if (everyoneCanSend && !everyoneCanCreatePolls) pollStartPowerLevel["org.matrix.msc3381.poll.start"] = 10
+
+	const spacePowerDetails = await mUtils.getEffectivePower(guildSpaceID, [], di.api)
+	spacePowerDetails.powerLevels.users ??= {}
+	const spaceCreatorsAndFounders = spacePowerDetails.allCreators
+		.concat(Object.entries(spacePowerDetails.powerLevels.users).filter(([, power]) => power >= spacePowerDetails.tombstone).map(([mxid]) => mxid))
+
+	const globalAdmins = select("member_power", ["mxid", "power_level"], {room_id: "*"}).all()
+	const globalAdminPower = globalAdmins.reduce((a, c) => (a[c.mxid] = c.power_level, a), {})
+
+	const additionalCreators = select("member_power", "mxid", {room_id: "*"}, "AND power_level > 100").pluck().all().concat(spaceCreatorsAndFounders)
+	const creationContent = {}
+	creationContent.additional_creators = additionalCreators
+
+	if (channel.type === DiscordTypes.ChannelType.GuildForum) creationContent.type = "m.space"
+
+	/** @type {any} */
+	const channelKState = {
+		"m.room.create/": creationContent,
+		"m.room.name/": {name: convertedName},
+		"m.room.topic/": {topic: convertedTopic},
+		"m.room.avatar/": avatarEventContent,
+		"m.room.guest_access/": {guest_access: PRIVACY_ENUMS.GUEST_ACCESS[privacyLevel]},
+		"m.room.history_visibility/": {history_visibility},
+		[`m.space.parent/${parentSpaceID}`]: {
+			via: [reg.ooye.server_name],
+			canonical: true
+		},
+		/** @type {{join_rule: string, [x: string]: any}} */
+		"m.room.join_rules/": join_rules,
+		/** @type {Ty.Event.M_Power_Levels} */
+		"m.room.power_levels/": {
+			events_default: everyoneCanSend ? 0 : READ_ONLY_ROOM_EVENTS_DEFAULT_POWER,
+			events: {
+				"m.reaction": 0,
+				"m.room.redaction": 0, // only affects redactions of own events, required to be able to un-react
+				...pollStartPowerLevel
+			},
+			notifications: {
+				room: everyoneCanMentionEveryone ? 0 : 20
+			},
+			users: {...spacePowerDetails.powerLevels.users, ...globalAdminPower}
+		},
+		[`uk.half-shot.bridge/moe.cadence.ooye://discord/${guild.id}/${channel.id}`]: {
+			bridgebot: mUtils.bot,
+			protocol: {
+				id: "discord",
+				displayname: "Discord"
+			},
+			network: {
+				id: guild.id,
+				displayname: guild.name,
+				avatar_url: {$url: file.guildIcon(guild)}
+			},
+			channel: {
+				id: channel.id,
+				displayname: channel.name,
+				external_url: `https://discord.com/channels/${guild.id}/${channel.id}`
+			}
+		}
+	}
+
+	// Don't overwrite room topic if the topic has been customised
+	if (hasCustomTopic) delete channelKState["m.room.topic/"]
+
+	// Don't add a space parent if it's self service
+	// (The person setting up self-service has already put it in their preferred space to be able to get this far.)
+	const autocreate = select("guild_active", "autocreate", {guild_id: guild.id}).pluck().get()
+	if (autocreate === 0 && ![DiscordTypes.ChannelType.PrivateThread, DiscordTypes.ChannelType.PublicThread, DiscordTypes.ChannelType.AnnouncementThread].includes(channel.type)) {
+		delete channelKState[`m.space.parent/${parentSpaceID}`]
+	}
+
+	return {spaceID: parentSpaceID, privacyLevel, channelKState}
+}
+
+/**
+ * Create a bridge room, store the relationship in the database, and add it to the guild's space.
+ * @param {DiscordTypes.APIGuildTextChannel} channel
+ * @param {DiscordTypes.APIGuild} guild
+ * @param {string} spaceID
+ * @param {any} kstate
+ * @param {number} privacyLevel
+ * @returns {Promise<string>} room ID
+ */
+async function createRoom(channel, guild, spaceID, kstate, privacyLevel) {
+	let threadParent = null
+	if (channel.type === DiscordTypes.ChannelType.PublicThread) threadParent = channel.parent_id
+
+	// Name and topic can be done earlier in room creation rather than in initial_state
+	// https://spec.matrix.org/latest/client-server-api/#creation
+	const name = kstate["m.room.name/"].name
+	delete kstate["m.room.name/"]
+	assert(name)
+	const topic = kstate["m.room.topic/"].topic
+	delete kstate["m.room.topic/"]
+	assert(topic)
+
+	const roomCreate = await postApplyPowerLevels(kstate, async kstate => {
+		const roomID = await api.createRoom({
+			name,
+			topic,
+			preset: PRIVACY_ENUMS.PRESET[privacyLevel], // This is closest to what we want, but properties from kstate override it anyway
+			visibility: PRIVACY_ENUMS.VISIBILITY[privacyLevel],
+			invite: [],
+			initial_state: await ks.kstateToState(kstate),
+			creation_content: ks.kstateToCreationContent(kstate)
+		})
+
+		/** @type {Ty.Event.StateOuter<Ty.Event.M_Room_Create>} */
+		const roomCreate = await api.getStateEventOuter(roomID, "m.room.create", "")
+
+		db.transaction(() => {
+			db.prepare("INSERT INTO channel_room (channel_id, room_id, name, nick, thread_parent, guild_id) VALUES (?, ?, ?, NULL, ?, ?)").run(channel.id, roomID, channel.name, threadParent, guild.id)
+			db.prepare("INSERT INTO historical_channel_room (reference_channel_id, room_id, upgraded_timestamp) VALUES (?, ?, 0)").run(channel.id, roomID)
+		})()
+
+		return roomCreate
+	})
+	const roomID = roomCreate.room_id
+
+	// Put the newly created child into the space
+	await _syncSpaceMember(channel, spaceID, roomID, guild.id)
+
+	return roomID
+}
+
+/**
+ * Handling power levels separately. The spec doesn't specify what happens, Dendrite differs,
+ * and Synapse does an absolutely insane *shallow merge* of what I provide on top of what it creates.
+ * We don't want the `events` key to be overridden completely.
+ * https://github.com/matrix-org/synapse/blob/develop/synapse/handlers/room.py#L1170-L1210
+ * https://github.com/matrix-org/matrix-spec/issues/492
+ * @param {any} kstate
+ * @param {(_: any) => Promise<Ty.Event.StateOuter<Ty.Event.M_Room_Create>>} callback must return room ID and room version
+ * @returns {Promise<Ty.Event.StateOuter<Ty.Event.M_Room_Create>>} room ID
+ */
+async function postApplyPowerLevels(kstate, callback) {
+	const powerLevelContent = kstate["m.room.power_levels/"]
+	const kstateWithoutPowerLevels = {...kstate}
+	delete kstateWithoutPowerLevels["m.room.power_levels/"]
+
+	const roomCreate = await callback(kstateWithoutPowerLevels)
+	const roomID = roomCreate.room_id
+
+	// Now *really* apply the power level overrides on top of what Synapse *really* set
+	if (powerLevelContent) {
+		mUtils.removeCreatorsFromPowerLevels(roomCreate, powerLevelContent)
+
+		const originalPowerLevels = await api.getStateEvent(roomID, "m.room.power_levels", "")
+		const powerLevelsDiff = ks.diffKState(
+			{"m.room.power_levels/": originalPowerLevels, "m.room.create/": roomCreate.content, "m.room.create/outer": roomCreate},
+			{"m.room.power_levels/": powerLevelContent}
+		)
+		await ks.applyKStateDiffToRoom(roomID, powerLevelsDiff)
+	}
+
+	return roomCreate
+}
+
+/**
+ * @param {DiscordTypes.APIGuildChannel} channel
+ */
+function channelToGuild(channel) {
+	const guildID = channel.guild_id
+	assert(guildID)
+	const guild = discord.guilds.get(guildID)
+	assert(guild)
+	return guild
+}
+
+/**
+ * This function handles whether it's allowed to bridge messages in this channel, and if so, where to.
+ * This has to account for whether self-service is enabled for the guild or not.
+ * This also has to account for different channel types, like forum channels (which need the
+ * parent forum to already exist, and ignore the self-service setting), or thread channels (which
+ * need the parent channel to already exist, and ignore the self-service setting).
+ * @param {DiscordTypes.APIGuildTextChannel | DiscordTypes.APIThreadChannel} channel text channel or thread
+ * @param {string} guildID
+ * @returns obj if bridged; 1 if autocreatable; null/undefined if guild is not bridged; 0 if self-service and not autocreatable thread
+ */
+function existsOrAutocreatable(channel, guildID) {
+	// 1. If the channel is already linked somewhere, it's always okay to bridge to that destination, no matter what. Yippee!
+	const existing = select("channel_room", ["room_id", "thread_parent"], {channel_id: channel.id}).get()
+	if (existing) return existing
+
+	// 2. If the guild is an autocreate guild, it's always okay to bridge to that destination, and
+	// we'll need to create any dependent resources recursively.
+	const autocreate = select("guild_active", "autocreate", {guild_id: guildID}).pluck().get()
+	if (autocreate === 1) return autocreate
+
+	// 3. If the guild is not approved for bridging yet, we can't bridge there.
+	// They need to decide one way or another whether it's self-service before we can continue.
+	if (autocreate == null) return autocreate
+
+	// 4. If we got here, the guild is in self-service mode.
+	// New channels won't be able to create new rooms. But forum threads or channel threads could be fine.
+	if ([DiscordTypes.ChannelType.PublicThread, DiscordTypes.ChannelType.PrivateThread, DiscordTypes.ChannelType.AnnouncementThread].includes(channel.type)) {
+		// In self-service mode, threads rely on the parent resource already existing.
+		/** @type {DiscordTypes.APIGuildTextChannel} */ // @ts-ignore
+		const parent = discord.channels.get(channel.parent_id)
+		assert(parent)
+		const parentExisting = existsOrAutocreatable(parent, guildID)
+		if (parentExisting) return 1 // Autocreatable
+	}
+
+	// 5. If we got here, the guild is in self-service mode and the channel is truly not bridged.
+	return autocreate
+}
+
+/**
+ * @param {DiscordTypes.APIGuildTextChannel | DiscordTypes.APIThreadChannel} channel text channel or thread
+ * @param {string} guildID
+ * @returns obj if bridged; 1 if autocreatable. (throws if not autocreatable)
+ */
+function assertExistsOrAutocreatable(channel, guildID) {
+	const existing = existsOrAutocreatable(channel, guildID)
+	if (existing === 0) {
+		throw new Error(`Guild ${guildID} is self-service, so won't create a Matrix room for channel ${channel.id}`)
+	}
+	if (!existing) {
+		throw new Error(`Guild ${guildID} is not bridged, so won't create a Matrix room for channel ${channel.id}`)
+	}
+	return existing
+}
+
+/*
+	Ensure flow:
+	1. Get IDs
+	2. Does room exist? If so great!
+	(it doesn't, so it needs to be created)
+	3. Get kstate for channel
+	4. Create room, return new ID
+
+	Ensure + sync flow:
+	1. Get IDs
+	2. Does room exist?
+	2.5: If room does exist AND wasn't asked to sync: return here
+	3. Get kstate for channel
+	4. Create room with kstate if room doesn't exist
+	5. Get and update room state with kstate if room does exist
+*/
+
+/**
+ * Create room and/or sync room data. Please check that a channel_room entry exists or autocreate = 1 before calling this.
+ * @param {string} channelID
+ * @param {boolean} shouldActuallySync false if just need to ensure room exists (which is a quick database check), true if also want to sync room data when it does exist (slow)
+ * @returns {Promise<string>} room ID
+ */
+async function _syncRoom(channelID, shouldActuallySync) {
+	/** @ts-ignore @type {DiscordTypes.APIGuildTextChannel} */
+	const channel = discord.channels.get(channelID)
+	assert.ok(channel)
+	const guild = channelToGuild(channel)
+
+	if (inflightRoomCreate.has(channelID)) {
+		await inflightRoomCreate.get(channelID) // just waiting, and then doing a new db query afterwards, is the simplest way of doing it
+	}
+
+	const existing = assertExistsOrAutocreatable(channel, guild.id)
+
+	if (existing === 1) {
+		const creation = (async () => {
+			const {spaceID, privacyLevel, channelKState} = await channelToKState(channel, guild, {api})
+			const roomID = await createRoom(channel, guild, spaceID, channelKState, privacyLevel)
+			inflightRoomCreate.delete(channelID) // OK to release inflight waiters now. they will read the correct `existing` row
+			return roomID
+		})()
+		inflightRoomCreate.set(channelID, creation)
+		return creation // Naturally, the newly created room is already up to date, so we can always skip syncing here.
+	}
+
+	const roomID = existing.room_id
+
+	if (!shouldActuallySync) {
+		return existing.room_id // only need to ensure room exists, and it does. return the room ID
+	}
+
+	console.log(`[room sync] to matrix: ${channel.name}`)
+
+	const {spaceID, channelKState} = await channelToKState(channel, guild, {api}) // calling this in both branches because we don't want to calculate this if not syncing
+	await ks.kstateUploadMxc(channelKState) // pre-upload icons before diffing
+
+	// sync channel state to room
+	const roomKState = await ks.roomToKState(roomID)
+	if (!mUtils.roomHasAtLeastVersion(roomKState["m.room.create/"].room_version, 9)) {
+		// join_rule `restricted` is not available in room version < 8 and not working properly in version == 8, so require version 9
+		// read more: https://spec.matrix.org/v1.8/rooms/v9/
+		// we have to use `public` instead, otherwise the room will be unjoinable.
+		channelKState["m.room.join_rules/"] = {join_rule: "public"}
+	}
+	const roomDiff = ks.diffKState(roomKState, channelKState)
+	const roomApply = ks.applyKStateDiffToRoom(roomID, roomDiff)
+	db.prepare("UPDATE channel_room SET name = ? WHERE channel_id = ?").run(channel.name, channel.id)
+
+	// sync room as space member
+	const spaceApply = _syncSpaceMember(channel, spaceID, roomID, guild.id)
+	await Promise.all([roomApply, spaceApply])
+
+	return roomID
+}
+
+/** Ensures the room exists. If it doesn't, creates the room with an accurate initial state. Please check that a channel_room entry exists or guild autocreate = 1 before calling this. */
+function ensureRoom(channelID) {
+	return _syncRoom(channelID, false)
+}
+
+/** Actually syncs. Gets all room state from the homeserver in order to diff, and uploads the icon to mxc if it has changed. Please check that a channel_room entry exists or guild autocreate = 1 before calling this. */
+function syncRoom(channelID) {
+	return _syncRoom(channelID, true)
+}
+
+/**
+ * @param {{id: string, topic?: string?}} channel channel-ish (just needs an id, topic is optional)
+ * @param {string} guildID
+ */
+async function unbridgeChannel(channel, guildID) {
+	const roomID = select("channel_room", "room_id", {channel_id: channel.id}).pluck().get()
+	assert.ok(roomID)
+	const row = from("guild_space").join("guild_active", "guild_id").select("space_id", "autocreate").where({guild_id: guildID}).get()
+	assert.ok(row)
+
+	let botInRoom = true
+
+	// remove declaration that the room is bridged
+	try {
+		await api.sendState(roomID, "uk.half-shot.bridge", `moe.cadence.ooye://discord/${guildID}/${channel.id}`, {})
+	} catch (e) {
+		if (String(e).includes("not in room")) {
+			botInRoom = false
+		} else {
+			throw e
+		}
+	}
+
+	if (botInRoom && "topic" in channel) {
+		// previously the Matrix topic would say the channel ID. we should remove that
+		await api.sendState(roomID, "m.room.topic", "", {topic: channel.topic || ""})
+	}
+
+	// delete webhook on discord
+	const webhook = select("webhook", ["webhook_id", "webhook_token"], {channel_id: channel.id}).get()
+	if (webhook) {
+		await discord.snow.webhook.deleteWebhook(webhook.webhook_id, webhook.webhook_token).catch(() => {})
+		db.prepare("DELETE FROM webhook WHERE channel_id = ?").run(channel.id)
+	}
+
+	// delete room from database
+	db.prepare("DELETE FROM member_cache WHERE room_id = ?").run(roomID)
+	db.prepare("DELETE FROM channel_room WHERE room_id = ? AND channel_id = ?").run(roomID, channel.id) // cascades to most other tables, like messages and historical rooms
+
+	if (!botInRoom) return
+
+	// demote discord sim admins in room
+	const {powerLevels, allCreators} = await mUtils.getEffectivePower(roomID, [], api)
+	const powerLevelsUsers = (powerLevels.users ||= {})
+	for (const mxid of Object.keys(powerLevelsUsers)) {
+		if (powerLevelsUsers[mxid] >= (powerLevels.state_default ?? 50) && !allCreators.includes(mxid) && mUtils.eventSenderIsFromDiscord(mxid) && mxid !== mUtils.bot) {
+			delete powerLevelsUsers[mxid]
+			await api.sendState(roomID, "m.room.power_levels", "", powerLevels, mxid) // done individually because each user must demote themselves
+		}
+	}
+
+	// send a notification in the room
+	await api.sendEvent(roomID, "m.room.message", {
+		msgtype: "m.notice",
+		body: "⚠️ This room was removed from the bridge."
+	})
+
+	// if it is an easy mode room, clean up the room from the managed space and make it clear it's not being bridged
+	// (don't do this for self-service rooms, because they might continue to be used on Matrix or linked somewhere else later)
+	if (row.autocreate === 1) {
+		// remove room from being a space member
+		await api.sendState(roomID, "m.space.parent", row.space_id, {})
+		await api.sendState(row.space_id, "m.space.child", roomID, {})
+	}
+
+	// if it is a self-service room, remove sim members
+	// (the room can be used with less clutter and the member list makes sense if it's bridged somewhere else)
+	if (row.autocreate === 0) {
+		// remove sim members
+		const members = db.prepare("SELECT mxid FROM sim_member WHERE room_id = ? AND mxid <> ?").pluck().all(roomID, mUtils.bot)
+		const preparedDelete = db.prepare("DELETE FROM sim_member WHERE room_id = ? AND mxid = ?")
+		for (const mxid of members) {
+			await api.leaveRoom(roomID, mxid)
+			preparedDelete.run(roomID, mxid)
+		}
+	}
+
+	// leave room
+	await mUtils.setUserPower(roomID, mUtils.bot, 0, api)
+	await api.leaveRoom(roomID)
+}
+
+/**
+ * Async because it gets all space state from the homeserver, then if necessary sends one state event back.
+ * @param {DiscordTypes.APIGuildTextChannel} channel
+ * @param {string} spaceID
+ * @param {string} roomID
+ * @param {string} guild_id
+ * @returns {Promise<string[]>}
+ */
+async function _syncSpaceMember(channel, spaceID, roomID, guild_id) {
+	// If space is self-service then only permit changes to space parenting for threads
+	// (The person setting up self-service has already put it in their preferred space to be able to get this far.)
+	const autocreate = select("guild_active", "autocreate", {guild_id}).pluck().get()
+	if (autocreate === 0 && ![DiscordTypes.ChannelType.PrivateThread, DiscordTypes.ChannelType.PublicThread, DiscordTypes.ChannelType.AnnouncementThread].includes(channel.type)) {
+		return []
+	}
+
+	const spaceKState = await ks.roomToKState(spaceID)
+	let spaceEventContent = {}
+	if (
+		channel.type !== DiscordTypes.ChannelType.PrivateThread // private threads do not belong in the space (don't offer people something they can't join)
+		&& (
+			!channel["thread_metadata"]?.archived // archived threads do not belong in the space (don't offer people conversations that are no longer relevant)
+			|| discord.channels.get(channel.parent_id || "")?.type === DiscordTypes.ChannelType.GuildForum
+		)
+	) {
+		spaceEventContent = {
+			via: [reg.ooye.server_name]
+		}
+	}
+	const spaceDiff = ks.diffKState(spaceKState, {
+		[`m.space.child/${roomID}`]: spaceEventContent
+	})
+	return ks.applyKStateDiffToRoom(spaceID, spaceDiff)
+}
+
+async function createAllForGuild(guildID) {
+	const channelIDs = discord.guildChannelMap.get(guildID)
+	assert.ok(channelIDs)
+	for (const channelID of channelIDs) {
+		const allowedTypes = [DiscordTypes.ChannelType.GuildText, DiscordTypes.ChannelType.PublicThread]
+		// @ts-ignore
+		if (allowedTypes.includes(discord.channels.get(channelID)?.type)) {
+			const roomID = await syncRoom(channelID)
+			console.log(`synced ${channelID} <-> ${roomID}`)
+		}
+	}
+}
+
+module.exports.DEFAULT_PRIVACY_LEVEL = DEFAULT_PRIVACY_LEVEL
+module.exports.READ_ONLY_ROOM_EVENTS_DEFAULT_POWER = READ_ONLY_ROOM_EVENTS_DEFAULT_POWER
+module.exports.PRIVACY_ENUMS = PRIVACY_ENUMS
+module.exports.createRoom = createRoom
+module.exports.ensureRoom = ensureRoom
+module.exports.syncRoom = syncRoom
+module.exports.createAllForGuild = createAllForGuild
+module.exports.channelToKState = channelToKState
+module.exports.postApplyPowerLevels = postApplyPowerLevels
+module.exports._convertNameAndTopic = convertNameAndTopic
+module.exports._syncSpaceMember = _syncSpaceMember
+module.exports.unbridgeChannel = unbridgeChannel
+module.exports.existsOrAutocreatable = existsOrAutocreatable
+module.exports.assertExistsOrAutocreatable = assertExistsOrAutocreatable

src/d2m/actions/create-room.test.js

@@ -0,0 +1,240 @@
+// @ts-check
+
+const mixin = require("@cloudrac3r/mixin-deep")
+const {channelToKState, _convertNameAndTopic} = require("./create-room")
+const {kstateStripConditionals} = require("../../matrix/kstate")
+const {test} = require("supertape")
+const testData = require("../../../test/data")
+
+const passthrough = require("../../passthrough")
+const {db} = passthrough
+
+function mockAPI(t) {
+	let called = 0
+	return {
+		getCalled() {
+			return called
+		},
+		async getStateEvent(roomID, type, key) { // getting power levels from space to apply to room
+			called++
+			t.equal(roomID, "!jjmvBegULiLucuWEHU:cadence.moe")
+			t.equal(type, "m.room.power_levels")
+			t.equal(key, "")
+			return {users: {"@example:matrix.org": 50}, events: {"m.room.tombstone": 100}}
+		},
+		async getStateEventOuter(roomID, type, key) {
+			called++
+			t.equal(roomID, "!jjmvBegULiLucuWEHU:cadence.moe")
+			t.equal(type, "m.room.create")
+			t.equal(key, "")
+			return {
+				type: "m.room.create",
+				state_key: "",
+				content: {
+					room_version: "11"
+				},
+				event_id: "$create",
+				origin_server_ts: 0,
+				room_id: "!jjmvBegULiLucuWEHU:cadence.moe",
+				sender: "@_ooye_bot:cadence.moe"
+			}
+		}
+	}
+}
+
+test("channel2room: discoverable privacy room", async t => {
+	const api = mockAPI(t)
+	db.prepare("UPDATE guild_space SET privacy_level = 2").run()
+	t.deepEqual(
+		kstateStripConditionals(await channelToKState(testData.channel.general, testData.guild.general, {api}).then(x => x.channelKState)),
+		Object.assign({}, testData.room.general, {
+			"m.room.guest_access/": {guest_access: "forbidden"},
+			"m.room.join_rules/": {join_rule: "public"},
+			"m.room.history_visibility/": {history_visibility: "world_readable"},
+			"m.room.power_levels/": mixin({users: {"@example:matrix.org": 50}}, testData.room.general["m.room.power_levels/"])
+		})
+	)
+	t.equal(api.getCalled(), 2)
+})
+
+test("channel2room: linkable privacy room", async t => {
+	const api = mockAPI(t)
+	db.prepare("UPDATE guild_space SET privacy_level = 1").run()
+	t.deepEqual(
+		kstateStripConditionals(await channelToKState(testData.channel.general, testData.guild.general, {api}).then(x => x.channelKState)),
+		Object.assign({}, testData.room.general, {
+			"m.room.guest_access/": {guest_access: "forbidden"},
+			"m.room.join_rules/": {join_rule: "public"},
+			"m.room.power_levels/": mixin({users: {"@example:matrix.org": 50}}, testData.room.general["m.room.power_levels/"])
+		})
+	)
+	t.equal(api.getCalled(), 2)
+})
+
+test("channel2room: invite-only privacy room", async t => {
+	const api = mockAPI(t)
+	db.prepare("UPDATE guild_space SET privacy_level = 0").run()
+	t.deepEqual(
+		kstateStripConditionals(await channelToKState(testData.channel.general, testData.guild.general, {api}).then(x => x.channelKState)),
+		Object.assign({}, testData.room.general, {
+			"m.room.power_levels/": mixin({users: {"@example:matrix.org": 50}}, testData.room.general["m.room.power_levels/"])
+		})
+	)
+	t.equal(api.getCalled(), 2)
+})
+
+test("channel2room: room where limited people can mention everyone", async t => {
+	const api = mockAPI(t)
+	const limitedGuild = mixin({}, testData.guild.general)
+	limitedGuild.roles[0].permissions = (BigInt(limitedGuild.roles[0].permissions) - 131072n).toString()
+	const limitedRoom = mixin({}, testData.room.general, {"m.room.power_levels/": {
+		notifications: {room: 20},
+		users: {"@example:matrix.org": 50}
+	}})
+	t.deepEqual(
+		kstateStripConditionals(await channelToKState(testData.channel.general, limitedGuild, {api}).then(x => x.channelKState)),
+		limitedRoom
+	)
+	t.equal(api.getCalled(), 2)
+})
+
+test("channel2room: matrix room that already has a custom topic set", async t => {
+	const api = mockAPI(t)
+	db.prepare("UPDATE channel_room SET custom_topic = 1 WHERE channel_id = ?").run(testData.channel.general.id)
+	const expected = mixin({}, testData.room.general, {"m.room.power_levels/": {notifications: {room: 20}, users: {"@example:matrix.org": 50}}})
+	// @ts-ignore
+	delete expected["m.room.topic/"]
+	t.deepEqual(
+		kstateStripConditionals(await channelToKState(testData.channel.general, testData.guild.general, {api}).then(x => x.channelKState)),
+		expected
+	)
+	t.equal(api.getCalled(), 2)
+})
+
+test("channel2room: read-only discord channel", async t => {
+	const api = mockAPI(t)
+	const expected = {
+		"m.room.create/": {
+			additional_creators: ["@test_auto_invite:example.org"],
+		},
+		"m.room.avatar/": {
+			url: {
+				$url: "/icons/112760669178241024/a_f83622e09ead74f0c5c527fe241f8f8c.png?size=1024",
+			},
+		},
+		"m.room.guest_access/": {
+			guest_access: "can_join",
+		},
+		"m.room.history_visibility/": {
+			history_visibility: "shared",
+		},
+		"m.room.join_rules/": {
+			allow: [
+				{
+					room_id: "!jjmvBegULiLucuWEHU:cadence.moe",
+					type: "m.room_membership",
+				},
+			],
+			join_rule: "restricted",
+		},
+		"m.room.name/": {
+			name: "updates",
+		},
+		"m.room.topic/": {
+      	topic: "Updates and release announcements for Out Of Your Element.\n\nChannel ID: 1161864271370666075\nGuild ID: 112760669178241024"
+		},
+		"m.room.power_levels/": {
+			events_default: 50, // <-- it should be read-only!
+			events: {
+				"m.reaction": 0,
+				"m.room.redaction": 0
+			},
+			notifications: {
+				room: 20,
+			},
+			users: {
+				"@test_auto_invite:example.org": 150,
+				"@example:matrix.org": 50
+			},
+		},
+		"m.space.parent/!jjmvBegULiLucuWEHU:cadence.moe": {
+			canonical: true,
+			via: [
+				"cadence.moe",
+			],
+		},
+		"uk.half-shot.bridge/moe.cadence.ooye://discord/112760669178241024/1161864271370666075": {
+			bridgebot: "@_ooye_bot:cadence.moe",
+			channel: {
+				displayname: "updates",
+				external_url: "https://discord.com/channels/112760669178241024/1161864271370666075",
+				id: "1161864271370666075",
+			},
+			network: {
+				avatar_url: {
+					"$url": "/icons/112760669178241024/a_f83622e09ead74f0c5c527fe241f8f8c.png?size=1024",
+				},
+				displayname: "Psychonauts 3",
+				id: "112760669178241024",
+			},
+			protocol: {
+				displayname: "Discord",
+				id: "discord",
+			}
+		}
+	}
+	t.deepEqual(
+		kstateStripConditionals(await channelToKState(testData.channel.updates, testData.guild.general, {api}).then(x => x.channelKState)),
+		expected
+	)
+	t.equal(api.getCalled(), 2)
+})
+
+test("convertNameAndTopic: custom name and topic", t => {
+	t.deepEqual(
+		_convertNameAndTopic({id: "123", name: "the-twilight-zone", topic: "Spooky stuff here. :ghost:", type: 0}, {id: "456"}, "hauntings"),
+		["hauntings", "#the-twilight-zone | Spooky stuff here. :ghost:\n\nChannel ID: 123\nGuild ID: 456"]
+	)
+})
+
+test("convertNameAndTopic: custom name, no topic", t => {
+	t.deepEqual(
+		_convertNameAndTopic({id: "123", name: "the-twilight-zone", type: 0}, {id: "456"}, "hauntings"),
+		["hauntings", "#the-twilight-zone\n\nChannel ID: 123\nGuild ID: 456"]
+	)
+})
+
+test("convertNameAndTopic: original name and topic", t => {
+	t.deepEqual(
+		_convertNameAndTopic({id: "123", name: "the-twilight-zone", topic: "Spooky stuff here. :ghost:", type: 0}, {id: "456"}, null),
+		["the-twilight-zone", "Spooky stuff here. :ghost:\n\nChannel ID: 123\nGuild ID: 456"]
+	)
+})
+
+test("convertNameAndTopic: original name, no topic", t => {
+	t.deepEqual(
+		_convertNameAndTopic({id: "123", name: "the-twilight-zone", type: 0}, {id: "456"}, null),
+		["the-twilight-zone", "Channel ID: 123\nGuild ID: 456"]
+	)
+})
+
+test("convertNameAndTopic: public thread icon", t => {
+	t.deepEqual(
+		_convertNameAndTopic({id: "123", name: "the-twilight-zone", topic: "Spooky stuff here. :ghost:", type: 11}, {id: "456"}, null),
+		["[⛓️] the-twilight-zone", "Spooky stuff here. :ghost:\n\nChannel ID: 123\nGuild ID: 456"]
+	)
+})
+
+test("convertNameAndTopic: private thread icon", t => {
+	t.deepEqual(
+		_convertNameAndTopic({id: "123", name: "the-twilight-zone", topic: "Spooky stuff here. :ghost:", type: 12}, {id: "456"}, null),
+		["[🔒⛓️] the-twilight-zone", "Spooky stuff here. :ghost:\n\nChannel ID: 123\nGuild ID: 456"]
+	)
+})
+
+test("convertNameAndTopic: voice channel icon", t => {
+	t.deepEqual(
+		_convertNameAndTopic({id: "123", name: "the-twilight-zone", topic: "Spooky stuff here. :ghost:", type: 2}, {id: "456"}, null),
+		["[🔊] the-twilight-zone", "Spooky stuff here. :ghost:\n\nChannel ID: 123\nGuild ID: 456"]
+	)
+})

src/d2m/actions/create-space.js

@@ -1,8 +1,10 @@
 // @ts-check
 
 const assert = require("assert").strict
+const {isDeepStrictEqual} = require("util")
 const DiscordTypes = require("discord-api-types/v10")
-const reg = require("../../matrix/read-registration")
+const Ty = require("../../types")
+const {reg} = require("../../matrix/read-registration")
 
 const passthrough = require("../../passthrough")
 const {discord, sync, db, select} = passthrough
@@ -12,8 +14,8 @@ const api = sync.require("../../matrix/api")
 const file = sync.require("../../matrix/file")
 /** @type {import("./create-room")} */
 const createRoom = sync.require("./create-room")
-/** @type {import("../converters/expression")} */
+/** @type {import("./expression")} */
-const expression = sync.require("../converters/expression")
+const expression = sync.require("./expression")
 /** @type {import("../../matrix/kstate")} */
 const ks = sync.require("../../matrix/kstate")
 
@@ -21,7 +23,7 @@ const ks = sync.require("../../matrix/kstate")
 const inflightSpaceCreate = new Map()
 
 /**
- * @param {import("discord-api-types/v10").RESTGetAPIGuildResult} guild
+ * @param {DiscordTypes.RESTGetAPIGuildResult} guild
  * @param {any} kstate
  */
 async function createSpace(guild, kstate) {
@@ -29,8 +31,12 @@ async function createSpace(guild, kstate) {
 	const topic = kstate["m.room.topic/"]?.topic || undefined
 	assert(name)
 
-	const roomID = await createRoom.postApplyPowerLevels(kstate, async kstate => {
+	const memberCount = guild["member_count"] ?? guild.approximate_member_count ?? 0
-		return api.createRoom({
+	const enablePresenceByDefault = +(memberCount < 50) // scary! all active users in a presence-enabled guild will be pinging the server every <30 seconds to stay online
+	const globalAdmins = select("member_power", "mxid", {room_id: "*"}).pluck().all()
+
+	const roomCreate = await createRoom.postApplyPowerLevels(kstate, async kstate => {
+		const roomID = await api.createRoom({
 			name,
 			preset: createRoom.PRIVACY_ENUMS.PRESET[createRoom.DEFAULT_PRIVACY_LEVEL], // New spaces will have to use the default privacy level; we obviously can't look up the existing entry
 			visibility: createRoom.PRIVACY_ENUMS.VISIBILITY[createRoom.DEFAULT_PRIVACY_LEVEL],
@@ -38,15 +44,17 @@ async function createSpace(guild, kstate) {
 				events_default: 100, // space can only be managed by bridge
 				invite: 0 // any existing member can invite others
 			},
-			invite: reg.ooye.invite,
+			invite: globalAdmins,
 			topic,
-			creation_content: {
+			initial_state: await ks.kstateToState(kstate),
-				type: "m.space"
+			creation_content: ks.kstateToCreationContent(kstate)
-			},
-			initial_state: ks.kstateToState(kstate)
 		})
+		const roomCreate = await api.getStateEventOuter(roomID, "m.room.create", "")
+		return roomCreate
 	})
-	db.prepare("INSERT INTO guild_space (guild_id, space_id) VALUES (?, ?)").run(guild.id, roomID)
+	const roomID = roomCreate.room_id
+
+	db.prepare("INSERT INTO guild_space (guild_id, space_id, presence) VALUES (?, ?, ?)").run(guild.id, roomID, enablePresenceByDefault)
 	return roomID
 }
 
@@ -55,19 +63,24 @@ async function createSpace(guild, kstate) {
  * @param {number} privacyLevel
  */
 async function guildToKState(guild, privacyLevel) {
-	const avatarEventContent = {}
+	assert.equal(typeof privacyLevel, "number")
-	if (guild.icon) {
+	const globalAdmins = select("member_power", ["mxid", "power_level"], {room_id: "*"}).all()
-		avatarEventContent.discord_path = file.guildIcon(guild)
+	const additionalCreators = select("member_power", "mxid", {room_id: "*"}, "AND power_level > 100").pluck().all()
-		avatarEventContent.url = await file.uploadDiscordFileToMxc(avatarEventContent.discord_path) // TODO: somehow represent future values in kstate (callbacks?), while still allowing for diffing, so test cases don't need to touch the media API
-	}
 
 	const guildKState = {
+		"m.room.create/": {
+			type: "m.space",
+			additional_creators: additionalCreators
+		},
 		"m.room.name/": {name: guild.name},
-		"m.room.avatar/": avatarEventContent,
+		"m.room.avatar/": {
+			$if: guild.icon,
+			url: {$url: file.guildIcon(guild)}
+		},
 		"m.room.guest_access/": {guest_access: createRoom.PRIVACY_ENUMS.GUEST_ACCESS[privacyLevel]},
 		"m.room.history_visibility/": {history_visibility: createRoom.PRIVACY_ENUMS.SPACE_HISTORY_VISIBILITY[privacyLevel]},
 		"m.room.join_rules/": {join_rule: createRoom.PRIVACY_ENUMS.SPACE_JOIN_RULES[privacyLevel]},
-		"m.room.power_levels/": {users: reg.ooye.invite.reduce((a, c) => (a[c] = 100, a), {})}
+		"m.room.power_levels/": {users: globalAdmins.reduce((a, c) => (a[c.mxid] = c.power_level, a), {})} // used in guild initial creation postApplyPowerLevels
 	}
 
 	return guildKState
@@ -89,6 +102,9 @@ async function _syncSpace(guild, shouldActuallySync) {
 	const row = select("guild_space", ["space_id", "privacy_level"], {guild_id: guild.id}).get()
 
 	if (!row) {
+		const autocreate = select("guild_active", "autocreate", {guild_id: guild.id}).pluck().get()
+		assert.equal(autocreate, 1, `refusing to implicitly create a space for guild ${guild.id}. set the guild_active data first before calling ensureSpace/syncSpace.`)
+
 		const creation = (async () => {
 			const guildKState = await guildToKState(guild, createRoom.DEFAULT_PRIVACY_LEVEL) // New spaces will have to use the default privacy level; we obviously can't look up the existing entry
 			const spaceID = await createSpace(guild, guildKState)
@@ -108,11 +124,13 @@ async function _syncSpace(guild, shouldActuallySync) {
 	console.log(`[space sync] to matrix: ${guild.name}`)
 
 	const guildKState = await guildToKState(guild, privacy_level) // calling this in both branches because we don't want to calculate this if not syncing
+	ks.kstateStripConditionals(guildKState) // pre-upload icons before diffing
+	await ks.kstateUploadMxc(guildKState)
 
 	// sync guild state to space
-	const spaceKState = await createRoom.roomToKState(spaceID)
+	const spaceKState = await ks.roomToKState(spaceID)
 	const spaceDiff = ks.diffKState(spaceKState, guildKState)
-	await createRoom.applyKStateDiffToRoom(spaceID, spaceDiff)
+	await ks.applyKStateDiffToRoom(spaceID, spaceDiff)
 
 	// guild icon was changed, so room avatars need to be updated as well as the space ones
 	// doing it this way rather than calling syncRoom for great efficiency gains
@@ -121,15 +139,10 @@ async function _syncSpace(guild, shouldActuallySync) {
 		// don't try to update rooms with custom avatars though
 		const roomsWithCustomAvatars = select("channel_room", "room_id", {}, "WHERE custom_avatar IS NOT NULL").pluck().all()
 
-		const childRooms = ks.kstateToState(spaceKState).filter(({type, state_key, content}) => {
+		for await (const room of api.generateFullHierarchy(spaceID)) {
-			return type === "m.space.child" && "via" in content && !roomsWithCustomAvatars.includes(state_key)
+			if (room.avatar_url === newAvatarState.url) continue
-		}).map(({state_key}) => state_key)
+			if (roomsWithCustomAvatars.includes(room.room_id)) continue
-
+			await api.sendState(room.room_id, "m.room.avatar", "", newAvatarState)
-		for (const roomID of childRooms) {
-			const avatarEventContent = await api.getStateEvent(roomID, "m.room.avatar", "")
-			if (avatarEventContent.url !== newAvatarState.url) {
-				await api.sendState(roomID, "m.room.avatar", "", newAvatarState)
-			}
 		}
 	}
 
@@ -174,23 +187,23 @@ async function syncSpaceFully(guildID) {
 	console.log(`[space sync] to matrix: ${guild.name}`)
 
 	const guildKState = await guildToKState(guild, privacy_level)
+	ks.kstateStripConditionals(guildKState) // pre-upload icons before diffing
+	await ks.kstateUploadMxc(guildKState)
 
 	// sync guild state to space
-	const spaceKState = await createRoom.roomToKState(spaceID)
+	const spaceKState = await ks.roomToKState(spaceID)
 	const spaceDiff = ks.diffKState(spaceKState, guildKState)
-	await createRoom.applyKStateDiffToRoom(spaceID, spaceDiff)
+	await ks.applyKStateDiffToRoom(spaceID, spaceDiff)
 
-	const childRooms = ks.kstateToState(spaceKState).filter(({type, content}) => {
+	const childRooms = await api.getFullHierarchy(spaceID)
-		return type === "m.space.child" && "via" in content
-	}).map(({state_key}) => state_key)
 
-	for (const roomID of childRooms) {
+	for (const {room_id} of childRooms) {
-		const channelID = select("channel_room", "channel_id", {room_id: roomID}).pluck().get()
+		const channelID = select("channel_room", "channel_id", {room_id}).pluck().get()
 		if (!channelID) continue
 		if (discord.channels.has(channelID)) {
 			await createRoom.syncRoom(channelID)
 		} else {
-			await createRoom.unbridgeDeletedChannel(channelID, guildID)
+			await createRoom.unbridgeChannel({id: channelID}, guildID)
 		}
 	}
 
@@ -198,23 +211,42 @@ async function syncSpaceFully(guildID) {
 }
 
 /**
- * @param {import("discord-api-types/v10").GatewayGuildEmojisUpdateDispatchData | import("discord-api-types/v10").GatewayGuildStickersUpdateDispatchData} data
+ * @param {DiscordTypes.GatewayGuildEmojisUpdateDispatchData | DiscordTypes.GatewayGuildStickersUpdateDispatchData} data
+ * @param {boolean} checkBeforeSync false to always send new state, true to check the current state and only apply if state would change
  */
-async function syncSpaceExpressions(data) {
+async function syncSpaceExpressions(data, checkBeforeSync) {
 	// No need for kstate here. Each of these maps to a single state event, which will always overwrite what was there before. I can just send the state event.
 
 	const spaceID = select("guild_space", "space_id", {guild_id: data.guild_id}).pluck().get()
 	if (!spaceID) return
 
-	if ("emojis" in data && data.emojis.length) {
+	/**
-		const content = await expression.emojisToState(data.emojis)
+	 * @typedef {DiscordTypes.GatewayGuildEmojisUpdateDispatchData & DiscordTypes.GatewayGuildStickersUpdateDispatchData} Expressions
-		api.sendState(spaceID, "im.ponies.room_emotes", "moe.cadence.ooye.pack.emojis", content)
+	 * @param {string} spaceID
+	 * @param {Expressions extends any ? keyof Expressions : never} key
+	 * @param {string} eventKey
+	 * @param {typeof expression["emojisToState"] | typeof expression["stickersToState"]} fn
+	 */
+	async function update(spaceID, key, eventKey, fn) {
+		if (!(key in data) || !data[key].length) return
+		const guild = discord.guilds.get(data.guild_id)
+		assert(guild)
+		const content = await fn(data[key], guild)
+		if (checkBeforeSync) {
+			let existing
+			try {
+				existing = await api.getStateEvent(spaceID, "im.ponies.room_emotes", eventKey)
+			} catch (e) {
+				// State event not found. This space doesn't have any existing emojis. We create a dummy empty event for comparison's sake.
+				existing = fn([], guild)
+			}
+			if (isDeepStrictEqual(existing, content)) return
+		}
+		await api.sendState(spaceID, "im.ponies.room_emotes", eventKey, content)
 	}
 
-	if ("stickers" in data && data.stickers.length) {
+	await update(spaceID, "emojis", "moe.cadence.ooye.pack.emojis", expression.emojisToState)
-		const content = await expression.stickersToState(data.stickers)
+	await update(spaceID, "stickers", "moe.cadence.ooye.pack.stickers", expression.stickersToState)
-		api.sendState(spaceID, "im.ponies.room_emotes", "moe.cadence.ooye.pack.stickers", content)
-	}
 }
 
 module.exports.createSpace = createSpace

src/d2m/actions/create-space.test.js

@@ -0,0 +1,42 @@
+// @ts-check
+
+const mixin = require("@cloudrac3r/mixin-deep")
+const {guildToKState, ensureSpace} = require("./create-space")
+const {kstateStripConditionals, kstateUploadMxc} = require("../../matrix/kstate")
+const {test} = require("supertape")
+const testData = require("../../../test/data")
+
+const passthrough = require("../../passthrough")
+const {db} = passthrough
+
+test("guild2space: can generate kstate for a guild, passing privacy level 0", async t => {
+	t.deepEqual(
+		await kstateUploadMxc(kstateStripConditionals(await guildToKState(testData.guild.general, 0))),
+		{
+			"m.room.create/": {
+				additional_creators: ["@test_auto_invite:example.org"],
+				type: "m.space"
+			},
+			"m.room.avatar/": {
+				url: "mxc://cadence.moe/zKXGZhmImMHuGQZWJEFKJbsF"
+			},
+			"m.room.guest_access/": {
+				guest_access: "can_join"
+			},
+			"m.room.history_visibility/": {
+				history_visibility: "invited"
+			},
+			"m.room.join_rules/": {
+				join_rule: "invite"
+			},
+			"m.room.name/": {
+				name: "Psychonauts 3"
+			},
+			"m.room.power_levels/": {
+				users: {
+					"@test_auto_invite:example.org": 150
+				},
+			},
+		}
+	)
+})

src/d2m/actions/delete-message.js

@@ -0,0 +1,48 @@
+// @ts-check
+
+const passthrough = require("../../passthrough")
+const {sync, db, select, from} = passthrough
+/** @type {import("../../matrix/api")} */
+const api = sync.require("../../matrix/api")
+/** @type {import("./speedbump")} */
+const speedbump = sync.require("./speedbump")
+
+/**
+ * @param {import("discord-api-types/v10").GatewayMessageDeleteDispatchData} data
+ */
+async function deleteMessage(data) {
+	const row = select("channel_room", ["room_id", "speedbump_checked", "thread_parent"], {channel_id: data.channel_id}).get()
+	if (!row) return
+
+	// Assume we can redact from tombstoned rooms.
+	const eventsToRedact = from("event_message").join("message_room", "message_id").join("historical_channel_room", "historical_room_index")
+		.select("event_id", "room_id").where({message_id: data.id}).all()
+	db.prepare("DELETE FROM message_room WHERE message_id = ?").run(data.id)
+	for (const {event_id, room_id} of eventsToRedact) {
+		// Unfortunately, we can't specify a sender to do the redaction as, unless we find out that info via the audit logs
+		await api.redactEvent(room_id, event_id)
+	}
+
+	await speedbump.updateCache(row.thread_parent || data.channel_id, row.speedbump_checked)
+}
+
+/**
+ * @param {import("discord-api-types/v10").GatewayMessageDeleteBulkDispatchData} data
+ */
+async function deleteMessageBulk(data) {
+	const row = select("channel_room", "room_id", {channel_id: data.channel_id}).get()
+	if (!row) return
+
+	const sids = JSON.stringify(data.ids)
+	// Assume we can redact from tombstoned rooms.
+	const eventsToRedact = from("event_message").join("message_room", "message_id").join("historical_channel_room", "historical_room_index")
+		.select("event_id", "room_id").and("WHERE message_id IN (SELECT value FROM json_each(?))").all(sids)
+	db.prepare("DELETE FROM message_room WHERE message_id IN (SELECT value FROM json_each(?))").run(sids)
+	for (const {event_id, room_id} of eventsToRedact) {
+		// Awaiting will make it go slower, but since this could be a long-running operation either way, we want to leave rate limit capacity for other operations
+		await api.redactEvent(room_id, event_id)
+	}
+}
+
+module.exports.deleteMessage = deleteMessage
+module.exports.deleteMessageBulk = deleteMessageBulk

src/d2m/actions/edit-message.js

@@ -1,18 +1,38 @@
 // @ts-check
 
+const assert = require("assert").strict
+
 const passthrough = require("../../passthrough")
-const {sync, db, select} = passthrough
+const {sync, db, select, from} = passthrough
 /** @type {import("../converters/edit-to-changes")} */
 const editToChanges = sync.require("../converters/edit-to-changes")
+/** @type {import("./register-pk-user")} */
+const registerPkUser = sync.require("./register-pk-user")
 /** @type {import("../../matrix/api")} */
 const api = sync.require("../../matrix/api")
+/** @type {import("../../matrix/mreq")} */
+const mreq = sync.require("../../matrix/mreq")
 
 /**
  * @param {import("discord-api-types/v10").GatewayMessageCreateDispatchData} message
  * @param {import("discord-api-types/v10").APIGuild} guild
+ * @param {{speedbump_id: string, speedbump_webhook_id: string} | null} row data about the webhook which is proxying messages in this channel
  */
-async function editMessage(message, guild) {
+async function editMessage(message, guild, row) {
-	const {roomID, eventsToRedact, eventsToReplace, eventsToSend, senderMxid, promotions} = await editToChanges.editToChanges(message, guild, api)
+	const historicalRoomOfMessage = from("message_room").join("historical_channel_room", "historical_room_index").where({message_id: message.id}).select("room_id").get()
+	const currentRoom = from("channel_room").join("historical_channel_room", "room_id").where({channel_id: message.channel_id}).select("room_id", "historical_room_index").get()
+	if (!currentRoom) return
+
+	if (historicalRoomOfMessage && historicalRoomOfMessage.room_id !== currentRoom.room_id) return // tombstoned rooms should not have new events (including edits) sent to them
+
+	let {roomID, eventsToRedact, eventsToReplace, eventsToSend, senderMxid, promotions} = await editToChanges.editToChanges(message, guild, api)
+
+	if (row && row.speedbump_webhook_id === message.webhook_id) {
+		// Handle the PluralKit public instance
+		if (row.speedbump_id === "466378653216014359") {
+			senderMxid = await registerPkUser.syncUser(message.id, message.author, roomID, true)
+		}
+	}
 
 	// 1. Replace all the things.
 	for (const {oldID, newContent} of eventsToReplace) {
@@ -39,7 +59,7 @@ async function editMessage(message, guild) {
 	const sendNewEventParts = new Set()
 	for (const promotion of promotions) {
 		if ("eventID" in promotion) {
-			db.prepare(`UPDATE event_message SET ${promotion.column} = 0 WHERE event_id = ?`).run(promotion.eventID)
+			db.prepare(`UPDATE event_message SET ${promotion.column} = ? WHERE event_id = ?`).run(promotion.value ?? 0, promotion.eventID)
 		} else if ("nextEvent" in promotion) {
 			sendNewEventParts.add(promotion.column)
 		}
@@ -47,7 +67,7 @@ async function editMessage(message, guild) {
 
 	// 4. Send all the things.
 	if (eventsToSend.length) {
-		db.prepare("REPLACE INTO message_channel (message_id, channel_id) VALUES (?, ?)").run(message.id, message.channel_id)
+		db.prepare("INSERT OR IGNORE INTO message_room (message_id, historical_room_index) VALUES (?, ?)").run(message.id, currentRoom.historical_room_index)
 	}
 	for (const content of eventsToSend) {
 		const eventType = content.$type
@@ -58,8 +78,17 @@ async function editMessage(message, guild) {
 
 		const part = sendNewEventParts.has("part") && eventsToSend[0] === content ? 0 : 1
 		const reactionPart = sendNewEventParts.has("reaction_part") && eventsToSend[eventsToSend.length - 1] === content ? 0 : 1
-		const eventID = await api.sendEvent(roomID, eventType, contentWithoutType, senderMxid)
+
-		db.prepare("INSERT INTO event_message (event_id, event_type, event_subtype, message_id, part, reaction_part, source) VALUES (?, ?, ?, ?, ?, ?, 1)").run(eventID, eventType, content.msgtype || null, message.id, part, reactionPart) // source 1 = discord
+		try {
+			const eventID = await api.sendEvent(roomID, eventType, contentWithoutType, senderMxid)
+			db.prepare("INSERT INTO event_message (event_id, event_type, event_subtype, message_id, part, reaction_part, source) VALUES (?, ?, ?, ?, ?, ?, 1)").run(eventID, eventType, content.msgtype || null, message.id, part, reactionPart) // source 1 = discord
+		} catch (e) {
+			if (e instanceof mreq.MatrixServerError && e.errcode === "M_FORBIDDEN") {
+				// sending user doesn't have permission to update message, e.g. because Discord generated an embed in a read-only room
+			} else {
+				throw e
+			}
+		}
 	}
 }
 

src/d2m/actions/expression.js

@@ -1,20 +1,20 @@
 // @ts-check
 
-const assert = require("assert").strict
 const DiscordTypes = require("discord-api-types/v10")
 
 const passthrough = require("../../passthrough")
-const {discord, sync, db, select} = passthrough
+const {sync, db} = passthrough
 /** @type {import("../../matrix/file")} */
 const file = sync.require("../../matrix/file")
 
 /**
  * @param {DiscordTypes.APIEmoji[]} emojis
+ * @param {DiscordTypes.APIGuild} guild
  */
-async function emojisToState(emojis) {
+async function emojisToState(emojis, guild) {
 	const result = {
 		pack: {
-			display_name: "Discord Emojis",
+			display_name: `${guild.name} (Discord Emojis)`,
 			usage: ["emoticon"] // we'll see...
 		},
 		images: {
@@ -25,13 +25,13 @@ async function emojisToState(emojis) {
 		file.uploadDiscordFileToMxc(file.emoji(emoji.id, emoji.animated)).then(url => {
 			result.images[emoji.name] = {
 				info: {
-					mimetype: emoji.animated ? "image/gif" : "image/png"
+					mimetype: "image/webp"
 				},
 				url
 			}
 			db.prepare("INSERT OR IGNORE INTO emoji (emoji_id, name, animated, mxc_url) VALUES (?, ?, ?, ?)").run(emoji.id, emoji.name, +!!emoji.animated, url)
 		}).catch(e => {
-			if (e.data.errcode === "M_TOO_LARGE") { // Very unlikely to happen. Only possible for 3x-series emojis uploaded shortly after animated emojis were introduced, when there was no 256 KB size limit.
+			if (e.data?.errcode === "M_TOO_LARGE") { // Very unlikely to happen. Only possible for 3x-series emojis uploaded shortly after animated emojis were introduced, when there was no 256 KB size limit.
 				return
 			}
 			console.error(`Trying to handle emoji ${emoji.name} (${emoji.id}), but...`)
@@ -43,11 +43,12 @@ async function emojisToState(emojis) {
 
 /**
  * @param {DiscordTypes.APISticker[]} stickers
+ * @param {DiscordTypes.APIGuild} guild
  */
-async function stickersToState(stickers) {
+async function stickersToState(stickers, guild) {
 	const result = {
 		pack: {
-			display_name: "Discord Stickers",
+			display_name: `${guild.name} (Discord Stickers)`,
 			usage: ["sticker"] // we'll see...
 		},
 		images: {
@@ -67,7 +68,7 @@ async function stickersToState(stickers) {
 			while (shortcodes.includes(shortcode)) shortcode = shortcode + "~"
 			shortcodes.push(shortcode)
 
-			result.images[shortcodes] = {
+			result.images[shortcode] = {
 				info: {
 					mimetype: file.stickerFormat.get(sticker.format_type)?.mime || "image/png"
 				},

src/d2m/actions/lottie.js

@@ -3,63 +3,40 @@
 const DiscordTypes = require("discord-api-types/v10")
 const Ty = require("../../types")
 const assert = require("assert").strict
-const {PNG} = require("pngjs")
 
 const passthrough = require("../../passthrough")
-const {sync, db, discord, select} = passthrough
+const {sync, db, select} = passthrough
 /** @type {import("../../matrix/file")} */
 const file = sync.require("../../matrix/file")
-//** @type {import("../../matrix/mreq")} */
+/** @type {import("../../matrix/mreq")} */
 const mreq = sync.require("../../matrix/mreq")
-
+/** @type {import("../converters/lottie")} */
-const SIZE = 160 // Discord's display size on 1x displays is 160
+const convertLottie = sync.require("../converters/lottie")
 
 const INFO = {
 	mimetype: "image/png",
-	w: SIZE,
+	w: convertLottie.SIZE,
-	h: SIZE
+	h: convertLottie.SIZE
 }
 
-/**
- * @typedef RlottieWasm
- * @prop {(string) => boolean} load load lottie data from string of json
- * @prop {() => number} frames get number of frames
- * @prop {(frameCount: number, width: number, height: number) => Uint8Array} render render lottie data to bitmap
- */
-
-const Rlottie = (async () => {
-	const Rlottie = require("./rlottie-wasm.js")
-	await new Promise(resolve => Rlottie.onRuntimeInitialized = resolve)
-	return Rlottie
-})()
-
 /**
  * @param {DiscordTypes.APIStickerItem} stickerItem
  * @returns {Promise<{mxc_url: string, info: typeof INFO}>}
  */
 async function convert(stickerItem) {
+	// Reuse sticker if already converted and uploaded
 	const existingMxc = select("lottie", "mxc_url", {sticker_id: stickerItem.id}).pluck().get()
 	if (existingMxc) return {mxc_url: existingMxc, info: INFO}
-	const r = await Rlottie
+
+	// Fetch sticker data from Discord
 	const res = await fetch(file.DISCORD_IMAGES_BASE + file.sticker(stickerItem))
 	if (res.status !== 200) throw new Error("Sticker data file not found.")
 	const text = await res.text()
-	/** @type RlottieWasm */
+
-	const rh = new r.RlottieWasm()
+	// Convert to PNG (stream.Readable)
-	const status = rh.load(text)
+	const readablePng = await convertLottie.convert(text)
-	if (!status) throw new Error(`Rlottie unable to load ${text.length} byte data file.`)
+
-	const rendered = rh.render(0, SIZE, SIZE)
+	// Upload to MXC
-	let png = new PNG({
-		width: SIZE,
-		height: SIZE,
-		bitDepth: 8, // 8 red + 8 green + 8 blue + 8 alpha
-		colorType: 6, // RGBA
-		inputColorType: 6, // RGBA
-		inputHasAlpha: true,
-	})
-	png.data = Buffer.from(rendered)
-	// @ts-ignore wrong type from pngjs
-	const readablePng = png.pack()
 	/** @type {Ty.R.FileUploaded} */
 	const root = await mreq.mreq("POST", "/media/v3/upload", readablePng, {
 		headers: {
@@ -67,6 +44,8 @@ async function convert(stickerItem) {
 		}
 	})
 	assert(root.content_uri)
+
+	// Save the link for next time
 	db.prepare("INSERT INTO lottie (sticker_id, mxc_url) VALUES (?, ?)").run(stickerItem.id, root.content_uri)
 	return {mxc_url: root.content_uri, info: INFO}
 }

src/d2m/actions/poll-end.js

@@ -0,0 +1,122 @@
+// @ts-check
+
+const assert = require("assert").strict
+const DiscordTypes = require("discord-api-types/v10")
+const {isDeepStrictEqual} = require("util")
+
+const passthrough = require("../../passthrough")
+const {discord, sync, db, select, from} = passthrough
+const {reg} = require("../../matrix/read-registration")
+/** @type {import("./poll-vote")} */
+const vote = sync.require("../actions/poll-vote")
+/** @type {import("../../discord/interactions/poll-responses")} */
+const pollResponses = sync.require("../../discord/interactions/poll-responses")
+
+/**
+ * @file This handles, in the following order:
+ * * verifying Matrix-side votes are accurate for a poll originating on Discord, sending missed votes to Matrix if necessary
+ * * sending a message to Discord if a vote in that poll has been cast on Matrix
+ * This does *not* handle bridging of poll closures on Discord to Matrix; that takes place in converters/message-to-event.js.
+ */
+
+/**
+ * @param {string} channelID
+ * @param {string} messageID
+ * @param {string} answerID
+ * @returns {Promise<DiscordTypes.RESTGetAPIPollAnswerVotersResult["users"]>}
+ */
+async function getAllVotesOnAnswer(channelID, messageID, answerID) {
+	const limit = 100
+	/** @type {DiscordTypes.RESTGetAPIPollAnswerVotersResult["users"]} */
+	let voteUsers = []
+	let after = undefined
+	while (true) {
+		const curVotes = await discord.snow.channel.getPollAnswerVoters(channelID, messageID, answerID, {after: after, limit})
+		voteUsers = voteUsers.concat(curVotes.users)
+		if (curVotes.users.length >= limit) { // Loop again for the next page.
+			// @ts-ignore - stupid
+			after = curVotes.users.at(-1).id
+		} else { // Reached the end.
+			return voteUsers
+		}
+	}
+}
+
+/**
+ * @param {typeof import("../../../test/data.js")["poll_close"]} closeMessage
+*/
+async function endPoll(closeMessage) {
+	const pollCloseObject = closeMessage.embeds[0]
+
+	const pollMessageID = closeMessage.message_reference.message_id
+	const pollEventID = select("event_message", "event_id", {message_id: pollMessageID, event_type: "org.matrix.msc3381.poll.start"}).pluck().get()
+	if (!pollEventID) return // Nothing we can send Discord-side if we don't have the original poll. We will still send a results message Matrix-side.
+
+	const discordPollOptions = select("poll_option", "discord_option", {message_id: pollMessageID}).pluck().all()
+	assert(discordPollOptions.every(x => typeof x === "string")) // This poll originated on Discord so it will have Discord option IDs
+
+	// If the closure came from Discord, we want to fetch all the votes there again and bridge over any that got lost to Matrix before posting the results.
+	// Database reads are cheap, and API calls are expensive, so we will only query Discord when the totals don't match.
+
+	const totalVotes = +pollCloseObject.fields.find(element => element.name === "total_votes").value // We could do [2], but best not to rely on the ordering staying consistent.
+
+	const databaseVotes = select("poll_vote", ["discord_or_matrix_user_id", "matrix_option"], {message_id: pollMessageID}, " AND discord_or_matrix_user_id NOT LIKE '@%'").all()
+
+	if (databaseVotes.length !== totalVotes) { // Matching length should be sufficient for most cases.
+		let voteUsers = [...new Set(databaseVotes.map(vote => vote.discord_or_matrix_user_id))] // Unique array of all users we have votes for in the database.
+
+		// Main design challenge here: we get the data by *answer*, but we need to send it to Matrix by *user*.
+
+		/** @type {{user: DiscordTypes.APIUser, matrixOptionVotes: string[]}[]} This will be our new array of answers */
+		const updatedAnswers = []
+
+		for (const discordPollOption of discordPollOptions) {
+			const optionUsers = await getAllVotesOnAnswer(closeMessage.channel_id, pollMessageID, discordPollOption) // Array of user IDs who voted for the option we're testing.
+			for (const user of optionUsers) {
+				const userLocation = updatedAnswers.findIndex(answer => answer.user.id === user.id)
+				const matrixOption = select("poll_option", "matrix_option", {message_id: pollMessageID, discord_option: discordPollOption}).pluck().get()
+				assert(matrixOption)
+				if (userLocation === -1) { // We haven't seen this user yet, so we need to add them.
+					updatedAnswers.push({user, matrixOptionVotes: [matrixOption]}) // toString as this is what we store and get from the database and send to Matrix.
+				} else { // This user already voted for another option on the poll.
+					updatedAnswers[userLocation].matrixOptionVotes.push(matrixOption)
+				}
+			}
+		}
+
+		// Check for inconsistencies in what was cached in database vs final confirmed poll answers
+		// If different, sync the final confirmed answers to Matrix-side to make it accurate there too
+
+		await Promise.all(updatedAnswers.map(async answer => {
+			voteUsers = voteUsers.filter(item => item !== answer.user.id) // Remove any users we have updated answers for from voteUsers. The only remaining entries in this array will be users who voted, but then removed their votes before the poll ended.
+			const cachedAnswers = select("poll_vote", "matrix_option", {discord_or_matrix_user_id: answer.user.id, message_id: pollMessageID}).pluck().all()
+			if (!isDeepStrictEqual(new Set(cachedAnswers), new Set(answer.matrixOptionVotes))) {
+				db.transaction(() => {
+					db.prepare("DELETE FROM poll_vote WHERE discord_or_matrix_user_id = ? AND message_id = ?").run(answer.user.id, pollMessageID) // Delete existing stored votes.
+					for (const matrixOption of answer.matrixOptionVotes) {
+						db.prepare("INSERT INTO poll_vote (discord_or_matrix_user_id, message_id, matrix_option) VALUES (?, ?, ?)").run(answer.user.id, pollMessageID, matrixOption)
+					}
+				})()
+				await vote.sendVotes(answer.user, closeMessage.channel_id, pollMessageID, pollEventID)
+			}
+		}))
+
+		await Promise.all(voteUsers.map(async user_id => { // Remove these votes.
+			db.prepare("DELETE FROM poll_vote WHERE discord_or_matrix_user_id = ? AND message_id = ?").run(user_id, pollMessageID)
+			await vote.sendVotes(user_id, closeMessage.channel_id, pollMessageID, pollEventID)
+		}))
+	}
+
+	const {combinedVotes, messageString} = pollResponses.getCombinedResults(pollMessageID, true)
+
+	if (combinedVotes !== totalVotes) { // This means some votes were cast on Matrix. Now that we've corrected the vote totals, we can get the results again and post them to Discord.
+		return {
+			username: "Total results including Matrix votes",
+			avatar_url: `${reg.ooye.bridge_origin}/download/file/poll-star-avatar.png`,
+			content: messageString,
+			flags: DiscordTypes.MessageFlags.SuppressEmbeds
+		}
+	}
+}
+
+module.exports.endPoll = endPoll

src/d2m/actions/poll-vote.js

@@ -0,0 +1,100 @@
+// @ts-check
+
+const assert = require("assert").strict
+const DiscordTypes = require("discord-api-types/v10")
+const {Semaphore} = require("@chriscdn/promise-semaphore")
+const {scheduler} = require("timers/promises")
+
+const passthrough = require("../../passthrough")
+const {discord, sync, db, select, from} = passthrough
+/** @type {import("../../matrix/api")} */
+const api = sync.require("../../matrix/api")
+/** @type {import("./register-user")} */
+const registerUser = sync.require("./register-user")
+
+const inFlightPollSema = new Semaphore()
+
+/**
+ * @param {import("discord-api-types/v10").GatewayMessagePollVoteAddDispatch["d"]} data
+ */
+async function addVote(data) {
+	const pollEventID = from("event_message").join("poll_option", "message_id").pluck("event_id").where({message_id: data.message_id, event_type: "org.matrix.msc3381.poll.start"}).get() // Currently Discord doesn't allow sending a poll with anything else, but we bridge it after all other content so reaction_part: 0 is the part that will have the poll.
+	if (!pollEventID) return // Nothing can be done if the parent message was never bridged.
+
+	let realAnswer = select("poll_option", "matrix_option", {message_id: data.message_id, discord_option: data.answer_id.toString()}).pluck().get() // Discord answer IDs don't match those on Matrix-created polls.
+	assert(realAnswer)
+	db.prepare("INSERT OR IGNORE INTO poll_vote (discord_or_matrix_user_id, message_id, matrix_option) VALUES (?, ?, ?)").run(data.user_id, data.message_id, realAnswer)
+	return debounceSendVotes(data, pollEventID)
+}
+
+/**
+ * @param {import("discord-api-types/v10").GatewayMessagePollVoteRemoveDispatch["d"]} data
+ */
+async function removeVote(data) {
+	const pollEventID = from("event_message").join("poll_option", "message_id").pluck("event_id").where({message_id: data.message_id, event_type: "org.matrix.msc3381.poll.start"}).get()
+	if (!pollEventID) return
+
+	let realAnswer = select("poll_option", "matrix_option", {message_id: data.message_id, discord_option: data.answer_id.toString()}).pluck().get() // Discord answer IDs don't match those on Matrix-created polls.
+	assert(realAnswer)
+	db.prepare("DELETE FROM poll_vote WHERE discord_or_matrix_user_id = ? AND message_id = ? AND matrix_option = ?").run(data.user_id, data.message_id, realAnswer)
+	return debounceSendVotes(data, pollEventID)
+}
+
+/**
+ * Multiple-choice polls send all the votes at the same time. This debounces and sends the combined votes.
+ * In the meantime, the combined votes are assembled in the `poll_vote` database table by the above functions.
+ * @param {import("discord-api-types/v10").GatewayMessagePollVoteAddDispatch["d"]} data
+ * @param {string} pollEventID
+ * @return {Promise<string>} event ID of Matrix vote
+ */
+async function debounceSendVotes(data, pollEventID) {
+	return await inFlightPollSema.request(async () => {
+		await scheduler.wait(1000) // Wait for votes to be collected
+
+		const user = await discord.snow.user.getUser(data.user_id) // Gateway event doesn't give us the object, only the ID.
+		return await sendVotes(user, data.channel_id, data.message_id, pollEventID)
+	}, `${data.user_id}/${data.message_id}`)
+}
+
+/**
+ * @param {DiscordTypes.APIUser | string} userOrID
+ * @param {string} channelID
+ * @param {string} pollMessageID
+ * @param {string} pollEventID
+ */
+async function sendVotes(userOrID, channelID, pollMessageID, pollEventID) {
+	const latestRoomID = select("channel_room", "room_id", {channel_id: channelID}).pluck().get()
+	const matchingRoomID = from("message_room").join("historical_channel_room", "historical_room_index").where({message_id: pollMessageID}).pluck("room_id").get()
+	if (!latestRoomID || latestRoomID !== matchingRoomID) { // room upgrade mid-poll??
+		db.prepare("UPDATE poll SET is_closed = 1 WHERE message_id = ?").run(pollMessageID)
+		return
+	}
+
+	let userID, senderMxid
+	if (typeof userOrID === "string") { // just a string when double-checking a vote removal - good thing the unvoter is already here from having voted
+		userID = userOrID
+		senderMxid = from("sim").join("sim_member", "mxid").where({user_id: userOrID, room_id: matchingRoomID}).pluck("mxid").get()
+		if (!senderMxid) return
+	} else { // sent in full when double-checking adding a vote, so we can properly ensure joined
+		userID = userOrID.id
+		senderMxid = await registerUser.ensureSimJoined(userOrID, matchingRoomID)
+	}
+
+	const answersArray = select("poll_vote", "matrix_option", {discord_or_matrix_user_id: userID, message_id: pollMessageID}).pluck().all()
+	const eventID = await api.sendEvent(matchingRoomID, "org.matrix.msc3381.poll.response", {
+		"m.relates_to": {
+			rel_type: "m.reference",
+			event_id: pollEventID,
+		},
+		"org.matrix.msc3381.poll.response": {
+			answers: answersArray
+		}
+	}, senderMxid)
+
+	return eventID
+}
+
+module.exports.addVote = addVote
+module.exports.removeVote = removeVote
+module.exports.debounceSendVotes = debounceSendVotes
+module.exports.sendVotes = sendVotes

src/d2m/actions/register-pk-user.js

@@ -0,0 +1,155 @@
+// @ts-check
+
+const assert = require("assert")
+const {reg} = require("../../matrix/read-registration")
+const Ty = require("../../types")
+
+const passthrough = require("../../passthrough")
+const {sync, db, select, from} = passthrough
+/** @type {import("../../matrix/api")} */
+const api = sync.require("../../matrix/api")
+/** @type {import("../../matrix/file")} */
+const file = sync.require("../../matrix/file")
+/** @type {import("./register-user")} */
+const registerUser = sync.require("./register-user")
+
+/** @returns {Promise<Ty.PkMessage>} */
+async function fetchMessage(messageID) {
+	try {
+		var res = await fetch(`https://api.pluralkit.me/v2/messages/${messageID}`)
+	} catch (networkError) {
+		// Network issue, raise a more readable message
+		throw new Error(`Failed to connect to PK API: ${networkError.toString()}`)
+	}
+	if (!res.ok) throw new Error(`PK API returned an error: ${await res.text()}`)
+	/** @type {any} */
+	const root = await res.json()
+	if (!root.member) throw new Error(`PK API didn't return member data: ${JSON.stringify(root)}`)
+	return root
+}
+
+/**
+ * A sim is an account that is being simulated by the bridge to copy events from the other side.
+ * @param {Ty.PkMessage} pkMessage
+ * @returns mxid
+ */
+async function createSim(pkMessage) {
+	// Choose sim name
+	const simName = "_pk_" + pkMessage.member.id
+	const localpart = reg.ooye.namespace_prefix + simName
+	const mxid = `@${localpart}:${reg.ooye.server_name}`
+
+	// Save chosen name in the database forever
+	db.prepare("INSERT INTO sim (user_id, username, sim_name, mxid) VALUES (?, ?, ?, ?)").run(pkMessage.member.uuid, simName, simName, mxid)
+
+	// Register matrix user with that name
+	try {
+		await api.register(localpart)
+	} catch (e) {
+		// If user creation fails, manually undo the database change. Still isn't perfect, but should help.
+		// (I would prefer a transaction, but it's not safe to leave transactions open across event loop ticks.)
+		db.prepare("DELETE FROM sim WHERE user_id = ?").run(pkMessage.member.uuid)
+		throw e
+	}
+	return mxid
+}
+
+/**
+ * Ensure a sim is registered for the user.
+ * If there is already a sim, use that one. If there isn't one yet, register a new sim.
+ * @param {Ty.PkMessage} pkMessage
+ * @returns {Promise<string>} mxid
+ */
+async function ensureSim(pkMessage) {
+	let mxid = null
+	const existing = select("sim", "mxid", {user_id: pkMessage.member.uuid}).pluck().get()
+	if (existing) {
+		mxid = existing
+	} else {
+		mxid = await createSim(pkMessage)
+	}
+	return mxid
+}
+
+/**
+ * Ensure a sim is registered for the user and is joined to the room.
+ * @param {Ty.PkMessage} pkMessage
+ * @param {string} roomID
+ * @returns {Promise<string>} mxid
+ */
+async function ensureSimJoined(pkMessage, roomID) {
+	// Ensure room ID is really an ID, not an alias
+	assert.ok(roomID[0] === "!")
+
+	// Ensure user
+	const mxid = await ensureSim(pkMessage)
+
+	// Ensure joined
+	const existing = select("sim_member", "mxid", {room_id: roomID, mxid}).pluck().get()
+	if (!existing) {
+		await api.inviteToRoom(roomID, mxid)
+		await api.joinRoom(roomID, mxid)
+		db.prepare("INSERT OR IGNORE INTO sim_member (room_id, mxid) VALUES (?, ?)").run(roomID, mxid)
+	}
+	return mxid
+}
+
+/**
+ * Generate profile data based on webhook displayname and configured avatar.
+ * @param {Ty.PkMessage} pkMessage
+ * @param {Ty.WebhookAuthor} author
+ */
+async function memberToStateContent(pkMessage, author) {
+	// We prefer to use the member's avatar URL data since the image upload can be cached across channels,
+	// unlike the userAvatar URL which is unique per channel, due to the webhook ID being in the URL.
+	const avatar = pkMessage.member.avatar_url || pkMessage.member.webhook_avatar_url || pkMessage.system.avatar_url || file.userAvatar(author)
+
+	const content = {
+		displayname: author.username,
+		membership: "join",
+		"moe.cadence.ooye.pk_member": pkMessage.member
+	}
+	if (avatar) content.avatar_url = await file.uploadDiscordFileToMxc(avatar)
+
+	return content
+}
+
+/**
+ * Sync profile data for a sim user. This function follows the following process:
+ * 1. Look up data about proxy user from API
+ * 2. If this fails, try to use previously cached data (won't sync)
+ * 3. Create and join the sim to the room if needed
+ * 4. Make an object of what the new room member state content would be, including uploading the profile picture if it hasn't been done before
+ * 5. Compare against the previously known state content, which is helpfully stored in the database
+ * 6. If the state content has changed, send it to Matrix and update it in the database for next time
+ * @param {string} messageID to call API with
+ * @param {Ty.WebhookAuthor} author for profile data
+ * @param {string} roomID room to join member to
+ * @param {boolean} shouldActuallySync whether to actually sync updated user data or just ensure it's joined
+ * @returns {Promise<string>} mxid of the updated sim
+ */
+async function syncUser(messageID, author, roomID, shouldActuallySync) {
+	try {
+		// API lookup
+		var pkMessage = await fetchMessage(messageID)
+		db.prepare("REPLACE INTO sim_proxy (user_id, proxy_owner_id, displayname) VALUES (?, ?, ?)").run(pkMessage.member.uuid, pkMessage.sender, author.username)
+	} catch (e) {
+		// Fall back to offline cache
+		const senderMxid = from("sim_proxy").join("sim", "user_id").join("sim_member", "mxid").where({displayname: author.username, room_id: roomID}).pluck("mxid").get()
+		if (!senderMxid) throw e
+		return senderMxid
+	}
+
+	// Create and join the sim to the room if needed
+	const mxid = await ensureSimJoined(pkMessage, roomID)
+
+	if (shouldActuallySync) {
+		// Build current profile data and sync if the hash has changed
+		const content = await memberToStateContent(pkMessage, author)
+		await registerUser._sendSyncUser(roomID, mxid, content, null)
+	}
+
+	return mxid
+}
+
+module.exports.syncUser = syncUser

src/d2m/actions/register-user.js

@@ -0,0 +1,298 @@
+// @ts-check
+
+const assert = require("assert").strict
+const {reg} = require("../../matrix/read-registration")
+const DiscordTypes = require("discord-api-types/v10")
+const Ty = require("../../types")
+
+const passthrough = require("../../passthrough")
+const {discord, sync, db, from, select} = passthrough
+/** @type {import("../../matrix/api")} */
+const api = sync.require("../../matrix/api")
+/** @type {import("../../matrix/file")} */
+const file = sync.require("../../matrix/file")
+/** @type {import("../../discord/utils")} */
+const dUtils = sync.require("../../discord/utils")
+/** @type {import("../../matrix/utils")} */
+const mxUtils = sync.require("../../matrix/utils")
+/** @type {import("../converters/user-to-mxid")} */
+const userToMxid = sync.require("../converters/user-to-mxid")
+/** @type {import("./create-room")} */
+const createRoom = sync.require("./create-room")
+/** @type {import("xxhash-wasm").XXHashAPI} */ // @ts-ignore
+let hasher = null
+// @ts-ignore
+require("xxhash-wasm")().then(h => hasher = h)
+
+const supportsMsc4069 = api.versions().then(v => !!v?.unstable_features?.["org.matrix.msc4069"]).catch(() => false)
+
+/**
+ * A sim is an account that is being simulated by the bridge to copy events from the other side.
+ * @param {DiscordTypes.APIUser} user
+ * @returns mxid
+ */
+async function createSim(user) {
+	// Choose sim name
+	const simName = userToMxid.userToSimName(user)
+	const localpart = reg.ooye.namespace_prefix + simName
+	const mxid = `@${localpart}:${reg.ooye.server_name}`
+
+	// Save chosen name in the database forever
+	// Making this database change right away so that in a concurrent registration, the 2nd registration will already have generated a different localpart because it can see this row when it generates
+	db.prepare("INSERT INTO sim (user_id, username, sim_name, mxid) VALUES (?, ?, ?, ?)").run(user.id, user.username, simName, mxid)
+
+	// Register matrix user with that name
+	try {
+		await api.register(localpart)
+	} catch (e) {
+		// If user creation fails, manually undo the database change. Still isn't perfect, but should help.
+		// (I would prefer a transaction, but it's not safe to leave transactions open across event loop ticks.)
+		db.prepare("DELETE FROM sim WHERE user_id = ?").run(user.id)
+		throw e
+	}
+	return mxid
+}
+
+/**
+ * Ensure a sim is registered for the user.
+ * If there is already a sim, use that one. If there isn't one yet, register a new sim.
+ * @param {DiscordTypes.APIUser} user
+ * @returns {Promise<string>} mxid
+ */
+async function ensureSim(user) {
+	let mxid = null
+	const existing = select("sim", "mxid", {user_id: user.id}).pluck().get()
+	if (existing) {
+		mxid = existing
+	} else {
+		mxid = await createSim(user)
+	}
+	return mxid
+}
+
+/**
+ * Ensure a sim is registered for the user and is joined to the room.
+ * @param {DiscordTypes.APIUser} user
+ * @param {string} roomID
+ * @returns {Promise<string>} mxid
+ */
+async function ensureSimJoined(user, roomID) {
+	// Ensure room ID is really an ID, not an alias
+	assert.ok(roomID[0] === "!")
+
+	// Ensure user
+	const mxid = await ensureSim(user)
+
+	// Ensure joined
+	const existing = select("sim_member", "mxid", {room_id: roomID, mxid}).pluck().get()
+	if (!existing) {
+		await api.inviteToRoom(roomID, mxid)
+		await api.joinRoom(roomID, mxid)
+		db.prepare("INSERT OR IGNORE INTO sim_member (room_id, mxid) VALUES (?, ?)").run(roomID, mxid)
+	}
+	return mxid
+}
+
+/**
+ * @param {DiscordTypes.APIUser} user
+ */
+async function userToGlobalProfile(user) {
+	const globalProfile = {}
+
+	globalProfile.displayname = user.username
+	if (user.global_name) globalProfile.displayname = user.global_name
+
+	if (user.avatar) {
+		const avatarPath = file.userAvatar(user) // the user avatar only
+		globalProfile.avatar_url = await file.uploadDiscordFileToMxc(avatarPath)
+	}
+
+	return globalProfile
+}
+
+/**
+ * @param {DiscordTypes.APIUser} user
+ * @param {Omit<DiscordTypes.APIGuildMember, "user"> | undefined} member
+ */
+async function memberToStateContent(user, member, guildID) {
+	let displayname = user.username
+	if (user.global_name) displayname = user.global_name
+	if (member?.nick) displayname = member.nick
+
+	const content = {
+		displayname,
+		membership: "join",
+		"moe.cadence.ooye.member": {
+		},
+		"uk.half-shot.discord.member": {
+			bot: !!user.bot,
+			displayColor: user.accent_color,
+			id: user.id,
+			username: user.discriminator.length === 4 ? `${user.username}#${user.discriminator}` : `@${user.username}`
+		}
+	}
+
+	if (member?.avatar || user.avatar) {
+		// const avatarPath = file.userAvatar(user) // the user avatar only
+		const avatarPath = file.memberAvatar(guildID, user, member) // the member avatar or the user avatar
+		content["moe.cadence.ooye.member"].avatar = avatarPath
+		content.avatar_url = await file.uploadDiscordFileToMxc(avatarPath)
+	}
+
+	return content
+}
+
+/**
+ * https://gitdab.com/cadence/out-of-your-element/issues/9
+ * @param {DiscordTypes.APIUser} user
+ * @param {Omit<DiscordTypes.APIGuildMember, "user"> | undefined} member
+ * @param {DiscordTypes.APIGuild} guild
+ * @param {DiscordTypes.APIGuildChannel} channel
+ * @returns {number} 0 to 100
+ */
+function memberToPowerLevel(user, member, guild, channel) {
+	if (!member) return 0
+
+	const permissions = dUtils.getPermissions(guild.id, member.roles, guild.roles, user.id, channel.permission_overwrites)
+	const everyonePermissions = dUtils.getPermissions(guild.id, [], guild.roles, undefined, channel.permission_overwrites)
+	/*
+	 * PL 100 = Administrator = People who can brick the room. RATIONALE:
+	 * 	- Administrator.
+	 * 	- Manage Webhooks: People who remove the webhook can break the room.
+	 * 	- Manage Guild: People who can manage guild can add bots.
+	 * 	- Manage Channels: People who can manage the channel can delete it.
+	 * (Setting sim users to PL 100 is safe because even though we can't demote the sims we can use code to make the sims demote themselves.)
+	 */
+	if (guild.owner_id === user.id || dUtils.hasSomePermissions(permissions, ["Administrator", "ManageWebhooks", "ManageGuild", "ManageChannels"])) return 100
+	/*
+	 * PL 50 = Moderator = People who can manage people and messages in many ways. RATIONALE:
+	 * 	- Manage Messages: Can moderate by pinning or deleting the conversation.
+	 * 	- Manage Nicknames: Can moderate by removing inappropriate nicknames.
+	 * 	- Manage Threads: Can moderate by deleting conversations.
+	 * 	- Kick Members & Ban Members: Can moderate by removing disruptive people.
+	 * 	- Mute Members & Deafen Members: Can moderate by silencing disruptive people in ways they can't undo.
+	 * 	- Moderate Members.
+	 */
+	if (dUtils.hasSomePermissions(permissions, ["ManageMessages", "ManageNicknames", "ManageThreads", "KickMembers", "BanMembers", "MuteMembers", "DeafenMembers", "ModerateMembers"])) return 50
+	/* PL 50 = if room is read-only but the user has been specially allowed to send messages */
+	const everyoneCanSend = dUtils.hasPermission(everyonePermissions, DiscordTypes.PermissionFlagsBits.SendMessages)
+	const userCanSend = dUtils.hasPermission(permissions, DiscordTypes.PermissionFlagsBits.SendMessages)
+	if (!everyoneCanSend && userCanSend) return createRoom.READ_ONLY_ROOM_EVENTS_DEFAULT_POWER
+	/* PL 20 = Mention Everyone for technical reasons. */
+	const everyoneCanMentionEveryone = dUtils.hasPermission(everyonePermissions, DiscordTypes.PermissionFlagsBits.MentionEveryone)
+	const userCanMentionEveryone = dUtils.hasPermission(permissions, DiscordTypes.PermissionFlagsBits.MentionEveryone)
+	if (!everyoneCanMentionEveryone && userCanMentionEveryone) return 20
+	/* PL 10 = Create Polls for technical reasons. */
+	const everyoneCanCreatePolls = dUtils.hasPermission(everyonePermissions, DiscordTypes.PermissionFlagsBits.SendPolls)
+	const userCanCreatePolls = dUtils.hasPermission(permissions, DiscordTypes.PermissionFlagsBits.SendPolls)
+	if (!everyoneCanCreatePolls && userCanCreatePolls) return 10
+	return 0
+}
+
+/**
+ * @param {any} content
+ * @param {number} powerLevel
+ */
+function _hashProfileContent(content, powerLevel) {
+	const unsignedHash = hasher.h64(`${content.displayname}\u0000${content.avatar_url}\u0000${powerLevel}`)
+	const signedHash = unsignedHash - 0x8000000000000000n // shifting down to signed 64-bit range
+	return signedHash
+}
+
+/**
+ * Sync profile data for a sim user. This function follows the following process:
+ * 1. Join the sim to the room if needed
+ * 2. Make an object of what the new room member state content would be, including uploading the profile picture if it hasn't been done before
+ * 3. Calculate the power level the user should get based on their Discord permissions
+ * 4. Compare against the previously known state content, which is helpfully stored in the database
+ * 5. If the state content or power level have changed, send them to Matrix and update them in the database for next time
+ * @param {DiscordTypes.APIUser} user
+ * @param {Omit<DiscordTypes.APIGuildMember, "user"> | undefined} member
+ * @param {DiscordTypes.APIGuildChannel} channel
+ * @param {DiscordTypes.APIGuild} guild
+ * @param {string} roomID
+ * @returns {Promise<string>} mxid of the updated sim
+ */
+async function syncUser(user, member, channel, guild, roomID) {
+	const mxid = await ensureSimJoined(user, roomID)
+	const content = await memberToStateContent(user, member, guild.id)
+	const powerLevel = memberToPowerLevel(user, member, guild, channel)
+	await _sendSyncUser(roomID, mxid, content, powerLevel, {
+		// do not overwrite pre-existing data if we already have data and `member` is not accessible, because this would replace good data with bad data
+		allowOverwrite: !!member,
+		globalProfile: await userToGlobalProfile(user)
+	})
+	return mxid
+}
+
+/**
+ * @param {string} roomID
+ * @param {string} mxid
+ * @param {{displayname: string, avatar_url?: string}} content
+ * @param {number | null} powerLevel
+ * @param {{allowOverwrite?: boolean, globalProfile?: {displayname: string, avatar_url?: string}}} [options]
+ */
+async function _sendSyncUser(roomID, mxid, content, powerLevel, options) {
+	const currentHash = _hashProfileContent(content, powerLevel ?? 0)
+	const existingHash = select("sim_member", "hashed_profile_content", {room_id: roomID, mxid}).safeIntegers().pluck().get()
+	// only do the actual sync if the hash has changed since we last looked
+	const hashHasChanged = existingHash !== currentHash
+	// always okay to add new data. for overwriting, restrict based on options.allowOverwrite, if present
+	const overwriteOkay = !existingHash || (options?.allowOverwrite ?? true)
+	if (hashHasChanged && overwriteOkay) {
+		const actions = []
+		// Update room member state
+		actions.push(api.sendState(roomID, "m.room.member", mxid, content, mxid))
+		// Update power levels
+		if (powerLevel != null) {
+			actions.push(mxUtils.setUserPower(roomID, mxid, powerLevel, api))
+		}
+		// Update global profile (if supported by server)
+		if (await supportsMsc4069) {
+			actions.push(api.profileSetDisplayname(mxid, options?.globalProfile?.displayname || content.displayname, true))
+			actions.push(api.profileSetAvatarUrl(mxid, options?.globalProfile?.avatar_url || content.avatar_url, true))
+		}
+		await Promise.all(actions)
+		// Update cached hash
+		db.prepare("UPDATE sim_member SET hashed_profile_content = ? WHERE room_id = ? AND mxid = ?").run(currentHash, roomID, mxid)
+	}
+}
+
+/**
+ * @param {string} roomID
+ */
+async function syncAllUsersInRoom(roomID) {
+	const users = from("sim_member").join("sim", "mxid")
+		.where({room_id: roomID}).and("and user_id not like '%-%' and user_id not like '%\\_%' escape '\\'").pluck("user_id").all()
+
+	const channelID = select("channel_room", "channel_id", {room_id: roomID}).pluck().get()
+	assert.ok(typeof channelID === "string")
+
+	/** @ts-ignore @type {DiscordTypes.APIGuildChannel} */
+	const channel = discord.channels.get(channelID)
+	const guildID = channel.guild_id
+	assert.ok(typeof guildID === "string")
+	/** @ts-ignore @type {DiscordTypes.APIGuild} */
+	const guild = discord.guilds.get(guildID)
+
+	for (const userID of users) {
+		/** @ts-ignore @type {Required<DiscordTypes.APIGuildMember>} */
+		const member = await discord.snow.guild.getGuildMember(guildID, userID)
+		/** @ts-ignore @type {Required<DiscordTypes.APIUser>} user */
+		const user = member.user
+		assert.ok(user)
+
+		console.log(`[user sync] to matrix: ${user.username} in ${channel.name}`)
+		await syncUser(user, member, channel, guild, roomID)
+	}
+}
+
+module.exports._memberToStateContent = memberToStateContent
+module.exports._hashProfileContent = _hashProfileContent
+module.exports.ensureSim = ensureSim
+module.exports.ensureSimJoined = ensureSimJoined
+module.exports.syncUser = syncUser
+module.exports._sendSyncUser = _sendSyncUser
+module.exports.syncAllUsersInRoom = syncAllUsersInRoom
+module.exports._memberToPowerLevel = memberToPowerLevel
+module.exports.supportsMsc4069 = supportsMsc4069

src/d2m/actions/register-user.test.js

@@ -0,0 +1,126 @@
+const {_memberToStateContent, _memberToPowerLevel} = require("./register-user")
+const {test} = require("supertape")
+const data = require("../../../test/data")
+const mixin = require("@cloudrac3r/mixin-deep")
+const DiscordTypes = require("discord-api-types/v10")
+
+test("member2state: without member nick or avatar", async t => {
+	t.deepEqual(
+		await _memberToStateContent(data.member.kumaccino.user, data.member.kumaccino, data.guild.general.id),
+		{
+			avatar_url: "mxc://cadence.moe/UpAeIqeclhKfeiZNdIWNcXXL",
+			displayname: "kumaccino",
+			membership: "join",
+			"moe.cadence.ooye.member": {
+				avatar: "/avatars/113340068197859328/b48302623a12bc7c59a71328f72ccb39.png?size=1024"
+			},
+			"uk.half-shot.discord.member": {
+				bot: false,
+				displayColor: 10206929,
+				id: "113340068197859328",
+				username: "@kumaccino"
+			}
+		}
+	)
+})
+
+test("member2state: with global name, without member nick or avatar", async t => {
+	t.deepEqual(
+		await _memberToStateContent(data.member.papiophidian.user, data.member.papiophidian, data.guild.general.id),
+		{
+			avatar_url: "mxc://cadence.moe/JPzSmALLirnIprlSMKohSSoX",
+			displayname: "PapiOphidian",
+			membership: "join",
+			"moe.cadence.ooye.member": {
+				avatar: "/avatars/320067006521147393/5fc4ad85c1ea876709e9a7d3374a78a1.png?size=1024"
+			},
+			"uk.half-shot.discord.member": {
+				bot: false,
+				displayColor: 1579292,
+				id: "320067006521147393",
+				username: "@papiophidian"
+			}
+		}
+	)
+})
+
+test("member2state: with member nick and avatar", async t => {
+	t.deepEqual(
+		await _memberToStateContent(data.member.sheep.user, data.member.sheep, data.guild.general.id),
+		{
+			avatar_url: "mxc://cadence.moe/rfemHmAtcprjLEiPiEuzPhpl",
+			displayname: "The Expert's Submarine",
+			membership: "join",
+			"moe.cadence.ooye.member": {
+				avatar: "/guilds/112760669178241024/users/134826546694193153/avatars/38dd359aa12bcd52dd3164126c587f8c.png?size=1024"
+			},
+			"uk.half-shot.discord.member": {
+				bot: false,
+				displayColor: null,
+				id: "134826546694193153",
+				username: "@aprilsong"
+			}
+		}
+	)
+})
+
+test("member2power: default to zero if member roles unknown", async t => {
+	const power = _memberToPowerLevel(data.user.clyde_ai, null, data.guild.data_horde, data.channel.saving_the_world)
+	t.equal(power, 0)
+})
+
+test("member2power: unremarkable = 0", async t => {
+	const power = _memberToPowerLevel(data.user.clyde_ai, {
+		roles: []
+	}, data.guild.data_horde, data.channel.general)
+	t.equal(power, 0)
+})
+
+test("member2power: can mention everyone = 20", async t => {
+	const power = _memberToPowerLevel(data.user.clyde_ai, {
+		roles: ["684524730274807911"]
+	}, data.guild.data_horde, data.channel.general)
+	t.equal(power, 20)
+})
+
+test("member2power: can send messages in protected channel due to role = 50", async t => {
+	const power = _memberToPowerLevel(data.user.clyde_ai, {
+		roles: ["684524730274807911"]
+	}, data.guild.data_horde, data.channel.saving_the_world)
+	t.equal(power, 50)
+})
+
+test("member2power: can send messages in protected channel due to user override = 50", async t => {
+	const power = _memberToPowerLevel(data.user.clyde_ai, {
+		roles: []
+	}, data.guild.data_horde, mixin({}, data.channel.saving_the_world, {
+		permission_overwrites: data.channel.saving_the_world.permission_overwrites.concat({
+			type: DiscordTypes.OverwriteType.member,
+			id: data.user.clyde_ai.id,
+			allow: String(DiscordTypes.PermissionFlagsBits.SendMessages),
+			deny: "0"
+		})
+	}))
+	t.equal(power, 50)
+})
+
+test("member2power: can kick users = 50", async t => {
+	const power = _memberToPowerLevel(data.user.clyde_ai, {
+		roles: ["682789592390281245"]
+	}, data.guild.data_horde, data.channel.general)
+	t.equal(power, 50)
+})
+
+test("member2power: can manage channels = 100", async t => {
+	const power = _memberToPowerLevel(data.user.clyde_ai, {
+		roles: ["665290147377578005"]
+	}, data.guild.data_horde, data.channel.saving_the_world)
+	t.equal(power, 100)
+})
+
+test("member2power: pathfinder use case", async t => {
+	const power = _memberToPowerLevel(data.user.jerassicore, {
+		roles: ["1235396773510647810", "1359752622130593802", "1249165855632265267", "1380768596929806356", "1380756348190462015"]
+	}, data.guild.pathfinder, data.channel.character_art)
+	t.equal(power, 50)
+})

src/d2m/actions/register-webhook-user.js

@@ -0,0 +1,131 @@
+// @ts-check
+
+const assert = require("assert")
+const {reg} = require("../../matrix/read-registration")
+const Ty = require("../../types")
+
+const passthrough = require("../../passthrough")
+const {sync, db, select, from} = passthrough
+/** @type {import("../../matrix/api")} */
+const api = sync.require("../../matrix/api")
+/** @type {import("../../matrix/file")} */
+const file = sync.require("../../matrix/file")
+/** @type {import("./register-user")} */
+const registerUser = sync.require("./register-user")
+/** @type {import("../converters/user-to-mxid")} */
+const userToMxid = sync.require("../converters/user-to-mxid")
+
+/**
+ * A sim is an account that is being simulated by the bridge to copy events from the other side.
+ * @param {string} fakeUserID
+ * @param {Ty.WebhookAuthor} author
+ * @returns mxid
+ */
+async function createSim(fakeUserID, author) {
+	// Choose sim name
+	const simName = userToMxid.webhookAuthorToSimName(author)
+	const localpart = reg.ooye.namespace_prefix + simName
+	const mxid = `@${localpart}:${reg.ooye.server_name}`
+
+	// Save chosen name in the database forever
+	db.prepare("INSERT INTO sim (user_id, username, sim_name, mxid) VALUES (?, ?, ?, ?)").run(fakeUserID, author.username, simName, mxid)
+
+	// Register matrix user with that name
+	try {
+		await api.register(localpart)
+	} catch (e) {
+		// If user creation fails, manually undo the database change. Still isn't perfect, but should help.
+		// (I would prefer a transaction, but it's not safe to leave transactions open across event loop ticks.)
+		db.prepare("DELETE FROM sim WHERE user_id = ?").run(fakeUserID)
+		throw e
+	}
+	return mxid
+}
+
+/**
+ * Ensure a sim is registered for the user.
+ * If there is already a sim, use that one. If there isn't one yet, register a new sim.
+ * @param {string} fakeUserID
+ * @param {Ty.WebhookAuthor} author
+ * @returns {Promise<string>} mxid
+ */
+async function ensureSim(fakeUserID, author) {
+	let mxid = null
+	const existing = select("sim", "mxid", {user_id: fakeUserID}).pluck().get()
+	if (existing) {
+		mxid = existing
+	} else {
+		mxid = await createSim(fakeUserID, author)
+	}
+	return mxid
+}
+
+/**
+ * Ensure a sim is registered for the user and is joined to the room.
+ * @param {string} fakeUserID
+ * @param {Ty.WebhookAuthor} author
+ * @param {string} roomID
+ * @returns {Promise<string>} mxid
+ */
+async function ensureSimJoined(fakeUserID, author, roomID) {
+	// Ensure room ID is really an ID, not an alias
+	assert.ok(roomID[0] === "!")
+
+	// Ensure user
+	const mxid = await ensureSim(fakeUserID, author)
+
+	// Ensure joined
+	const existing = select("sim_member", "mxid", {room_id: roomID, mxid}).pluck().get()
+	if (!existing) {
+		await api.inviteToRoom(roomID, mxid)
+		await api.joinRoom(roomID, mxid)
+		db.prepare("INSERT OR IGNORE INTO sim_member (room_id, mxid) VALUES (?, ?)").run(roomID, mxid)
+	}
+	return mxid
+}
+
+/**
+ * Generate profile data based on webhook displayname and configured avatar.
+ * @param {Ty.WebhookAuthor} author
+ */
+async function authorToStateContent(author) {
+	// We prefer to use the member's avatar URL data since the image upload can be cached across channels,
+	// unlike the userAvatar URL which is unique per channel, due to the webhook ID being in the URL.
+	const avatar = file.userAvatar(author)
+
+	const content = {
+		displayname: author.username,
+		membership: "join",
+	}
+	if (avatar) content.avatar_url = await file.uploadDiscordFileToMxc(avatar)
+
+	return content
+}
+
+/**
+ * Sync profile data for a sim webhook user. This function follows the following process:
+ * 1. Create and join the sim to the room if needed
+ * 2. Make an object of what the new room member state content would be, including uploading the profile picture if it hasn't been done before
+ * 3. Compare against the previously known state content, which is helpfully stored in the database
+ * 4. If the state content has changed, send it to Matrix and update it in the database for next time
+ * @param {Ty.WebhookAuthor} author for profile data
+ * @param {string} roomID room to join member to
+ * @param {boolean} shouldActuallySync whether to actually sync updated user data or just ensure it's joined
+ * @returns {Promise<string>} mxid of the updated sim
+ */
+async function syncUser(author, roomID, shouldActuallySync) {
+	const fakeUserID = userToMxid.webhookAuthorToFakeUserID(author)
+
+	// Create and join the sim to the room if needed
+	const mxid = await ensureSimJoined(fakeUserID, author, roomID)
+
+	if (shouldActuallySync) {
+		// Build current profile data and sync if the hash has changed
+		const content = await authorToStateContent(author)
+		await registerUser._sendSyncUser(roomID, mxid, content, null)
+	}
+
+	return mxid
+}
+
+module.exports.syncUser = syncUser

src/d2m/actions/remove-reaction.js

@@ -4,7 +4,7 @@ const Ty = require("../../types")
 const DiscordTypes = require("discord-api-types/v10")
 
 const passthrough = require("../../passthrough")
-const {discord, sync, db, select} = passthrough
+const {discord, sync, db, from, select} = passthrough
 /** @type {import("../../matrix/api")} */
 const api = sync.require("../../matrix/api")
 /** @type {import("../converters/emoji-to-key")} */
@@ -18,21 +18,15 @@ const converter = sync.require("../converters/remove-reaction")
  * @param {DiscordTypes.GatewayMessageReactionRemoveDispatchData | DiscordTypes.GatewayMessageReactionRemoveEmojiDispatchData | DiscordTypes.GatewayMessageReactionRemoveAllDispatchData} data
  */
 async function removeSomeReactions(data) {
-	const roomID = select("channel_room", "room_id", {channel_id: data.channel_id}).pluck().get()
+	const row = select("channel_room", "room_id", {channel_id: data.channel_id}).get()
-	if (!roomID) return
+	if (!row) return
-	const eventIDForMessage = select("event_message", "event_id", {message_id: data.message_id, reaction_part: 0}).pluck().get()
-	if (!eventIDForMessage) return
 
-	/** @type {Ty.Event.Outer<Ty.Event.M_Reaction>[]} */
+	const eventReactedTo = from("event_message").join("message_room", "message_id").join("historical_channel_room", "historical_room_index")
-	let reactions = []
+		.where({message_id: data.message_id}).and("ORDER BY reaction_part").select("event_id", "room_id").get()
-	/** @type {string | undefined} */
+	if (!eventReactedTo) return
-	let nextBatch = undefined
+
-	do {
+	// Due to server restrictions, all relations (i.e. reactions) have to be in the same room as the original event.
-		/** @type {Ty.Pagination<Ty.Event.Outer<Ty.Event.M_Reaction>>} */
+	const reactions = await api.getFullRelations(eventReactedTo.room_id, eventReactedTo.event_id, "m.annotation")
-		const res = await api.getRelations(roomID, eventIDForMessage, {from: nextBatch}, "m.annotation")
-		reactions = reactions.concat(res.chunk)
-		nextBatch = res.next_batch
-	} while (nextBatch)
 
 	// Run the proper strategy and any strategy-specific database changes
 	const removals = await
@@ -42,7 +36,7 @@ async function removeSomeReactions(data) {
 
 	// Redact the events and delete individual stored events in the database
 	for (const removal of removals) {
-		await api.redactEvent(roomID, removal.eventID, removal.mxid)
+		await api.redactEvent(eventReactedTo.room_id, removal.eventID, removal.mxid)
 		if (removal.hash) db.prepare("DELETE FROM reaction WHERE hashed_event_id = ?").run(removal.hash)
 	}
 }
@@ -52,7 +46,7 @@ async function removeSomeReactions(data) {
  * @param {Ty.Event.Outer<Ty.Event.M_Reaction>[]} reactions
  */
 async function removeReaction(data, reactions) {
-	const key = await emojiToKey.emojiToKey(data.emoji)
+	const key = await emojiToKey.emojiToKey(data.emoji, data.message_id)
 	return converter.removeReaction(data, reactions, key)
 }
 
@@ -61,8 +55,8 @@ async function removeReaction(data, reactions) {
  * @param {Ty.Event.Outer<Ty.Event.M_Reaction>[]} reactions
  */
 async function removeEmojiReaction(data, reactions) {
-	const key = await emojiToKey.emojiToKey(data.emoji)
+	const key = await emojiToKey.emojiToKey(data.emoji, data.message_id)
-	const discordPreferredEncoding = emoji.encodeEmoji(key, undefined)
+	const discordPreferredEncoding = await emoji.encodeEmoji(key, undefined)
 	db.prepare("DELETE FROM reaction WHERE message_id = ? AND encoded_emoji = ?").run(data.message_id, discordPreferredEncoding)
 
 	return converter.removeEmojiReaction(data, reactions, key)

src/d2m/actions/retrigger.js

@@ -0,0 +1,92 @@
+// @ts-check
+
+const {EventEmitter} = require("events")
+const passthrough = require("../../passthrough")
+const {select} = passthrough
+
+const DEBUG_RETRIGGER = false
+
+function debugRetrigger(message) {
+	if (DEBUG_RETRIGGER) {
+		console.log(message)
+	}
+}
+
+const paused = new Set()
+const emitter = new EventEmitter()
+
+/**
+ * Due to Eventual Consistency(TM) an update/delete may arrive before the original message arrives
+ * (or before the it has finished being bridged to an event).
+ * In this case, wait until the original message has finished bridging, then retrigger the passed function.
+ * @template {(...args: any[]) => any} T
+ * @param {string} inputID
+ * @param {T} fn
+ * @param {Parameters<T>} rest
+ * @returns {boolean} false if the event was found and the function will be ignored, true if the event was not found and the function will be retriggered
+ */
+function eventNotFoundThenRetrigger(inputID, fn, ...rest) {
+	if (!paused.has(inputID)) {
+		if (inputID.match(/^[0-9]+$/)) {
+			const eventID = select("event_message", "event_id", {message_id: inputID}).pluck().get()
+			if (eventID) {
+				debugRetrigger(`[retrigger] OK mid <-> eid = ${inputID} <-> ${eventID}`)
+				return false // event was found so don't retrigger
+			}
+		} else if (inputID.match(/^\$/)) {
+			const messageID = select("event_message", "message_id", {event_id: inputID}).pluck().get()
+			if (messageID) {
+				debugRetrigger(`[retrigger] OK eid <-> mid = ${inputID} <-> ${messageID}`)
+				return false // message was found so don't retrigger
+			}
+		}
+	}
+
+	debugRetrigger(`[retrigger] WAIT id = ${inputID}`)
+	emitter.once(inputID, () => {
+		debugRetrigger(`[retrigger] TRIGGER id = ${inputID}`)
+		fn(...rest)
+	})
+	// if the event never arrives, don't trigger the callback, just clean up
+	setTimeout(() => {
+		if (emitter.listeners(inputID).length) {
+			debugRetrigger(`[retrigger] EXPIRE id = ${inputID}`)
+		}
+		emitter.removeAllListeners(inputID)
+	}, 60 * 1000) // 1 minute
+	return true // event was not found, then retrigger
+}
+
+/**
+ * Anything calling retrigger during the callback will be paused and retriggered after the callback resolves.
+ * @template T
+ * @param {string} messageID
+ * @param {Promise<T>} promise
+ * @returns {Promise<T>}
+ */
+async function pauseChanges(messageID, promise) {
+	try {
+		debugRetrigger(`[retrigger] PAUSE id = ${messageID}`)
+		paused.add(messageID)
+		return await promise
+	} finally {
+		debugRetrigger(`[retrigger] RESUME id = ${messageID}`)
+		paused.delete(messageID)
+		messageFinishedBridging(messageID)
+	}
+}
+
+/**
+ * Triggers any pending operations that were waiting on the corresponding event ID.
+ * @param {string} messageID
+ */
+function messageFinishedBridging(messageID) {
+	if (emitter.listeners(messageID).length) {
+		debugRetrigger(`[retrigger] EMIT id = ${messageID}`)
+	}
+	emitter.emit(messageID)
+}
+
+module.exports.eventNotFoundThenRetrigger = eventNotFoundThenRetrigger
+module.exports.messageFinishedBridging = messageFinishedBridging
+module.exports.pauseChanges = pauseChanges

src/d2m/actions/send-message.js

@@ -0,0 +1,143 @@
+// @ts-check
+
+const assert = require("assert").strict
+const DiscordTypes = require("discord-api-types/v10")
+
+const passthrough = require("../../passthrough")
+const { discord, sync, db, select, from} = passthrough
+/** @type {import("../converters/message-to-event")} */
+const messageToEvent = sync.require("../converters/message-to-event")
+/** @type {import("../../matrix/api")} */
+const api = sync.require("../../matrix/api")
+/** @type {import("./register-user")} */
+const registerUser = sync.require("./register-user")
+/** @type {import("./register-pk-user")} */
+const registerPkUser = sync.require("./register-pk-user")
+/** @type {import("./register-webhook-user")} */
+const registerWebhookUser = sync.require("./register-webhook-user")
+/** @type {import("../actions/create-room")} */
+const createRoom = sync.require("../actions/create-room")
+/** @type {import("../actions/poll-end")} */
+const pollEnd = sync.require("../actions/poll-end")
+/** @type {import("../../discord/utils")} */
+const dUtils = sync.require("../../discord/utils")
+/** @type {import("../../m2d/actions/channel-webhook")} */
+const channelWebhook = sync.require("../../m2d/actions/channel-webhook")
+
+/**
+ * @param {DiscordTypes.GatewayMessageCreateDispatchData} message
+ * @param {DiscordTypes.APIGuildChannel} channel
+ * @param {DiscordTypes.APIGuild} guild
+ * @param {{speedbump_id: string, speedbump_webhook_id: string} | null} row data about the webhook which is proxying messages in this channel
+ */
+async function sendMessage(message, channel, guild, row) {
+	const roomID = await createRoom.ensureRoom(message.channel_id)
+	const historicalRoomIndex = select("historical_channel_room", "historical_room_index", {room_id: roomID}).pluck().get()
+	assert(historicalRoomIndex)
+
+	let senderMxid = null
+	if (dUtils.isWebhookMessage(message)) {
+		const useWebhookProfile = select("guild_space", "webhook_profile", {guild_id: guild.id}).pluck().get() ?? 0
+		if (row && row.speedbump_webhook_id === message.webhook_id) {
+			// Handle the PluralKit public instance
+			if (row.speedbump_id === "466378653216014359") {
+				senderMxid = await registerPkUser.syncUser(message.id, message.author, roomID, true)
+			}
+		} else if (useWebhookProfile) {
+			senderMxid = await registerWebhookUser.syncUser(message.author, roomID, true)
+		}
+	} else {
+		// not a webhook
+		if (message.author.id === discord.application.id) {
+			// no need to sync the bot's own user
+		} else {
+			senderMxid = await registerUser.syncUser(message.author, message.member, channel, guild, roomID)
+		}
+	}
+
+	let sentResultsMessage
+	if (message.type === DiscordTypes.MessageType.PollResult) { // ensure all Discord-side votes were pushed to Matrix before a poll is closed
+		const detailedResultsMessage = await pollEnd.endPoll(message)
+		if (detailedResultsMessage) {
+			const threadParent = select("channel_room", "thread_parent", {channel_id: message.channel_id}).pluck().get()
+			const channelID = threadParent ? threadParent : message.channel_id
+			const threadID = threadParent ? message.channel_id : undefined
+			sentResultsMessage = await channelWebhook.sendMessageWithWebhook(channelID, detailedResultsMessage, threadID)
+		}
+	}
+
+	const events = await messageToEvent.messageToEvent(message, guild, {}, {api, snow: discord.snow})
+	const eventIDs = []
+	if (events.length) {
+		db.prepare("INSERT OR IGNORE INTO message_room (message_id, historical_room_index) VALUES (?, ?)").run(message.id, historicalRoomIndex)
+		const typingMxid = from("sim").join("sim_member", "mxid").where({user_id: message.author.id, room_id: roomID}).pluck("mxid").get()
+		if (typingMxid) api.sendTyping(roomID, false, typingMxid).catch(() => {})
+	}
+	for (const event of events) {
+		const part = event === events[0] ? 0 : 1
+		const reactionPart = event === events[events.length - 1] ? 0 : 1
+
+		const eventType = event.$type
+		if ("$sender" in event) senderMxid = event.$sender
+		/** @type {Pick<typeof event, Exclude<keyof event, "$type" | "$sender">> & { $type?: string, $sender?: string }} */
+		const eventWithoutType = {...event}
+		delete eventWithoutType.$type
+		delete eventWithoutType.$sender
+
+		const useTimestamp = message["backfill"] ? new Date(message.timestamp).getTime() : undefined
+		const eventID = await api.sendEvent(roomID, eventType, eventWithoutType, senderMxid, useTimestamp)
+		eventIDs.push(eventID)
+
+		try {
+			db.prepare("INSERT INTO event_message (event_id, event_type, event_subtype, message_id, part, reaction_part, source) VALUES (?, ?, ?, ?, ?, ?, 1)").run(eventID, eventType, event.msgtype || null, message.id, part, reactionPart) // source 1 = discord
+		} catch (e) {
+			// check if we got rugpulled
+			if (!select("message_room", "message_id", {message_id: message.id}).get()) {
+				for (const eventID of eventIDs) {
+					await api.redactEvent(roomID, eventID)
+				}
+				return []
+			}
+		}
+
+		// The primary event is part = 0 and has the most important and distinct information. It is used to provide reply previews, be pinned, and possibly future uses.
+		// The first event is chosen to be the primary part because it is usually the message text content and is more likely to be distinct.
+		// For example, "Reply to 'this meme made me think of you'" is more useful than "Replied to image".
+
+		// The last event gets reaction_part = 0. Reactions are managed there because reactions are supposed to appear at the bottom.
+
+
+		if (eventType === "org.matrix.msc3381.poll.start") {
+			db.transaction(() => {
+				db.prepare("INSERT INTO poll (message_id, max_selections, question_text, is_closed) VALUES (?, ?, ?, 0)").run(
+					message.id,
+					event["org.matrix.msc3381.poll.start"].max_selections,
+					event["org.matrix.msc3381.poll.start"].question["org.matrix.msc1767.text"]
+				)
+				for (const [index, option] of Object.entries(event["org.matrix.msc3381.poll.start"].answers)) {
+					db.prepare("INSERT INTO poll_option (message_id, matrix_option, discord_option, option_text, seq) VALUES (?, ?, ?, ?, ?)").run(
+						message.id,
+						option.id,
+						option.id,
+						option["org.matrix.msc1767.text"],
+						index
+					)
+				}
+			})()
+		}
+
+		// part/reaction_part consistency for polls
+		if (sentResultsMessage) {
+			db.transaction(() => {
+				db.prepare("INSERT OR IGNORE INTO message_room (message_id, historical_room_index) VALUES (?, ?)").run(sentResultsMessage.id, historicalRoomIndex)
+				db.prepare("UPDATE event_message SET reaction_part = 1 WHERE event_id = ?").run(eventID)
+				// part = 1, reaction_part = 0, source = 0 as the results are "from Matrix" and doing otherwise breaks things when that message gets updated by Discord (it just does that sometimes)
+				db.prepare("INSERT INTO event_message (event_id, event_type, event_subtype, message_id, part, reaction_part, source) VALUES (?, ?, ?, ?, ?, ?, 0)").run(eventID, eventType, event.msgtype || null, sentResultsMessage.id, 1, 0)
+			})()
+		}
+	}
+
+	return eventIDs
+}
+
+module.exports.sendMessage = sendMessage

src/d2m/actions/set-presence.js

@@ -0,0 +1,114 @@
+// @ts-check
+
+const passthrough = require("../../passthrough")
+const {sync, select} = passthrough
+/** @type {import("../../matrix/api")} */
+const api = sync.require("../../matrix/api")
+
+/*
+	We do this in two phases for optimisation reasons.
+	Discord sends us an event when the presence *changes.*
+	We need to keep the event data in memory because we need to *repeatedly* send it to Matrix using a long-lived loop.
+
+	There are two phases to get it from Discord to Matrix.
+	The first phase stores Discord presence data in memory.
+	The second phase loops over the memory and sends it on to Matrix.
+
+	Optimisations:
+	* Presence can be deactivated per-guild in OOYE settings. If the user doesn't share any presence-enabled-guilds with us, we don't need to do anything.
+	* Presence can be sent for users without sims. In this case, they will be discarded from memory when the next loop begins.
+	* Matrix ID is cached in memory on the Presence class. The alternative to this is querying it every time we receive a presence change event in a valid guild.
+	* Presence can be sent multiple times in a row for the same user for each guild we share. The loop timer prevents these "changes" from individually reaching the homeserver.
+*/
+
+// Synapse expires each user's presence after 30 seconds and makes them offline, so we have to loop every 28 seconds and update each user again.
+const presenceLoopInterval = 28e3
+
+// Cache the list of enabled guilds rather than accessing it like multiple times per second when any user changes presence
+const guildPresenceSetting = new class {
+	/** @private @type {Set<string>} */ guilds
+	constructor() {
+		this.update()
+	}
+	update() {
+		this.guilds = new Set(select("guild_space", "guild_id", {presence: 1}).pluck().all())
+	}
+	isEnabled(guildID) {
+		return this.guilds.has(guildID)
+	}
+}
+
+class Presence extends sync.reloadClassMethods(() => Presence) {
+	/** @type {string} */ userID
+	/** @type {{presence: "online" | "offline" | "unavailable", status_msg?: string}} */ data
+	/** @private @type {?string | undefined} */ mxid
+	/** @private @type {number} */ delay = Math.random()
+
+	constructor(userID) {
+		super()
+		this.userID = userID
+	}
+
+	/**
+	 * @param {string} status status field from Discord's PRESENCE_UPDATE event
+	 */
+	setData(status) {
+		const presence =
+			( status === "online" ? "online"
+			: status === "offline" ? "offline"
+			: "unavailable")
+		this.data = {presence}
+	}
+
+	sync(presences) {
+		const mxid = this.mxid ??= select("sim", "mxid", {user_id: this.userID}).pluck().get()
+		if (!mxid) return presences.delete(this.userID)
+		// I haven't tried, but I assume Synapse explodes if you try to update too many presences at the same time.
+		// This random delay will space them out over the whole 28 second cycle.
+		setTimeout(() => {
+			api.setPresence(this.data, mxid).catch(() => {})
+		}, this.delay * presenceLoopInterval).unref()
+	}
+}
+
+const presenceTracker = new class {
+	/** @private @type {Map<string, Presence>} userID -> Presence */ presences = sync.remember(() => new Map())
+
+	constructor() {
+		sync.addTemporaryInterval(() => this.syncPresences(), presenceLoopInterval)
+	}
+
+	/**
+	 * This function is called for each Discord presence packet.
+	 * @param {string} userID Discord user ID
+	 * @param {string} guildID Discord guild ID that this presence applies to (really, the same presence applies to every single guild, but is delivered separately by Discord for some reason)
+	 * @param {string} status status field from Discord's PRESENCE_UPDATE event
+	 */
+	incomingPresence(userID, guildID, status) {
+		// stop tracking offline presence objects - they will naturally expire and fall offline on the homeserver
+		if (status === "offline") return this.presences.delete(userID)
+		// check if we care about this guild
+		if (!guildPresenceSetting.isEnabled(guildID)) return
+		// start tracking presence for user (we'll check if they have a sim in the next sync loop)
+		this.getOrCreatePresence(userID).setData(status)
+	}
+
+	/** @private */
+	getOrCreatePresence(userID) {
+		return this.presences.get(userID) || (() => {
+			const presence = new Presence(userID)
+			this.presences.set(userID, presence)
+			return presence
+		})()
+	}
+
+	/** @private */
+	syncPresences() {
+		for (const presence of this.presences.values()) {
+			presence.sync(this.presences)
+		}
+	}
+}
+
+module.exports.presenceTracker = presenceTracker
+module.exports.guildPresenceSetting = guildPresenceSetting

src/d2m/actions/speedbump.js

@@ -0,0 +1,93 @@
+// @ts-check
+
+const DiscordTypes = require("discord-api-types/v10")
+const passthrough = require("../../passthrough")
+const {discord, select, db} = passthrough
+
+const DEBUG_SPEEDBUMP = false
+
+function debugSpeedbump(message) {
+	if (DEBUG_SPEEDBUMP) {
+		console.log(message)
+	}
+}
+
+const SPEEDBUMP_SPEED = 4000 // 4 seconds delay
+const SPEEDBUMP_UPDATE_FREQUENCY = 2 * 60 * 60 // 2 hours
+
+/** @type {Set<any>} */
+const KNOWN_BOTS = new Set([
+	"466378653216014359" // PluralKit
+])
+
+/**
+ * Fetch new speedbump data for the channel and put it in the database as cache
+ * @param {string} channelID
+ * @param {number?} lastChecked
+ */
+async function updateCache(channelID, lastChecked) {
+	const now = Math.floor(Date.now() / 1000)
+	if (lastChecked && now - lastChecked < SPEEDBUMP_UPDATE_FREQUENCY) return
+	const webhooks = await discord.snow.webhook.getChannelWebhooks(channelID)
+	const found = webhooks.find(b => KNOWN_BOTS.has(b.application_id))
+	const foundApplication = found?.application_id
+	const foundWebhook = found?.id
+	db.prepare("UPDATE channel_room SET speedbump_id = ?, speedbump_webhook_id = ?, speedbump_checked = ? WHERE channel_id = ?").run(foundApplication, foundWebhook, now, channelID)
+}
+
+/** @type {Map<string, number>} messageID -> number of gateway events currently bumping */
+const bumping = new Map()
+
+/**
+ * Slow down a message. After it passes the speedbump, return whether it's okay or if it's been deleted.
+ * @param {string} messageID
+ * @returns whether it was deleted
+ */
+async function doSpeedbump(messageID) {
+	let value = (bumping.get(messageID) ?? 0) + 1
+	bumping.set(messageID, value)
+	debugSpeedbump(`[speedbump] WAIT ${messageID}++ = ${value}`)
+
+	await new Promise(resolve => setTimeout(resolve, SPEEDBUMP_SPEED))
+
+	if (!bumping.has(messageID)) {
+		debugSpeedbump(`[speedbump] DELETED ${messageID}`)
+		return true
+	}
+	value = (bumping.get(messageID) ?? 0) - 1
+	if (value <= 0) {
+		debugSpeedbump(`[speedbump] OK ${messageID}-- = ${value}`)
+		bumping.delete(messageID)
+		return false
+	} else {
+		debugSpeedbump(`[speedbump] MULTI ${messageID}-- = ${value}`)
+		bumping.set(messageID, value)
+		return true
+	}
+}
+
+/**
+ * Check whether to slow down a message, and do it. After it passes the speedbump, return whether it's okay or if it's been deleted.
+ * @param {string} channelID
+ * @param {string} messageID
+ * @returns whether it was deleted, and data about the channel's (not thread's) speedbump
+ */
+async function maybeDoSpeedbump(channelID, messageID) {
+	let row = select("channel_room", ["thread_parent", "speedbump_id", "speedbump_webhook_id"], {channel_id: channelID}).get()
+	if (row?.thread_parent) row = select("channel_room", ["thread_parent", "speedbump_id", "speedbump_webhook_id"], {channel_id: row.thread_parent}).get() // webhooks belong to the channel, not the thread
+	if (!row?.speedbump_webhook_id) return {affected: false, row: null} // not affected, no speedbump
+	const affected = await doSpeedbump(messageID)
+	return {affected, row} // maybe affected, and there is a speedbump
+}
+
+/**
+ * @param {string} messageID
+ */
+function onMessageDelete(messageID) {
+	bumping.delete(messageID)
+}
+
+module.exports.updateCache = updateCache
+module.exports.doSpeedbump = doSpeedbump
+module.exports.maybeDoSpeedbump = maybeDoSpeedbump
+module.exports.onMessageDelete = onMessageDelete

src/d2m/actions/update-pins.js

@@ -0,0 +1,47 @@
+// @ts-check
+
+const passthrough = require("../../passthrough")
+const {discord, sync, db} = passthrough
+/** @type {import("../converters/pins-to-list")} */
+const pinsToList = sync.require("../converters/pins-to-list")
+/** @type {import("../../matrix/api")} */
+const api = sync.require("../../matrix/api")
+/** @type {import("../../matrix/kstate")} */
+const ks = sync.require("../../matrix/kstate")
+
+/**
+ * @template {string | null | undefined} T
+ * @param {T} timestamp
+ * @returns {T extends string ? number : null}
+ */
+function convertTimestamp(timestamp) {
+	// @ts-ignore
+	return typeof timestamp === "string" ? Math.floor(new Date(timestamp).getTime() / 1000) : null
+}
+
+/**
+ * @param {string} channelID
+ * @param {string} roomID
+ * @param {number?} convertedTimestamp
+ */
+async function updatePins(channelID, roomID, convertedTimestamp) {
+	try {
+		var discordPins = await discord.snow.channel.getChannelPinnedMessages(channelID)
+	} catch (e) {
+		if (e.message === `{"message": "Missing Access", "code": 50001}`) {
+			return // Discord sends channel pins update events even for channels that the bot can't view/get pins in, just ignore it
+		}
+		throw e
+	}
+
+	const kstate = await ks.roomToKState(roomID, [["m.room.pinned_events", ""]])
+	const pinned = pinsToList.pinsToList(discordPins, kstate)
+
+	const diff = ks.diffKState(kstate, {"m.room.pinned_events/": {pinned}})
+	await ks.applyKStateDiffToRoom(roomID, diff)
+
+	db.prepare("UPDATE channel_room SET last_bridged_pin_timestamp = ? WHERE channel_id = ?").run(convertedTimestamp || 0, channelID)
+}
+
+module.exports.convertTimestamp = convertTimestamp
+module.exports.updatePins = updatePins