149 lines
6.5 KiB
JavaScript
149 lines
6.5 KiB
JavaScript
// @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"], {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
|
|
|
|
// If events are being deleted, we might be deleting the part = 0. But we want to have a part = 0 at all times. In this case we choose an existing event to promote.
|
|
let promoteEvent = null, promoteNextEvent = false
|
|
if (eventsToRedact.some(e => e.part === 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))
|
|
promoteEvent = eventsToReplace[0].old.event_id
|
|
} else {
|
|
// Everything is being deleted. Whatever gets sent in their place will be the new part = 0.
|
|
promoteNextEvent = 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") {
|
|
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, promoteEvent, promoteNextEvent}
|
|
}
|
|
|
|
/**
|
|
* @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
|