Files
mautrix-discord/pkg/connector/handlediscord.go
Skip R d36528400d handlediscord: don't log upon "unknown" events
Due to how discordgo dispatches events, this would be extraneously
logged for every event received.
2026-02-11 19:36:30 -08:00

341 lines
10 KiB
Go

// mautrix-discord - A Matrix-Discord puppeting bridge.
// Copyright (C) 2026 Tulir Asokan
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
package connector
import (
"context"
"fmt"
"runtime/debug"
"slices"
"strconv"
"time"
"github.com/bwmarrin/discordgo"
"github.com/rs/zerolog"
"maunium.net/go/mautrix/bridgev2"
"maunium.net/go/mautrix/bridgev2/database"
"maunium.net/go/mautrix/bridgev2/networkid"
"maunium.net/go/mautrix/bridgev2/simplevent"
"maunium.net/go/mautrix/bridgev2/status"
"go.mau.fi/mautrix-discord/pkg/discordid"
)
type DiscordEventMeta struct {
Type bridgev2.RemoteEventType
PortalKey networkid.PortalKey
LogContext func(c zerolog.Context) zerolog.Context
}
func (em *DiscordEventMeta) AddLogContext(c zerolog.Context) zerolog.Context {
if em.LogContext == nil {
return c
}
c = em.LogContext(c)
return c
}
func (em *DiscordEventMeta) GetType() bridgev2.RemoteEventType {
return em.Type
}
func (em *DiscordEventMeta) GetPortalKey() networkid.PortalKey {
return em.PortalKey
}
type DiscordMessage struct {
*DiscordEventMeta
Data *discordgo.Message
Client *DiscordClient
}
func (m *DiscordMessage) ConvertEdit(ctx context.Context, portal *bridgev2.Portal, intent bridgev2.MatrixAPI, existing []*database.Message) (*bridgev2.ConvertedEdit, error) {
log := zerolog.Ctx(ctx).With().
Str("action", "convert discord edit").Logger()
ctx = log.WithContext(ctx)
// FIXME don't redundantly reupload attachments
convertedEdit := m.Client.connector.MsgConv.ToMatrix(
ctx,
portal,
intent,
m.Client.UserLogin,
m.Client.Session,
m.Data,
)
// TODO this is really gross and relies on how we assign incrementing numeric
// part ids. to return a semantically correct `ConvertedEdit` we should ditch
// this system
slices.SortStableFunc(existing, func(a *database.Message, b *database.Message) int {
ai, _ := strconv.Atoi(string(a.PartID))
bi, _ := strconv.Atoi(string(b.PartID))
return ai - bi
})
if len(convertedEdit.Parts) != len(existing) {
// FIXME support # of parts changing; triggerable by removing individual
// attachments, etc.
//
// at the very least we can make this better by handling attachments,
// which are always(?) at the end
log.Warn().Int("n_parts_existing", len(existing)).Int("n_parts_after_edit", len(convertedEdit.Parts)).
Msg("Ignoring message edit that changed number of parts")
return nil, bridgev2.ErrIgnoringRemoteEvent
}
parts := make([]*bridgev2.ConvertedEditPart, 0, len(existing))
for pi, part := range convertedEdit.Parts {
parts = append(parts, part.ToEditPart(existing[pi]))
}
return &bridgev2.ConvertedEdit{
ModifiedParts: parts,
}, nil
}
var (
_ bridgev2.RemoteMessage = (*DiscordMessage)(nil)
_ bridgev2.RemoteMessageWithTransactionID = (*DiscordMessage)(nil)
_ bridgev2.RemoteEdit = (*DiscordMessage)(nil)
_ bridgev2.RemoteMessageRemove = (*DiscordMessage)(nil)
)
func (m *DiscordMessage) GetTargetMessage() networkid.MessageID {
return discordid.MakeMessageID(m.Data.ID)
}
func (m *DiscordMessage) GetTransactionID() networkid.TransactionID {
if m.Data.Nonce == "" {
return ""
}
return networkid.TransactionID(m.Data.Nonce)
}
func (m *DiscordMessage) ConvertMessage(ctx context.Context, portal *bridgev2.Portal, intent bridgev2.MatrixAPI) (*bridgev2.ConvertedMessage, error) {
return m.Client.connector.MsgConv.ToMatrix(ctx, portal, intent, m.Client.UserLogin, m.Client.Session, m.Data), nil
}
func (m *DiscordMessage) GetID() networkid.MessageID {
return discordid.MakeMessageID(m.Data.ID)
}
func (m *DiscordMessage) GetSender() bridgev2.EventSender {
if m.Data.Author == nil {
// Message deletions don't have a sender associated with them.
return bridgev2.EventSender{}
}
return m.Client.makeEventSender(m.Data.Author)
}
func (d *DiscordClient) wrapDiscordMessage(msg *discordgo.Message, typ bridgev2.RemoteEventType) DiscordMessage {
return DiscordMessage{
DiscordEventMeta: &DiscordEventMeta{
Type: typ,
PortalKey: networkid.PortalKey{
ID: discordid.MakePortalID(msg.ChannelID),
Receiver: d.UserLogin.ID,
},
},
Data: msg,
Client: d,
}
}
type DiscordReaction struct {
*DiscordEventMeta
Reaction *discordgo.MessageReaction
Client *DiscordClient
}
func (r *DiscordReaction) GetSender() bridgev2.EventSender {
return r.Client.makeEventSenderWithID(r.Reaction.UserID)
}
func (r *DiscordReaction) GetTargetMessage() networkid.MessageID {
return discordid.MakeMessageID(r.Reaction.MessageID)
}
func (r *DiscordReaction) GetRemovedEmojiID() networkid.EmojiID {
return discordid.MakeEmojiID(r.Reaction.Emoji.Name)
}
var (
_ bridgev2.RemoteReaction = (*DiscordReaction)(nil)
_ bridgev2.RemoteReactionRemove = (*DiscordReaction)(nil)
_ bridgev2.RemoteReactionWithExtraContent = (*DiscordReaction)(nil)
)
func (r *DiscordReaction) GetReactionEmoji() (string, networkid.EmojiID) {
// name is either a grapheme cluster consisting of a Unicode emoji, or the
// name of a custom emoji.
name := r.Reaction.Emoji.Name
return name, discordid.MakeEmojiID(name)
}
func (r *DiscordReaction) GetReactionExtraContent() map[string]any {
extra := make(map[string]any)
reaction := r.Reaction
emoji := reaction.Emoji
if emoji.ID != "" {
// The emoji is a custom emoji.
extra["fi.mau.discord.reaction"] = map[string]any{
"id": emoji.ID,
"name": emoji.Name,
// FIXME Handle custom emoji.
// "mxc": reaction,
}
wrappedShortcode := fmt.Sprintf(":%s:", reaction.Emoji.Name)
extra["com.beeper.reaction.shortcode"] = wrappedShortcode
}
return extra
}
func (d *DiscordClient) wrapDiscordReaction(reaction *discordgo.MessageReaction, beingAdded bool) DiscordReaction {
evtType := bridgev2.RemoteEventReaction
if !beingAdded {
evtType = bridgev2.RemoteEventReactionRemove
}
return DiscordReaction{
DiscordEventMeta: &DiscordEventMeta{
Type: evtType,
PortalKey: networkid.PortalKey{
ID: discordid.MakePortalID(reaction.ChannelID),
Receiver: d.UserLogin.ID,
},
},
Reaction: reaction,
Client: d,
}
}
func (d *DiscordClient) handleDiscordTyping(ctx context.Context, typing *discordgo.TypingStart) {
if typing.UserID == d.Session.State.User.ID {
return
}
log := zerolog.Ctx(ctx)
portalKey := networkid.PortalKey{
ID: discordid.MakePortalID(typing.ChannelID),
Receiver: d.UserLogin.ID,
}
portal, err := d.connector.Bridge.GetExistingPortalByKey(ctx, portalKey)
if err != nil {
log.Err(err).Msg("Failed to query for existing portal")
return
}
if portal == nil || portal.MXID == "" {
return
}
// Make sure we have this user's info in case we haven't seen them at all yet.
_ = d.userCache.Resolve(ctx, typing.UserID)
d.UserLogin.Bridge.QueueRemoteEvent(d.UserLogin, &simplevent.Typing{
EventMeta: simplevent.EventMeta{
Type: bridgev2.RemoteEventTyping,
PortalKey: portalKey,
Sender: d.makeEventSenderWithID(typing.UserID),
},
Timeout: 12 * time.Second,
Type: bridgev2.TypingTypeText,
})
}
func (d *DiscordClient) handleDiscordEvent(rawEvt any) {
defer func() {
err := recover()
if err != nil {
d.UserLogin.Log.Error().
Bytes(zerolog.ErrorStackFieldName, debug.Stack()).
Any(zerolog.ErrorFieldName, err).
Msg("Panic in Discord event handler")
}
}()
log := d.UserLogin.Log.With().Str("action", "handle discord event").
Type("event_type", rawEvt).
Logger()
ctx := log.WithContext(d.UserLogin.Bridge.BackgroundCtx)
// NOTE: discordgo seemingly dispatches both the proper unmarshalled type
// (e.g. `*discordgo.TypingStart`) _as well as_ a "raw" *discordgo.Event
// (e.g. `*discordgo.Event` with `Type` of `TYPING_START`) for every gateway
// event
switch evt := rawEvt.(type) {
case *discordgo.Ready:
log.Info().Msg("Received READY dispatch from discordgo")
d.userCache.UpdateWithReady(evt)
d.UserLogin.BridgeState.Send(status.BridgeState{
StateEvent: status.StateConnected,
})
case *discordgo.TypingStart:
d.handleDiscordTyping(ctx, evt)
case *discordgo.Resumed:
log.Info().Msg("Received RESUMED dispatch from discordgo")
d.UserLogin.BridgeState.Send(status.BridgeState{
StateEvent: status.StateConnected,
})
case *discordgo.MessageCreate:
if evt.Author == nil {
log.Trace().Int("message_type", int(evt.Message.Type)).
Str("guild_id", evt.GuildID).
Str("message_id", evt.ID).
Str("channel_id", evt.ChannelID).
Msg("Dropping message that lacks an author")
return
}
d.userCache.UpdateWithMessage(evt.Message)
wrappedEvt := d.wrapDiscordMessage(evt.Message, bridgev2.RemoteEventMessage)
d.UserLogin.Bridge.QueueRemoteEvent(d.UserLogin, &wrappedEvt)
case *discordgo.MessageUpdate:
wrappedEvt := d.wrapDiscordMessage(evt.Message, bridgev2.RemoteEventEdit)
d.UserLogin.Bridge.QueueRemoteEvent(d.UserLogin, &wrappedEvt)
case *discordgo.UserUpdate:
d.userCache.UpdateWithUserUpdate(evt)
case *discordgo.MessageDelete:
wrappedEvt := d.wrapDiscordMessage(evt.Message, bridgev2.RemoteEventMessageRemove)
d.UserLogin.Bridge.QueueRemoteEvent(d.UserLogin, &wrappedEvt)
// TODO *discordgo.MessageDeleteBulk
case *discordgo.MessageReactionAdd:
wrappedEvt := d.wrapDiscordReaction(evt.MessageReaction, true)
d.UserLogin.Bridge.QueueRemoteEvent(d.UserLogin, &wrappedEvt)
case *discordgo.MessageReactionRemove:
wrappedEvt := d.wrapDiscordReaction(evt.MessageReaction, false)
d.UserLogin.Bridge.QueueRemoteEvent(d.UserLogin, &wrappedEvt)
// TODO case *discordgo.MessageReactionRemoveAll:
// TODO case *discordgo.MessageReactionRemoveEmoji: (needs impl. in discordgo)
case *discordgo.PresenceUpdate:
return
case *discordgo.GuildDelete:
if evt.Unavailable {
log.Warn().Str("guild_id", evt.ID).Msg("Guild became unavailable")
// For now, leave the portals alone if the guild only went away due to an outage.
return
}
d.deleteGuildPortalSpace(ctx, evt.ID)
}
}