// @ts-check const assert = require("assert").strict const DiscordTypes = require("discord-api-types/v10") const deepEqual = require("deep-equal") 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("./create-room")} */ const createRoom = sync.require("./create-room") /** @type {import("../converters/expression")} */ const expression = sync.require("../converters/expression") /** @type {import("../../matrix/kstate")} */ const ks = sync.require("../../matrix/kstate") /** @type {Map>} guild ID -> Promise */ const inflightSpaceCreate = new Map() /** * @param {import("discord-api-types/v10").RESTGetAPIGuildResult} guild * @param {any} kstate */ async function createSpace(guild, kstate) { const name = kstate["m.room.name/"].name const topic = kstate["m.room.topic/"]?.topic || undefined assert(name) const roomID = await createRoom.postApplyPowerLevels(kstate, async kstate => { return 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], power_level_content_override: { events_default: 100, // space can only be managed by bridge invite: 0 // any existing member can invite others }, invite: reg.ooye.invite, topic, creation_content: { type: "m.space" }, initial_state: ks.kstateToState(kstate) }) }) db.prepare("INSERT INTO guild_space (guild_id, space_id) VALUES (?, ?)").run(guild.id, roomID) return roomID } /** * @param {DiscordTypes.APIGuild} guild * @param {number} privacyLevel */ async function guildToKState(guild, privacyLevel) { const avatarEventContent = {} 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 } const guildKState = { "m.room.name/": {name: guild.name}, "m.room.avatar/": avatarEventContent, "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), {})} } return guildKState } /** * @param {DiscordTypes.APIGuild} guild * @param {boolean} shouldActuallySync false if just need to ensure nspace exists (which is a quick database check), * true if also want to efficiently sync space name, space avatar, and child room avatars * @returns {Promise} room ID */ async function _syncSpace(guild, shouldActuallySync) { assert.ok(guild) if (inflightSpaceCreate.has(guild.id)) { await inflightSpaceCreate.get(guild.id) // just waiting, and then doing a new db query afterwards, is the simplest way of doing it } const row = select("guild_space", ["space_id", "privacy_level"], {guild_id: guild.id}).get() if (!row) { 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) inflightSpaceCreate.delete(guild.id) return spaceID })() inflightSpaceCreate.set(guild.id, creation) return creation // Naturally, the newly created space is already up to date, so we can always skip syncing here. } const {space_id: spaceID, privacy_level} = row if (!shouldActuallySync) { return spaceID // only need to ensure space exists, and it does. return the space ID } 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 // sync guild state to space const spaceKState = await createRoom.roomToKState(spaceID) const spaceDiff = ks.diffKState(spaceKState, guildKState) await createRoom.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 const newAvatarState = spaceDiff["m.room.avatar/"] if (guild.icon && newAvatarState?.url) { // 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}) => { return type === "m.space.child" && "via" in content && !roomsWithCustomAvatars.includes(state_key) }).map(({state_key}) => state_key) 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) } } } return spaceID } /** * Ensures the space exists. If it doesn't, creates the space with an accurate initial state. * @param {DiscordTypes.APIGuild} guild */ function ensureSpace(guild) { return _syncSpace(guild, false) } /** * Actually syncs. Efficiently updates the space name, space avatar, and child room avatars. * @param {DiscordTypes.APIGuild} guild */ function syncSpace(guild) { return _syncSpace(guild, true) } /** * Inefficiently force the space and its existing child rooms to be fully updated. * Prefer not to call this as part of the bridge's normal operation. */ async function syncSpaceFully(guildID) { /** @ts-ignore @type {DiscordTypes.APIGuild} */ const guild = discord.guilds.get(guildID) assert.ok(guild) const row = select("guild_space", ["space_id", "privacy_level"], {guild_id: guildID}).get() if (!row) { const guildKState = await guildToKState(guild, createRoom.DEFAULT_PRIVACY_LEVEL) const spaceID = await createSpace(guild, guildKState) return spaceID // Naturally, the newly created space is already up to date, so we can always skip syncing here. } const {space_id: spaceID, privacy_level} = row console.log(`[space sync] to matrix: ${guild.name}`) const guildKState = await guildToKState(guild, privacy_level) // sync guild state to space const spaceKState = await createRoom.roomToKState(spaceID) const spaceDiff = ks.diffKState(spaceKState, guildKState) await createRoom.applyKStateDiffToRoom(spaceID, spaceDiff) const childRooms = ks.kstateToState(spaceKState).filter(({type, content}) => { return type === "m.space.child" && "via" in content }).map(({state_key}) => state_key) for (const roomID of childRooms) { const channelID = select("channel_room", "channel_id", {room_id: roomID}).pluck().get() if (!channelID) continue if (discord.channels.has(channelID)) { await createRoom.syncRoom(channelID) } else { await createRoom.unbridgeDeletedChannel(channelID, guildID) } } return spaceID } /** * @param {import("discord-api-types/v10").GatewayGuildEmojisUpdateDispatchData | import("discord-api-types/v10").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, 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 /** * @typedef {import("discord-api-types/v10").GatewayGuildEmojisUpdateDispatchData & import("discord-api-types/v10").GatewayGuildStickersUpdateDispatchData} Expressions * @param {string} spaceID * @param {Expressions extends any ? keyof Expressions : never} key * @param {string} eventKey * @param {(emojis: any[]) => any} fn */ async function update(spaceID, key, eventKey, fn) { if (!(key in data) || !data[key].length) return const content = await fn(data[key]) if (checkBeforeSync) { const existing = await api.getStateEvent(spaceID, "im.ponies.room_emotes", eventKey) if (deepEqual(existing, content, {strict: true})) return } api.sendState(spaceID, "im.ponies.room_emotes", eventKey, content) } update(spaceID, "emojis", "moe.cadence.ooye.pack.emojis", expression.emojisToState) update(spaceID, "stickers", "moe.cadence.ooye.pack.stickers", expression.stickersToState) } module.exports.createSpace = createSpace module.exports.ensureSpace = ensureSpace module.exports.syncSpace = syncSpace module.exports.syncSpaceFully = syncSpaceFully module.exports.guildToKState = guildToKState module.exports.syncSpaceExpressions = syncSpaceExpressions