%s%s not found", html.EscapeString(identifier)), false, true)
return
}
- formattedName := formatResolveIdentifierResult(ce.Ctx, resp)
+ formattedName := formatResolveIdentifierResult(resp)
if createChat {
- if resp.Chat == nil {
- ce.Reply("Interface error: network connector did not return chat for create chat request")
- return
+ name := resp.Portal.Name
+ if name == "" {
+ name = resp.Portal.MXID.String()
}
- portal := resp.Chat.Portal
- if portal == nil {
- portal, err = ce.Bridge.GetPortalByKey(ce.Ctx, resp.Chat.PortalKey)
- if err != nil {
- ce.Log.Err(err).Msg("Failed to get portal")
- ce.Reply("Failed to get portal: %v", err)
- return
- }
- }
- if resp.Chat.PortalInfo == nil {
- resp.Chat.PortalInfo, err = api.GetChatInfo(ce.Ctx, portal)
- if err != nil {
- ce.Log.Err(err).Msg("Failed to get portal info")
- ce.Reply("Failed to get portal info: %v", err)
- return
- }
- }
- if portal.MXID != "" {
- name := portal.Name
- if name == "" {
- name = portal.MXID.String()
- }
- portal.UpdateInfo(ce.Ctx, resp.Chat.PortalInfo, login, nil, time.Time{})
- ce.Reply("You already have a direct chat with %s at [%s](%s)", formattedName, name, portal.MXID.URI().MatrixToURL())
+ if !resp.JustCreated {
+ ce.Reply("You already have a direct chat with %s at [%s](%s)", formattedName, name, resp.Portal.MXID.URI().MatrixToURL())
} else {
- err = portal.CreateMatrixRoom(ce.Ctx, login, resp.Chat.PortalInfo)
- if err != nil {
- ce.Log.Err(err).Msg("Failed to create room")
- ce.Reply("Failed to create room: %v", err)
- return
- }
- name := portal.Name
- if name == "" {
- name = portal.MXID.String()
- }
- ce.Reply("Created chat with %s: [%s](%s)", formattedName, name, portal.MXID.URI().MatrixToURL())
+ ce.Reply("Created chat with %s: [%s](%s)", formattedName, name, resp.Portal.MXID.URI().MatrixToURL())
}
} else {
ce.Reply("Found %s", formattedName)
}
}
+var CommandCreateGroup = &FullHandler{
+ Func: fnCreateGroup,
+ Name: "create-group",
+ Aliases: []string{"create"},
+ Help: HelpMeta{
+ Section: HelpSectionChats,
+ Description: "Create a new group chat for the current Matrix room",
+ Args: "[_group type_]",
+ },
+ RequiresLogin: true,
+ NetworkAPI: NetworkAPIImplements[bridgev2.GroupCreatingNetworkAPI],
+}
+
+func getState[T any](ctx context.Context, roomID id.RoomID, evtType event.Type, provider bridgev2.MatrixConnectorWithArbitraryRoomState) (content T) {
+ evt, err := provider.GetStateEvent(ctx, roomID, evtType, "")
+ if err != nil {
+ zerolog.Ctx(ctx).Err(err).Stringer("event_type", evtType).Msg("Failed to get state event for group creation")
+ } else if evt != nil {
+ content, _ = evt.Content.Parsed.(T)
+ }
+ return
+}
+
+func fnCreateGroup(ce *Event) {
+ ce.Bridge.Matrix.GetCapabilities()
+ login, api, remainingArgs := getClientForStartingChat[bridgev2.GroupCreatingNetworkAPI](ce, "creating group")
+ if api == nil {
+ return
+ }
+ stateProvider, ok := ce.Bridge.Matrix.(bridgev2.MatrixConnectorWithArbitraryRoomState)
+ if !ok {
+ ce.Reply("Matrix connector doesn't support fetching room state")
+ return
+ }
+ members, err := ce.Bridge.Matrix.GetMembers(ce.Ctx, ce.RoomID)
+ if err != nil {
+ ce.Log.Err(err).Msg("Failed to get room members for group creation")
+ ce.Reply("Failed to get room members: %v", err)
+ return
+ }
+ caps := ce.Bridge.Network.GetCapabilities()
+ params := &bridgev2.GroupCreateParams{
+ Username: "",
+ Participants: make([]networkid.UserID, 0, len(members)-2),
+ Parent: nil, // TODO check space parent event
+ Name: getState[*event.RoomNameEventContent](ce.Ctx, ce.RoomID, event.StateRoomName, stateProvider),
+ Avatar: getState[*event.RoomAvatarEventContent](ce.Ctx, ce.RoomID, event.StateRoomAvatar, stateProvider),
+ Topic: getState[*event.TopicEventContent](ce.Ctx, ce.RoomID, event.StateTopic, stateProvider),
+ Disappear: getState[*event.BeeperDisappearingTimer](ce.Ctx, ce.RoomID, event.StateBeeperDisappearingTimer, stateProvider),
+ RoomID: ce.RoomID,
+ }
+ for userID, member := range members {
+ if userID == ce.User.MXID || userID == ce.Bot.GetMXID() || !member.Membership.IsInviteOrJoin() {
+ continue
+ }
+ if parsedUserID, ok := ce.Bridge.Matrix.ParseGhostMXID(userID); ok {
+ params.Participants = append(params.Participants, parsedUserID)
+ } else if !ce.Bridge.Config.SplitPortals {
+ if user, err := ce.Bridge.GetExistingUserByMXID(ce.Ctx, userID); err != nil {
+ ce.Log.Err(err).Stringer("user_id", userID).Msg("Failed to get user for room member")
+ } else if user != nil {
+ // TODO add user logins to participants
+ //for _, login := range user.GetUserLogins() {
+ // params.Participants = append(params.Participants, login.GetUserID())
+ //}
+ }
+ }
+ }
+
+ if len(caps.Provisioning.GroupCreation) == 0 {
+ ce.Reply("No group creation types defined in network capabilities")
+ return
+ } else if len(remainingArgs) > 0 {
+ params.Type = remainingArgs[0]
+ } else if len(caps.Provisioning.GroupCreation) == 1 {
+ for params.Type = range caps.Provisioning.GroupCreation {
+ // The loop assigns the variable we want
+ }
+ } else {
+ types := strings.Join(slices.Collect(maps.Keys(caps.Provisioning.GroupCreation)), "`, `")
+ ce.Reply("Please specify type of group to create: `%s`", types)
+ return
+ }
+ resp, err := provisionutil.CreateGroup(ce.Ctx, login, params)
+ if err != nil {
+ ce.Reply("Failed to create group: %v", err)
+ return
+ }
+ var postfix string
+ if len(resp.FailedParticipants) > 0 {
+ failedParticipantsStrings := make([]string, len(resp.FailedParticipants))
+ i := 0
+ for participantID, meta := range resp.FailedParticipants {
+ failedParticipantsStrings[i] = fmt.Sprintf("* %s: %s", format.SafeMarkdownCode(participantID), meta.Reason)
+ i++
+ }
+ postfix += "\n\nFailed to add some participants:\n" + strings.Join(failedParticipantsStrings, "\n")
+ }
+ ce.Reply("Successfully created group `%s`%s", resp.ID, postfix)
+}
+
var CommandSearch = &FullHandler{
Func: fnSearch,
Name: "search",
@@ -154,6 +259,7 @@ var CommandSearch = &FullHandler{
Args: "<_query_>",
},
RequiresLogin: true,
+ NetworkAPI: NetworkAPIImplements[bridgev2.UserSearchingNetworkAPI],
}
func fnSearch(ce *Event) {
@@ -161,35 +267,67 @@ func fnSearch(ce *Event) {
ce.Reply("Usage: `$cmdprefix search " + textPart.Content.FormattedBody + mediaPart.Content.Mentions = mediaPart.Content.Mentions.Merge(textPart.Content.Mentions) + mediaPart.Content.BeeperLinkPreviews = append(mediaPart.Content.BeeperLinkPreviews, textPart.Content.BeeperLinkPreviews...) } else { mediaPart.Content.FileName = mediaPart.Content.Body mediaPart.Content.Body = textPart.Content.Body mediaPart.Content.Format = textPart.Content.Format mediaPart.Content.FormattedBody = textPart.Content.FormattedBody + mediaPart.Content.Mentions = textPart.Content.Mentions + mediaPart.Content.BeeperLinkPreviews = textPart.Content.BeeperLinkPreviews } if metaMerger, ok := mediaPart.DBMetadata.(database.MetaMerger); ok { metaMerger.CopyFrom(textPart.DBMetadata) @@ -227,9 +254,14 @@ type NetworkConnector interface { // This should generally not do any work, it should just return a LoginProcess that remembers // the user and will execute the requested flow. The actual work should start when [LoginProcess.Start] is called. CreateLogin(ctx context.Context, user *User, flowID string) (LoginProcess, error) + + // GetBridgeInfoVersion returns version numbers for bridge info and room capabilities respectively. + // When the versions change, the bridge will automatically resend bridge info to all rooms. + GetBridgeInfoVersion() (info, capabilities int) } type StoppableNetwork interface { + NetworkConnector // Stop is called when the bridge is stopping, after all network clients have been disconnected. Stop() } @@ -243,14 +275,22 @@ type StoppableNetwork interface { type DirectMediableNetwork interface { NetworkConnector SetUseDirectMedia() - Download(ctx context.Context, mediaID networkid.MediaID) (mediaproxy.GetMediaResponse, error) + Download(ctx context.Context, mediaID networkid.MediaID, params map[string]string) (mediaproxy.GetMediaResponse, error) } +// IdentifierValidatingNetwork is an optional interface that network connectors can implement to validate the shape of user IDs. +// +// This should not perform any checks to see if the user ID actually exists on the network, just that the user ID looks valid. type IdentifierValidatingNetwork interface { NetworkConnector ValidateUserID(id networkid.UserID) bool } +type TransactionIDGeneratingNetwork interface { + NetworkConnector + GenerateTransactionID(userID id.UserID, roomID id.RoomID, eventType event.Type) networkid.RawTransactionID +} + type PortalBridgeInfoFillingNetwork interface { NetworkConnector FillPortalBridgeInfo(portal *Portal, content *event.BridgeEventContent) @@ -278,6 +318,16 @@ type MaxFileSizeingNetwork interface { SetMaxFileSize(maxSize int64) } +type NetworkResettingNetwork interface { + NetworkConnector + // ResetHTTPTransport should recreate the HTTP client used by the bridge. + // It should refetch settings from the Matrix connector using GetHTTPClientSettings if applicable. + ResetHTTPTransport() + // ResetNetworkConnections should forcefully disconnect and restart any persistent network connections. + // ResetHTTPTransport will usually be called before this, so resetting the transport is not necessary here. + ResetNetworkConnections() +} + type RemoteEchoHandler func(RemoteMessage, *database.Message) (bool, error) type MatrixMessageResponse struct { @@ -294,9 +344,12 @@ type MatrixMessageResponse struct { PostSave func(context.Context, *database.Message) } -type FileRestriction struct { - MaxSize int64 - MimeTypes []string +type OutgoingTimeoutConfig struct { + CheckInterval time.Duration + NoEchoTimeout time.Duration + NoEchoMessage string + NoAckTimeout time.Duration + NoAckMessage string } type NetworkGeneralCapabilities struct { @@ -306,35 +359,16 @@ type NetworkGeneralCapabilities struct { // Should the bridge re-request user info on incoming messages even if the ghost already has info? // By default, info is only requested for ghosts with no name, and other updating is left to events. AggressiveUpdateInfo bool -} - -type NetworkRoomCapabilities struct { - FormattedText bool - UserMentions bool - RoomMentions bool - - LocationMessages bool - Captions bool - MaxTextLength int - MaxCaptionLength int - Polls bool - - Threads bool - Replies bool - Edits bool - EditMaxCount int - EditMaxAge time.Duration - Deletes bool - DeleteMaxAge time.Duration - - DefaultFileRestriction *FileRestriction - Files map[event.MessageType]FileRestriction - - ReadReceipts bool - - Reactions bool - ReactionCount int - AllowedReactions []string + // Should the bridge call HandleMatrixReadReceipt with fake data when receiving a new message? + // This should be enabled if the network requires each message to be marked as read independently, + // and doesn't automatically do it when sending a message. + ImplicitReadReceipts bool + // If the bridge uses the pending message mechanism ([MatrixMessage.AddPendingToSave]) + // to handle asynchronous message responses, this field can be set to enable + // automatic timeout errors in case the asynchronous response never arrives. + OutgoingMessageTimeouts *OutgoingTimeoutConfig + // Capabilities related to the provisioning API. + Provisioning ProvisioningCapabilities } // NetworkAPI is an interface representing a remote network client for a single user login. @@ -344,7 +378,9 @@ type NetworkRoomCapabilities struct { type NetworkAPI interface { // Connect is called to actually connect to the remote network. // If there's no persistent connection, this may just check access token validity, or even do nothing at all. - Connect(ctx context.Context) error + // This method isn't allowed to return errors, because any connection errors should be sent + // using the bridge state mechanism (UserLogin.BridgeState.Send) + Connect(ctx context.Context) // Disconnect should disconnect from the remote network. // A clean disconnection is preferred, but it should not take too long. Disconnect() @@ -367,7 +403,7 @@ type NetworkAPI interface { // GetCapabilities returns the bridging capabilities in a given room. // This can simply return a static list if the remote network has no per-chat capability differences, // but all calls will include the portal, because some networks do have per-chat differences. - GetCapabilities(ctx context.Context, portal *Portal) *NetworkRoomCapabilities + GetCapabilities(ctx context.Context, portal *Portal) *event.RoomFeatures // HandleMatrixMessage is called when a message is sent from Matrix in an existing portal room. // This function should convert the message as appropriate, send it over to the remote network, @@ -377,6 +413,30 @@ type NetworkAPI interface { HandleMatrixMessage(ctx context.Context, msg *MatrixMessage) (message *MatrixMessageResponse, err error) } +type ConnectBackgroundParams struct { + // RawData is the raw data in the push that triggered the background connection. + RawData json.RawMessage + // ExtraData is the data returned by [PushParsingNetwork.ParsePushNotification]. + // It's only present for native pushes. Relayed pushes will only have the raw data. + ExtraData any +} + +// BackgroundSyncingNetworkAPI is an optional interface that network connectors can implement to support background resyncs. +type BackgroundSyncingNetworkAPI interface { + NetworkAPI + // ConnectBackground is called in place of Connect for background resyncs. + // The client should connect to the remote network, handle pending messages, and then disconnect. + // This call should block until the entire sync is complete and the client is disconnected. + ConnectBackground(ctx context.Context, params *ConnectBackgroundParams) error +} + +// CredentialExportingNetworkAPI is an optional interface that networks connectors can implement to support export of +// the credentials associated with that login. Credential type is bridge specific. +type CredentialExportingNetworkAPI interface { + NetworkAPI + ExportCredentials(ctx context.Context) any +} + // FetchMessagesParams contains the parameters for a message history pagination request. type FetchMessagesParams struct { // The portal to fetch messages in. Always present. @@ -513,11 +573,18 @@ type FetchMessagesResponse struct { // BackfillingNetworkAPI is an optional interface that network connectors can implement to support backfilling message history. type BackfillingNetworkAPI interface { NetworkAPI + // FetchMessages returns a batch of messages to backfill in a portal room. + // For details on the input and output, see the documentation of [FetchMessagesParams] and [FetchMessagesResponse]. FetchMessages(ctx context.Context, fetchParams FetchMessagesParams) (*FetchMessagesResponse, error) } +// BackfillingNetworkAPIWithLimits is an optional interface that network connectors can implement to customize +// the limit for backwards backfilling tasks. It is recommended to implement this by reading the MaxBatchesOverride +// config field with network-specific keys for different room types. type BackfillingNetworkAPIWithLimits interface { BackfillingNetworkAPI + // GetBackfillMaxBatchCount is called before a backfill task is executed to determine the maximum number of batches + // that should be backfilled. Return values less than 0 are treated as unlimited. GetBackfillMaxBatchCount(ctx context.Context, portal *Portal, task *database.BackfillTask) int } @@ -571,6 +638,16 @@ type ReadReceiptHandlingNetworkAPI interface { HandleMatrixReadReceipt(ctx context.Context, msg *MatrixReadReceipt) error } +// ChatViewingNetworkAPI is an optional interface that network connectors can implement to handle viewing chat status. +type ChatViewingNetworkAPI interface { + NetworkAPI + // HandleMatrixViewingChat is called when the user opens a portal room. + // This will never be called by the standard appservice connector, + // as Matrix doesn't have any standard way of signaling chat open status. + // Clients are expected to call this every 5 seconds. There is no signal for closing a chat. + HandleMatrixViewingChat(ctx context.Context, msg *MatrixViewingChat) error +} + // TypingHandlingNetworkAPI is an optional interface that network connectors can implement to handle typing events. type TypingHandlingNetworkAPI interface { NetworkAPI @@ -625,6 +702,35 @@ type RoomTopicHandlingNetworkAPI interface { HandleMatrixRoomTopic(ctx context.Context, msg *MatrixRoomTopic) (bool, error) } +type DisappearTimerChangingNetworkAPI interface { + NetworkAPI + // HandleMatrixDisappearingTimer is called when the disappearing timer of a portal room is changed. + // This method should update the Disappear field of the Portal with the new timer and return true + // if the change was successful. If the change is not successful, then the field should not be updated. + HandleMatrixDisappearingTimer(ctx context.Context, msg *MatrixDisappearingTimer) (bool, error) +} + +// DeleteChatHandlingNetworkAPI is an optional interface that network connectors +// can implement to delete a chat from the remote network. +type DeleteChatHandlingNetworkAPI interface { + NetworkAPI + // HandleMatrixDeleteChat is called when the user explicitly deletes a chat. + HandleMatrixDeleteChat(ctx context.Context, msg *MatrixDeleteChat) error +} + +// MessageRequestAcceptingNetworkAPI is an optional interface that network connectors +// can implement to accept message requests from the remote network. +type MessageRequestAcceptingNetworkAPI interface { + NetworkAPI + // HandleMatrixAcceptMessageRequest is called when the user accepts a message request. + HandleMatrixAcceptMessageRequest(ctx context.Context, msg *MatrixAcceptMessageRequest) error +} + +type BeeperAIStreamHandlingNetworkAPI interface { + NetworkAPI + HandleMatrixBeeperAIStream(ctx context.Context, msg *MatrixBeeperAIStream) error +} + type ResolveIdentifierResponse struct { // Ghost is the ghost of the user that the identifier resolves to. // This field should be set whenever possible. However, it is not required, @@ -644,11 +750,27 @@ type ResolveIdentifierResponse struct { Chat *CreateChatResponse } +var SpecialValueDMRedirectedToBot = networkid.UserID("__fi.mau.bridgev2.dm_redirected_to_bot::" + random.String(10)) + type CreateChatResponse struct { PortalKey networkid.PortalKey // Portal and PortalInfo are not required, the caller will fetch them automatically based on PortalKey if necessary. Portal *Portal PortalInfo *ChatInfo + // If a start DM request (CreateChatWithGhost or ResolveIdentifier) returns the DM to a different user, + // this field should have the user ID of said different user. + DMRedirectedTo networkid.UserID + + FailedParticipants map[networkid.UserID]*CreateChatFailedParticipant +} + +type CreateChatFailedParticipant struct { + Reason string `json:"reason"` + InviteEventType string `json:"invite_event_type,omitempty"` + InviteContent *event.Content `json:"invite_content,omitempty"` + + UserMXID id.UserID `json:"user_mxid,omitempty"` + DMRoomMXID id.RoomID `json:"dm_room_mxid,omitempty"` } // IdentifierResolvingNetworkAPI is an optional interface that network connectors can implement to support starting new direct chats. @@ -660,6 +782,16 @@ type IdentifierResolvingNetworkAPI interface { ResolveIdentifier(ctx context.Context, identifier string, createChat bool) (*ResolveIdentifierResponse, error) } +// GhostDMCreatingNetworkAPI is an optional extension to IdentifierResolvingNetworkAPI for starting chats with pre-validated user IDs. +type GhostDMCreatingNetworkAPI interface { + IdentifierResolvingNetworkAPI + // CreateChatWithGhost may be called instead of [IdentifierResolvingNetworkAPI.ResolveIdentifier] + // when starting a chat with an internal user identifier that has been pre-validated using + // [IdentifierValidatingNetwork.ValidateUserID]. If this is not implemented, ResolveIdentifier + // will be used instead (by stringifying the ghost ID). + CreateChatWithGhost(ctx context.Context, ghost *Ghost) (*CreateChatResponse, error) +} + // ContactListingNetworkAPI is an optional interface that network connectors can implement to provide the user's contact list. type ContactListingNetworkAPI interface { NetworkAPI @@ -673,7 +805,83 @@ type UserSearchingNetworkAPI interface { type GroupCreatingNetworkAPI interface { IdentifierResolvingNetworkAPI - CreateGroup(ctx context.Context, name string, users ...networkid.UserID) (*CreateChatResponse, error) + CreateGroup(ctx context.Context, params *GroupCreateParams) (*CreateChatResponse, error) +} + +type PersonalFilteringCustomizingNetworkAPI interface { + NetworkAPI + CustomizePersonalFilteringSpace(req *mautrix.ReqCreateRoom) +} + +type ProvisioningCapabilities struct { + ResolveIdentifier ResolveIdentifierCapabilities `json:"resolve_identifier"` + GroupCreation map[string]GroupTypeCapabilities `json:"group_creation"` +} + +type ResolveIdentifierCapabilities struct { + // Can DMs be created after resolving an identifier? + CreateDM bool `json:"create_dm"` + // Can users be looked up by phone number? + LookupPhone bool `json:"lookup_phone"` + // Can users be looked up by email address? + LookupEmail bool `json:"lookup_email"` + // Can users be looked up by network-specific username? + LookupUsername bool `json:"lookup_username"` + // Can any phone number be contacted without having to validate it via lookup first? + AnyPhone bool `json:"any_phone"` + // Can a contact list be retrieved from the bridge? + ContactList bool `json:"contact_list"` + // Can users be searched by name on the remote network? + Search bool `json:"search"` +} + +type GroupTypeCapabilities struct { + TypeDescription string `json:"type_description"` + + Name GroupFieldCapability `json:"name"` + Username GroupFieldCapability `json:"username"` + Avatar GroupFieldCapability `json:"avatar"` + Topic GroupFieldCapability `json:"topic"` + Disappear GroupFieldCapability `json:"disappear"` + Participants GroupFieldCapability `json:"participants"` + Parent GroupFieldCapability `json:"parent"` +} + +type GroupFieldCapability struct { + // Is setting this field allowed at all in the create request? + // Even if false, the network connector should attempt to set the metadata after group creation, + // as the allowed flag can't be enforced properly when creating a group for an existing Matrix room. + Allowed bool `json:"allowed"` + // Is setting this field mandatory for the creation to succeed? + Required bool `json:"required,omitempty"` + // The minimum/maximum length of the field, if applicable. + // For members, length means the number of members excluding the creator. + MinLength int `json:"min_length,omitempty"` + MaxLength int `json:"max_length,omitempty"` + + // Only for the disappear field: allowed disappearing settings + DisappearSettings *event.DisappearingTimerCapability `json:"settings,omitempty"` + + // This can be used to tell provisionutil not to call ValidateUserID on each participant. + // It only meant to allow hacks where ResolveIdentifier returns a fake ID that isn't actually valid for MXIDs. + SkipIdentifierValidation bool `json:"-"` +} + +type GroupCreateParams struct { + Type string `json:"type,omitempty"` + + Username string `json:"username,omitempty"` + // Clients may also provide MXIDs here, but provisionutil will normalize them, so bridges only need to handle network IDs + Participants []networkid.UserID `json:"participants,omitempty"` + Parent *networkid.PortalKey `json:"parent,omitempty"` + + Name *event.RoomNameEventContent `json:"name,omitempty"` + Avatar *event.RoomAvatarEventContent `json:"avatar,omitempty"` + Topic *event.TopicEventContent `json:"topic,omitempty"` + Disappear *event.BeeperDisappearingTimer `json:"disappear,omitempty"` + + // An existing room ID to bridge to. If unset, a new room will be created. + RoomID id.RoomID `json:"room_id,omitempty"` } type MembershipChangeType struct { @@ -713,16 +921,15 @@ type MatrixMembershipChange struct { MatrixRoomMeta[*event.MemberEventContent] Target GhostOrUserLogin Type MembershipChangeType +} - // Deprecated: Use Target instead - TargetGhost *Ghost - // Deprecated: Use Target instead - TargetUserLogin *UserLogin +type MatrixMembershipResult struct { + RedirectTo networkid.UserID } type MembershipHandlingNetworkAPI interface { NetworkAPI - HandleMatrixMembership(ctx context.Context, msg *MatrixMembershipChange) (bool, error) + HandleMatrixMembership(ctx context.Context, msg *MatrixMembershipChange) (*MatrixMembershipResult, error) } type SinglePowerLevelChange struct { @@ -811,13 +1018,32 @@ type PushConfig struct { Web *WebPushConfig `json:"web,omitempty"` FCM *FCMPushConfig `json:"fcm,omitempty"` APNs *APNsPushConfig `json:"apns,omitempty"` + // If Native is true, it means the network supports registering for pushes + // that are delivered directly to the app without the use of a push relay. + Native bool `json:"native,omitempty"` } +// PushableNetworkAPI is an optional interface that network connectors can implement +// to support waking up the wrapper app using push notifications. type PushableNetworkAPI interface { + NetworkAPI + + // RegisterPushNotifications is called when the wrapper app wants to register a push token with the remote network. RegisterPushNotifications(ctx context.Context, pushType PushType, token string) error + // GetPushConfigs is used to find which types of push notifications the remote network can provide. GetPushConfigs() *PushConfig } +// PushParsingNetwork is an optional interface that network connectors can implement +// to support parsing native push notifications from networks. +type PushParsingNetwork interface { + NetworkConnector + + // ParsePushNotification is called when a native push is received. + // It must return the corresponding user login ID to wake up, plus optionally data to pass to the wakeup call. + ParsePushNotification(ctx context.Context, data json.RawMessage) (networkid.UserLoginID, any, error) +} + type RemoteEventType int func (ret RemoteEventType) String() string { @@ -942,6 +1168,11 @@ type RemoteChatDelete interface { RemoteDeleteOnlyForMe } +type RemoteChatDeleteWithChildren interface { + RemoteChatDelete + DeleteChildren() bool +} + type RemoteEventThatMayCreatePortal interface { RemoteEvent ShouldCreatePortal() bool @@ -1061,6 +1292,11 @@ type RemoteReadReceipt interface { GetReadUpTo() time.Time } +type RemoteReadReceiptWithStreamOrder interface { + RemoteReadReceipt + GetReadUpToStreamOrder() int64 +} + type RemoteDeliveryReceipt interface { RemoteEvent GetReceiptTargets() []networkid.MessageID @@ -1096,6 +1332,7 @@ type OrigSender struct { RequiresDisambiguation bool DisambiguatedName string FormattedName string + PerMessageProfile event.BeeperPerMessageProfile event.MemberEventContent } @@ -1110,12 +1347,16 @@ type MatrixEventBase[ContentType any] struct { // The original sender user ID. Only present in case the event is being relayed (and Sender is not the same user). OrigSender *OrigSender + + InputTransactionID networkid.RawTransactionID } type MatrixMessage struct { MatrixEventBase[*event.MessageEventContent] ThreadRoot *database.Message ReplyTo *database.Message + + pendingSaves []*outgoingMessage } type MatrixEdit struct { @@ -1164,12 +1405,14 @@ type MatrixMessageRemove struct { type MatrixRoomMeta[ContentType any] struct { MatrixEventBase[ContentType] - PrevContent ContentType + PrevContent ContentType + IsStateRequest bool } type MatrixRoomName = MatrixRoomMeta[*event.RoomNameEventContent] type MatrixRoomAvatar = MatrixRoomMeta[*event.RoomAvatarEventContent] type MatrixRoomTopic = MatrixRoomMeta[*event.TopicEventContent] +type MatrixDisappearingTimer = MatrixRoomMeta[*event.BeeperDisappearingTimer] type MatrixReadReceipt struct { Portal *Portal @@ -1184,6 +1427,8 @@ type MatrixReadReceipt struct { LastRead time.Time // The receipt metadata. Receipt event.ReadReceipt + // Whether the receipt is implicit, i.e. triggered by an incoming timeline event rather than an explicit receipt. + Implicit bool } type MatrixTyping struct { @@ -1192,6 +1437,14 @@ type MatrixTyping struct { Type TypingType } +type MatrixViewingChat struct { + // The portal that the user is viewing. This will be nil when the user switches to a chat from a different bridge. + Portal *Portal +} + +type MatrixDeleteChat = MatrixEventBase[*event.BeeperChatDeleteEventContent] +type MatrixAcceptMessageRequest = MatrixEventBase[*event.BeeperAcceptMessageRequestEventContent] +type MatrixBeeperAIStream = MatrixEventBase[*event.BeeperAIStreamEventContent] type MatrixMarkedUnread = MatrixRoomMeta[*event.MarkedUnreadEventContent] type MatrixMute = MatrixRoomMeta[*event.BeeperMuteEventContent] type MatrixRoomTag = MatrixRoomMeta[*event.TagEventContent] diff --git a/bridgev2/portal.go b/bridgev2/portal.go index aa263098..16aa703b 100644 --- a/bridgev2/portal.go +++ b/bridgev2/portal.go @@ -19,7 +19,9 @@ import ( "github.com/rs/zerolog" "go.mau.fi/util/exfmt" + "go.mau.fi/util/exmaps" "go.mau.fi/util/exslices" + "go.mau.fi/util/exsync" "go.mau.fi/util/ptr" "go.mau.fi/util/variationselector" "golang.org/x/exp/maps" @@ -59,10 +61,12 @@ type portalEvent interface { } type outgoingMessage struct { - db *database.Message - evt *event.Event - ignore bool - handle func(RemoteMessage, *database.Message) (bool, error) + db *database.Message + evt *event.Event + ignore bool + handle func(RemoteMessage, *database.Message) (bool, error) + ackedAt time.Time + timeouted bool } type Portal struct { @@ -75,16 +79,28 @@ type Portal struct { currentlyTyping []id.UserID currentlyTypingLogins map[id.UserID]*UserLogin currentlyTypingLock sync.Mutex + currentlyTypingGhosts *exsync.Set[id.UserID] - outgoingMessages map[networkid.TransactionID]outgoingMessage + outgoingMessages map[networkid.TransactionID]*outgoingMessage outgoingMessagesLock sync.Mutex - roomCreateLock sync.Mutex + lastCapUpdate time.Time - events chan portalEvent + roomCreateLock sync.Mutex + cancelRoomCreate atomic.Pointer[context.CancelFunc] + RoomCreated *exsync.Event + + functionalMembersLock sync.Mutex + functionalMembersCache *event.ElementFunctionalMembersContent + + events chan portalEvent + deleted *exsync.Event + + eventsLock sync.Mutex + eventIdx int } -const PortalEventBuffer = 64 +var PortalEventBuffer = 64 func (br *Bridge) loadPortal(ctx context.Context, dbPortal *database.Portal, queryErr error, key *networkid.PortalKey) (*Portal, error) { if queryErr != nil { @@ -107,10 +123,18 @@ func (br *Bridge) loadPortal(ctx context.Context, dbPortal *database.Portal, que Portal: dbPortal, Bridge: br, - events: make(chan portalEvent, PortalEventBuffer), currentlyTypingLogins: make(map[id.UserID]*UserLogin), - outgoingMessages: make(map[networkid.TransactionID]outgoingMessage), + currentlyTypingGhosts: exsync.NewSet[id.UserID](), + outgoingMessages: make(map[networkid.TransactionID]*outgoingMessage), + + RoomCreated: exsync.NewEvent(), + deleted: exsync.NewEvent(), } + if portal.MXID != "" { + portal.RoomCreated.Set() + } + // Putting the portal in the cache before it's fully initialized is mildly dangerous, + // but loading the relay user login may depend on it. br.portalsByKey[portal.PortalKey] = portal if portal.MXID != "" { br.portalsByMXID[portal.MXID] = portal @@ -119,22 +143,35 @@ func (br *Bridge) loadPortal(ctx context.Context, dbPortal *database.Portal, que if portal.ParentKey.ID != "" { portal.Parent, err = br.UnlockedGetPortalByKey(ctx, portal.ParentKey, false) if err != nil { + delete(br.portalsByKey, portal.PortalKey) + if portal.MXID != "" { + delete(br.portalsByMXID, portal.MXID) + } return nil, fmt.Errorf("failed to load parent portal (%s): %w", portal.ParentKey, err) } } if portal.RelayLoginID != "" { portal.Relay, err = br.unlockedGetExistingUserLoginByID(ctx, portal.RelayLoginID) if err != nil { + delete(br.portalsByKey, portal.PortalKey) + if portal.MXID != "" { + delete(br.portalsByMXID, portal.MXID) + } return nil, fmt.Errorf("failed to load relay login (%s): %w", portal.RelayLoginID, err) } } portal.updateLogger() - go portal.eventLoop() + if PortalEventBuffer != 0 { + portal.events = make(chan portalEvent, PortalEventBuffer) + go portal.eventLoop() + } return portal, nil } func (portal *Portal) updateLogger() { - logWith := portal.Bridge.Log.With().Str("portal_id", string(portal.ID)) + logWith := portal.Bridge.Log.With(). + Str("portal_id", string(portal.ID)). + Str("portal_receiver", string(portal.Receiver)) if portal.MXID != "" { logWith = logWith.Stringer("portal_mxid", portal.MXID) } @@ -158,6 +195,16 @@ func (br *Bridge) loadManyPortals(ctx context.Context, portals []*database.Porta return output, nil } +func (br *Bridge) loadPortalWithCacheCheck(ctx context.Context, dbPortal *database.Portal) (*Portal, error) { + if dbPortal == nil { + return nil, nil + } else if cached, ok := br.portalsByKey[dbPortal.PortalKey]; ok { + return cached, nil + } else { + return br.loadPortal(ctx, dbPortal, nil, nil) + } +} + func (br *Bridge) UnlockedGetPortalByKey(ctx context.Context, key networkid.PortalKey, onlyIfExists bool) (*Portal, error) { if br.Config.SplitPortals && key.Receiver == "" { return nil, fmt.Errorf("receiver must always be set when split portals is enabled") @@ -247,6 +294,26 @@ func (br *Bridge) GetDMPortalsWith(ctx context.Context, otherUserID networkid.Us return br.loadManyPortals(ctx, rows) } +func (br *Bridge) GetChildPortals(ctx context.Context, parent networkid.PortalKey) ([]*Portal, error) { + br.cacheLock.Lock() + defer br.cacheLock.Unlock() + rows, err := br.DB.Portal.GetChildren(ctx, parent) + if err != nil { + return nil, err + } + return br.loadManyPortals(ctx, rows) +} + +func (br *Bridge) GetDMPortal(ctx context.Context, receiver networkid.UserLoginID, otherUserID networkid.UserID) (*Portal, error) { + br.cacheLock.Lock() + defer br.cacheLock.Unlock() + dbPortal, err := br.DB.Portal.GetDM(ctx, receiver, otherUserID) + if err != nil { + return nil, err + } + return br.loadPortalWithCacheCheck(ctx, dbPortal) +} + func (br *Bridge) GetPortalByKey(ctx context.Context, key networkid.PortalKey) (*Portal, error) { br.cacheLock.Lock() defer br.cacheLock.Unlock() @@ -271,61 +338,114 @@ func (br *Bridge) GetExistingPortalByKey(ctx context.Context, key networkid.Port return br.loadPortal(ctx, db, err, nil) } -func (portal *Portal) queueEvent(ctx context.Context, evt portalEvent) { - select { - case portal.events <- evt: - default: - zerolog.Ctx(ctx).Error(). - Str("portal_id", string(portal.ID)). - Msg("Portal event channel is full") +func (portal *Portal) queueEvent(ctx context.Context, evt portalEvent) EventHandlingResult { + if portal.deleted.IsSet() { + return EventHandlingResultIgnored + } + if PortalEventBuffer == 0 { + portal.eventsLock.Lock() + defer portal.eventsLock.Unlock() + portal.eventIdx++ + return portal.handleSingleEventWithDelayLogging(portal.eventIdx, evt) + } else { + if portal.events == nil { + panic(fmt.Errorf("queueEvent into uninitialized portal %s", portal.PortalKey)) + } + select { + case portal.events <- evt: + return EventHandlingResultQueued + case <-portal.deleted.GetChan(): + return EventHandlingResultIgnored + default: + zerolog.Ctx(ctx).Error(). + Str("portal_id", string(portal.ID)). + Msg("Portal event channel is full, queue will block") + for { + select { + case portal.events <- evt: + return EventHandlingResultQueued + case <-time.After(5 * time.Second): + zerolog.Ctx(ctx).Error(). + Str("portal_id", string(portal.ID)). + Msg("Portal event channel is still full") + } + } + } } } func (portal *Portal) eventLoop() { - i := 0 - for rawEvt := range portal.events { - i++ - portal.handleSingleEventAsync(i, rawEvt) + if cfg := portal.Bridge.Network.GetCapabilities().OutgoingMessageTimeouts; cfg != nil { + ctx, cancel := context.WithCancel(portal.Log.WithContext(portal.Bridge.BackgroundCtx)) + go portal.pendingMessageTimeoutLoop(ctx, cfg) + defer cancel() + } + deleteCh := portal.deleted.GetChan() + for i := 0; ; i++ { + select { + case rawEvt := <-portal.events: + if rawEvt == nil { + return + } + if portal.Bridge.Config.AsyncEvents { + go portal.handleSingleEventWithDelayLogging(i, rawEvt) + } else { + portal.handleSingleEventWithDelayLogging(i, rawEvt) + } + case <-deleteCh: + return + } } } -func (portal *Portal) handleSingleEventAsync(idx int, rawEvt any) { +func (portal *Portal) handleSingleEventWithDelayLogging(idx int, rawEvt any) (outerRes EventHandlingResult) { ctx := portal.getEventCtxWithLog(rawEvt, idx) - if _, isCreate := rawEvt.(*portalCreateEvent); isCreate { - portal.handleSingleEvent(ctx, rawEvt, func() {}) - } else if portal.Bridge.Config.AsyncEvents { - go portal.handleSingleEvent(ctx, rawEvt, func() {}) - } else { - log := zerolog.Ctx(ctx) - doneCh := make(chan struct{}) - var backgrounded atomic.Bool - start := time.Now() - var handleDuration time.Duration - go portal.handleSingleEvent(ctx, rawEvt, func() { - handleDuration = time.Since(start) - close(doneCh) - if backgrounded.Load() { - log.Debug().Stringer("duration", handleDuration). - Msg("Event that took too long finally finished handling") + log := zerolog.Ctx(ctx) + doneCh := make(chan struct{}) + var backgrounded atomic.Bool + start := time.Now() + var handleDuration time.Duration + // Note: this will not set the success flag if the handler times out + outerRes = EventHandlingResult{Queued: true} + go portal.handleSingleEvent(ctx, rawEvt, func(res EventHandlingResult) { + outerRes = res + handleDuration = time.Since(start) + close(doneCh) + if backgrounded.Load() { + log.Debug(). + Time("started_at", start). + Stringer("duration", handleDuration). + Msg("Event that took too long finally finished handling") + } + }) + tick := time.NewTicker(30 * time.Second) + _, isCreate := rawEvt.(*portalCreateEvent) + defer tick.Stop() + for i := 0; i < 10; i++ { + select { + case <-doneCh: + if i > 0 { + log.Debug(). + Time("started_at", start). + Stringer("duration", handleDuration). + Msg("Event that took long finished handling") } - }) - tick := time.NewTicker(30 * time.Second) - defer tick.Stop() - for i := 0; i < 10; i++ { - select { - case <-doneCh: - if i > 0 { - log.Debug().Stringer("duration", handleDuration). - Msg("Event that took long finished handling") - } - return - case <-tick.C: - log.Warn().Msg("Event handling is taking long") + return + case <-tick.C: + log.Warn(). + Time("started_at", start). + Msg("Event handling is taking long") + if isCreate { + // Never background portal creation events + i = 1 } } - log.Warn().Msg("Event handling is taking too long, continuing in background") - backgrounded.Store(true) } + log.Warn(). + Time("started_at", start). + Msg("Event handling is taking too long, continuing in background") + backgrounded.Store(true) + return } func (portal *Portal) getEventCtxWithLog(rawEvt any, idx int) context.Context { @@ -348,22 +468,49 @@ func (portal *Portal) getEventCtxWithLog(rawEvt any, idx int) context.Context { Str("source_id", string(evt.source.ID)). Stringer("bridge_evt_type", evt.evtType) logWith = evt.evt.AddLogContext(logWith) + if remoteSender := evt.evt.GetSender(); remoteSender.Sender != "" || remoteSender.IsFromMe { + logWith = logWith.Object("remote_sender", remoteSender) + } + if remoteMsg, ok := evt.evt.(RemoteMessage); ok { + if remoteMsgID := remoteMsg.GetID(); remoteMsgID != "" { + logWith = logWith.Str("remote_message_id", string(remoteMsgID)) + } + } + if remoteMsg, ok := evt.evt.(RemoteEventWithTargetMessage); ok { + if targetMsgID := remoteMsg.GetTargetMessage(); targetMsgID != "" { + logWith = logWith.Str("remote_target_message_id", string(targetMsgID)) + } + } + if remoteMsg, ok := evt.evt.(RemoteEventWithStreamOrder); ok { + if remoteStreamOrder := remoteMsg.GetStreamOrder(); remoteStreamOrder != 0 { + logWith = logWith.Int64("remote_stream_order", remoteStreamOrder) + } + } + if remoteMsg, ok := evt.evt.(RemoteEventWithTimestamp); ok { + if remoteTimestamp := remoteMsg.GetTimestamp(); !remoteTimestamp.IsZero() { + logWith = logWith.Time("remote_timestamp", remoteTimestamp) + } + } case *portalCreateEvent: return evt.ctx } - return logWith.Logger().WithContext(context.Background()) + return logWith.Logger().WithContext(portal.Bridge.BackgroundCtx) } -func (portal *Portal) handleSingleEvent(ctx context.Context, rawEvt any, doneCallback func()) { +func (portal *Portal) handleSingleEvent(ctx context.Context, rawEvt any, doneCallback func(res EventHandlingResult)) { log := zerolog.Ctx(ctx) + var res EventHandlingResult defer func() { - doneCallback() + doneCallback(res) if err := recover(); err != nil { logEvt := log.Error() + var errorString string if realErr, ok := err.(error); ok { logEvt = logEvt.Err(realErr) + errorString = realErr.Error() } else { logEvt = logEvt.Any(zerolog.ErrorFieldName, err) + errorString = fmt.Sprintf("%v", err) } logEvt. Bytes("stack", debug.Stack()). @@ -376,32 +523,92 @@ func (portal *Portal) handleSingleEvent(ctx context.Context, rawEvt any, doneCal case *portalCreateEvent: evt.cb(fmt.Errorf("portal creation panicked")) } + portal.Bridge.TrackAnalytics("", "Bridge Event Handler Panic", map[string]any{ + "error": errorString, + }) } }() switch evt := rawEvt.(type) { case *portalMatrixEvent: - portal.handleMatrixEvent(ctx, evt.sender, evt.evt) + isStateRequest := evt.evt.Type == event.BeeperSendState + if isStateRequest { + if err := portal.unwrapBeeperSendState(ctx, evt.evt); err != nil { + portal.sendErrorStatus(ctx, evt.evt, err) + return + } + } + res = portal.handleMatrixEvent(ctx, evt.sender, evt.evt, isStateRequest) + if res.SendMSS { + if res.Error != nil { + portal.sendErrorStatus(ctx, evt.evt, res.Error) + } else { + portal.sendSuccessStatus(ctx, evt.evt, 0, "") + } + } + if !isStateRequest && res.Error != nil && evt.evt.StateKey != nil { + portal.revertRoomMeta(ctx, evt.evt) + } + if isStateRequest && res.Success && !res.SkipStateEcho { + portal.sendRoomMeta( + ctx, + evt.sender.DoublePuppet(ctx), + time.UnixMilli(evt.evt.Timestamp), + evt.evt.Type, + evt.evt.GetStateKey(), + evt.evt.Content.Parsed, + false, + evt.evt.Content.Raw, + ) + } case *portalRemoteEvent: - portal.handleRemoteEvent(ctx, evt.source, evt.evtType, evt.evt) + res = portal.handleRemoteEvent(ctx, evt.source, evt.evtType, evt.evt) case *portalCreateEvent: - evt.cb(portal.createMatrixRoomInLoop(evt.ctx, evt.source, evt.info, nil)) + err := portal.createMatrixRoomInLoop(evt.ctx, evt.source, evt.info, nil) + res.Success = err == nil + evt.cb(err) default: panic(fmt.Errorf("illegal type %T in eventLoop", evt)) } } +func (portal *Portal) unwrapBeeperSendState(ctx context.Context, evt *event.Event) error { + content, ok := evt.Content.Parsed.(*event.BeeperSendStateEventContent) + if !ok { + return fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed) + } + evt.Content = content.Content + evt.StateKey = &content.StateKey + evt.Type = event.Type{Type: content.Type, Class: event.StateEventType} + _ = evt.Content.ParseRaw(evt.Type) + mx, ok := portal.Bridge.Matrix.(MatrixConnectorWithArbitraryRoomState) + if !ok { + return fmt.Errorf("matrix connector doesn't support fetching state") + } + prevEvt, err := mx.GetStateEvent(ctx, portal.MXID, evt.Type, evt.GetStateKey()) + if err != nil && !errors.Is(err, mautrix.MNotFound) { + return fmt.Errorf("failed to get prev event: %w", err) + } else if prevEvt != nil { + evt.Unsigned.PrevContent = &prevEvt.Content + evt.Unsigned.PrevSender = prevEvt.Sender + } + return nil +} + func (portal *Portal) FindPreferredLogin(ctx context.Context, user *User, allowRelay bool) (*UserLogin, *database.UserPortal, error) { if portal.Receiver != "" { login, err := portal.Bridge.GetExistingUserLoginByID(ctx, portal.Receiver) if err != nil { return nil, nil, err } - if login == nil || login.UserMXID != user.MXID { + if login == nil { + return nil, nil, fmt.Errorf("%w (receiver login is nil)", ErrNotLoggedIn) + } else if !login.Client.IsLoggedIn() { + return nil, nil, fmt.Errorf("%w (receiver login is not logged in)", ErrNotLoggedIn) + } else if login.UserMXID != user.MXID { if allowRelay && portal.Relay != nil { return nil, nil, nil } - // TODO different error for this case? - return nil, nil, ErrNotLoggedIn + return nil, nil, fmt.Errorf("%w (relay not set and receiver login is owned by %s, not %s)", ErrNotLoggedIn, login.UserMXID, user.MXID) } up, err := portal.Bridge.DB.UserPortal.Get(ctx, login.UserLogin, portal.PortalKey) return login, up, err @@ -412,9 +619,9 @@ func (portal *Portal) FindPreferredLogin(ctx context.Context, user *User, allowR } portal.Bridge.cacheLock.Lock() defer portal.Bridge.cacheLock.Unlock() - for i, up := range logins { + for _, up := range logins { login, ok := user.logins[up.LoginID] - if ok && login.Client != nil && (len(logins) == i-1 || login.Client.IsLoggedIn()) { + if ok && login.Client != nil && login.Client.IsLoggedIn() { return login, up, nil } } @@ -430,7 +637,7 @@ func (portal *Portal) FindPreferredLogin(ctx context.Context, user *User, allowR firstLogin = login break } - if firstLogin != nil { + if firstLogin != nil && firstLogin.Client.IsLoggedIn() { zerolog.Ctx(ctx).Warn(). Str("chosen_login_id", string(firstLogin.ID)). Msg("No usable user portal rows found, returning random login") @@ -482,29 +689,45 @@ func (portal *Portal) checkConfusableName(ctx context.Context, userID id.UserID, return false } -func (portal *Portal) handleMatrixEvent(ctx context.Context, sender *User, evt *event.Event) { +var fakePerMessageProfileEventType = event.Type{Class: event.StateEventType, Type: "m.per_message_profile"} + +func (portal *Portal) handleMatrixEvent(ctx context.Context, sender *User, evt *event.Event, isStateRequest bool) EventHandlingResult { log := zerolog.Ctx(ctx) if evt.Mautrix.EventSource&event.SourceEphemeral != 0 { switch evt.Type { case event.EphemeralEventReceipt: - portal.handleMatrixReceipts(ctx, evt) + return portal.handleMatrixReceipts(ctx, evt) case event.EphemeralEventTyping: - portal.handleMatrixTyping(ctx, evt) + return portal.handleMatrixTyping(ctx, evt) + case event.BeeperEphemeralEventAIStream: + return portal.handleMatrixAIStream(ctx, sender, evt) + default: + return EventHandlingResultIgnored } - return } - login, _, err := portal.FindPreferredLogin(ctx, sender, true) + if evt.Type == event.StateTombstone { + // Tombstones aren't bridged so they don't need a login + return portal.handleMatrixTombstone(ctx, evt) + } + login, userPortal, err := portal.FindPreferredLogin(ctx, sender, true) if err != nil { log.Err(err).Msg("Failed to get user login to handle Matrix event") if errors.Is(err, ErrNotLoggedIn) { - portal.sendErrorStatus(ctx, evt, WrapErrorInStatus(err).WithMessage("You're not logged in").WithIsCertain(true).WithSendNotice(true)) + shouldSendNotice := evt.Content.AsMessage().MsgType != event.MsgNotice + return EventHandlingResultFailed.WithMSSError( + WrapErrorInStatus(err).WithMessage("You're not logged in").WithIsCertain(true).WithSendNotice(shouldSendNotice), + ) } else { - portal.sendErrorStatus(ctx, evt, WrapErrorInStatus(err).WithMessage("Failed to get login to handle event").WithIsCertain(true).WithSendNotice(true)) + return EventHandlingResultFailed.WithMSSError( + WrapErrorInStatus(err).WithMessage("Failed to get login to handle event").WithIsCertain(true).WithSendNotice(true), + ) } - return } var origSender *OrigSender if login == nil { + if isStateRequest { + return EventHandlingResultFailed.WithMSSError(ErrCantRelayStateRequest) + } login = portal.Relay origSender = &OrigSender{ User: sender, @@ -526,47 +749,88 @@ func (portal *Portal) handleMatrixEvent(ctx context.Context, sender *User, evt * } else { origSender.DisambiguatedName = sender.MXID.String() } + msg := evt.Content.AsMessage() + if msg != nil && msg.BeeperPerMessageProfile != nil && msg.BeeperPerMessageProfile.Displayname != "" { + pmp := msg.BeeperPerMessageProfile + origSender.PerMessageProfile = *pmp + roomPLs, err := portal.Bridge.Matrix.GetPowerLevels(ctx, portal.MXID) + if err != nil { + log.Warn().Err(err).Msg("Failed to get power levels to check relay profile") + } + if roomPLs != nil && + roomPLs.GetUserLevel(sender.MXID) >= roomPLs.GetEventLevel(fakePerMessageProfileEventType) && + !portal.checkConfusableName(ctx, sender.MXID, pmp.Displayname) { + origSender.DisambiguatedName = pmp.Displayname + origSender.RequiresDisambiguation = false + } else { + origSender.DisambiguatedName = fmt.Sprintf("%s via %s", pmp.Displayname, origSender.DisambiguatedName) + } + } + origSender.FormattedName = portal.Bridge.Config.Relay.FormatName(origSender) } // Copy logger because many of the handlers will use UpdateContext ctx = log.With().Str("login_id", string(login.ID)).Logger().WithContext(ctx) + + if origSender == nil && portal.Bridge.Network.GetCapabilities().ImplicitReadReceipts && !evt.Type.IsAccountData() { + rrLog := log.With().Str("subaction", "implicit read receipt").Logger() + rrCtx := rrLog.WithContext(ctx) + rrLog.Debug().Msg("Sending implicit read receipt for event") + evtTS := time.UnixMilli(evt.Timestamp) + portal.callReadReceiptHandler(rrCtx, login, nil, &MatrixReadReceipt{ + Portal: portal, + EventID: evt.ID, + Implicit: true, + ReadUpTo: evtTS, + Receipt: event.ReadReceipt{Timestamp: evtTS}, + }, userPortal) + } + switch evt.Type { case event.EventMessage, event.EventSticker, event.EventUnstablePollStart, event.EventUnstablePollResponse: - portal.handleMatrixMessage(ctx, login, origSender, evt) + return portal.handleMatrixMessage(ctx, login, origSender, evt) case event.EventReaction: if origSender != nil { log.Debug().Msg("Ignoring reaction event from relayed user") - portal.sendErrorStatus(ctx, evt, ErrIgnoringReactionFromRelayedUser) - return + return EventHandlingResultIgnored.WithMSSError(ErrIgnoringReactionFromRelayedUser) } - portal.handleMatrixReaction(ctx, login, evt) + return portal.handleMatrixReaction(ctx, login, evt) case event.EventRedaction: - portal.handleMatrixRedaction(ctx, login, origSender, evt) + return portal.handleMatrixRedaction(ctx, login, origSender, evt) case event.StateRoomName: - handleMatrixRoomMeta(portal, ctx, login, origSender, evt, RoomNameHandlingNetworkAPI.HandleMatrixRoomName) + return handleMatrixRoomMeta(portal, ctx, login, origSender, evt, isStateRequest, RoomNameHandlingNetworkAPI.HandleMatrixRoomName) case event.StateTopic: - handleMatrixRoomMeta(portal, ctx, login, origSender, evt, RoomTopicHandlingNetworkAPI.HandleMatrixRoomTopic) + return handleMatrixRoomMeta(portal, ctx, login, origSender, evt, isStateRequest, RoomTopicHandlingNetworkAPI.HandleMatrixRoomTopic) case event.StateRoomAvatar: - handleMatrixRoomMeta(portal, ctx, login, origSender, evt, RoomAvatarHandlingNetworkAPI.HandleMatrixRoomAvatar) + return handleMatrixRoomMeta(portal, ctx, login, origSender, evt, isStateRequest, RoomAvatarHandlingNetworkAPI.HandleMatrixRoomAvatar) + case event.StateBeeperDisappearingTimer: + return handleMatrixRoomMeta(portal, ctx, login, origSender, evt, isStateRequest, DisappearTimerChangingNetworkAPI.HandleMatrixDisappearingTimer) case event.StateEncryption: // TODO? + return EventHandlingResultIgnored case event.AccountDataMarkedUnread: - handleMatrixAccountData(portal, ctx, login, evt, MarkedUnreadHandlingNetworkAPI.HandleMarkedUnread) + return handleMatrixAccountData(portal, ctx, login, evt, MarkedUnreadHandlingNetworkAPI.HandleMarkedUnread) case event.AccountDataRoomTags: - handleMatrixAccountData(portal, ctx, login, evt, TagHandlingNetworkAPI.HandleRoomTag) + return handleMatrixAccountData(portal, ctx, login, evt, TagHandlingNetworkAPI.HandleRoomTag) case event.AccountDataBeeperMute: - handleMatrixAccountData(portal, ctx, login, evt, MuteHandlingNetworkAPI.HandleMute) + return handleMatrixAccountData(portal, ctx, login, evt, MuteHandlingNetworkAPI.HandleMute) case event.StateMember: - portal.handleMatrixMembership(ctx, login, origSender, evt) + return portal.handleMatrixMembership(ctx, login, origSender, evt, isStateRequest) case event.StatePowerLevels: - portal.handleMatrixPowerLevels(ctx, login, origSender, evt) + return portal.handleMatrixPowerLevels(ctx, login, origSender, evt, isStateRequest) + case event.BeeperDeleteChat: + return portal.handleMatrixDeleteChat(ctx, login, origSender, evt) + case event.BeeperAcceptMessageRequest: + return portal.handleMatrixAcceptMessageRequest(ctx, login, origSender, evt) + default: + return EventHandlingResultIgnored } } -func (portal *Portal) handleMatrixReceipts(ctx context.Context, evt *event.Event) { +func (portal *Portal) handleMatrixReceipts(ctx context.Context, evt *event.Event) EventHandlingResult { content, ok := evt.Content.Parsed.(*event.ReceiptEventContent) if !ok { - return + return EventHandlingResultFailed } for evtID, receipts := range *content { readReceipts, ok := receipts[event.ReceiptTypeRead] @@ -576,12 +840,14 @@ func (portal *Portal) handleMatrixReceipts(ctx context.Context, evt *event.Event for userID, receipt := range readReceipts { sender, err := portal.Bridge.GetUserByMXID(ctx, userID) if err != nil { - // TODO log - return + zerolog.Ctx(ctx).Err(err).Msg("Failed to get user to handle read receipt") + return EventHandlingResultFailed.WithError(err) } portal.handleMatrixReadReceipt(ctx, sender, evtID, receipt) } } + // TODO actual status + return EventHandlingResultSuccess } func (portal *Portal) handleMatrixReadReceipt(ctx context.Context, user *User, eventID id.EventID, receipt event.ReadReceipt) { @@ -613,15 +879,10 @@ func (portal *Portal) handleMatrixReadReceipt(ctx context.Context, user *User, e EventID: eventID, Receipt: receipt, } - if userPortal == nil { - userPortal = database.UserPortalFor(login.UserLogin, portal.PortalKey) - } else { - evt.LastRead = userPortal.LastRead - userPortal = userPortal.CopyWithoutValues() - } evt.ExactMessage, err = portal.Bridge.DB.Message.GetPartByMXID(ctx, eventID) if err != nil { log.Err(err).Msg("Failed to get exact message from database") + evt.ReadUpTo = receipt.Timestamp } else if evt.ExactMessage != nil { log.UpdateContext(func(c zerolog.Context) zerolog.Context { return c.Str("exact_message_id", string(evt.ExactMessage.ID)).Time("exact_message_ts", evt.ExactMessage.Timestamp) @@ -630,27 +891,46 @@ func (portal *Portal) handleMatrixReadReceipt(ctx context.Context, user *User, e } else { evt.ReadUpTo = receipt.Timestamp } - err = rrClient.HandleMatrixReadReceipt(ctx, evt) - if err != nil { - log.Err(err).Msg("Failed to handle read receipt") - return - } - if evt.ExactMessage != nil { - userPortal.LastRead = evt.ExactMessage.Timestamp - } else { - userPortal.LastRead = receipt.Timestamp - } - err = portal.Bridge.DB.UserPortal.Put(ctx, userPortal) - if err != nil { - log.Err(err).Msg("Failed to save user portal metadata") - } - portal.Bridge.DisappearLoop.StartAll(ctx, portal.MXID) + portal.callReadReceiptHandler(ctx, login, rrClient, evt, userPortal) } -func (portal *Portal) handleMatrixTyping(ctx context.Context, evt *event.Event) { +func (portal *Portal) callReadReceiptHandler( + ctx context.Context, + login *UserLogin, + rrClient ReadReceiptHandlingNetworkAPI, + evt *MatrixReadReceipt, + userPortal *database.UserPortal, +) { + if rrClient == nil { + var ok bool + rrClient, ok = login.Client.(ReadReceiptHandlingNetworkAPI) + if !ok { + return + } + } + if userPortal == nil { + userPortal = database.UserPortalFor(login.UserLogin, portal.PortalKey) + } else { + evt.LastRead = userPortal.LastRead + userPortal = userPortal.CopyWithoutValues() + } + err := rrClient.HandleMatrixReadReceipt(ctx, evt) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to handle read receipt") + return + } + userPortal.LastRead = evt.ReadUpTo + err = portal.Bridge.DB.UserPortal.Put(ctx, userPortal) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to save user portal metadata") + } + portal.Bridge.DisappearLoop.StartAllBefore(ctx, portal.MXID, evt.ReadUpTo) +} + +func (portal *Portal) handleMatrixTyping(ctx context.Context, evt *event.Event) EventHandlingResult { content, ok := evt.Content.Parsed.(*event.TypingEventContent) if !ok { - return + return EventHandlingResultFailed } portal.currentlyTypingLock.Lock() defer portal.currentlyTypingLock.Unlock() @@ -661,6 +941,52 @@ func (portal *Portal) handleMatrixTyping(ctx context.Context, evt *event.Event) portal.sendTypings(ctx, stoppedTyping, false) portal.sendTypings(ctx, startedTyping, true) portal.currentlyTyping = content.UserIDs + // TODO actual status + return EventHandlingResultSuccess +} + +func (portal *Portal) handleMatrixAIStream(ctx context.Context, sender *User, evt *event.Event) EventHandlingResult { + log := zerolog.Ctx(ctx) + if sender == nil { + log.Error().Msg("Missing sender for Matrix AI stream event") + return EventHandlingResultIgnored + } + login, _, err := portal.FindPreferredLogin(ctx, sender, true) + if err != nil { + log.Err(err).Msg("Failed to get user login to handle Matrix AI stream event") + return EventHandlingResultFailed.WithMSSError(err) + } + var origSender *OrigSender + if login == nil { + if portal.Relay == nil { + return EventHandlingResultIgnored + } + login = portal.Relay + origSender = &OrigSender{ + User: sender, + UserID: sender.MXID, + } + } + content, ok := evt.Content.Parsed.(*event.BeeperAIStreamEventContent) + if !ok { + log.Error().Type("content_type", evt.Content.Parsed).Msg("Unexpected parsed content type") + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) + } + api, ok := login.Client.(BeeperAIStreamHandlingNetworkAPI) + if !ok { + return EventHandlingResultIgnored.WithMSSError(ErrBeeperAIStreamNotSupported) + } + err = api.HandleMatrixBeeperAIStream(ctx, &MatrixBeeperAIStream{ + Event: evt, + Content: content, + Portal: portal, + OrigSender: origSender, + }) + if err != nil { + log.Err(err).Msg("Failed to handle Matrix AI stream event") + return EventHandlingResultFailed.WithMSSError(err) + } + return EventHandlingResultSuccess.WithMSS() } func (portal *Portal) sendTypings(ctx context.Context, userIDs []id.UserID, typing bool) { @@ -751,28 +1077,55 @@ func (portal *Portal) periodicTypingUpdater() { } } -func (portal *Portal) checkMessageContentCaps(ctx context.Context, caps *NetworkRoomCapabilities, content *event.MessageEventContent, evt *event.Event) bool { +func (portal *Portal) checkMessageContentCaps(caps *event.RoomFeatures, content *event.MessageEventContent) error { switch content.MsgType { case event.MsgText, event.MsgNotice, event.MsgEmote: // No checks for now, message length is safer to check after conversion inside connector case event.MsgLocation: - if !caps.LocationMessages { - portal.sendErrorStatus(ctx, evt, ErrLocationMessagesNotAllowed) - return false + if caps.LocationMessage.Reject() { + return ErrLocationMessagesNotAllowed } - case event.MsgImage, event.MsgAudio, event.MsgVideo, event.MsgFile: - if content.FileName != "" && content.Body != content.FileName { - if !caps.Captions { - portal.sendErrorStatus(ctx, evt, ErrCaptionsNotAllowed) - return false + case event.MsgImage, event.MsgAudio, event.MsgVideo, event.MsgFile, event.CapMsgSticker: + capMsgType := content.GetCapMsgType() + feat, ok := caps.File[capMsgType] + if !ok { + return ErrUnsupportedMessageType + } + if content.MsgType != event.CapMsgSticker && + content.FileName != "" && + content.Body != content.FileName && + feat.Caption.Reject() { + return ErrCaptionsNotAllowed + } + if content.Info != nil { + dur := time.Duration(content.Info.Duration) * time.Millisecond + if feat.MaxDuration != nil && dur > feat.MaxDuration.Duration { + if capMsgType == event.CapMsgVoice { + return fmt.Errorf("%w: %s supports voice messages up to %s long", ErrVoiceMessageDurationTooLong, portal.Bridge.Network.GetName().DisplayName, exfmt.Duration(feat.MaxDuration.Duration)) + } + return fmt.Errorf("%w: %s is longer than the maximum of %s", ErrMediaDurationTooLong, exfmt.Duration(dur), exfmt.Duration(feat.MaxDuration.Duration)) + } + if feat.MaxSize != 0 && int64(content.Info.Size) > feat.MaxSize { + return fmt.Errorf("%w: %.1f MiB is larger than the maximum of %.1f MiB", ErrMediaTooLarge, float64(content.Info.Size)/1024/1024, float64(feat.MaxSize)/1024/1024) + } + if content.Info.MimeType != "" && feat.GetMimeSupport(content.Info.MimeType).Reject() { + return fmt.Errorf("%w (%s in %s)", ErrUnsupportedMediaType, content.Info.MimeType, capMsgType) } } + fallthrough default: } - return true + return nil } -func (portal *Portal) handleMatrixMessage(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event) { +func (portal *Portal) parseInputTransactionID(origSender *OrigSender, evt *event.Event) networkid.RawTransactionID { + if origSender != nil || !strings.HasPrefix(evt.ID.String(), database.NetworkTxnMXIDPrefix) { + return "" + } + return networkid.RawTransactionID(strings.TrimPrefix(evt.ID.String(), database.NetworkTxnMXIDPrefix)) +} + +func (portal *Portal) handleMatrixMessage(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event) EventHandlingResult { log := zerolog.Ctx(ctx) var relatesTo *event.RelatesTo var msgContent *event.MessageEventContent @@ -788,46 +1141,49 @@ func (portal *Portal) handleMatrixMessage(ctx context.Context, sender *UserLogin } else { msgContent, ok = evt.Content.Parsed.(*event.MessageEventContent) relatesTo = msgContent.RelatesTo + if evt.Type == event.EventSticker { + msgContent.MsgType = event.CapMsgSticker + } + if msgContent.MsgType == event.MsgNotice && !portal.Bridge.Config.BridgeNotices { + return EventHandlingResultIgnored.WithMSSError(ErrIgnoringMNotice) + } } if !ok { log.Error().Type("content_type", evt.Content.Parsed).Msg("Unexpected parsed content type") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) - return + return EventHandlingResultFailed. + WithMSSError(fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) } caps := sender.Client.GetCapabilities(ctx, portal) if relatesTo.GetReplaceID() != "" { if msgContent == nil { log.Warn().Msg("Ignoring edit of poll") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("%w of polls", ErrEditsNotSupported)) - return + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w of polls", ErrEditsNotSupported)) } - portal.handleMatrixEdit(ctx, sender, origSender, evt, msgContent, caps) - return + return portal.handleMatrixEdit(ctx, sender, origSender, evt, msgContent, caps) } var err error if origSender != nil { if msgContent == nil { log.Debug().Msg("Ignoring poll event from relayed user") - portal.sendErrorStatus(ctx, evt, ErrIgnoringPollFromRelayedUser) - return + return EventHandlingResultIgnored.WithMSSError(ErrIgnoringPollFromRelayedUser) } - msgContent, err = portal.Bridge.Config.Relay.FormatMessage(msgContent, origSender) - if err != nil { - log.Err(err).Msg("Failed to format message for relaying") - portal.sendErrorStatus(ctx, evt, err) - return + if !caps.PerMessageProfileRelay { + msgContent, err = portal.Bridge.Config.Relay.FormatMessage(msgContent, origSender) + if err != nil { + log.Err(err).Msg("Failed to format message for relaying") + return EventHandlingResultFailed.WithMSSError(err) + } } } if msgContent != nil { - if !portal.checkMessageContentCaps(ctx, caps, msgContent, evt) { - return + if err = portal.checkMessageContentCaps(caps, msgContent); err != nil { + return EventHandlingResultFailed.WithMSSError(err) } } else if pollResponseContent != nil || pollContent != nil { if _, ok = sender.Client.(PollHandlingNetworkAPI); !ok { log.Debug().Msg("Ignoring poll event as network connector doesn't implement PollHandlingNetworkAPI") - portal.sendErrorStatus(ctx, evt, ErrPollsNotSupported) - return + return EventHandlingResultIgnored.WithMSSError(ErrPollsNotSupported) } } @@ -837,29 +1193,29 @@ func (portal *Portal) handleMatrixMessage(ctx context.Context, sender *UserLogin if err != nil { log.Err(err).Msg("Failed to get poll target message from database") // TODO send status - return + return EventHandlingResultFailed } else if voteTo == nil { log.Warn().Stringer("vote_to_id", relatesTo.GetReferenceID()).Msg("Poll target message not found") // TODO send status - return + return EventHandlingResultFailed } } var replyToID id.EventID - if caps.Threads { + threadRootID := relatesTo.GetThreadParent() + if caps.Thread.Partial() { replyToID = relatesTo.GetNonFallbackReplyTo() + if threadRootID != "" { + threadRoot, err = portal.Bridge.DB.Message.GetPartByMXID(ctx, threadRootID) + if err != nil { + log.Err(err).Msg("Failed to get thread root message from database") + } else if threadRoot == nil { + log.Warn().Stringer("thread_root_id", threadRootID).Msg("Thread root message not found") + } + } } else { replyToID = relatesTo.GetReplyTo() } - threadRootID := relatesTo.GetThreadParent() - if caps.Threads && threadRootID != "" { - threadRoot, err = portal.Bridge.DB.Message.GetPartByMXID(ctx, threadRootID) - if err != nil { - log.Err(err).Msg("Failed to get thread root message from database") - } else if threadRoot == nil { - log.Warn().Stringer("thread_root_id", threadRootID).Msg("Thread root message not found") - } - } - if replyToID != "" && (caps.Replies || caps.Threads) { + if replyToID != "" && (caps.Reply.Partial() || caps.Thread.Partial()) { replyTo, err = portal.Bridge.DB.Message.GetPartByMXID(ctx, replyToID) if err != nil { log.Err(err).Msg("Failed to get reply target message from database") @@ -870,7 +1226,7 @@ func (portal *Portal) handleMatrixMessage(ctx context.Context, sender *UserLogin // The fallback happens if the message is not a Matrix thread and either // * the replied-to message is in a thread, or // * the network only supports threads (assume the user wants to start a new thread) - if caps.Threads && threadRoot == nil && (replyTo.ThreadRoot != "" || !caps.Replies) { + if caps.Thread.Partial() && threadRoot == nil && (replyTo.ThreadRoot != "" || !caps.Reply.Partial()) { threadRootRemoteID := replyTo.ThreadRoot if threadRootRemoteID == "" { threadRootRemoteID = replyTo.ID @@ -880,11 +1236,21 @@ func (portal *Portal) handleMatrixMessage(ctx context.Context, sender *UserLogin log.Err(err).Msg("Failed to get thread root message from database (via reply fallback)") } } - if !caps.Replies { + if !caps.Reply.Partial() { replyTo = nil } } } + var messageTimer *event.BeeperDisappearingTimer + if msgContent != nil { + messageTimer = msgContent.BeeperDisappearingTimer + } + if messageTimer != nil && *portal.Disappear.ToEventContent() != *messageTimer { + log.Warn(). + Any("event_timer", messageTimer). + Any("portal_timer", portal.Disappear.ToEventContent()). + Msg("Mismatching disappearing timer in event") + } wrappedMsgEvt := &MatrixMessage{ MatrixEventBase: MatrixEventBase[*event.MessageEventContent]{ @@ -892,10 +1258,30 @@ func (portal *Portal) handleMatrixMessage(ctx context.Context, sender *UserLogin Content: msgContent, OrigSender: origSender, Portal: portal, + + InputTransactionID: portal.parseInputTransactionID(origSender, evt), }, ThreadRoot: threadRoot, ReplyTo: replyTo, } + if portal.Bridge.Config.DeduplicateMatrixMessages { + if part, err := portal.Bridge.DB.Message.GetPartByTxnID(ctx, portal.Receiver, evt.ID, wrappedMsgEvt.InputTransactionID); err != nil { + log.Err(err).Msg("Failed to check db if message is already sent") + } else if part != nil { + log.Debug(). + Stringer("message_mxid", part.MXID). + Stringer("input_event_id", evt.ID). + Msg("Message already sent, ignoring") + return EventHandlingResultIgnored + } + } + + err = portal.autoAcceptMessageRequest(ctx, evt, sender, origSender, caps) + if err != nil { + log.Warn().Err(err).Msg("Failed to auto-accept message request on message") + // TODO stop processing? + } + var resp *MatrixMessageResponse if msgContent != nil { resp, err = sender.Client.HandleMatrixMessage(ctx, wrappedMsgEvt) @@ -912,16 +1298,18 @@ func (portal *Portal) handleMatrixMessage(ctx context.Context, sender *UserLogin }) } else { log.Error().Msg("Failed to handle Matrix message: all contents are nil?") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("all contents are nil")) - return + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("all contents are nil")) } if err != nil { log.Err(err).Msg("Failed to handle Matrix message") - portal.sendErrorStatus(ctx, evt, err) - return + return EventHandlingResultFailed.WithMSSError(err) } message := wrappedMsgEvt.fillDBMessage(resp.DB) - if !resp.Pending { + if resp.Pending { + for _, save := range wrappedMsgEvt.pendingSaves { + save.ackedAt = time.Now() + } + } else { if resp.DB == nil { log.Error().Msg("Network connector didn't return a message to save") } else { @@ -945,17 +1333,23 @@ func (portal *Portal) handleMatrixMessage(ctx context.Context, sender *UserLogin } portal.sendSuccessStatus(ctx, evt, resp.StreamOrder, message.MXID) } - if portal.Disappear.Type != database.DisappearingTypeNone { + ds := portal.Disappear + if messageTimer != nil { + ds = database.DisappearingSettingFromEvent(messageTimer) + } + if ds.Type != event.DisappearingTypeNone { go portal.Bridge.DisappearLoop.Add(ctx, &database.DisappearingMessage{ - RoomID: portal.MXID, - EventID: message.MXID, - DisappearingSetting: database.DisappearingSetting{ - Type: portal.Disappear.Type, - Timer: portal.Disappear.Timer, - DisappearAt: message.Timestamp.Add(portal.Disappear.Timer), - }, + RoomID: portal.MXID, + EventID: message.MXID, + Timestamp: message.Timestamp, + DisappearingSetting: ds.StartingAt(message.Timestamp), }) } + if resp.Pending { + // Not exactly queued, but not finished either + return EventHandlingResultQueued + } + return EventHandlingResultSuccess.WithEventID(message.MXID).WithStreamOrder(resp.StreamOrder) } // AddPendingToIgnore adds a transaction ID that should be ignored if encountered as a new message. @@ -967,7 +1361,7 @@ func (portal *Portal) handleMatrixMessage(ctx context.Context, sender *UserLogin // See also: [MatrixMessage.AddPendingToSave] func (evt *MatrixMessage) AddPendingToIgnore(txnID networkid.TransactionID) { evt.Portal.outgoingMessagesLock.Lock() - evt.Portal.outgoingMessages[txnID] = outgoingMessage{ + evt.Portal.outgoingMessages[txnID] = &outgoingMessage{ ignore: true, } evt.Portal.outgoingMessagesLock.Unlock() @@ -981,12 +1375,14 @@ func (evt *MatrixMessage) AddPendingToIgnore(txnID networkid.TransactionID) { // // The provided function will be called when the message is encountered. func (evt *MatrixMessage) AddPendingToSave(message *database.Message, txnID networkid.TransactionID, handleEcho RemoteEchoHandler) { - evt.Portal.outgoingMessagesLock.Lock() - evt.Portal.outgoingMessages[txnID] = outgoingMessage{ + pending := &outgoingMessage{ db: evt.fillDBMessage(message), evt: evt.Event, handle: handleEcho, } + evt.Portal.outgoingMessagesLock.Lock() + evt.Portal.outgoingMessages[txnID] = pending + evt.pendingSaves = append(evt.pendingSaves, pending) evt.Portal.outgoingMessagesLock.Unlock() } @@ -994,6 +1390,12 @@ func (evt *MatrixMessage) AddPendingToSave(message *database.Message, txnID netw // This should only be called if sending the message fails. func (evt *MatrixMessage) RemovePending(txnID networkid.TransactionID) { evt.Portal.outgoingMessagesLock.Lock() + pendingSave := evt.Portal.outgoingMessages[txnID] + if pendingSave != nil { + evt.pendingSaves = slices.DeleteFunc(evt.pendingSaves, func(save *outgoingMessage) bool { + return save == pendingSave + }) + } delete(evt.Portal.outgoingMessages, txnID) evt.Portal.outgoingMessagesLock.Unlock() } @@ -1024,10 +1426,49 @@ func (evt *MatrixMessage) fillDBMessage(message *database.Message) *database.Mes if message.SenderMXID == "" { message.SenderMXID = evt.Event.Sender } + if message.SendTxnID != "" { + message.SendTxnID = evt.InputTransactionID + } return message } -func (portal *Portal) handleMatrixEdit(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event, content *event.MessageEventContent, caps *NetworkRoomCapabilities) { +func (portal *Portal) pendingMessageTimeoutLoop(ctx context.Context, cfg *OutgoingTimeoutConfig) { + ticker := time.NewTicker(cfg.CheckInterval) + defer ticker.Stop() + for { + select { + case <-ticker.C: + portal.checkPendingMessages(ctx, cfg) + case <-ctx.Done(): + return + } + } +} + +func (portal *Portal) checkPendingMessages(ctx context.Context, cfg *OutgoingTimeoutConfig) { + portal.outgoingMessagesLock.Lock() + defer portal.outgoingMessagesLock.Unlock() + for _, msg := range portal.outgoingMessages { + if msg.evt != nil && !msg.timeouted { + if cfg.NoEchoTimeout > 0 && !msg.ackedAt.IsZero() && time.Since(msg.ackedAt) > cfg.NoEchoTimeout { + msg.timeouted = true + portal.sendErrorStatus(ctx, msg.evt, ErrRemoteEchoTimeout.WithMessage(cfg.NoEchoMessage)) + } else if cfg.NoAckTimeout > 0 && time.Since(msg.db.Timestamp) > cfg.NoAckTimeout { + msg.timeouted = true + portal.sendErrorStatus(ctx, msg.evt, ErrRemoteAckTimeout.WithMessage(cfg.NoAckMessage)) + } + } + } +} + +func (portal *Portal) handleMatrixEdit( + ctx context.Context, + sender *UserLogin, + origSender *OrigSender, + evt *event.Event, + content *event.MessageEventContent, + caps *event.RoomFeatures, +) EventHandlingResult { log := zerolog.Ctx(ctx) editTargetID := content.RelatesTo.GetReplaceID() log.UpdateContext(func(c zerolog.Context) zerolog.Context { @@ -1035,44 +1476,40 @@ func (portal *Portal) handleMatrixEdit(ctx context.Context, sender *UserLogin, o }) if content.NewContent != nil { content = content.NewContent + if evt.Type == event.EventSticker { + content.MsgType = event.CapMsgSticker + } } if origSender != nil { var err error content, err = portal.Bridge.Config.Relay.FormatMessage(content, origSender) if err != nil { log.Err(err).Msg("Failed to format message for relaying") - portal.sendErrorStatus(ctx, evt, err) - return + return EventHandlingResultFailed.WithMSSError(err) } } editingAPI, ok := sender.Client.(EditHandlingNetworkAPI) if !ok { log.Debug().Msg("Ignoring edit as network connector doesn't implement EditHandlingNetworkAPI") - portal.sendErrorStatus(ctx, evt, ErrEditsNotSupported) - return - } else if !caps.Edits { + return EventHandlingResultIgnored.WithMSSError(ErrEditsNotSupported) + } else if !caps.Edit.Partial() { log.Debug().Msg("Ignoring edit as room doesn't support edits") - portal.sendErrorStatus(ctx, evt, ErrEditsNotSupportedInPortal) - return - } else if !portal.checkMessageContentCaps(ctx, caps, content, evt) { - return + return EventHandlingResultIgnored.WithMSSError(ErrEditsNotSupportedInPortal) + } else if err := portal.checkMessageContentCaps(caps, content); err != nil { + return EventHandlingResultFailed.WithMSSError(err) } editTarget, err := portal.Bridge.DB.Message.GetPartByMXID(ctx, editTargetID) if err != nil { log.Err(err).Msg("Failed to get edit target message from database") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("%w: failed to get edit target: %w", ErrDatabaseError, err)) - return + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: failed to get edit target: %w", ErrDatabaseError, err)) } else if editTarget == nil { log.Warn().Msg("Edit target message not found in database") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("edit %w", ErrTargetMessageNotFound)) - return - } else if caps.EditMaxAge > 0 && time.Since(editTarget.Timestamp) > caps.EditMaxAge { - portal.sendErrorStatus(ctx, evt, ErrEditTargetTooOld) - return + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("edit %w", ErrTargetMessageNotFound)) + } else if caps.EditMaxAge != nil && caps.EditMaxAge.Duration > 0 && time.Since(editTarget.Timestamp) > caps.EditMaxAge.Duration { + return EventHandlingResultFailed.WithMSSError(ErrEditTargetTooOld) } else if caps.EditMaxCount > 0 && editTarget.EditCount >= caps.EditMaxCount { - portal.sendErrorStatus(ctx, evt, ErrEditTargetTooManyEdits) - return + return EventHandlingResultFailed.WithMSSError(ErrEditTargetTooManyEdits) } log.UpdateContext(func(c zerolog.Context) zerolog.Context { return c.Str("edit_target_remote_id", string(editTarget.ID)) @@ -1083,13 +1520,14 @@ func (portal *Portal) handleMatrixEdit(ctx context.Context, sender *UserLogin, o Content: content, OrigSender: origSender, Portal: portal, + + InputTransactionID: portal.parseInputTransactionID(origSender, evt), }, EditTarget: editTarget, }) if err != nil { log.Err(err).Msg("Failed to handle Matrix edit") - portal.sendErrorStatus(ctx, evt, err) - return + return EventHandlingResultFailed.WithMSSError(err) } err = portal.Bridge.DB.Message.Update(ctx, editTarget) if err != nil { @@ -1097,21 +1535,20 @@ func (portal *Portal) handleMatrixEdit(ctx context.Context, sender *UserLogin, o } // TODO allow returning stream order from HandleMatrixEdit portal.sendSuccessStatus(ctx, evt, 0, "") + return EventHandlingResultSuccess } -func (portal *Portal) handleMatrixReaction(ctx context.Context, sender *UserLogin, evt *event.Event) { +func (portal *Portal) handleMatrixReaction(ctx context.Context, sender *UserLogin, evt *event.Event) (handleRes EventHandlingResult) { log := zerolog.Ctx(ctx) reactingAPI, ok := sender.Client.(ReactionHandlingNetworkAPI) if !ok { log.Debug().Msg("Ignoring reaction as network connector doesn't implement ReactionHandlingNetworkAPI") - portal.sendErrorStatus(ctx, evt, ErrReactionsNotSupported) - return + return EventHandlingResultIgnored.WithMSSError(ErrReactionsNotSupported) } content, ok := evt.Content.Parsed.(*event.ReactionEventContent) if !ok { log.Error().Type("content_type", evt.Content.Parsed).Msg("Unexpected parsed content type") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) - return + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) } log.UpdateContext(func(c zerolog.Context) zerolog.Context { return c.Stringer("reaction_target_mxid", content.RelatesTo.EventID) @@ -1119,12 +1556,16 @@ func (portal *Portal) handleMatrixReaction(ctx context.Context, sender *UserLogi reactionTarget, err := portal.Bridge.DB.Message.GetPartByMXID(ctx, content.RelatesTo.EventID) if err != nil { log.Err(err).Msg("Failed to get reaction target message from database") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("%w: failed to get reaction target: %w", ErrDatabaseError, err)) - return + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: failed to get reaction target: %w", ErrDatabaseError, err)) } else if reactionTarget == nil { log.Warn().Msg("Reaction target message not found in database") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("reaction %w", ErrTargetMessageNotFound)) - return + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("reaction %w", ErrTargetMessageNotFound)) + } + caps := sender.Client.GetCapabilities(ctx, portal) + err = portal.autoAcceptMessageRequest(ctx, evt, sender, nil, caps) + if err != nil { + log.Warn().Err(err).Msg("Failed to auto-accept message request on reaction") + // TODO stop processing? } log.UpdateContext(func(c zerolog.Context) zerolog.Context { return c.Str("reaction_target_remote_id", string(reactionTarget.ID)) @@ -1134,42 +1575,64 @@ func (portal *Portal) handleMatrixReaction(ctx context.Context, sender *UserLogi Event: evt, Content: content, Portal: portal, + + InputTransactionID: portal.parseInputTransactionID(nil, evt), }, TargetMessage: reactionTarget, } preResp, err := reactingAPI.PreHandleMatrixReaction(ctx, react) if err != nil { log.Err(err).Msg("Failed to pre-handle Matrix reaction") - portal.sendErrorStatus(ctx, evt, err) - return + return EventHandlingResultFailed.WithMSSError(err) } - existing, err := portal.Bridge.DB.Reaction.GetByID(ctx, reactionTarget.ID, reactionTarget.PartID, preResp.SenderID, preResp.EmojiID) - if err != nil { - log.Err(err).Msg("Failed to check if reaction is a duplicate") - return - } else if existing != nil { - if existing.EmojiID != "" || existing.Emoji == preResp.Emoji { - log.Debug().Msg("Ignoring duplicate reaction") - portal.sendSuccessStatus(ctx, evt, 0, "") + var deterministicID id.EventID + if portal.Bridge.Config.OutgoingMessageReID { + deterministicID = portal.Bridge.Matrix.GenerateReactionEventID(portal.MXID, reactionTarget, preResp.SenderID, preResp.EmojiID) + } + defer func() { + // Do this in a defer so that it happens after any potential defer calls to removeOutdatedReaction + if handleRes.Success { + portal.sendSuccessStatus(ctx, evt, 0, deterministicID) + } + }() + removeOutdatedReaction := func(oldReact *database.Reaction, deleteDB bool) { + if !handleRes.Success { return } - react.ReactionToOverride = existing - _, err = portal.Bridge.Bot.SendMessage(ctx, portal.MXID, event.EventRedaction, &event.Content{ + _, err := portal.Bridge.Bot.SendMessage(ctx, portal.MXID, event.EventRedaction, &event.Content{ Parsed: &event.RedactionEventContent{ - Redacts: existing.MXID, + Redacts: oldReact.MXID, }, }, nil) if err != nil { log.Err(err).Msg("Failed to remove old reaction") } + if deleteDB { + err = portal.Bridge.DB.Reaction.Delete(ctx, oldReact) + if err != nil { + log.Err(err).Msg("Failed to delete old reaction from database") + } + } + } + existing, err := portal.Bridge.DB.Reaction.GetByID(ctx, portal.Receiver, reactionTarget.ID, reactionTarget.PartID, preResp.SenderID, preResp.EmojiID) + if err != nil { + log.Err(err).Msg("Failed to check if reaction is a duplicate") + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: failed to check for existing reaction: %w", ErrDatabaseError, err)) + } else if existing != nil { + if existing.EmojiID != "" || existing.Emoji == preResp.Emoji { + log.Debug().Msg("Ignoring duplicate reaction") + portal.sendSuccessStatus(ctx, evt, 0, deterministicID) + return EventHandlingResultIgnored.WithEventID(deterministicID) + } + react.ReactionToOverride = existing + defer removeOutdatedReaction(existing, false) } react.PreHandleResp = &preResp if preResp.MaxReactions > 0 { - allReactions, err := portal.Bridge.DB.Reaction.GetAllToMessageBySender(ctx, reactionTarget.ID, preResp.SenderID) + allReactions, err := portal.Bridge.DB.Reaction.GetAllToMessageBySender(ctx, portal.Receiver, reactionTarget.ID, preResp.SenderID) if err != nil { log.Err(err).Msg("Failed to get all reactions to message by sender") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("%w: failed to get previous reactions: %w", ErrDatabaseError, err)) - return + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: failed to get previous reactions: %w", ErrDatabaseError, err)) } if len(allReactions) < preResp.MaxReactions { react.ExistingReactionsToKeep = allReactions @@ -1177,26 +1640,21 @@ func (portal *Portal) handleMatrixReaction(ctx context.Context, sender *UserLogi // Keep n-1 previous reactions and remove the rest react.ExistingReactionsToKeep = allReactions[:preResp.MaxReactions-1] for _, oldReaction := range allReactions[preResp.MaxReactions-1:] { - _, err = portal.Bridge.Bot.SendMessage(ctx, portal.MXID, event.EventRedaction, &event.Content{ - Parsed: &event.RedactionEventContent{ - Redacts: oldReaction.MXID, - }, - }, nil) - if err != nil { - log.Err(err).Msg("Failed to remove previous reaction after limit was exceeded") - } - err = portal.Bridge.DB.Reaction.Delete(ctx, oldReaction) - if err != nil { - log.Err(err).Msg("Failed to delete previous reaction from database after limit was exceeded") + if existing != nil && oldReaction.EmojiID == existing.EmojiID { + // Don't double-delete on networks that only allow one emoji + continue } + // Intentionally defer in a loop, there won't be that many items, + // and we want all of them to be done after this function completes successfully + //goland:noinspection GoDeferInLoop + defer removeOutdatedReaction(oldReaction, true) } } } dbReaction, err := reactingAPI.HandleMatrixReaction(ctx, react) if err != nil { log.Err(err).Msg("Failed to handle Matrix reaction") - portal.sendErrorStatus(ctx, evt, err) - return + return EventHandlingResultFailed.WithMSSError(err) } if dbReaction == nil { dbReaction = &database.Reaction{} @@ -1209,7 +1667,9 @@ func (portal *Portal) handleMatrixReaction(ctx context.Context, sender *UserLogi dbReaction.MessageID = reactionTarget.ID dbReaction.MessagePartID = reactionTarget.PartID } - if dbReaction.MXID == "" { + if deterministicID != "" { + dbReaction.MXID = deterministicID + } else if dbReaction.MXID == "" { dbReaction.MXID = evt.ID } if dbReaction.Timestamp.IsZero() { @@ -1232,7 +1692,7 @@ func (portal *Portal) handleMatrixReaction(ctx context.Context, sender *UserLogi if err != nil { log.Err(err).Msg("Failed to save reaction to database") } - portal.sendSuccessStatus(ctx, evt, 0, "") + return EventHandlingResultSuccess.WithEventID(deterministicID) } func handleMatrixRoomMeta[APIType any, ContentType any]( @@ -1241,35 +1701,53 @@ func handleMatrixRoomMeta[APIType any, ContentType any]( sender *UserLogin, origSender *OrigSender, evt *event.Event, + isStateRequest bool, fn func(APIType, context.Context, *MatrixRoomMeta[ContentType]) (bool, error), -) { +) EventHandlingResult { + if evt.StateKey == nil || *evt.StateKey != "" { + return EventHandlingResultFailed.WithMSSError(ErrInvalidStateKey) + } + //caps := sender.Client.GetCapabilities(ctx, portal) + //if stateCap, ok := caps.State[evt.Type.Type]; !ok || stateCap.Level <= event.CapLevelUnsupported { + // return EventHandlingResultIgnored.WithMSSError(fmt.Errorf("%s %w", evt.Type.Type, ErrRoomMetadataNotAllowed)) + //} api, ok := sender.Client.(APIType) if !ok { - portal.sendErrorStatus(ctx, evt, ErrRoomMetadataNotSupported) - return + return EventHandlingResultIgnored.WithMSSError(fmt.Errorf("%w of type %s", ErrRoomMetadataNotSupported, evt.Type)) } log := zerolog.Ctx(ctx) content, ok := evt.Content.Parsed.(ContentType) if !ok { log.Error().Type("content_type", evt.Content.Parsed).Msg("Unexpected parsed content type") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) - return + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) } switch typedContent := evt.Content.Parsed.(type) { case *event.RoomNameEventContent: if typedContent.Name == portal.Name { portal.sendSuccessStatus(ctx, evt, 0, "") - return + return EventHandlingResultIgnored } case *event.TopicEventContent: if typedContent.Topic == portal.Topic { portal.sendSuccessStatus(ctx, evt, 0, "") - return + return EventHandlingResultIgnored } case *event.RoomAvatarEventContent: if typedContent.URL == portal.AvatarMXC { portal.sendSuccessStatus(ctx, evt, 0, "") - return + return EventHandlingResultIgnored + } + case *event.BeeperDisappearingTimer: + if typedContent.Type == event.DisappearingTypeNone || typedContent.Timer.Duration <= 0 { + typedContent.Type = event.DisappearingTypeNone + typedContent.Timer.Duration = 0 + } + if typedContent.Type == portal.Disappear.Type && typedContent.Timer.Duration == portal.Disappear.Timer { + portal.sendSuccessStatus(ctx, evt, 0, "") + return EventHandlingResultIgnored + } + if !sender.Client.GetCapabilities(ctx, portal).DisappearingTimer.Supports(typedContent) { + return EventHandlingResultFailed.WithMSSError(ErrDisappearingTimerUnsupported) } } var prevContent ContentType @@ -1284,37 +1762,41 @@ func handleMatrixRoomMeta[APIType any, ContentType any]( Content: content, Portal: portal, OrigSender: origSender, + + InputTransactionID: portal.parseInputTransactionID(origSender, evt), }, - PrevContent: prevContent, + IsStateRequest: isStateRequest, + PrevContent: prevContent, }) if err != nil { log.Err(err).Msg("Failed to handle Matrix room metadata") - portal.sendErrorStatus(ctx, evt, err) - return + return EventHandlingResultFailed.WithMSSError(err) } if changed { - portal.UpdateBridgeInfo(ctx) + if evt.Type != event.StateBeeperDisappearingTimer { + portal.UpdateBridgeInfo(ctx) + } err = portal.Save(ctx) if err != nil { log.Err(err).Msg("Failed to save portal after updating room metadata") } } - portal.sendSuccessStatus(ctx, evt, 0, "") + return EventHandlingResultSuccess.WithMSS() } func handleMatrixAccountData[APIType any, ContentType any]( portal *Portal, ctx context.Context, sender *UserLogin, evt *event.Event, fn func(APIType, context.Context, *MatrixRoomMeta[ContentType]) error, -) { +) EventHandlingResult { api, ok := sender.Client.(APIType) if !ok { - return + return EventHandlingResultIgnored } log := zerolog.Ctx(ctx) content, ok := evt.Content.Parsed.(ContentType) if !ok { log.Error().Type("content_type", evt.Content.Parsed).Msg("Unexpected parsed content type") - return + return EventHandlingResultFailed.WithError(fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) } var prevContent ContentType if evt.Unsigned.PrevContent != nil { @@ -1332,7 +1814,9 @@ func handleMatrixAccountData[APIType any, ContentType any]( }) if err != nil { log.Err(err).Msg("Failed to handle Matrix room account data") + return EventHandlingResultFailed.WithError(err) } + return EventHandlingResultSuccess } func (portal *Portal) getTargetUser(ctx context.Context, userID id.UserID) (GhostOrUserLogin, error) { @@ -1352,18 +1836,144 @@ func (portal *Portal) getTargetUser(ctx context.Context, userID id.UserID) (Ghos } } +func (portal *Portal) handleMatrixAcceptMessageRequest( + ctx context.Context, + sender *UserLogin, + origSender *OrigSender, + evt *event.Event, +) EventHandlingResult { + if origSender != nil { + return EventHandlingResultFailed.WithMSSError(ErrIgnoringAcceptRequestRelayedUser) + } + log := zerolog.Ctx(ctx) + content, ok := evt.Content.Parsed.(*event.BeeperAcceptMessageRequestEventContent) + if !ok { + log.Error().Type("content_type", evt.Content.Parsed).Msg("Unexpected parsed content type") + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) + } + api, ok := sender.Client.(MessageRequestAcceptingNetworkAPI) + if !ok { + return EventHandlingResultIgnored.WithMSSError(ErrDeleteChatNotSupported) + } + err := api.HandleMatrixAcceptMessageRequest(ctx, &MatrixAcceptMessageRequest{ + Event: evt, + Content: content, + Portal: portal, + }) + if err != nil { + log.Err(err).Msg("Failed to handle Matrix accept message request") + return EventHandlingResultFailed.WithMSSError(err) + } + if portal.MessageRequest { + portal.MessageRequest = false + portal.UpdateBridgeInfo(ctx) + err = portal.Save(ctx) + if err != nil { + log.Err(err).Msg("Failed to save portal after accepting message request") + } + } + return EventHandlingResultSuccess.WithMSS() +} + +func (portal *Portal) autoAcceptMessageRequest( + ctx context.Context, evt *event.Event, sender *UserLogin, origSender *OrigSender, caps *event.RoomFeatures, +) error { + if !portal.MessageRequest || caps.MessageRequest == nil || caps.MessageRequest.AcceptWithMessage == event.CapLevelFullySupported { + return nil + } + mran, ok := sender.Client.(MessageRequestAcceptingNetworkAPI) + if !ok { + return nil + } + err := mran.HandleMatrixAcceptMessageRequest(ctx, &MatrixAcceptMessageRequest{ + Event: evt, + Content: &event.BeeperAcceptMessageRequestEventContent{ + IsImplicit: true, + }, + Portal: portal, + OrigSender: origSender, + }) + if err != nil { + return err + } + if portal.MessageRequest { + portal.MessageRequest = false + portal.UpdateBridgeInfo(ctx) + err = portal.Save(ctx) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to save portal after accepting message request") + } + } + return nil +} + +func (portal *Portal) handleMatrixDeleteChat( + ctx context.Context, + sender *UserLogin, + origSender *OrigSender, + evt *event.Event, +) EventHandlingResult { + if origSender != nil { + return EventHandlingResultFailed.WithMSSError(ErrIgnoringDeleteChatRelayedUser) + } + log := zerolog.Ctx(ctx) + content, ok := evt.Content.Parsed.(*event.BeeperChatDeleteEventContent) + if !ok { + log.Error().Type("content_type", evt.Content.Parsed).Msg("Unexpected parsed content type") + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) + } + api, ok := sender.Client.(DeleteChatHandlingNetworkAPI) + if !ok { + return EventHandlingResultIgnored.WithMSSError(ErrDeleteChatNotSupported) + } + err := api.HandleMatrixDeleteChat(ctx, &MatrixDeleteChat{ + Event: evt, + Content: content, + Portal: portal, + }) + if err != nil { + log.Err(err).Msg("Failed to handle Matrix chat delete") + return EventHandlingResultFailed.WithMSSError(err) + } + if portal.Receiver == "" { + _, others, err := portal.findOtherLogins(ctx, sender) + if err != nil { + log.Err(err).Msg("Failed to check if portal has other logins") + return EventHandlingResultFailed.WithError(err) + } else if len(others) > 0 { + log.Debug().Msg("Not deleting portal after chat delete as other logins are present") + return EventHandlingResultSuccess + } + } + err = portal.Delete(ctx) + if err != nil { + log.Err(err).Msg("Failed to delete portal from database") + return EventHandlingResultFailed.WithMSSError(err) + } + err = portal.Bridge.Bot.DeleteRoom(ctx, portal.MXID, false) + if err != nil { + log.Err(err).Msg("Failed to delete Matrix room") + return EventHandlingResultFailed.WithMSSError(err) + } + // No MSS here as the portal was deleted + return EventHandlingResultSuccess +} + func (portal *Portal) handleMatrixMembership( ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event, -) { + isStateRequest bool, +) EventHandlingResult { + if evt.StateKey == nil { + return EventHandlingResultFailed.WithMSSError(ErrInvalidStateKey) + } log := zerolog.Ctx(ctx) content, ok := evt.Content.Parsed.(*event.MemberEventContent) if !ok { log.Error().Type("content_type", evt.Content.Parsed).Msg("Unexpected parsed content type") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) - return + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) } prevContent := &event.MemberEventContent{Membership: event.MembershipLeave} if evt.Unsigned.PrevContent != nil { @@ -1378,26 +1988,22 @@ func (portal *Portal) handleMatrixMembership( }) api, ok := sender.Client.(MembershipHandlingNetworkAPI) if !ok { - portal.sendErrorStatus(ctx, evt, ErrMembershipNotSupported) - return + return EventHandlingResultIgnored.WithMSSError(ErrMembershipNotSupported) } targetMXID := id.UserID(*evt.StateKey) isSelf := sender.User.MXID == targetMXID target, err := portal.getTargetUser(ctx, targetMXID) if err != nil { log.Err(err).Msg("Failed to get member event target") - portal.sendErrorStatus(ctx, evt, err) - return + return EventHandlingResultFailed.WithMSSError(err) } membershipChangeType := MembershipChangeType{From: prevContent.Membership, To: content.Membership, IsSelf: isSelf} if !portal.Bridge.Config.BridgeMatrixLeave && membershipChangeType == Leave { log.Debug().Msg("Dropping leave event") - //portal.sendErrorStatus(ctx, evt, ErrIgnoringLeaveEvent) - return + return EventHandlingResultIgnored //.WithMSSError(ErrIgnoringLeaveEvent) } targetGhost, _ := target.(*Ghost) - targetUserLogin, _ := target.(*UserLogin) membershipChange := &MatrixMembershipChange{ MatrixRoomMeta: MatrixRoomMeta[*event.MemberEventContent]{ MatrixEventBase: MatrixEventBase[*event.MemberEventContent]{ @@ -1405,20 +2011,63 @@ func (portal *Portal) handleMatrixMembership( Content: content, Portal: portal, OrigSender: origSender, + + InputTransactionID: portal.parseInputTransactionID(origSender, evt), }, - PrevContent: prevContent, + IsStateRequest: isStateRequest, + PrevContent: prevContent, }, - Target: target, - TargetGhost: targetGhost, - TargetUserLogin: targetUserLogin, - Type: membershipChangeType, + Target: target, + Type: membershipChangeType, } - _, err = api.HandleMatrixMembership(ctx, membershipChange) + res, err := api.HandleMatrixMembership(ctx, membershipChange) if err != nil { log.Err(err).Msg("Failed to handle Matrix membership change") - portal.sendErrorStatus(ctx, evt, err) - return + return EventHandlingResultFailed.WithMSSError(err) } + didRedirectInvite := membershipChangeType == Invite && + targetGhost != nil && + res != nil && + res.RedirectTo != "" && + res.RedirectTo != targetGhost.ID + if didRedirectInvite { + log.Debug(). + Str("orig_id", string(targetGhost.ID)). + Str("redirect_id", string(res.RedirectTo)). + Msg("Invite was redirected to different ghost") + var redirectGhost *Ghost + redirectGhost, err = portal.Bridge.GetGhostByID(ctx, res.RedirectTo) + if err != nil { + log.Err(err).Msg("Failed to get redirect target ghost") + return EventHandlingResultFailed.WithError(err) + } + if !isStateRequest { + portal.sendRoomMeta( + ctx, + sender.User.DoublePuppet(ctx), + time.UnixMilli(evt.Timestamp), + event.StateMember, + evt.GetStateKey(), + &event.MemberEventContent{ + Membership: event.MembershipLeave, + Reason: fmt.Sprintf("Invite redirected to %s", res.RedirectTo), + }, + true, + nil, + ) + } + portal.sendRoomMeta( + ctx, + sender.User.DoublePuppet(ctx), + time.UnixMilli(evt.Timestamp), + event.StateMember, + redirectGhost.Intent.GetMXID().String(), + content, + false, + nil, + ) + } + return EventHandlingResultSuccess.WithMSS().WithSkipStateEcho(didRedirectInvite) } func makePLChange(old, new int, newIsSet bool) *SinglePowerLevelChange { @@ -1443,23 +2092,36 @@ func (portal *Portal) handleMatrixPowerLevels( sender *UserLogin, origSender *OrigSender, evt *event.Event, -) { + isStateRequest bool, +) EventHandlingResult { + if evt.StateKey == nil || *evt.StateKey != "" { + return EventHandlingResultFailed.WithMSSError(ErrInvalidStateKey) + } log := zerolog.Ctx(ctx) content, ok := evt.Content.Parsed.(*event.PowerLevelsEventContent) if !ok { log.Error().Type("content_type", evt.Content.Parsed).Msg("Unexpected parsed content type") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) - return + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) + } + if content.CreateEvent == nil { + ars, ok := portal.Bridge.Matrix.(MatrixConnectorWithArbitraryRoomState) + if ok { + var err error + content.CreateEvent, err = ars.GetStateEvent(ctx, portal.MXID, event.StateCreate, "") + if err != nil { + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("failed to get create event for power levels: %w", err)) + } + } } api, ok := sender.Client.(PowerLevelHandlingNetworkAPI) if !ok { - portal.sendErrorStatus(ctx, evt, ErrPowerLevelsNotSupported) - return + return EventHandlingResultIgnored.WithMSSError(ErrPowerLevelsNotSupported) } prevContent := &event.PowerLevelsEventContent{} if evt.Unsigned.PrevContent != nil { _ = evt.Unsigned.PrevContent.ParseRaw(evt.Type) prevContent, _ = evt.Unsigned.PrevContent.Parsed.(*event.PowerLevelsEventContent) + prevContent.CreateEvent = content.CreateEvent } plChange := &MatrixPowerLevelChange{ @@ -1469,8 +2131,11 @@ func (portal *Portal) handleMatrixPowerLevels( Content: content, Portal: portal, OrigSender: origSender, + + InputTransactionID: portal.parseInputTransactionID(origSender, evt), }, - PrevContent: prevContent, + IsStateRequest: isStateRequest, + PrevContent: prevContent, }, Users: make(map[id.UserID]*UserPowerLevelChange), Events: make(map[string]*SinglePowerLevelChange), @@ -1511,18 +2176,269 @@ func (portal *Portal) handleMatrixPowerLevels( _, err := api.HandleMatrixPowerLevels(ctx, plChange) if err != nil { log.Err(err).Msg("Failed to handle Matrix power level change") - portal.sendErrorStatus(ctx, evt, err) - return + return EventHandlingResultFailed.WithMSSError(err) } + return EventHandlingResultSuccess.WithMSS() } -func (portal *Portal) handleMatrixRedaction(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event) { +func (portal *Portal) handleMatrixTombstone(ctx context.Context, evt *event.Event) EventHandlingResult { + if evt.StateKey == nil || *evt.StateKey != "" || portal.MXID != evt.RoomID { + return EventHandlingResultIgnored + } + log := *zerolog.Ctx(ctx) + sentByBridge := evt.Sender == portal.Bridge.Bot.GetMXID() || portal.Bridge.IsGhostMXID(evt.Sender) + var senderUser *User + var err error + if !sentByBridge { + senderUser, err = portal.Bridge.GetUserByMXID(ctx, evt.Sender) + if err != nil { + log.Err(err).Msg("Failed to get tombstone sender user") + return EventHandlingResultFailed.WithError(err) + } + } + content, ok := evt.Content.Parsed.(*event.TombstoneEventContent) + if !ok { + log.Error().Type("content_type", evt.Content.Parsed).Msg("Unexpected parsed content type") + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) + } + log = log.With(). + Stringer("replacement_room", content.ReplacementRoom). + Logger() + if content.ReplacementRoom == "" { + log.Info().Msg("Received tombstone with no replacement room, cleaning up portal") + err := portal.RemoveMXID(ctx) + if err != nil { + log.Err(err).Msg("Failed to remove portal MXID") + return EventHandlingResultFailed.WithMSSError(err) + } + err = portal.Bridge.Bot.DeleteRoom(ctx, portal.MXID, true) + if err != nil { + log.Err(err).Msg("Failed to clean up Matrix room") + return EventHandlingResultFailed.WithError(err) + } + return EventHandlingResultSuccess + } + existingMemberEvt, err := portal.Bridge.Matrix.GetMemberInfo(ctx, content.ReplacementRoom, portal.Bridge.Bot.GetMXID()) + if err != nil { + log.Err(err).Msg("Failed to get member info of bot in replacement room") + return EventHandlingResultFailed.WithError(err) + } + leaveOnError := func() { + if existingMemberEvt != nil && existingMemberEvt.Membership == event.MembershipJoin { + return + } + log.Debug().Msg("Leaving replacement room with bot after tombstone validation failed") + _, err = portal.Bridge.Bot.SendState( + ctx, + content.ReplacementRoom, + event.StateMember, + portal.Bridge.Bot.GetMXID().String(), + &event.Content{ + Parsed: &event.MemberEventContent{ + Membership: event.MembershipLeave, + Reason: fmt.Sprintf("Failed to validate tombstone sent by %s from %s", evt.Sender, evt.RoomID), + }, + }, + time.Time{}, + ) + if err != nil { + log.Err(err).Msg("Failed to leave replacement room after tombstone validation failed") + } + } + var via []string + if senderHS := evt.Sender.Homeserver(); senderHS != "" { + via = []string{senderHS} + } + err = portal.Bridge.Bot.EnsureJoined(ctx, content.ReplacementRoom, EnsureJoinedParams{Via: via}) + if err != nil { + log.Err(err).Msg("Failed to join replacement room from tombstone") + return EventHandlingResultFailed.WithError(err) + } + if !sentByBridge && !senderUser.Permissions.Admin { + powers, err := portal.Bridge.Matrix.GetPowerLevels(ctx, content.ReplacementRoom) + if err != nil { + log.Err(err).Msg("Failed to get power levels in replacement room") + leaveOnError() + return EventHandlingResultFailed.WithError(err) + } + if powers.GetUserLevel(evt.Sender) < powers.Invite() { + log.Warn().Msg("Tombstone sender doesn't have enough power to invite the bot to the replacement room") + leaveOnError() + return EventHandlingResultIgnored + } + } + err = portal.UpdateMatrixRoomID(ctx, content.ReplacementRoom, UpdateMatrixRoomIDParams{ + DeleteOldRoom: true, + FetchInfoVia: senderUser, + }) + if errors.Is(err, ErrTargetRoomIsPortal) { + return EventHandlingResultIgnored + } else if err != nil { + return EventHandlingResultFailed.WithError(err) + } + return EventHandlingResultSuccess +} + +var ErrTargetRoomIsPortal = errors.New("target room is already a portal") +var ErrRoomAlreadyExists = errors.New("this portal already has a room") + +type UpdateMatrixRoomIDParams struct { + SyncDBMetadata func() + FailIfMXIDSet bool + OverwriteOldPortal bool + TombstoneOldRoom bool + DeleteOldRoom bool + + RoomCreateAlreadyLocked bool + + FetchInfoVia *User + ChatInfo *ChatInfo + ChatInfoSource *UserLogin +} + +func (portal *Portal) UpdateMatrixRoomID( + ctx context.Context, + newRoomID id.RoomID, + params UpdateMatrixRoomIDParams, +) error { + if !params.RoomCreateAlreadyLocked { + portal.roomCreateLock.Lock() + defer portal.roomCreateLock.Unlock() + } + oldRoom := portal.MXID + if oldRoom == newRoomID { + return nil + } else if oldRoom != "" && params.FailIfMXIDSet { + return ErrRoomAlreadyExists + } + log := zerolog.Ctx(ctx) + portal.Bridge.cacheLock.Lock() + // Wrap unlock in a sync.OnceFunc because we want to both defer it to catch early returns + // and unlock it before return if nothing goes wrong. + unlockCacheLock := sync.OnceFunc(portal.Bridge.cacheLock.Unlock) + defer unlockCacheLock() + if existingPortal, alreadyExists := portal.Bridge.portalsByMXID[newRoomID]; alreadyExists && !params.OverwriteOldPortal { + log.Warn().Msg("Replacement room is already a portal, ignoring") + return ErrTargetRoomIsPortal + } else if alreadyExists { + log.Debug().Msg("Replacement room is already a portal, overwriting") + existingPortal.MXID = "" + existingPortal.RoomCreated.Clear() + err := existingPortal.Save(ctx) + if err != nil { + return fmt.Errorf("failed to clear mxid of existing portal: %w", err) + } + delete(portal.Bridge.portalsByMXID, portal.MXID) + } + portal.MXID = newRoomID + portal.RoomCreated.Set() + portal.Bridge.portalsByMXID[portal.MXID] = portal + portal.NameSet = false + portal.AvatarSet = false + portal.TopicSet = false + portal.InSpace = false + portal.CapState = database.CapabilityState{} + portal.lastCapUpdate = time.Time{} + if params.SyncDBMetadata != nil { + params.SyncDBMetadata() + } + unlockCacheLock() + portal.updateLogger() + + err := portal.Save(ctx) + if err != nil { + log.Err(err).Msg("Failed to save portal in UpdateMatrixRoomID") + return err + } + log.Info().Msg("Successfully followed tombstone and updated portal MXID") + err = portal.Bridge.DB.UserPortal.MarkAllNotInSpace(ctx, portal.PortalKey) + if err != nil { + log.Err(err).Msg("Failed to update in_space flag for user portals after updating portal MXID") + } + go portal.addToUserSpaces(ctx) + if params.FetchInfoVia != nil { + go portal.updateInfoAfterTombstone(ctx, params.FetchInfoVia) + } else if params.ChatInfo != nil { + go portal.UpdateInfo(ctx, params.ChatInfo, params.ChatInfoSource, nil, time.Time{}) + } else if params.ChatInfoSource != nil { + portal.UpdateCapabilities(ctx, params.ChatInfoSource, true) + portal.UpdateBridgeInfo(ctx) + } + go func() { + // TODO this might become unnecessary if UpdateInfo starts taking care of it + _, err = portal.Bridge.Bot.SendState(ctx, portal.MXID, event.StateElementFunctionalMembers, "", &event.Content{ + Parsed: &event.ElementFunctionalMembersContent{ + ServiceMembers: []id.UserID{portal.Bridge.Bot.GetMXID()}, + }, + }, time.Time{}) + if err != nil { + if err != nil { + log.Warn().Err(err).Msg("Failed to set service members in new room") + } + } + }() + if params.TombstoneOldRoom && oldRoom != "" { + _, err = portal.Bridge.Bot.SendState(ctx, portal.MXID, event.StateTombstone, "", &event.Content{ + Parsed: &event.TombstoneEventContent{ + Body: "Room has been replaced.", + ReplacementRoom: newRoomID, + }, + }, time.Now()) + if err != nil { + log.Err(err).Msg("Failed to send tombstone event to old room") + } + } + if params.DeleteOldRoom && oldRoom != "" { + go func() { + err = portal.Bridge.Bot.DeleteRoom(ctx, oldRoom, true) + if err != nil { + log.Err(err).Msg("Failed to clean up old Matrix room after updating portal MXID") + } + }() + } + return nil +} + +func (portal *Portal) updateInfoAfterTombstone(ctx context.Context, senderUser *User) { + log := zerolog.Ctx(ctx) + logins, err := portal.Bridge.GetUserLoginsInPortal(ctx, portal.PortalKey) + if err != nil { + log.Err(err).Msg("Failed to get user logins in portal to sync info") + return + } + var preferredLogin *UserLogin + for _, login := range logins { + if !login.Client.IsLoggedIn() { + continue + } else if preferredLogin == nil { + preferredLogin = login + } else if senderUser != nil && login.User == senderUser { + preferredLogin = login + } + } + if preferredLogin == nil { + log.Warn().Msg("No logins found to sync info") + return + } + info, err := preferredLogin.Client.GetChatInfo(ctx, portal) + if err != nil { + log.Err(err).Msg("Failed to get chat info") + return + } + log.Info(). + Str("info_source_login", string(preferredLogin.ID)). + Msg("Fetched info to update portal after tombstone") + portal.UpdateInfo(ctx, info, preferredLogin, nil, time.Time{}) +} + +func (portal *Portal) handleMatrixRedaction( + ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event, +) EventHandlingResult { log := zerolog.Ctx(ctx) content, ok := evt.Content.Parsed.(*event.RedactionEventContent) if !ok { log.Error().Type("content_type", evt.Content.Parsed).Msg("Unexpected parsed content type") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) - return + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) } if evt.Redacts != "" && content.Redacts != evt.Redacts { content.Redacts = evt.Redacts @@ -1534,20 +2450,17 @@ func (portal *Portal) handleMatrixRedaction(ctx context.Context, sender *UserLog reactingAPI, reactOK := sender.Client.(ReactionHandlingNetworkAPI) if !deleteOK && !reactOK { log.Debug().Msg("Ignoring redaction without checking target as network connector doesn't implement RedactionHandlingNetworkAPI nor ReactionHandlingNetworkAPI") - portal.sendErrorStatus(ctx, evt, ErrRedactionsNotSupported) - return + return EventHandlingResultIgnored.WithMSSError(ErrRedactionsNotSupported) } var redactionTargetReaction *database.Reaction redactionTargetMsg, err := portal.Bridge.DB.Message.GetPartByMXID(ctx, content.Redacts) if err != nil { log.Err(err).Msg("Failed to get redaction target message from database") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("%w: failed to get redaction target message: %w", ErrDatabaseError, err)) - return + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: failed to get redaction target message: %w", ErrDatabaseError, err)) } else if redactionTargetMsg != nil { if !deleteOK { log.Debug().Msg("Ignoring message redaction event as network connector doesn't implement RedactionHandlingNetworkAPI") - portal.sendErrorStatus(ctx, evt, ErrRedactionsNotSupported) - return + return EventHandlingResultIgnored.WithMSSError(ErrRedactionsNotSupported) } err = deletingAPI.HandleMatrixMessageRemove(ctx, &MatrixMessageRemove{ MatrixEventBase: MatrixEventBase[*event.RedactionEventContent]{ @@ -1555,18 +2468,18 @@ func (portal *Portal) handleMatrixRedaction(ctx context.Context, sender *UserLog Content: content, Portal: portal, OrigSender: origSender, + + InputTransactionID: portal.parseInputTransactionID(origSender, evt), }, TargetMessage: redactionTargetMsg, }) } else if redactionTargetReaction, err = portal.Bridge.DB.Reaction.GetByMXID(ctx, content.Redacts); err != nil { log.Err(err).Msg("Failed to get redaction target reaction from database") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("%w: failed to get redaction target message reaction: %w", ErrDatabaseError, err)) - return + return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: failed to get redaction target message reaction: %w", ErrDatabaseError, err)) } else if redactionTargetReaction != nil { if !reactOK { log.Debug().Msg("Ignoring reaction redaction event as network connector doesn't implement ReactionHandlingNetworkAPI") - portal.sendErrorStatus(ctx, evt, ErrReactionsNotSupported) - return + return EventHandlingResultIgnored.WithMSSError(ErrReactionsNotSupported) } // TODO ignore if sender doesn't match? err = reactingAPI.HandleMatrixReactionRemove(ctx, &MatrixReactionRemove{ @@ -1575,30 +2488,30 @@ func (portal *Portal) handleMatrixRedaction(ctx context.Context, sender *UserLog Content: content, Portal: portal, OrigSender: origSender, + + InputTransactionID: portal.parseInputTransactionID(origSender, evt), }, TargetReaction: redactionTargetReaction, }) } else { log.Debug().Msg("Redaction target message not found in database") - portal.sendErrorStatus(ctx, evt, fmt.Errorf("redaction %w", ErrTargetMessageNotFound)) - return + return EventHandlingResultIgnored.WithMSSError(fmt.Errorf("redaction %w", ErrTargetMessageNotFound)) } if err != nil { log.Err(err).Msg("Failed to handle Matrix redaction") - portal.sendErrorStatus(ctx, evt, err) - return + return EventHandlingResultFailed.WithMSSError(err) } // TODO delete msg/reaction db row - portal.sendSuccessStatus(ctx, evt, 0, "") + return EventHandlingResultSuccess.WithMSS() } -func (portal *Portal) handleRemoteEvent(ctx context.Context, source *UserLogin, evtType RemoteEventType, evt RemoteEvent) { +func (portal *Portal) handleRemoteEvent(ctx context.Context, source *UserLogin, evtType RemoteEventType, evt RemoteEvent) (res EventHandlingResult) { log := zerolog.Ctx(ctx) if portal.MXID == "" { mcp, ok := evt.(RemoteEventThatMayCreatePortal) if !ok || !mcp.ShouldCreatePortal() { log.Debug().Msg("Dropping event as portal doesn't exist") - return + return EventHandlingResultIgnored } infoProvider, ok := mcp.(RemoteChatResyncWithInfo) var info *ChatInfo @@ -1617,12 +2530,15 @@ func (portal *Portal) handleRemoteEvent(ctx context.Context, source *UserLogin, err = portal.createMatrixRoomInLoop(ctx, source, info, bundle) if err != nil { log.Err(err).Msg("Failed to create portal to handle event") - // TODO error - return + return EventHandlingResultFailed.WithError(err) } if evtType == RemoteEventChatResync { log.Debug().Msg("Not handling chat resync event further as portal was created by it") - return + postHandler, ok := evt.(RemotePostHandler) + if ok { + postHandler.PostHandle(ctx, portal) + } + return EventHandlingResultSuccess } } preHandler, ok := evt.(RemotePreHandler) @@ -1633,34 +2549,35 @@ func (portal *Portal) handleRemoteEvent(ctx context.Context, source *UserLogin, switch evtType { case RemoteEventUnknown: log.Debug().Msg("Ignoring remote event with type unknown") + res = EventHandlingResultIgnored case RemoteEventMessage, RemoteEventMessageUpsert: - portal.handleRemoteMessage(ctx, source, evt.(RemoteMessage)) + res = portal.handleRemoteMessage(ctx, source, evt.(RemoteMessage)) case RemoteEventEdit: - portal.handleRemoteEdit(ctx, source, evt.(RemoteEdit)) + res = portal.handleRemoteEdit(ctx, source, evt.(RemoteEdit)) case RemoteEventReaction: - portal.handleRemoteReaction(ctx, source, evt.(RemoteReaction)) + res = portal.handleRemoteReaction(ctx, source, evt.(RemoteReaction)) case RemoteEventReactionRemove: - portal.handleRemoteReactionRemove(ctx, source, evt.(RemoteReactionRemove)) + res = portal.handleRemoteReactionRemove(ctx, source, evt.(RemoteReactionRemove)) case RemoteEventReactionSync: - portal.handleRemoteReactionSync(ctx, source, evt.(RemoteReactionSync)) + res = portal.handleRemoteReactionSync(ctx, source, evt.(RemoteReactionSync)) case RemoteEventMessageRemove: - portal.handleRemoteMessageRemove(ctx, source, evt.(RemoteMessageRemove)) + res = portal.handleRemoteMessageRemove(ctx, source, evt.(RemoteMessageRemove)) case RemoteEventReadReceipt: - portal.handleRemoteReadReceipt(ctx, source, evt.(RemoteReadReceipt)) + res = portal.handleRemoteReadReceipt(ctx, source, evt.(RemoteReadReceipt)) case RemoteEventMarkUnread: - portal.handleRemoteMarkUnread(ctx, source, evt.(RemoteMarkUnread)) + res = portal.handleRemoteMarkUnread(ctx, source, evt.(RemoteMarkUnread)) case RemoteEventDeliveryReceipt: - portal.handleRemoteDeliveryReceipt(ctx, source, evt.(RemoteDeliveryReceipt)) + res = portal.handleRemoteDeliveryReceipt(ctx, source, evt.(RemoteDeliveryReceipt)) case RemoteEventTyping: - portal.handleRemoteTyping(ctx, source, evt.(RemoteTyping)) + res = portal.handleRemoteTyping(ctx, source, evt.(RemoteTyping)) case RemoteEventChatInfoChange: - portal.handleRemoteChatInfoChange(ctx, source, evt.(RemoteChatInfoChange)) + res = portal.handleRemoteChatInfoChange(ctx, source, evt.(RemoteChatInfoChange)) case RemoteEventChatResync: - portal.handleRemoteChatResync(ctx, source, evt.(RemoteChatResync)) + res = portal.handleRemoteChatResync(ctx, source, evt.(RemoteChatResync)) case RemoteEventChatDelete: - portal.handleRemoteChatDelete(ctx, source, evt.(RemoteChatDelete)) + res = portal.handleRemoteChatDelete(ctx, source, evt.(RemoteChatDelete)) case RemoteEventBackfill: - portal.handleRemoteBackfill(ctx, source, evt.(RemoteBackfill)) + res = portal.handleRemoteBackfill(ctx, source, evt.(RemoteBackfill)) default: log.Warn().Msg("Got remote event with unknown type") } @@ -1668,26 +2585,73 @@ func (portal *Portal) handleRemoteEvent(ctx context.Context, source *UserLogin, if ok { postHandler.PostHandle(ctx, portal) } + return } -func (portal *Portal) getIntentAndUserMXIDFor(ctx context.Context, sender EventSender, source *UserLogin, otherLogins []*UserLogin, evtType RemoteEventType) (intent MatrixAPI, extraUserID id.UserID) { +func (portal *Portal) ensureFunctionalMember(ctx context.Context, ghost *Ghost) { + if !ghost.IsBot || portal.RoomType != database.RoomTypeDM || portal.OtherUserID == ghost.ID || portal.MXID == "" { + return + } + ars, ok := portal.Bridge.Matrix.(MatrixConnectorWithArbitraryRoomState) + if !ok { + return + } + portal.functionalMembersLock.Lock() + defer portal.functionalMembersLock.Unlock() + var functionalMembers *event.ElementFunctionalMembersContent + if portal.functionalMembersCache != nil { + functionalMembers = portal.functionalMembersCache + } else { + evt, err := ars.GetStateEvent(ctx, portal.MXID, event.StateElementFunctionalMembers, "") + if err != nil && !errors.Is(err, mautrix.MNotFound) { + zerolog.Ctx(ctx).Err(err).Msg("Failed to get functional members state event") + return + } + functionalMembers = &event.ElementFunctionalMembersContent{} + if evt != nil { + evtContent, ok := evt.Content.Parsed.(*event.ElementFunctionalMembersContent) + if ok && evtContent != nil { + functionalMembers = evtContent + } + } + } + // TODO what about non-double-puppeted user ghosts? + functionalMembers.Add(portal.Bridge.Bot.GetMXID()) + if functionalMembers.Add(ghost.Intent.GetMXID()) { + _, err := portal.Bridge.Bot.SendState(ctx, portal.MXID, event.StateElementFunctionalMembers, "", &event.Content{ + Parsed: functionalMembers, + }, time.Time{}) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to update functional members state event") + return + } + } +} + +func (portal *Portal) getIntentAndUserMXIDFor(ctx context.Context, sender EventSender, source *UserLogin, otherLogins []*UserLogin, evtType RemoteEventType) (intent MatrixAPI, extraUserID id.UserID, err error) { var ghost *Ghost if !sender.IsFromMe && sender.ForceDMUser && portal.OtherUserID != "" && sender.Sender != portal.OtherUserID { zerolog.Ctx(ctx).Warn(). Str("original_id", string(sender.Sender)). Str("default_other_user", string(portal.OtherUserID)). Msg("Overriding event sender with primary other user in DM portal") + // Ensure the ghost row exists anyway to prevent foreign key errors when saving messages + // TODO it'd probably be better to override the sender in the saved message, but that's more effort + _, err = portal.Bridge.GetGhostByID(ctx, sender.Sender) + if err != nil { + zerolog.Ctx(ctx).Warn().Err(err).Msg("Failed to get ghost with original user ID") + return + } sender.Sender = portal.OtherUserID } if sender.Sender != "" { - var err error ghost, err = portal.Bridge.GetGhostByID(ctx, sender.Sender) if err != nil { zerolog.Ctx(ctx).Err(err).Msg("Failed to get ghost for message sender") return - } else { - ghost.UpdateInfoIfNecessary(ctx, source, evtType) } + ghost.UpdateInfoIfNecessary(ctx, source, evtType) + portal.ensureFunctionalMember(ctx, ghost) } if sender.IsFromMe { intent = source.User.DoublePuppet(ctx) @@ -1722,58 +2686,90 @@ func (portal *Portal) getIntentAndUserMXIDFor(ctx context.Context, sender EventS return } -func (portal *Portal) GetIntentFor(ctx context.Context, sender EventSender, source *UserLogin, evtType RemoteEventType) MatrixAPI { - intent, _ := portal.getIntentAndUserMXIDFor(ctx, sender, source, nil, evtType) +func (portal *Portal) GetIntentFor(ctx context.Context, sender EventSender, source *UserLogin, evtType RemoteEventType) (MatrixAPI, bool) { + intent, _, err := portal.getIntentAndUserMXIDFor(ctx, sender, source, nil, evtType) + if err != nil { + return nil, false + } if intent == nil { // TODO this is very hacky - we should either insert an empty ghost row automatically // (and not fetch it at runtime) or make the message sender column nullable. portal.Bridge.GetGhostByID(ctx, "") intent = portal.Bridge.Bot + if intent == nil { + panic(fmt.Errorf("bridge bot is nil")) + } } - return intent + return intent, true } -func (portal *Portal) getRelationMeta(ctx context.Context, currentMsg networkid.MessageID, replyToPtr *networkid.MessageOptionalPartID, threadRootPtr *networkid.MessageID, isBatchSend bool) (replyTo, threadRoot, prevThreadEvent *database.Message) { +func (portal *Portal) getRelationMeta( + ctx context.Context, + currentMsgID networkid.MessageID, + currentMsg *ConvertedMessage, + isBatchSend bool, +) (replyTo, threadRoot, prevThreadEvent *database.Message) { log := zerolog.Ctx(ctx) var err error - if replyToPtr != nil { - replyTo, err = portal.Bridge.DB.Message.GetFirstOrSpecificPartByID(ctx, portal.Receiver, *replyToPtr) + if currentMsg.ReplyTo != nil { + replyTo, err = portal.Bridge.DB.Message.GetFirstOrSpecificPartByID(ctx, portal.Receiver, *currentMsg.ReplyTo) if err != nil { log.Err(err).Msg("Failed to get reply target message from database") } else if replyTo == nil { - if isBatchSend { + if isBatchSend || portal.Bridge.Config.OutgoingMessageReID { // This is somewhat evil replyTo = &database.Message{ - MXID: portal.Bridge.Matrix.GenerateDeterministicEventID(portal.MXID, portal.PortalKey, replyToPtr.MessageID, ptr.Val(replyToPtr.PartID)), + MXID: portal.Bridge.Matrix.GenerateDeterministicEventID(portal.MXID, portal.PortalKey, currentMsg.ReplyTo.MessageID, ptr.Val(currentMsg.ReplyTo.PartID)), + Room: currentMsg.ReplyToRoom, + SenderID: currentMsg.ReplyToUser, + } + if currentMsg.ReplyToLogin != "" && (portal.Receiver == "" || portal.Receiver == currentMsg.ReplyToLogin) { + userLogin, err := portal.Bridge.GetExistingUserLoginByID(ctx, currentMsg.ReplyToLogin) + if err != nil { + log.Err(err). + Str("reply_to_login", string(currentMsg.ReplyToLogin)). + Msg("Failed to get reply target user login") + } else if userLogin != nil { + replyTo.SenderMXID = userLogin.UserMXID + } + } else { + ghost, err := portal.Bridge.GetGhostByID(ctx, currentMsg.ReplyToUser) + if err != nil { + log.Err(err). + Str("reply_to_user_id", string(currentMsg.ReplyToUser)). + Msg("Failed to get reply target ghost") + } else { + replyTo.SenderMXID = ghost.Intent.GetMXID() + } } } else { - log.Warn().Any("reply_to", *replyToPtr).Msg("Reply target message not found in database") + log.Warn().Any("reply_to", *currentMsg.ReplyTo).Msg("Reply target message not found in database") } } } - if threadRootPtr != nil && *threadRootPtr != currentMsg { - threadRoot, err = portal.Bridge.DB.Message.GetFirstThreadMessage(ctx, portal.PortalKey, *threadRootPtr) + if currentMsg.ThreadRoot != nil && *currentMsg.ThreadRoot != currentMsgID { + threadRoot, err = portal.Bridge.DB.Message.GetFirstThreadMessage(ctx, portal.PortalKey, *currentMsg.ThreadRoot) if err != nil { log.Err(err).Msg("Failed to get thread root message from database") } else if threadRoot == nil { - if isBatchSend { + if isBatchSend || portal.Bridge.Config.OutgoingMessageReID { threadRoot = &database.Message{ - MXID: portal.Bridge.Matrix.GenerateDeterministicEventID(portal.MXID, portal.PortalKey, *threadRootPtr, ""), + MXID: portal.Bridge.Matrix.GenerateDeterministicEventID(portal.MXID, portal.PortalKey, *currentMsg.ThreadRoot, ""), } } else { - log.Warn().Str("thread_root", string(*threadRootPtr)).Msg("Thread root message not found in database") + log.Warn().Str("thread_root", string(*currentMsg.ThreadRoot)).Msg("Thread root message not found in database") } - } else if prevThreadEvent, err = portal.Bridge.DB.Message.GetLastThreadMessage(ctx, portal.PortalKey, *threadRootPtr); err != nil { + } else if prevThreadEvent, err = portal.Bridge.DB.Message.GetLastThreadMessage(ctx, portal.PortalKey, *currentMsg.ThreadRoot); err != nil { log.Err(err).Msg("Failed to get last thread message from database") } if prevThreadEvent == nil { - prevThreadEvent = threadRoot + prevThreadEvent = ptr.Clone(threadRoot) } } return } -func (portal *Portal) applyRelationMeta(content *event.MessageEventContent, replyTo, threadRoot, prevThreadEvent *database.Message) { +func (portal *Portal) applyRelationMeta(ctx context.Context, content *event.MessageEventContent, replyTo, threadRoot, prevThreadEvent *database.Message) { if content.Mentions == nil { content.Mentions = &event.Mentions{} } @@ -1781,7 +2777,24 @@ func (portal *Portal) applyRelationMeta(content *event.MessageEventContent, repl content.GetRelatesTo().SetThread(threadRoot.MXID, prevThreadEvent.MXID) } if replyTo != nil { - content.GetRelatesTo().SetReplyTo(replyTo.MXID) + crossRoom := !replyTo.Room.IsEmpty() && replyTo.Room != portal.PortalKey + if !crossRoom || portal.Bridge.Config.CrossRoomReplies { + content.GetRelatesTo().SetReplyTo(replyTo.MXID) + } + if crossRoom && portal.Bridge.Config.CrossRoomReplies { + targetPortal, err := portal.Bridge.GetExistingPortalByKey(ctx, replyTo.Room) + if err != nil { + zerolog.Ctx(ctx).Err(err). + Object("target_portal_key", replyTo.Room). + Msg("Failed to get cross-room reply portal") + } else if targetPortal == nil || targetPortal.MXID == "" { + zerolog.Ctx(ctx).Warn(). + Object("target_portal_key", replyTo.Room). + Msg("Cross-room reply portal not found") + } else { + content.RelatesTo.InReplyTo.UnstableRoomID = targetPortal.MXID + } + } content.Mentions.Add(replyTo.SenderMXID) } } @@ -1795,27 +2808,32 @@ func (portal *Portal) sendConvertedMessage( ts time.Time, streamOrder int64, logContext func(*zerolog.Event) *zerolog.Event, -) []*database.Message { +) ([]*database.Message, EventHandlingResult) { if logContext == nil { logContext = func(e *zerolog.Event) *zerolog.Event { return e } } log := zerolog.Ctx(ctx) - replyTo, threadRoot, prevThreadEvent := portal.getRelationMeta(ctx, id, converted.ReplyTo, converted.ThreadRoot, false) + replyTo, threadRoot, prevThreadEvent := portal.getRelationMeta( + ctx, id, converted, false, + ) output := make([]*database.Message, 0, len(converted.Parts)) + allSuccess := true for i, part := range converted.Parts { - portal.applyRelationMeta(part.Content, replyTo, threadRoot, prevThreadEvent) + portal.applyRelationMeta(ctx, part.Content, replyTo, threadRoot, prevThreadEvent) + part.Content.BeeperDisappearingTimer = converted.Disappear.ToEventContent() dbMessage := &database.Message{ - ID: id, - PartID: part.ID, - Room: portal.PortalKey, - SenderID: senderID, - SenderMXID: intent.GetMXID(), - Timestamp: ts, - ThreadRoot: ptr.Val(converted.ThreadRoot), - ReplyTo: ptr.Val(converted.ReplyTo), - Metadata: part.DBMetadata, + ID: id, + PartID: part.ID, + Room: portal.PortalKey, + SenderID: senderID, + SenderMXID: intent.GetMXID(), + Timestamp: ts, + ThreadRoot: ptr.Val(converted.ThreadRoot), + ReplyTo: ptr.Val(converted.ReplyTo), + Metadata: part.DBMetadata, + IsDoublePuppeted: intent.IsDoublePuppet(), } if part.DontBridge { dbMessage.SetFakeMXID() @@ -1835,6 +2853,7 @@ func (portal *Portal) sendConvertedMessage( }) if err != nil { logContext(log.Err(err)).Str("part_id", string(part.ID)).Msg("Failed to send message part to Matrix") + allSuccess = false continue } logContext(log.Debug()). @@ -1846,14 +2865,16 @@ func (portal *Portal) sendConvertedMessage( err := portal.Bridge.DB.Message.Insert(ctx, dbMessage) if err != nil { logContext(log.Err(err)).Str("part_id", string(part.ID)).Msg("Failed to save message part to database") + allSuccess = false } - if converted.Disappear.Type != database.DisappearingTypeNone && !dbMessage.HasFakeMXID() { - if converted.Disappear.Type == database.DisappearingTypeAfterSend && converted.Disappear.DisappearAt.IsZero() { + if converted.Disappear.Type != event.DisappearingTypeNone && !dbMessage.HasFakeMXID() { + if converted.Disappear.Type == event.DisappearingTypeAfterSend && converted.Disappear.DisappearAt.IsZero() { converted.Disappear.DisappearAt = dbMessage.Timestamp.Add(converted.Disappear.Timer) } - go portal.Bridge.DisappearLoop.Add(ctx, &database.DisappearingMessage{ + portal.Bridge.DisappearLoop.Add(ctx, &database.DisappearingMessage{ RoomID: portal.MXID, EventID: dbMessage.MXID, + Timestamp: dbMessage.Timestamp, DisappearingSetting: converted.Disappear, }) } @@ -1862,7 +2883,10 @@ func (portal *Portal) sendConvertedMessage( } output = append(output, dbMessage) } - return output + if !allSuccess { + return output, EventHandlingResultFailed + } + return output, EventHandlingResultSuccess } func (portal *Portal) checkPendingMessage(ctx context.Context, evt RemoteMessage) (bool, *database.Message) { @@ -1922,21 +2946,24 @@ func (portal *Portal) checkPendingMessage(ctx context.Context, evt RemoteMessage return true, pending.db } -func (portal *Portal) handleRemoteUpsert(ctx context.Context, source *UserLogin, evt RemoteMessageUpsert, existing []*database.Message) bool { +func (portal *Portal) handleRemoteUpsert(ctx context.Context, source *UserLogin, evt RemoteMessageUpsert, existing []*database.Message) (handleRes EventHandlingResult, continueHandling bool) { log := zerolog.Ctx(ctx) - intent := portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventMessageUpsert) - if intent == nil { - return false + intent, ok := portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventMessageUpsert) + if !ok { + return } res, err := evt.HandleExisting(ctx, portal, intent, existing) if err != nil { log.Err(err).Msg("Failed to handle existing message in upsert event after receiving remote echo") + } else { + handleRes = EventHandlingResultSuccess } if res.SaveParts { for _, part := range existing { err = portal.Bridge.DB.Message.Update(ctx, part) if err != nil { log.Err(err).Str("part_id", string(part.PartID)).Msg("Failed to update message part in database") + handleRes = EventHandlingResultFailed.WithError(err) } } } @@ -1948,19 +2975,25 @@ func (portal *Portal) handleRemoteUpsert(ctx context.Context, source *UserLogin, Str("action", "handle remote subevent"). Stringer("bridge_evt_type", subType). Logger() - portal.handleRemoteEvent(log.WithContext(ctx), source, subType, subEvt) + subRes := portal.handleRemoteEvent(log.WithContext(ctx), source, subType, subEvt) + if !subRes.Success { + handleRes.Success = false + } } } - return res.ContinueMessageHandling + continueHandling = res.ContinueMessageHandling + return } -func (portal *Portal) handleRemoteMessage(ctx context.Context, source *UserLogin, evt RemoteMessage) { +func (portal *Portal) handleRemoteMessage(ctx context.Context, source *UserLogin, evt RemoteMessage) (res EventHandlingResult) { log := zerolog.Ctx(ctx) upsertEvt, isUpsert := evt.(RemoteMessageUpsert) isUpsert = isUpsert && evt.GetType() == RemoteEventMessageUpsert if wasPending, dbMessage := portal.checkPendingMessage(ctx, evt); wasPending { if isUpsert && dbMessage != nil { - portal.handleRemoteUpsert(ctx, source, upsertEvt, []*database.Message{dbMessage}) + res, _ = portal.handleRemoteUpsert(ctx, source, upsertEvt, []*database.Message{dbMessage}) + } else { + res = EventHandlingResultIgnored } return } @@ -1969,32 +3002,42 @@ func (portal *Portal) handleRemoteMessage(ctx context.Context, source *UserLogin log.Err(err).Msg("Failed to check if message is a duplicate") } else if len(existing) > 0 { if isUpsert { - if portal.handleRemoteUpsert(ctx, source, upsertEvt, existing) { + var continueHandling bool + res, continueHandling = portal.handleRemoteUpsert(ctx, source, upsertEvt, existing) + if continueHandling { log.Debug().Msg("Upsert handler said to continue message handling normally") } else { - return + return res } } else { log.Debug().Stringer("existing_mxid", existing[0].MXID).Msg("Ignoring duplicate message") - return + return EventHandlingResultIgnored } } - intent := portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventMessage) - if intent == nil { - return + intent, ok := portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventMessage) + if !ok { + return EventHandlingResultFailed } ts := getEventTS(evt) converted, err := evt.ConvertMessage(ctx, portal, intent) if err != nil { if errors.Is(err, ErrIgnoringRemoteEvent) { log.Debug().Err(err).Msg("Remote message handling was cancelled by convert function") + return EventHandlingResultIgnored } else { log.Err(err).Msg("Failed to convert remote message") portal.sendRemoteErrorNotice(ctx, intent, err, ts, "message") + return EventHandlingResultFailed.WithError(err) } - return } - portal.sendConvertedMessage(ctx, evt.GetID(), intent, evt.GetSender().Sender, converted, ts, getStreamOrder(evt), nil) + _, res = portal.sendConvertedMessage(ctx, evt.GetID(), intent, evt.GetSender().Sender, converted, ts, getStreamOrder(evt), nil) + if portal.currentlyTypingGhosts.Pop(intent.GetMXID()) { + err = intent.MarkTyping(ctx, portal.MXID, TypingTypeText, 0) + if err != nil { + log.Warn().Err(err).Msg("Failed to send stop typing event after bridging message") + } + } + return } func (portal *Portal) sendRemoteErrorNotice(ctx context.Context, intent MatrixAPI, err error, ts time.Time, evtTypeName string) { @@ -2017,7 +3060,7 @@ func (portal *Portal) sendRemoteErrorNotice(ctx context.Context, intent MatrixAP } } -func (portal *Portal) handleRemoteEdit(ctx context.Context, source *UserLogin, evt RemoteEdit) { +func (portal *Portal) handleRemoteEdit(ctx context.Context, source *UserLogin, evt RemoteEdit) EventHandlingResult { log := zerolog.Ctx(ctx) var existing []*database.Message if bundledEvt, ok := evt.(RemoteEventWithBundledParts); ok { @@ -2029,28 +3072,41 @@ func (portal *Portal) handleRemoteEdit(ctx context.Context, source *UserLogin, e existing, err = portal.Bridge.DB.Message.GetAllPartsByID(ctx, portal.Receiver, targetID) if err != nil { log.Err(err).Msg("Failed to get edit target message") - return + return EventHandlingResultFailed.WithError(err) } } if existing == nil { log.Warn().Msg("Edit target message not found") - return + return EventHandlingResultIgnored } - intent := portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventEdit) - if intent == nil { - return + intent, ok := portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventEdit) + if !ok { + return EventHandlingResultFailed + } else if intent.GetMXID() != existing[0].SenderMXID { + log.Warn(). + Stringer("edit_sender_mxid", intent.GetMXID()). + Stringer("original_sender_mxid", existing[0].SenderMXID). + Msg("Not bridging edit: sender doesn't match original message sender") + return EventHandlingResultIgnored } ts := getEventTS(evt) converted, err := evt.ConvertEdit(ctx, portal, intent, existing) if errors.Is(err, ErrIgnoringRemoteEvent) { log.Debug().Err(err).Msg("Remote edit handling was cancelled by convert function") - return + return EventHandlingResultIgnored } else if err != nil { log.Err(err).Msg("Failed to convert remote edit") portal.sendRemoteErrorNotice(ctx, intent, err, ts, "edit") - return + return EventHandlingResultFailed.WithError(err) } - portal.sendConvertedEdit(ctx, existing[0].ID, evt.GetSender().Sender, converted, intent, ts, getStreamOrder(evt)) + res := portal.sendConvertedEdit(ctx, existing[0].ID, evt.GetSender().Sender, converted, intent, ts, getStreamOrder(evt)) + if portal.currentlyTypingGhosts.Pop(intent.GetMXID()) { + err = intent.MarkTyping(ctx, portal.MXID, TypingTypeText, 0) + if err != nil { + log.Warn().Err(err).Msg("Failed to send stop typing event after bridging edit") + } + } + return res } func (portal *Portal) sendConvertedEdit( @@ -2061,8 +3117,9 @@ func (portal *Portal) sendConvertedEdit( intent MatrixAPI, ts time.Time, streamOrder int64, -) { +) EventHandlingResult { log := zerolog.Ctx(ctx) + allSuccess := true for i, part := range converted.ModifiedParts { if part.Content.Mentions == nil { part.Content.Mentions = &event.Mentions{} @@ -2098,6 +3155,7 @@ func (portal *Portal) sendConvertedEdit( }) if err != nil { log.Err(err).Stringer("part_mxid", part.Part.MXID).Msg("Failed to edit message part") + allSuccess = false continue } else { log.Debug(). @@ -2112,6 +3170,7 @@ func (portal *Portal) sendConvertedEdit( err := portal.Bridge.DB.Message.Update(ctx, part.Part) if err != nil { log.Err(err).Int64("part_rowid", part.Part.RowID).Msg("Failed to update message part in database") + allSuccess = false } } for _, part := range converted.DeletedParts { @@ -2125,6 +3184,7 @@ func (portal *Portal) sendConvertedEdit( }) if err != nil { log.Err(err).Stringer("part_mxid", part.MXID).Msg("Failed to redact message part deleted in edit") + allSuccess = false } else { log.Debug(). Stringer("redaction_event_id", resp.EventID). @@ -2135,11 +3195,19 @@ func (portal *Portal) sendConvertedEdit( err = portal.Bridge.DB.Message.Delete(ctx, part.RowID) if err != nil { log.Err(err).Int64("part_rowid", part.RowID).Msg("Failed to delete message part from database") + allSuccess = false } } if converted.AddedParts != nil { - portal.sendConvertedMessage(ctx, targetID, intent, senderID, converted.AddedParts, ts, streamOrder, nil) + _, res := portal.sendConvertedMessage(ctx, targetID, intent, senderID, converted.AddedParts, ts, streamOrder, nil) + if !res.Success { + allSuccess = false + } } + if !allSuccess { + return EventHandlingResultFailed + } + return EventHandlingResultSuccess } func (portal *Portal) getTargetMessagePart(ctx context.Context, evt RemoteEventWithTargetMessage) (*database.Message, error) { @@ -2152,9 +3220,9 @@ func (portal *Portal) getTargetMessagePart(ctx context.Context, evt RemoteEventW func (portal *Portal) getTargetReaction(ctx context.Context, evt RemoteReactionRemove) (*database.Reaction, error) { if partTargeter, ok := evt.(RemoteEventWithTargetPart); ok { - return portal.Bridge.DB.Reaction.GetByID(ctx, evt.GetTargetMessage(), partTargeter.GetTargetMessagePart(), evt.GetSender().Sender, evt.GetRemovedEmojiID()) + return portal.Bridge.DB.Reaction.GetByID(ctx, portal.Receiver, evt.GetTargetMessage(), partTargeter.GetTargetMessagePart(), evt.GetSender().Sender, evt.GetRemovedEmojiID()) } else { - return portal.Bridge.DB.Reaction.GetByIDWithoutMessagePart(ctx, evt.GetTargetMessage(), evt.GetSender().Sender, evt.GetRemovedEmojiID()) + return portal.Bridge.DB.Reaction.GetByIDWithoutMessagePart(ctx, portal.Receiver, evt.GetTargetMessage(), evt.GetSender().Sender, evt.GetRemovedEmojiID()) } } @@ -2172,23 +3240,27 @@ func getStreamOrder(evt RemoteEvent) int64 { return 0 } -func (portal *Portal) handleRemoteReactionSync(ctx context.Context, source *UserLogin, evt RemoteReactionSync) { +func (portal *Portal) handleRemoteReactionSync(ctx context.Context, source *UserLogin, evt RemoteReactionSync) EventHandlingResult { log := zerolog.Ctx(ctx) eventTS := getEventTS(evt) targetMessage, err := portal.getTargetMessagePart(ctx, evt) if err != nil { log.Err(err).Msg("Failed to get target message for reaction") - return + return EventHandlingResultFailed.WithError(err) } else if targetMessage == nil { // TODO use deterministic event ID as target if applicable? log.Warn().Msg("Target message for reaction not found") - return + return EventHandlingResultIgnored } var existingReactions []*database.Reaction if partTargeter, ok := evt.(RemoteEventWithTargetPart); ok { - existingReactions, err = portal.Bridge.DB.Reaction.GetAllToMessagePart(ctx, evt.GetTargetMessage(), partTargeter.GetTargetMessagePart()) + existingReactions, err = portal.Bridge.DB.Reaction.GetAllToMessagePart(ctx, portal.Receiver, evt.GetTargetMessage(), partTargeter.GetTargetMessagePart()) } else { - existingReactions, err = portal.Bridge.DB.Reaction.GetAllToMessage(ctx, evt.GetTargetMessage()) + existingReactions, err = portal.Bridge.DB.Reaction.GetAllToMessage(ctx, portal.Receiver, evt.GetTargetMessage()) + } + if err != nil { + log.Err(err).Msg("Failed to get existing reactions for reaction sync") + return EventHandlingResultFailed.WithError(err) } existing := make(map[networkid.UserID]map[networkid.EmojiID]*database.Reaction) for _, existingReaction := range existingReactions { @@ -2198,8 +3270,14 @@ func (portal *Portal) handleRemoteReactionSync(ctx context.Context, source *User existing[existingReaction.SenderID][existingReaction.EmojiID] = existingReaction } - doAddReaction := func(new *BackfillReaction) MatrixAPI { - intent := portal.GetIntentFor(ctx, new.Sender, source, RemoteEventReactionSync) + doAddReaction := func(new *BackfillReaction, intent MatrixAPI) { + if intent == nil { + var ok bool + intent, ok = portal.GetIntentFor(ctx, new.Sender, source, RemoteEventReactionSync) + if !ok { + return + } + } portal.sendConvertedReaction( ctx, new.Sender.Sender, intent, targetMessage, new.EmojiID, new.Emoji, new.Timestamp, new.DBMetadata, new.ExtraContent, @@ -2209,7 +3287,6 @@ func (portal *Portal) handleRemoteReactionSync(ctx context.Context, source *User Time("reaction_ts", new.Timestamp) }, ) - return intent } doRemoveReaction := func(old *database.Reaction, intent MatrixAPI, deleteRow bool) { if intent == nil && old.SenderMXID != "" { @@ -2243,8 +3320,12 @@ func (portal *Portal) handleRemoteReactionSync(ctx context.Context, source *User } } doOverwriteReaction := func(new *BackfillReaction, old *database.Reaction) { - intent := doAddReaction(new) + intent, ok := portal.GetIntentFor(ctx, new.Sender, source, RemoteEventReactionSync) + if !ok { + return + } doRemoveReaction(old, intent, false) + doAddReaction(new, intent) } newData := evt.GetReactions() @@ -2258,12 +3339,12 @@ func (portal *Portal) handleRemoteReactionSync(ctx context.Context, source *User existingReaction, ok := existingUserReactions[reaction.EmojiID] if ok { delete(existingUserReactions, reaction.EmojiID) - if reaction.EmojiID != "" { + if reaction.EmojiID != "" || reaction.Emoji == existingReaction.Emoji { continue } doOverwriteReaction(reaction, existingReaction) } else { - doAddReaction(reaction) + doAddReaction(reaction, nil) } } totalReactionCount := len(existingUserReactions) + len(reactions.Reactions) @@ -2293,30 +3374,34 @@ func (portal *Portal) handleRemoteReactionSync(ctx context.Context, source *User } } } + return EventHandlingResultSuccess } -func (portal *Portal) handleRemoteReaction(ctx context.Context, source *UserLogin, evt RemoteReaction) { +func (portal *Portal) handleRemoteReaction(ctx context.Context, source *UserLogin, evt RemoteReaction) EventHandlingResult { log := zerolog.Ctx(ctx) targetMessage, err := portal.getTargetMessagePart(ctx, evt) if err != nil { log.Err(err).Msg("Failed to get target message for reaction") - return + return EventHandlingResultFailed.WithError(err) } else if targetMessage == nil { // TODO use deterministic event ID as target if applicable? log.Warn().Msg("Target message for reaction not found") - return + return EventHandlingResultIgnored } emoji, emojiID := evt.GetReactionEmoji() - existingReaction, err := portal.Bridge.DB.Reaction.GetByID(ctx, targetMessage.ID, targetMessage.PartID, evt.GetSender().Sender, emojiID) + existingReaction, err := portal.Bridge.DB.Reaction.GetByID(ctx, portal.Receiver, targetMessage.ID, targetMessage.PartID, evt.GetSender().Sender, emojiID) if err != nil { log.Err(err).Msg("Failed to check if reaction is a duplicate") - return + return EventHandlingResultFailed.WithError(err) } else if existingReaction != nil && (emojiID != "" || existingReaction.Emoji == emoji) { log.Debug().Msg("Ignoring duplicate reaction") - return + return EventHandlingResultIgnored } ts := getEventTS(evt) - intent := portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventReaction) + intent, ok := portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventReaction) + if !ok { + return EventHandlingResultFailed + } var extra map[string]any if extraContentProvider, ok := evt.(RemoteReactionWithExtraContent); ok { extra = extraContentProvider.GetReactionExtraContent() @@ -2325,7 +3410,6 @@ func (portal *Portal) handleRemoteReaction(ctx context.Context, source *UserLogi if metaProvider, ok := evt.(RemoteReactionWithMeta); ok { dbMetadata = metaProvider.GetReactionDBMetadata() } - portal.sendConvertedReaction(ctx, evt.GetSender().Sender, intent, targetMessage, emojiID, emoji, ts, dbMetadata, extra, nil) if existingReaction != nil { _, err = intent.SendMessage(ctx, portal.MXID, event.EventRedaction, &event.Content{ Parsed: &event.RedactionEventContent{ @@ -2336,13 +3420,14 @@ func (portal *Portal) handleRemoteReaction(ctx context.Context, source *UserLogi log.Err(err).Msg("Failed to redact old reaction") } } + return portal.sendConvertedReaction(ctx, evt.GetSender().Sender, intent, targetMessage, emojiID, emoji, ts, dbMetadata, extra, nil) } func (portal *Portal) sendConvertedReaction( ctx context.Context, senderID networkid.UserID, intent MatrixAPI, targetMessage *database.Message, emojiID networkid.EmojiID, emoji string, ts time.Time, dbMetadata any, extraContent map[string]any, logContext func(*zerolog.Event) *zerolog.Event, -) { +) EventHandlingResult { if logContext == nil { logContext = func(e *zerolog.Event) *zerolog.Event { return e @@ -2377,7 +3462,7 @@ func (portal *Portal) sendConvertedReaction( }) if err != nil { logContext(log.Err(err)).Msg("Failed to send reaction to Matrix") - return + return EventHandlingResultFailed.WithError(err) } logContext(log.Debug()). Stringer("event_id", resp.EventID). @@ -2386,7 +3471,9 @@ func (portal *Portal) sendConvertedReaction( err = portal.Bridge.DB.Reaction.Upsert(ctx, dbReaction) if err != nil { logContext(log.Err(err)).Msg("Failed to save reaction to database") + return EventHandlingResultFailed.WithError(err) } + return EventHandlingResultSuccess } func (portal *Portal) getIntentForMXID(ctx context.Context, userID id.UserID) (MatrixAPI, error) { @@ -2405,22 +3492,26 @@ func (portal *Portal) getIntentForMXID(ctx context.Context, userID id.UserID) (M } } -func (portal *Portal) handleRemoteReactionRemove(ctx context.Context, source *UserLogin, evt RemoteReactionRemove) { +func (portal *Portal) handleRemoteReactionRemove(ctx context.Context, source *UserLogin, evt RemoteReactionRemove) EventHandlingResult { log := zerolog.Ctx(ctx) targetReaction, err := portal.getTargetReaction(ctx, evt) if err != nil { log.Err(err).Msg("Failed to get target reaction for removal") - return + return EventHandlingResultFailed.WithError(err) } else if targetReaction == nil { log.Warn().Msg("Target reaction not found") - return + return EventHandlingResultIgnored } intent, err := portal.getIntentForMXID(ctx, targetReaction.SenderMXID) if err != nil { log.Err(err).Stringer("sender_mxid", targetReaction.SenderMXID).Msg("Failed to get intent for removing reaction") } if intent == nil { - intent = portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventReactionRemove) + var ok bool + intent, ok = portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventReactionRemove) + if !ok { + return EventHandlingResultFailed + } } ts := getEventTS(evt) _, err = intent.SendMessage(ctx, portal.MXID, event.EventRedaction, &event.Content{ @@ -2430,30 +3521,42 @@ func (portal *Portal) handleRemoteReactionRemove(ctx context.Context, source *Us }, &MatrixSendExtra{Timestamp: ts, ReactionMeta: targetReaction}) if err != nil { log.Err(err).Stringer("reaction_mxid", targetReaction.MXID).Msg("Failed to redact reaction") + return EventHandlingResultFailed.WithError(err) } err = portal.Bridge.DB.Reaction.Delete(ctx, targetReaction) if err != nil { log.Err(err).Msg("Failed to delete target reaction from database") } + return EventHandlingResultSuccess } -func (portal *Portal) handleRemoteMessageRemove(ctx context.Context, source *UserLogin, evt RemoteMessageRemove) { +func (portal *Portal) handleRemoteMessageRemove(ctx context.Context, source *UserLogin, evt RemoteMessageRemove) EventHandlingResult { log := zerolog.Ctx(ctx) targetParts, err := portal.Bridge.DB.Message.GetAllPartsByID(ctx, portal.Receiver, evt.GetTargetMessage()) if err != nil { log.Err(err).Msg("Failed to get target message for removal") - return + return EventHandlingResultFailed.WithError(err) } else if len(targetParts) == 0 { log.Debug().Msg("Target message not found") - return + return EventHandlingResultIgnored } onlyForMeProvider, ok := evt.(RemoteDeleteOnlyForMe) onlyForMe := ok && onlyForMeProvider.DeleteOnlyForMe() if onlyForMe && portal.Receiver == "" { - // TODO check if there are other user logins before deleting + _, others, err := portal.findOtherLogins(ctx, source) + if err != nil { + log.Err(err).Msg("Failed to check if portal has other logins") + return EventHandlingResultFailed.WithError(err) + } else if len(others) > 0 { + log.Debug().Msg("Ignoring delete for me event in portal with multiple logins") + return EventHandlingResultIgnored + } } - intent := portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventMessageRemove) + intent, ok := portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventMessageRemove) + if !ok { + return EventHandlingResultFailed + } if intent == portal.Bridge.Bot && len(targetParts) > 0 { senderIntent, err := portal.getIntentForMXID(ctx, targetParts[0].SenderMXID) if err != nil { @@ -2462,15 +3565,17 @@ func (portal *Portal) handleRemoteMessageRemove(ctx context.Context, source *Use intent = senderIntent } } - portal.redactMessageParts(ctx, targetParts, intent, getEventTS(evt)) + res := portal.redactMessageParts(ctx, targetParts, intent, getEventTS(evt)) err = portal.Bridge.DB.Message.DeleteAllParts(ctx, portal.Receiver, evt.GetTargetMessage()) if err != nil { log.Err(err).Msg("Failed to delete target message from database") } + return res } -func (portal *Portal) redactMessageParts(ctx context.Context, parts []*database.Message, intent MatrixAPI, ts time.Time) { +func (portal *Portal) redactMessageParts(ctx context.Context, parts []*database.Message, intent MatrixAPI, ts time.Time) EventHandlingResult { log := zerolog.Ctx(ctx) + var anyFailed bool for _, part := range parts { if part.HasFakeMXID() { continue @@ -2482,6 +3587,7 @@ func (portal *Portal) redactMessageParts(ctx context.Context, parts []*database. }, &MatrixSendExtra{Timestamp: ts, MessageMeta: part}) if err != nil { log.Err(err).Stringer("part_mxid", part.MXID).Msg("Failed to redact message part") + anyFailed = true } else { log.Debug(). Stringer("redaction_event_id", resp.EventID). @@ -2490,22 +3596,33 @@ func (portal *Portal) redactMessageParts(ctx context.Context, parts []*database. Msg("Sent redaction of message part to Matrix") } } + if anyFailed { + return EventHandlingResultFailed + } + return EventHandlingResultSuccess } -func (portal *Portal) handleRemoteReadReceipt(ctx context.Context, source *UserLogin, evt RemoteReadReceipt) { - // TODO exclude fake mxids +func (portal *Portal) handleRemoteReadReceipt(ctx context.Context, source *UserLogin, evt RemoteReadReceipt) EventHandlingResult { log := zerolog.Ctx(ctx) var err error var lastTarget *database.Message + readUpTo := evt.GetReadUpTo() if lastTargetID := evt.GetLastReceiptTarget(); lastTargetID != "" { lastTarget, err = portal.Bridge.DB.Message.GetLastPartByID(ctx, portal.Receiver, lastTargetID) if err != nil { log.Err(err).Str("last_target_id", string(lastTargetID)). Msg("Failed to get last target message for read receipt") - return + return EventHandlingResultFailed.WithError(err) } else if lastTarget == nil { log.Debug().Str("last_target_id", string(lastTargetID)). Msg("Last target message not found") + } else if lastTarget.HasFakeMXID() { + log.Debug().Str("last_target_id", string(lastTargetID)). + Msg("Last target message is fake") + if readUpTo.IsZero() { + readUpTo = lastTarget.Timestamp + } + lastTarget = nil } } if lastTarget == nil { @@ -2514,62 +3631,89 @@ func (portal *Portal) handleRemoteReadReceipt(ctx context.Context, source *UserL if err != nil { log.Err(err).Str("target_id", string(targetID)). Msg("Failed to get target message for read receipt") - return - } else if target != nil && (lastTarget == nil || target.Timestamp.After(lastTarget.Timestamp)) { + return EventHandlingResultFailed.WithError(err) + } else if target != nil && !target.HasFakeMXID() && (lastTarget == nil || target.Timestamp.After(lastTarget.Timestamp)) { lastTarget = target } } } - readUpTo := evt.GetReadUpTo() if lastTarget == nil && !readUpTo.IsZero() { - lastTarget, err = portal.Bridge.DB.Message.GetLastPartAtOrBeforeTime(ctx, portal.PortalKey, readUpTo) + lastTarget, err = portal.Bridge.DB.Message.GetLastNonFakePartAtOrBeforeTime(ctx, portal.PortalKey, readUpTo) if err != nil { log.Err(err).Time("read_up_to", readUpTo).Msg("Failed to get target message for read receipt") } } - if lastTarget == nil { - log.Warn().Msg("No target message found for read receipt") - return - } sender := evt.GetSender() - intent := portal.GetIntentFor(ctx, sender, source, RemoteEventReadReceipt) - err = intent.MarkRead(ctx, portal.MXID, lastTarget.MXID, getEventTS(evt)) - if err != nil { - log.Err(err).Stringer("target_mxid", lastTarget.MXID).Msg("Failed to bridge read receipt") + intent, ok := portal.GetIntentFor(ctx, sender, source, RemoteEventReadReceipt) + if !ok { + return EventHandlingResultFailed + } + var addTargetLog func(evt *zerolog.Event) *zerolog.Event + if lastTarget == nil { + sevt, evtOK := evt.(RemoteReadReceiptWithStreamOrder) + soIntent, soIntentOK := intent.(StreamOrderReadingMatrixAPI) + if !evtOK || !soIntentOK || sevt.GetReadUpToStreamOrder() == 0 { + log.Warn().Msg("No target message found for read receipt") + return EventHandlingResultIgnored + } + targetStreamOrder := sevt.GetReadUpToStreamOrder() + addTargetLog = func(evt *zerolog.Event) *zerolog.Event { + return evt.Int64("target_stream_order", targetStreamOrder) + } + err = soIntent.MarkStreamOrderRead(ctx, portal.MXID, targetStreamOrder, getEventTS(evt)) + if readUpTo.IsZero() { + readUpTo = getEventTS(evt) + } } else { - log.Debug().Stringer("target_mxid", lastTarget.MXID).Msg("Bridged read receipt") + addTargetLog = func(evt *zerolog.Event) *zerolog.Event { + return evt.Stringer("target_mxid", lastTarget.MXID) + } + err = intent.MarkRead(ctx, portal.MXID, lastTarget.MXID, getEventTS(evt)) + readUpTo = lastTarget.Timestamp + } + if err != nil { + addTargetLog(log.Err(err)).Msg("Failed to bridge read receipt") + return EventHandlingResultFailed.WithError(err) + } else { + addTargetLog(log.Debug()).Msg("Bridged read receipt") } if sender.IsFromMe { - portal.Bridge.DisappearLoop.StartAll(ctx, portal.MXID) + portal.Bridge.DisappearLoop.StartAllBefore(ctx, portal.MXID, readUpTo) } + return EventHandlingResultSuccess } -func (portal *Portal) handleRemoteMarkUnread(ctx context.Context, source *UserLogin, evt RemoteMarkUnread) { +func (portal *Portal) handleRemoteMarkUnread(ctx context.Context, source *UserLogin, evt RemoteMarkUnread) EventHandlingResult { if !evt.GetSender().IsFromMe { zerolog.Ctx(ctx).Warn().Msg("Ignoring mark unread event from non-self user") - return + return EventHandlingResultIgnored } dp := source.User.DoublePuppet(ctx) if dp == nil { - return + return EventHandlingResultIgnored } err := dp.MarkUnread(ctx, portal.MXID, evt.GetUnread()) if err != nil { zerolog.Ctx(ctx).Err(err).Msg("Failed to bridge mark unread event") + return EventHandlingResultFailed.WithError(err) } + return EventHandlingResultSuccess } -func (portal *Portal) handleRemoteDeliveryReceipt(ctx context.Context, source *UserLogin, evt RemoteDeliveryReceipt) { - if portal.RoomType != database.RoomTypeDM || evt.GetSender().Sender != portal.OtherUserID { - return +func (portal *Portal) handleRemoteDeliveryReceipt(ctx context.Context, source *UserLogin, evt RemoteDeliveryReceipt) EventHandlingResult { + if portal.RoomType != database.RoomTypeDM || (evt.GetSender().Sender != portal.OtherUserID && portal.OtherUserID != "") { + return EventHandlingResultIgnored + } + intent, ok := portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventDeliveryReceipt) + if !ok { + return EventHandlingResultFailed } - intent := portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventDeliveryReceipt) log := zerolog.Ctx(ctx) for _, target := range evt.GetReceiptTargets() { targetParts, err := portal.Bridge.DB.Message.GetAllPartsByID(ctx, portal.Receiver, target) if err != nil { log.Err(err).Str("target_id", string(target)).Msg("Failed to get target message for delivery receipt") - continue + return EventHandlingResultFailed.WithError(err) } else if len(targetParts) == 0 { continue } else if _, sentByGhost := portal.Bridge.Matrix.ParseGhostMXID(targetParts[0].SenderMXID); sentByGhost { @@ -2583,33 +3727,48 @@ func (portal *Portal) handleRemoteDeliveryReceipt(ctx context.Context, source *U RoomID: portal.MXID, SourceEventID: part.MXID, Sender: part.SenderMXID, + + IsSourceEventDoublePuppeted: part.IsDoublePuppeted, }) } } + return EventHandlingResultSuccess } -func (portal *Portal) handleRemoteTyping(ctx context.Context, source *UserLogin, evt RemoteTyping) { +func (portal *Portal) handleRemoteTyping(ctx context.Context, source *UserLogin, evt RemoteTyping) EventHandlingResult { var typingType TypingType if typedEvt, ok := evt.(RemoteTypingWithType); ok { typingType = typedEvt.GetTypingType() } - intent := portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventTyping) - err := intent.MarkTyping(ctx, portal.MXID, typingType, evt.GetTimeout()) + intent, ok := portal.GetIntentFor(ctx, evt.GetSender(), source, RemoteEventTyping) + if !ok { + return EventHandlingResultFailed + } + timeout := evt.GetTimeout() + err := intent.MarkTyping(ctx, portal.MXID, typingType, timeout) if err != nil { zerolog.Ctx(ctx).Err(err).Msg("Failed to bridge typing event") + return EventHandlingResultFailed.WithError(err) } + if timeout == 0 { + portal.currentlyTypingGhosts.Remove(intent.GetMXID()) + } else { + portal.currentlyTypingGhosts.Add(intent.GetMXID()) + } + return EventHandlingResultSuccess } -func (portal *Portal) handleRemoteChatInfoChange(ctx context.Context, source *UserLogin, evt RemoteChatInfoChange) { +func (portal *Portal) handleRemoteChatInfoChange(ctx context.Context, source *UserLogin, evt RemoteChatInfoChange) EventHandlingResult { info, err := evt.GetChatInfoChange(ctx) if err != nil { zerolog.Ctx(ctx).Err(err).Msg("Failed to get chat info change") - return + return EventHandlingResultFailed.WithError(err) } portal.ProcessChatInfoChange(ctx, evt.GetSender(), source, info, getEventTS(evt)) + return EventHandlingResultSuccess } -func (portal *Portal) handleRemoteChatResync(ctx context.Context, source *UserLogin, evt RemoteChatResync) { +func (portal *Portal) handleRemoteChatResync(ctx context.Context, source *UserLogin, evt RemoteChatResync) EventHandlingResult { log := zerolog.Ctx(ctx) infoProvider, ok := evt.(RemoteChatResyncWithInfo) if ok { @@ -2623,7 +3782,7 @@ func (portal *Portal) handleRemoteChatResync(ctx context.Context, source *UserLo } } backfillChecker, ok := evt.(RemoteChatResyncBackfill) - if portal.Bridge.Config.Backfill.Enabled && ok { + if portal.Bridge.Config.Backfill.Enabled && ok && portal.RoomType != database.RoomTypeSpace { latestMessage, err := portal.Bridge.DB.Message.GetLastPartAtOrBeforeTime(ctx, portal.PortalKey, time.Now().Add(10*time.Second)) if err != nil { log.Err(err).Msg("Failed to get last message in portal to check if backfill is necessary") @@ -2638,29 +3797,120 @@ func (portal *Portal) handleRemoteChatResync(ctx context.Context, source *UserLo portal.doForwardBackfill(ctx, source, latestMessage, bundle) } } + return EventHandlingResultSuccess } -func (portal *Portal) handleRemoteChatDelete(ctx context.Context, source *UserLogin, evt RemoteChatDelete) { +func (portal *Portal) findOtherLogins(ctx context.Context, source *UserLogin) (ownUP *database.UserPortal, others []*database.UserPortal, err error) { + others, err = portal.Bridge.DB.UserPortal.GetAllInPortal(ctx, portal.PortalKey) + if err != nil { + return + } + others = slices.DeleteFunc(others, func(up *database.UserPortal) bool { + if up.LoginID == source.ID { + ownUP = up + return true + } + return false + }) + return +} + +type childDeleteProxy struct { + RemoteChatDeleteWithChildren + child networkid.PortalKey + done func() +} + +func (cdp *childDeleteProxy) AddLogContext(c zerolog.Context) zerolog.Context { + return cdp.RemoteChatDeleteWithChildren.AddLogContext(c).Str("subaction", "delete children") +} +func (cdp *childDeleteProxy) GetPortalKey() networkid.PortalKey { return cdp.child } +func (cdp *childDeleteProxy) ShouldCreatePortal() bool { return false } +func (cdp *childDeleteProxy) PreHandle(ctx context.Context, portal *Portal) {} +func (cdp *childDeleteProxy) PostHandle(ctx context.Context, portal *Portal) { cdp.done() } + +func (portal *Portal) handleRemoteChatDelete(ctx context.Context, source *UserLogin, evt RemoteChatDelete) EventHandlingResult { + log := zerolog.Ctx(ctx) if portal.Receiver == "" && evt.DeleteOnlyForMe() { - // TODO check if there are other users + ownUP, logins, err := portal.findOtherLogins(ctx, source) + if err != nil { + log.Err(err).Msg("Failed to check if portal has other logins") + return EventHandlingResultFailed.WithError(err) + } + if len(logins) > 0 { + log.Debug().Msg("Not deleting portal with other logins in remote chat delete event") + if ownUP != nil { + err = portal.Bridge.DB.UserPortal.Delete(ctx, ownUP) + if err != nil { + log.Err(err).Msg("Failed to delete own user portal row from database") + } else { + log.Debug().Msg("Deleted own user portal row from database") + } + } + _, err = portal.sendStateWithIntentOrBot( + ctx, + source.User.DoublePuppet(ctx), + event.StateMember, + source.UserMXID.String(), + &event.Content{Parsed: &event.MemberEventContent{Membership: event.MembershipLeave}}, + getEventTS(evt), + ) + if err != nil { + log.Err(err).Msg("Failed to send leave state event for user after remote chat delete") + return EventHandlingResultFailed.WithError(err) + } else { + log.Debug().Msg("Sent leave state event for user after remote chat delete") + return EventHandlingResultSuccess + } + } + } + if childDeleter, ok := evt.(RemoteChatDeleteWithChildren); ok && childDeleter.DeleteChildren() && portal.RoomType == database.RoomTypeSpace { + children, err := portal.Bridge.GetChildPortals(ctx, portal.PortalKey) + if err != nil { + log.Err(err).Msg("Failed to fetch children to delete") + return EventHandlingResultFailed.WithError(err) + } + log.Debug(). + Int("portal_count", len(children)). + Msg("Deleting child portals before remote chat delete") + var wg sync.WaitGroup + wg.Add(len(children)) + for _, child := range children { + child.queueEvent(ctx, &portalRemoteEvent{ + evt: &childDeleteProxy{ + RemoteChatDeleteWithChildren: childDeleter, + child: child.PortalKey, + done: wg.Done, + }, + source: source, + evtType: RemoteEventChatDelete, + }) + } + wg.Wait() + log.Debug().Msg("Finished deleting child portals") } err := portal.Delete(ctx) if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to delete portal from database") - return + log.Err(err).Msg("Failed to delete portal from database") + return EventHandlingResultFailed.WithError(err) } err = portal.Bridge.Bot.DeleteRoom(ctx, portal.MXID, false) if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to delete Matrix room") + log.Err(err).Msg("Failed to delete Matrix room") + return EventHandlingResultFailed.WithError(err) + } else { + log.Info().Msg("Deleted room after remote chat delete event") + return EventHandlingResultSuccess } } -func (portal *Portal) handleRemoteBackfill(ctx context.Context, source *UserLogin, backfill RemoteBackfill) { +func (portal *Portal) handleRemoteBackfill(ctx context.Context, source *UserLogin, backfill RemoteBackfill) (res EventHandlingResult) { //data, err := backfill.GetBackfillData(ctx, portal) //if err != nil { // zerolog.Ctx(ctx).Err(err).Msg("Failed to get backfill data") // return //} + return } type ChatInfoChange struct { @@ -2673,7 +3923,10 @@ type ChatInfoChange struct { } func (portal *Portal) ProcessChatInfoChange(ctx context.Context, sender EventSender, source *UserLogin, change *ChatInfoChange, ts time.Time) { - intent := portal.GetIntentFor(ctx, sender, source, RemoteEventChatInfoChange) + intent, ok := portal.GetIntentFor(ctx, sender, source, RemoteEventChatInfoChange) + if !ok { + return + } if change.ChatInfo != nil { portal.UpdateInfo(ctx, change.ChatInfo, source, intent, ts) } @@ -2691,13 +3944,45 @@ type PortalInfo = ChatInfo type ChatMember struct { EventSender Membership event.Membership - Nickname *string + // Per-room nickname for the user. Not yet used. + Nickname *string + // The power level to set for the user when syncing power levels. PowerLevel *int - UserInfo *UserInfo - + // Optional user info to sync the ghost user while updating membership. + UserInfo *UserInfo + // The user who sent the membership change (user who invited/kicked/banned this user). + // Not yet used. Not applicable if Membership is join or knock. + MemberSender EventSender + // Extra fields to include in the member event. + MemberEventExtra map[string]any + // The expected previous membership. If this doesn't match, the change is ignored. PrevMembership event.Membership } +type ChatMemberMap map[networkid.UserID]ChatMember + +// Set adds the given entry to this map, overwriting any existing entry with the same Sender field. +func (cmm ChatMemberMap) Set(member ChatMember) ChatMemberMap { + if member.Sender == "" && member.SenderLogin == "" && !member.IsFromMe { + return cmm + } + cmm[member.Sender] = member + return cmm +} + +// Add adds the given entry to this map, but will ignore it if an entry with the same Sender field already exists. +// It returns true if the entry was added, false otherwise. +func (cmm ChatMemberMap) Add(member ChatMember) bool { + if member.Sender == "" && member.SenderLogin == "" && !member.IsFromMe { + return false + } + if _, exists := cmm[member.Sender]; exists { + return false + } + cmm[member.Sender] = member + return true +} + type ChatMemberList struct { // Whether this is the full member list. // If true, any extra members not listed here will be removed from the portal. @@ -2705,6 +3990,10 @@ type ChatMemberList struct { // Should the bridge call IsThisUser for every member in the list? // This should be used when SenderLogin can't be filled accurately. CheckAllLogins bool + // Should any changes have the `com.beeper.exclude_from_timeline` flag set by default? + // This is recommended for syncs with non-real-time changes. + // Real-time changes (e.g. a user joining) should not set this flag set. + ExcludeChangesFromTimeline bool // The total number of members in the chat, regardless of how many of those members are included in MemberMap. TotalMemberCount int @@ -2715,7 +4004,7 @@ type ChatMemberList struct { // Deprecated: Use MemberMap instead to avoid duplicate entries Members []ChatMember - MemberMap map[networkid.UserID]ChatMember + MemberMap ChatMemberMap PowerLevels *PowerLevelOverrides } @@ -2801,6 +4090,10 @@ func (plc *PowerLevelOverrides) Apply(actor id.UserID, content *event.PowerLevel return changed } +// DefaultChatName can be used to explicitly clear the name of a room +// and reset it to the default one based on members. +var DefaultChatName = ptr.Ptr("") + type ChatInfo struct { Name *string Topic *string @@ -2813,9 +4106,11 @@ type ChatInfo struct { Disappear *database.DisappearingSetting ParentID *networkid.PortalID - UserLocal *UserLocalPortalInfo + UserLocal *UserLocalPortalInfo + MessageRequest *bool + CanBackfill bool - CanBackfill bool + ExcludeChangesFromTimeline bool ExtraUpdates ExtraUpdater[*Portal] } @@ -2849,26 +4144,36 @@ type UserLocalPortalInfo struct { Tag *event.RoomTag } -func (portal *Portal) updateName(ctx context.Context, name string, sender MatrixAPI, ts time.Time) bool { +func (portal *Portal) updateName( + ctx context.Context, name string, sender MatrixAPI, ts time.Time, excludeFromTimeline bool, +) bool { if portal.Name == name && (portal.NameSet || portal.MXID == "") { return false } portal.Name = name - portal.NameSet = portal.sendRoomMeta(ctx, sender, ts, event.StateRoomName, "", &event.RoomNameEventContent{Name: name}) + portal.NameSet = portal.sendRoomMeta( + ctx, sender, ts, event.StateRoomName, "", &event.RoomNameEventContent{Name: name}, excludeFromTimeline, nil, + ) return true } -func (portal *Portal) updateTopic(ctx context.Context, topic string, sender MatrixAPI, ts time.Time) bool { +func (portal *Portal) updateTopic( + ctx context.Context, topic string, sender MatrixAPI, ts time.Time, excludeFromTimeline bool, +) bool { if portal.Topic == topic && (portal.TopicSet || portal.MXID == "") { return false } portal.Topic = topic - portal.TopicSet = portal.sendRoomMeta(ctx, sender, ts, event.StateTopic, "", &event.TopicEventContent{Topic: topic}) + portal.TopicSet = portal.sendRoomMeta( + ctx, sender, ts, event.StateTopic, "", &event.TopicEventContent{Topic: topic}, excludeFromTimeline, nil, + ) return true } -func (portal *Portal) updateAvatar(ctx context.Context, avatar *Avatar, sender MatrixAPI, ts time.Time) bool { - if portal.AvatarID == avatar.ID && (portal.AvatarSet || portal.MXID == "") { +func (portal *Portal) updateAvatar( + ctx context.Context, avatar *Avatar, sender MatrixAPI, ts time.Time, excludeFromTimeline bool, +) bool { + if portal.AvatarID == avatar.ID && (avatar.Remove || portal.AvatarMXC != "") && (portal.AvatarSet || portal.MXID == "") { return false } portal.AvatarID = avatar.ID @@ -2884,13 +4189,15 @@ func (portal *Portal) updateAvatar(ctx context.Context, avatar *Avatar, sender M portal.AvatarSet = false zerolog.Ctx(ctx).Err(err).Msg("Failed to reupload room avatar") return true - } else if newHash == portal.AvatarHash && portal.AvatarSet { + } else if newHash == portal.AvatarHash && portal.AvatarMXC != "" && portal.AvatarSet { return true } portal.AvatarMXC = newMXC portal.AvatarHash = newHash } - portal.AvatarSet = portal.sendRoomMeta(ctx, sender, ts, event.StateRoomAvatar, "", &event.RoomAvatarEventContent{URL: portal.AvatarMXC}) + portal.AvatarSet = portal.sendRoomMeta( + ctx, sender, ts, event.StateRoomAvatar, "", &event.RoomAvatarEventContent{URL: portal.AvatarMXC}, excludeFromTimeline, nil, + ) return true } @@ -2904,16 +4211,28 @@ func (portal *Portal) GetTopLevelParent() *Portal { return portal.Parent.GetTopLevelParent() } +func (portal *Portal) getBridgeInfoStateKey() string { + if portal.Bridge.Config.NoBridgeInfoStateKey { + return "" + } + idProvider, ok := portal.Bridge.Matrix.(MatrixConnectorWithBridgeIdentifier) + if ok { + return idProvider.GetUniqueBridgeID() + } + return string(portal.BridgeID) +} + func (portal *Portal) getBridgeInfo() (string, event.BridgeEventContent) { bridgeInfo := event.BridgeEventContent{ BridgeBot: portal.Bridge.Bot.GetMXID(), Creator: portal.Bridge.Bot.GetMXID(), Protocol: portal.Bridge.Network.GetName().AsBridgeInfoSection(), Channel: event.BridgeInfoSection{ - ID: string(portal.ID), - DisplayName: portal.Name, - AvatarURL: portal.AvatarMXC, - Receiver: string(portal.Receiver), + ID: string(portal.ID), + DisplayName: portal.Name, + AvatarURL: portal.AvatarMXC, + Receiver: string(portal.Receiver), + MessageRequest: portal.MessageRequest, // TODO external URL? }, BeeperRoomTypeV2: string(portal.RoomType), @@ -2921,6 +4240,10 @@ func (portal *Portal) getBridgeInfo() (string, event.BridgeEventContent) { if portal.RoomType == database.RoomTypeDM || portal.RoomType == database.RoomTypeGroupDM { bridgeInfo.BeeperRoomType = "dm" } + if bridgeInfo.Protocol.ID == "slackgo" { + bridgeInfo.TempSlackRemoteIDMigratedFlag = true + bridgeInfo.TempSlackRemoteIDMigratedFlag2 = true + } parent := portal.GetTopLevelParent() if parent != nil { bridgeInfo.Network = &event.BridgeInfoSection{ @@ -2934,10 +4257,7 @@ func (portal *Portal) getBridgeInfo() (string, event.BridgeEventContent) { if ok { filler.FillPortalBridgeInfo(portal, &bridgeInfo) } - // TODO use something globally unique instead of bridge ID? - // maybe ask the matrix connector to use serverName+appserviceID+bridgeID - stateKey := string(portal.BridgeID) - return stateKey, bridgeInfo + return portal.getBridgeInfoStateKey(), bridgeInfo } func (portal *Portal) UpdateBridgeInfo(ctx context.Context) { @@ -2945,8 +4265,54 @@ func (portal *Portal) UpdateBridgeInfo(ctx context.Context) { return } stateKey, bridgeInfo := portal.getBridgeInfo() - portal.sendRoomMeta(ctx, nil, time.Now(), event.StateBridge, stateKey, &bridgeInfo) - portal.sendRoomMeta(ctx, nil, time.Now(), event.StateHalfShotBridge, stateKey, &bridgeInfo) + portal.sendRoomMeta(ctx, nil, time.Now(), event.StateBridge, stateKey, &bridgeInfo, false, nil) + portal.sendRoomMeta(ctx, nil, time.Now(), event.StateHalfShotBridge, stateKey, &bridgeInfo, false, nil) +} + +func (portal *Portal) UpdateCapabilities(ctx context.Context, source *UserLogin, implicit bool) bool { + if portal.MXID == "" { + return false + } else if !implicit && time.Since(portal.lastCapUpdate) < 24*time.Hour { + return false + } else if portal.CapState.ID != "" && source.ID != portal.CapState.Source && source.ID != portal.Receiver { + // TODO allow capability state source to change if the old user login is removed from the portal + return false + } + caps := source.Client.GetCapabilities(ctx, portal) + capID := caps.GetID() + if capID == portal.CapState.ID { + return false + } + zerolog.Ctx(ctx).Debug(). + Str("user_login_id", string(source.ID)). + Str("old_id", portal.CapState.ID). + Str("new_id", capID). + Msg("Sending new room capability event") + success := portal.sendRoomMeta(ctx, nil, time.Now(), event.StateBeeperRoomFeatures, portal.getBridgeInfoStateKey(), caps, false, nil) + if !success { + return false + } + portal.CapState = database.CapabilityState{ + Source: source.ID, + ID: capID, + Flags: portal.CapState.Flags, + } + if caps.DisappearingTimer != nil && !portal.CapState.Flags.Has(database.CapStateFlagDisappearingTimerSet) { + zerolog.Ctx(ctx).Debug().Msg("Disappearing timer capability was added, sending disappearing timer state event") + success = portal.sendRoomMeta(ctx, nil, time.Now(), event.StateBeeperDisappearingTimer, "", portal.Disappear.ToEventContent(), true, nil) + if !success { + return false + } + portal.CapState.Flags |= database.CapStateFlagDisappearingTimerSet + } + portal.lastCapUpdate = time.Now() + if implicit { + err := portal.Save(ctx) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to save portal capability state after sending state event") + } + } + return true } func (portal *Portal) sendStateWithIntentOrBot(ctx context.Context, sender MatrixAPI, eventType event.Type, stateKey string, content *event.Content, ts time.Time) (resp *mautrix.RespSendEvent, err error) { @@ -2964,15 +4330,27 @@ func (portal *Portal) sendStateWithIntentOrBot(ctx context.Context, sender Matri return } -func (portal *Portal) sendRoomMeta(ctx context.Context, sender MatrixAPI, ts time.Time, eventType event.Type, stateKey string, content any) bool { +func (portal *Portal) sendRoomMeta( + ctx context.Context, + sender MatrixAPI, + ts time.Time, + eventType event.Type, + stateKey string, + content any, + excludeFromTimeline bool, + extra map[string]any, +) bool { if portal.MXID == "" { return false } - var extra map[string]any + if extra == nil { + extra = make(map[string]any) + } + if excludeFromTimeline { + extra["com.beeper.exclude_from_timeline"] = true + } if !portal.NameIsCustom && (eventType == event.StateRoomName || eventType == event.StateRoomAvatar) { - extra = map[string]any{ - "fi.mau.implicit_name": true, - } + extra["fi.mau.implicit_name"] = true } _, err := portal.sendStateWithIntentOrBot(ctx, sender, eventType, stateKey, &event.Content{ Parsed: content, @@ -2984,9 +4362,55 @@ func (portal *Portal) sendRoomMeta(ctx context.Context, sender MatrixAPI, ts tim Msg("Failed to set room metadata") return false } + if eventType == event.StateBeeperDisappearingTimer { + // TODO remove this debug log at some point + zerolog.Ctx(ctx).Debug(). + Any("content", content). + Msg("Sent new disappearing timer event") + } return true } +func (portal *Portal) revertRoomMeta(ctx context.Context, evt *event.Event) { + if !portal.Bridge.Config.RevertFailedStateChanges { + return + } + if evt.GetStateKey() != "" && evt.Type != event.StateMember { + return + } + switch evt.Type { + case event.StateRoomName: + portal.sendRoomMeta(ctx, nil, time.Time{}, event.StateRoomName, "", &event.RoomNameEventContent{Name: portal.Name}, true, nil) + case event.StateRoomAvatar: + portal.sendRoomMeta(ctx, nil, time.Time{}, event.StateRoomAvatar, "", &event.RoomAvatarEventContent{URL: portal.AvatarMXC}, true, nil) + case event.StateTopic: + portal.sendRoomMeta(ctx, nil, time.Time{}, event.StateTopic, "", &event.TopicEventContent{Topic: portal.Topic}, true, nil) + case event.StateBeeperDisappearingTimer: + portal.sendRoomMeta(ctx, nil, time.Time{}, event.StateBeeperDisappearingTimer, "", portal.Disappear.ToEventContent(), true, nil) + case event.StateMember: + var prevContent *event.MemberEventContent + var extra map[string]any + if evt.Unsigned.PrevContent != nil { + _ = evt.Unsigned.PrevContent.ParseRaw(evt.Type) + prevContent = evt.Unsigned.PrevContent.AsMember() + newContent := evt.Content.AsMember() + if prevContent.Membership == newContent.Membership { + return + } + extra = evt.Unsigned.PrevContent.Raw + } else { + prevContent = &event.MemberEventContent{Membership: event.MembershipLeave} + } + if portal.Bridge.Matrix.GetCapabilities().ArbitraryMemberChange { + if extra == nil { + extra = make(map[string]any) + } + extra["com.beeper.member_rollback"] = true + portal.sendRoomMeta(ctx, nil, time.Time{}, event.StateMember, evt.GetStateKey(), prevContent, true, extra) + } + } +} + func (portal *Portal) getInitialMemberList(ctx context.Context, members *ChatMemberList, source *UserLogin, pl *event.PowerLevelsEventContent) (invite, functional []id.UserID, err error) { if members == nil { invite = []id.UserID{source.UserMXID} @@ -3003,6 +4427,10 @@ func (portal *Portal) getInitialMemberList(ctx context.Context, members *ChatMem members.PowerLevels.Apply("", pl) members.memberListToMap(ctx) for _, member := range members.MemberMap { + if ctx.Err() != nil { + err = ctx.Err() + return + } if member.Membership != event.MembershipJoin && member.Membership != "" { continue } @@ -3014,7 +4442,10 @@ func (portal *Portal) getInitialMemberList(ctx context.Context, members *ChatMem ghost.UpdateInfo(ctx, member.UserInfo) } } - intent, extraUserID := portal.getIntentAndUserMXIDFor(ctx, member.EventSender, source, loginsInPortal, 0) + intent, extraUserID, err := portal.getIntentAndUserMXIDFor(ctx, member.EventSender, source, loginsInPortal, 0) + if err != nil { + return nil, nil, err + } if extraUserID != "" { invite = append(invite, extraUserID) if member.PowerLevel != nil { @@ -3063,7 +4494,46 @@ func (portal *Portal) updateOtherUser(ctx context.Context, members *ChatMemberLi return false } -func (portal *Portal) syncParticipants(ctx context.Context, members *ChatMemberList, source *UserLogin, sender MatrixAPI, ts time.Time) error { +func looksDirectlyJoinable(rule *event.JoinRulesEventContent) bool { + switch rule.JoinRule { + case event.JoinRulePublic: + return true + case event.JoinRuleKnockRestricted, event.JoinRuleRestricted: + for _, allow := range rule.Allow { + if allow.Type == "fi.mau.spam_checker" { + return true + } + } + } + return false +} + +func (portal *Portal) roomIsPublic(ctx context.Context) bool { + mx, ok := portal.Bridge.Matrix.(MatrixConnectorWithArbitraryRoomState) + if !ok { + return false + } + evt, err := mx.GetStateEvent(ctx, portal.MXID, event.StateJoinRules, "") + if err != nil { + zerolog.Ctx(ctx).Warn().Err(err).Msg("Failed to get join rules to check if room is public") + return false + } else if evt == nil { + return false + } + content, ok := evt.Content.Parsed.(*event.JoinRulesEventContent) + if !ok { + return false + } + return looksDirectlyJoinable(content) +} + +func (portal *Portal) syncParticipants( + ctx context.Context, + members *ChatMemberList, + source *UserLogin, + sender MatrixAPI, + ts time.Time, +) error { members.memberListToMap(ctx) var loginsInPortal []*UserLogin var err error @@ -3087,7 +4557,13 @@ func (portal *Portal) syncParticipants(ctx context.Context, members *ChatMemberL } delete(currentMembers, portal.Bridge.Bot.GetMXID()) powerChanged := members.PowerLevels.Apply(portal.Bridge.Bot.GetMXID(), currentPower) - syncUser := func(extraUserID id.UserID, member ChatMember, hasIntent bool) bool { + addExcludeFromTimeline := func(raw map[string]any) { + _, hasKey := raw["com.beeper.exclude_from_timeline"] + if !hasKey && members.ExcludeChangesFromTimeline { + raw["com.beeper.exclude_from_timeline"] = true + } + } + syncUser := func(extraUserID id.UserID, member ChatMember, intent MatrixAPI) bool { if member.Membership == "" { member.Membership = event.MembershipJoin } @@ -3116,58 +4592,74 @@ func (portal *Portal) syncParticipants(ctx context.Context, members *ChatMemberL Displayname: currentMember.Displayname, AvatarURL: currentMember.AvatarURL, } - wrappedContent := &event.Content{Parsed: content, Raw: make(map[string]any)} + wrappedContent := &event.Content{Parsed: content, Raw: exmaps.NonNilClone(member.MemberEventExtra)} + addExcludeFromTimeline(wrappedContent.Raw) thisEvtSender := sender - if member.Membership == event.MembershipJoin { + if member.Membership == event.MembershipJoin && (intent == nil || !portal.roomIsPublic(ctx)) { content.Membership = event.MembershipInvite - if hasIntent { + if intent != nil { wrappedContent.Raw["fi.mau.will_auto_accept"] = true } if thisEvtSender.GetMXID() == extraUserID { thisEvtSender = portal.Bridge.Bot } } + addLogContext := func(e *zerolog.Event) *zerolog.Event { + return e.Stringer("target_user_id", extraUserID). + Stringer("sender_user_id", thisEvtSender.GetMXID()). + Str("prev_membership", string(currentMember.Membership)) + } if currentMember != nil && currentMember.Membership == event.MembershipBan && member.Membership != event.MembershipLeave { unbanContent := *content unbanContent.Membership = event.MembershipLeave wrappedUnbanContent := &event.Content{Parsed: &unbanContent} _, err = portal.sendStateWithIntentOrBot(ctx, thisEvtSender, event.StateMember, extraUserID.String(), wrappedUnbanContent, ts) if err != nil { - log.Err(err). - Stringer("target_user_id", extraUserID). - Stringer("sender_user_id", thisEvtSender.GetMXID()). - Str("prev_membership", string(currentMember.Membership)). - Str("membership", string(member.Membership)). + addLogContext(log.Err(err)). + Str("new_membership", string(unbanContent.Membership)). Msg("Failed to unban user to update membership") } else { - log.Trace(). - Stringer("target_user_id", extraUserID). - Stringer("sender_user_id", thisEvtSender.GetMXID()). - Str("prev_membership", string(currentMember.Membership)). - Str("membership", string(member.Membership)). + addLogContext(log.Trace()). + Str("new_membership", string(unbanContent.Membership)). Msg("Unbanned user to update membership") + currentMember.Membership = event.MembershipLeave } } - _, err = portal.sendStateWithIntentOrBot(ctx, thisEvtSender, event.StateMember, extraUserID.String(), wrappedContent, ts) + if content.Membership == event.MembershipJoin && intent != nil && intent.GetMXID() == extraUserID { + _, err = intent.SendState(ctx, portal.MXID, event.StateMember, extraUserID.String(), wrappedContent, ts) + } else { + _, err = portal.sendStateWithIntentOrBot(ctx, thisEvtSender, event.StateMember, extraUserID.String(), wrappedContent, ts) + } if err != nil { - log.Err(err). - Stringer("target_user_id", extraUserID). - Stringer("sender_user_id", thisEvtSender.GetMXID()). - Str("prev_membership", string(currentMember.Membership)). - Str("membership", string(member.Membership)). + addLogContext(log.Err(err)). + Str("new_membership", string(content.Membership)). Msg("Failed to update user membership") } else { - log.Trace(). - Stringer("target_user_id", extraUserID). - Stringer("sender_user_id", thisEvtSender.GetMXID()). - Str("prev_membership", string(currentMember.Membership)). - Str("membership", string(member.Membership)). - Msg("Updating membership in room") + addLogContext(log.Trace()). + Str("new_membership", string(content.Membership)). + Msg("Updated membership in room") + currentMember.Membership = content.Membership + + if intent != nil && content.Membership == event.MembershipInvite && member.Membership == event.MembershipJoin { + content.Membership = event.MembershipJoin + wrappedJoinContent := &event.Content{Parsed: content, Raw: exmaps.NonNilClone(member.MemberEventExtra)} + addExcludeFromTimeline(wrappedContent.Raw) + _, err = intent.SendState(ctx, portal.MXID, event.StateMember, intent.GetMXID().String(), wrappedJoinContent, ts) + if err != nil { + addLogContext(log.Err(err)). + Str("new_membership", string(content.Membership)). + Msg("Failed to join with intent") + } else { + addLogContext(log.Trace()). + Str("new_membership", string(content.Membership)). + Msg("Joined room with intent") + } + } } return true } syncIntent := func(intent MatrixAPI, member ChatMember) { - if !syncUser(intent.GetMXID(), member, true) { + if !syncUser(intent.GetMXID(), member, intent) { return } if member.Membership == event.MembershipJoin || member.Membership == "" { @@ -3180,6 +4672,9 @@ func (portal *Portal) syncParticipants(ctx context.Context, members *ChatMemberL } } for _, member := range members.MemberMap { + if ctx.Err() != nil { + return ctx.Err() + } if member.Sender != "" && member.UserInfo != nil { ghost, err := portal.Bridge.GetGhostByID(ctx, member.Sender) if err != nil { @@ -3188,12 +4683,15 @@ func (portal *Portal) syncParticipants(ctx context.Context, members *ChatMemberL ghost.UpdateInfo(ctx, member.UserInfo) } } - intent, extraUserID := portal.getIntentAndUserMXIDFor(ctx, member.EventSender, source, loginsInPortal, 0) + intent, extraUserID, err := portal.getIntentAndUserMXIDFor(ctx, member.EventSender, source, loginsInPortal, 0) + if err != nil { + return err + } if intent != nil { syncIntent(intent, member) } if extraUserID != "" { - syncUser(extraUserID, member, false) + syncUser(extraUserID, member, nil) } } if powerChanged { @@ -3208,7 +4706,7 @@ func (portal *Portal) syncParticipants(ctx context.Context, members *ChatMemberL if memberEvt.Membership == event.MembershipLeave || memberEvt.Membership == event.MembershipBan { continue } - if !portal.Bridge.IsGhostMXID(extraMember) && portal.Relay != nil { + if !portal.Bridge.IsGhostMXID(extraMember) && (portal.Relay != nil || !portal.Bridge.Config.KickMatrixUsers) { continue } _, err = portal.Bridge.Bot.SendState(ctx, portal.MXID, event.StateMember, extraMember.String(), &event.Content{ @@ -3218,6 +4716,9 @@ func (portal *Portal) syncParticipants(ctx context.Context, members *ChatMemberL Displayname: memberEvt.Displayname, Reason: "User is not in remote chat", }, + Raw: map[string]any{ + "com.beeper.exclude_from_timeline": members.ExcludeChangesFromTimeline, + }, }, time.Now()) if err != nil { zerolog.Ctx(ctx).Err(err). @@ -3255,7 +4756,11 @@ func (portal *Portal) updateUserLocalInfo(ctx context.Context, info *UserLocalPo zerolog.Ctx(ctx).Err(err).Msg("Failed to mute room") } } - if info.Tag != nil && (didJustCreate || !portal.Bridge.Config.TagOnlyOnCreate) && (!didJustCreate || *info.Tag != "") { + if info.Tag != nil && + len(portal.Bridge.Config.OnlyBridgeTags) > 0 && + (*info.Tag == "" || slices.Contains(portal.Bridge.Config.OnlyBridgeTags, *info.Tag)) && + (didJustCreate || !portal.Bridge.Config.TagOnlyOnCreate) && + (!didJustCreate || *info.Tag != "") { err := dp.TagRoom(ctx, portal.MXID, *info.Tag, *info.Tag != "") if err != nil { zerolog.Ctx(ctx).Err(err).Msg("Failed to tag room") @@ -3266,27 +4771,44 @@ func (portal *Portal) updateUserLocalInfo(ctx context.Context, info *UserLocalPo func DisappearingMessageNotice(expiration time.Duration, implicit bool) *event.MessageEventContent { formattedDuration := exfmt.DurationCustom(expiration, nil, exfmt.Day, time.Hour, time.Minute, time.Second) content := &event.MessageEventContent{ - MsgType: event.MsgNotice, - Body: fmt.Sprintf("Set the disappearing message timer to %s", formattedDuration), + MsgType: event.MsgNotice, + Body: fmt.Sprintf("Set the disappearing message timer to %s", formattedDuration), + Mentions: &event.Mentions{}, } - if implicit { + if expiration == 0 { + if implicit { + content.Body = "Automatically turned off disappearing messages because incoming message is not disappearing" + } else { + content.Body = "Turned off disappearing messages" + } + } else if implicit { content.Body = fmt.Sprintf("Automatically enabled disappearing message timer (%s) because incoming message is disappearing", formattedDuration) - } else if expiration == 0 { - content.Body = "Turned off disappearing messages" } return content } -func (portal *Portal) UpdateDisappearingSetting(ctx context.Context, setting database.DisappearingSetting, sender MatrixAPI, ts time.Time, implicit, save bool) bool { - if setting.Timer == 0 { - setting.Type = "" - } +type UpdateDisappearingSettingOpts struct { + Sender MatrixAPI + Timestamp time.Time + Implicit bool + Save bool + SendNotice bool + + ExcludeFromTimeline bool +} + +func (portal *Portal) UpdateDisappearingSetting( + ctx context.Context, + setting database.DisappearingSetting, + opts UpdateDisappearingSettingOpts, +) bool { + setting = setting.Normalize() if portal.Disappear.Timer == setting.Timer && portal.Disappear.Type == setting.Type { return false } portal.Disappear.Type = setting.Type portal.Disappear.Timer = setting.Timer - if save { + if opts.Save { err := portal.Save(ctx) if err != nil { zerolog.Ctx(ctx).Err(err).Msg("Failed to save portal to database after updating disappearing setting") @@ -3295,19 +4817,45 @@ func (portal *Portal) UpdateDisappearingSetting(ctx context.Context, setting dat if portal.MXID == "" { return true } - content := DisappearingMessageNotice(setting.Timer, implicit) - if sender == nil { - sender = portal.Bridge.Bot + + if opts.Sender == nil { + opts.Sender = portal.Bridge.Bot } - _, err := sender.SendMessage(ctx, portal.MXID, event.EventMessage, &event.Content{ + if opts.Timestamp.IsZero() { + opts.Timestamp = time.Now() + } + portal.sendRoomMeta( + ctx, + opts.Sender, + opts.Timestamp, + event.StateBeeperDisappearingTimer, + "", + setting.ToEventContent(), + opts.ExcludeFromTimeline, + nil, + ) + + if !opts.SendNotice { + return true + } + content := DisappearingMessageNotice(setting.Timer, opts.Implicit) + _, err := opts.Sender.SendMessage(ctx, portal.MXID, event.EventMessage, &event.Content{ Parsed: content, - }, &MatrixSendExtra{Timestamp: ts}) + Raw: map[string]any{ + "com.beeper.action_message": map[string]any{ + "type": "disappearing_timer", + "timer": setting.Timer.Milliseconds(), + "timer_type": setting.Type, + "implicit": opts.Implicit, + }, + }, + }, &MatrixSendExtra{Timestamp: opts.Timestamp}) if err != nil { zerolog.Ctx(ctx).Err(err).Msg("Failed to send disappearing messages notice") } else { zerolog.Ctx(ctx).Debug(). Dur("new_timer", portal.Disappear.Timer). - Bool("implicit", implicit). + Bool("implicit", opts.Implicit). Msg("Sent disappearing messages notice") } return true @@ -3369,38 +4917,51 @@ func (portal *Portal) UpdateInfoFromGhost(ctx context.Context, ghost *Ghost) (ch return } } - changed = portal.updateName(ctx, ghost.Name, nil, time.Time{}) || changed + changed = portal.updateName(ctx, ghost.Name, nil, time.Time{}, false) || changed changed = portal.updateAvatar(ctx, &Avatar{ ID: ghost.AvatarID, MXC: ghost.AvatarMXC, Hash: ghost.AvatarHash, Remove: ghost.AvatarID == "", - }, nil, time.Time{}) || changed + }, nil, time.Time{}, false) || changed return } func (portal *Portal) UpdateInfo(ctx context.Context, info *ChatInfo, source *UserLogin, sender MatrixAPI, ts time.Time) { changed := false - if info.Name != nil { + if info.Name == DefaultChatName { + if portal.NameIsCustom { + portal.NameIsCustom = false + changed = portal.updateName(ctx, "", sender, ts, info.ExcludeChangesFromTimeline) || changed + } + } else if info.Name != nil { portal.NameIsCustom = true - changed = portal.updateName(ctx, *info.Name, sender, ts) || changed + changed = portal.updateName(ctx, *info.Name, sender, ts, info.ExcludeChangesFromTimeline) || changed } if info.Topic != nil { - changed = portal.updateTopic(ctx, *info.Topic, sender, ts) || changed + changed = portal.updateTopic(ctx, *info.Topic, sender, ts, info.ExcludeChangesFromTimeline) || changed } if info.Avatar != nil { portal.NameIsCustom = true - changed = portal.updateAvatar(ctx, info.Avatar, sender, ts) || changed + changed = portal.updateAvatar(ctx, info.Avatar, sender, ts, info.ExcludeChangesFromTimeline) || changed } if info.Disappear != nil { - changed = portal.UpdateDisappearingSetting(ctx, *info.Disappear, sender, ts, false, false) || changed + changed = portal.UpdateDisappearingSetting(ctx, *info.Disappear, UpdateDisappearingSettingOpts{ + Sender: sender, + Timestamp: ts, + Implicit: false, + Save: false, + + SendNotice: !info.ExcludeChangesFromTimeline, + ExcludeFromTimeline: info.ExcludeChangesFromTimeline, + }) || changed } if info.ParentID != nil { changed = portal.updateParent(ctx, *info.ParentID, source) || changed } if info.JoinRule != nil { // TODO change detection instead of spamming this every time? - portal.sendRoomMeta(ctx, sender, ts, event.StateJoinRules, "", info.JoinRule) + portal.sendRoomMeta(ctx, sender, ts, event.StateJoinRules, "", info.JoinRule, info.ExcludeChangesFromTimeline, nil) } if info.Type != nil && portal.RoomType != *info.Type { if portal.MXID != "" && (*info.Type == database.RoomTypeSpace || portal.RoomType == database.RoomTypeSpace) { @@ -3413,6 +4974,10 @@ func (portal *Portal) UpdateInfo(ctx context.Context, info *ChatInfo, source *Us portal.RoomType = *info.Type } } + if info.MessageRequest != nil && *info.MessageRequest != portal.MessageRequest { + changed = true + portal.MessageRequest = *info.MessageRequest + } if info.Members != nil && portal.MXID != "" && source != nil { err := portal.syncParticipants(ctx, info.Members, source, nil, time.Time{}) if err != nil { @@ -3426,6 +4991,7 @@ func (portal *Portal) UpdateInfo(ctx context.Context, info *ChatInfo, source *Us if source != nil { source.MarkInPortal(ctx, portal) portal.updateUserLocalInfo(ctx, info.UserLocal, source, false) + changed = portal.UpdateCapabilities(ctx, source, false) || changed } if info.CanBackfill && source != nil && portal.MXID != "" { err := portal.Bridge.DB.BackfillTask.EnsureExists(ctx, portal.PortalKey, source.ID) @@ -3453,9 +5019,12 @@ func (portal *Portal) CreateMatrixRoom(ctx context.Context, source *UserLogin, i } return nil } + if portal.deleted.IsSet() { + return ErrPortalIsDeleted + } waiter := make(chan struct{}) closed := false - portal.events <- &portalCreateEvent{ + evt := &portalCreateEvent{ ctx: ctx, source: source, info: info, @@ -3467,6 +5036,15 @@ func (portal *Portal) CreateMatrixRoom(ctx context.Context, source *UserLogin, i } }, } + if PortalEventBuffer == 0 { + go portal.queueEvent(ctx, evt) + } else { + select { + case portal.events <- evt: + case <-portal.deleted.GetChan(): + return ErrPortalIsDeleted + } + } select { case <-ctx.Done(): return ctx.Err() @@ -3476,7 +5054,11 @@ func (portal *Portal) CreateMatrixRoom(ctx context.Context, source *UserLogin, i } func (portal *Portal) createMatrixRoomInLoop(ctx context.Context, source *UserLogin, info *ChatInfo, backfillBundle any) error { + cancellableCtx, cancel := context.WithCancel(ctx) + defer cancel() + portal.cancelRoomCreate.CompareAndSwap(nil, &cancel) portal.roomCreateLock.Lock() + portal.cancelRoomCreate.Store(&cancel) defer portal.roomCreateLock.Unlock() if portal.MXID != "" { if source != nil { @@ -3487,6 +5069,7 @@ func (portal *Portal) createMatrixRoomInLoop(ctx context.Context, source *UserLo log := zerolog.Ctx(ctx).With(). Str("action", "create matrix room"). Logger() + cancellableCtx = log.WithContext(cancellableCtx) ctx = log.WithContext(ctx) log.Info().Msg("Creating Matrix room") @@ -3495,14 +5078,17 @@ func (portal *Portal) createMatrixRoomInLoop(ctx context.Context, source *UserLo if info != nil { log.Warn().Msg("CreateMatrixRoom got info without members. Refetching info") } - info, err = source.Client.GetChatInfo(ctx, portal) + info, err = source.Client.GetChatInfo(cancellableCtx, portal) if err != nil { log.Err(err).Msg("Failed to update portal info for creation") return err } } - portal.UpdateInfo(ctx, info, source, nil, time.Time{}) + portal.UpdateInfo(cancellableCtx, info, source, nil, time.Time{}) + if cancellableCtx.Err() != nil { + return cancellableCtx.Err() + } powerLevels := &event.PowerLevelsEventContent{ Events: map[string]int{ @@ -3514,7 +5100,7 @@ func (portal *Portal) createMatrixRoomInLoop(ctx context.Context, source *UserLo portal.Bridge.Bot.GetMXID(): 9001, }, } - initialMembers, extraFunctionalMembers, err := portal.getInitialMemberList(ctx, info.Members, source, powerLevels) + initialMembers, extraFunctionalMembers, err := portal.getInitialMemberList(cancellableCtx, info.Members, source, powerLevels) if err != nil { log.Err(err).Msg("Failed to process participant list for portal creation") return err @@ -3523,14 +5109,12 @@ func (portal *Portal) createMatrixRoomInLoop(ctx context.Context, source *UserLo req := mautrix.ReqCreateRoom{ Visibility: "private", - Name: portal.Name, - Topic: portal.Topic, CreationContent: make(map[string]any), InitialState: make([]*event.Event, 0, 6), Preset: "private_chat", IsDirect: portal.RoomType == database.RoomTypeDM, PowerLevelOverride: powerLevels, - BeeperLocalRoomID: id.RoomID(fmt.Sprintf("!%s.%s:%s", portal.ID, portal.Receiver, portal.Bridge.Matrix.ServerName())), + BeeperLocalRoomID: portal.Bridge.Matrix.GenerateDeterministicRoomID(portal.PortalKey), } autoJoinInvites := portal.Bridge.Matrix.GetCapabilities().AutoJoinInvites if autoJoinInvites { @@ -3543,6 +5127,11 @@ func (portal *Portal) createMatrixRoomInLoop(ctx context.Context, source *UserLo req.CreationContent["type"] = event.RoomTypeSpace } bridgeInfoStateKey, bridgeInfo := portal.getBridgeInfo() + roomFeatures := source.Client.GetCapabilities(cancellableCtx, portal) + portal.CapState = database.CapabilityState{ + Source: source.ID, + ID: roomFeatures.GetID(), + } req.InitialState = append(req.InitialState, &event.Event{ Type: event.StateElementFunctionalMembers, @@ -3557,19 +5146,51 @@ func (portal *Portal) createMatrixRoomInLoop(ctx context.Context, source *UserLo StateKey: &bridgeInfoStateKey, Type: event.StateBridge, Content: event.Content{Parsed: &bridgeInfo}, + }, &event.Event{ + StateKey: &bridgeInfoStateKey, + Type: event.StateBeeperRoomFeatures, + Content: event.Content{Parsed: roomFeatures}, + }, &event.Event{ + Type: event.StateTopic, + Content: event.Content{ + Parsed: &event.TopicEventContent{Topic: portal.Topic}, + Raw: map[string]any{ + "com.beeper.exclude_from_timeline": true, + }, + }, }) - if req.Topic == "" { - // Add explicit topic event if topic is empty to ensure the event is set. - // This ensures that there won't be an extra event later if PUT /state/... is called. + if roomFeatures.DisappearingTimer != nil { req.InitialState = append(req.InitialState, &event.Event{ - Type: event.StateTopic, - Content: event.Content{Parsed: &event.TopicEventContent{Topic: ""}}, + Type: event.StateBeeperDisappearingTimer, + Content: event.Content{ + Parsed: portal.Disappear.ToEventContent(), + Raw: map[string]any{ + "com.beeper.exclude_from_timeline": true, + }, + }, + }) + portal.CapState.Flags |= database.CapStateFlagDisappearingTimerSet + } + if portal.Name != "" { + req.InitialState = append(req.InitialState, &event.Event{ + Type: event.StateRoomName, + Content: event.Content{ + Parsed: &event.RoomNameEventContent{Name: portal.Name}, + Raw: map[string]any{ + "com.beeper.exclude_from_timeline": true, + }, + }, }) } if portal.AvatarMXC != "" { req.InitialState = append(req.InitialState, &event.Event{ - Type: event.StateRoomAvatar, - Content: event.Content{Parsed: &event.RoomAvatarEventContent{URL: portal.AvatarMXC}}, + Type: event.StateRoomAvatar, + Content: event.Content{ + Parsed: &event.RoomAvatarEventContent{URL: portal.AvatarMXC}, + Raw: map[string]any{ + "com.beeper.exclude_from_timeline": true, + }, + }, }) } if portal.Parent != nil && portal.Parent.MXID != "" { @@ -3588,6 +5209,9 @@ func (portal *Portal) createMatrixRoomInLoop(ctx context.Context, source *UserLo Content: event.Content{Parsed: info.JoinRule}, }) } + if cancellableCtx.Err() != nil { + return cancellableCtx.Err() + } roomID, err := portal.Bridge.Bot.CreateRoom(ctx, &req) if err != nil { log.Err(err).Msg("Failed to create Matrix room") @@ -3598,6 +5222,7 @@ func (portal *Portal) createMatrixRoomInLoop(ctx context.Context, source *UserLo portal.TopicSet = true portal.NameSet = true portal.MXID = roomID + portal.RoomCreated.Set() portal.Bridge.cacheLock.Lock() portal.Bridge.portalsByMXID[roomID] = portal portal.Bridge.cacheLock.Unlock() @@ -3607,7 +5232,7 @@ func (portal *Portal) createMatrixRoomInLoop(ctx context.Context, source *UserLo log.Err(err).Msg("Failed to save portal to database after creating Matrix room") return err } - if info.CanBackfill { + if info.CanBackfill && portal.RoomType != database.RoomTypeSpace { err = portal.Bridge.DB.BackfillTask.Upsert(ctx, &database.BackfillTask{ PortalKey: portal.PortalKey, UserLoginID: source.ID, @@ -3618,7 +5243,7 @@ func (portal *Portal) createMatrixRoomInLoop(ctx context.Context, source *UserLo } portal.Bridge.WakeupBackfillQueue() } - withoutCancelCtx := context.WithoutCancel(ctx) + withoutCancelCtx := zerolog.Ctx(ctx).WithContext(portal.Bridge.BackgroundCtx) if portal.Parent != nil { if portal.Parent.MXID != "" { portal.addToParentSpaceAndSave(ctx, true) @@ -3644,42 +5269,55 @@ func (portal *Portal) createMatrixRoomInLoop(ctx context.Context, source *UserLo } } } - if portal.Parent == nil { - if portal.Receiver != "" { - login := portal.Bridge.GetCachedUserLoginByID(portal.Receiver) - if login != nil { - up, err := portal.Bridge.DB.UserPortal.Get(ctx, login.UserLogin, portal.PortalKey) - if err != nil { - log.Err(err).Msg("Failed to get user portal to add portal to spaces") - } else { - login.inPortalCache.Remove(portal.PortalKey) - go login.tryAddPortalToSpace(withoutCancelCtx, portal, up.CopyWithoutValues()) - } - } - } else { - userPortals, err := portal.Bridge.DB.UserPortal.GetAllInPortal(ctx, portal.PortalKey) - if err != nil { - log.Err(err).Msg("Failed to get user logins in portal to add portal to spaces") - } else { - for _, up := range userPortals { - login := portal.Bridge.GetCachedUserLoginByID(up.LoginID) - if login != nil { - login.inPortalCache.Remove(portal.PortalKey) - go login.tryAddPortalToSpace(withoutCancelCtx, portal, up.CopyWithoutValues()) - } - } - } - } - } - if portal.Bridge.Config.Backfill.Enabled { + portal.addToUserSpaces(ctx) + if info.CanBackfill && + portal.Bridge.Config.Backfill.Enabled && + portal.RoomType != database.RoomTypeSpace && + !portal.Bridge.Background { portal.doForwardBackfill(ctx, source, nil, backfillBundle) } return nil } +func (portal *Portal) addToUserSpaces(ctx context.Context) { + if portal.Parent != nil { + return + } + log := zerolog.Ctx(ctx) + withoutCancelCtx := log.WithContext(portal.Bridge.BackgroundCtx) + if portal.Receiver != "" { + login := portal.Bridge.GetCachedUserLoginByID(portal.Receiver) + if login != nil { + up, err := portal.Bridge.DB.UserPortal.GetOrCreate(ctx, login.UserLogin, portal.PortalKey) + if err != nil { + log.Err(err).Msg("Failed to get user portal to add portal to spaces") + } else { + login.inPortalCache.Remove(portal.PortalKey) + go login.tryAddPortalToSpace(withoutCancelCtx, portal, up.CopyWithoutValues()) + } + } + } else { + userPortals, err := portal.Bridge.DB.UserPortal.GetAllInPortal(ctx, portal.PortalKey) + if err != nil { + log.Err(err).Msg("Failed to get user logins in portal to add portal to spaces") + } else { + for _, up := range userPortals { + login := portal.Bridge.GetCachedUserLoginByID(up.LoginID) + if login != nil { + login.inPortalCache.Remove(portal.PortalKey) + go login.tryAddPortalToSpace(withoutCancelCtx, portal, up.CopyWithoutValues()) + } + } + } + } +} + func (portal *Portal) Delete(ctx context.Context) error { + if portal.deleted.IsSet() { + return nil + } portal.removeInPortalCache(ctx) - err := portal.Bridge.DB.Portal.Delete(ctx, portal.PortalKey) + err := portal.safeDBDelete(ctx) if err != nil { return err } @@ -3689,11 +5327,21 @@ func (portal *Portal) Delete(ctx context.Context) error { return nil } +func (portal *Portal) safeDBDelete(ctx context.Context) error { + err := portal.Bridge.DB.Message.DeleteInChunks(ctx, portal.PortalKey) + if err != nil { + return fmt.Errorf("failed to delete messages in portal: %w", err) + } + // TODO delete child portals? + return portal.Bridge.DB.Portal.Delete(ctx, portal.PortalKey) +} + func (portal *Portal) RemoveMXID(ctx context.Context) error { if portal.MXID == "" { return nil } portal.MXID = "" + portal.RoomCreated.Clear() err := portal.Save(ctx) if err != nil { return err @@ -3726,8 +5374,10 @@ func (portal *Portal) removeInPortalCache(ctx context.Context) { } func (portal *Portal) unlockedDelete(ctx context.Context) error { - // TODO delete child portals? - err := portal.Bridge.DB.Portal.Delete(ctx, portal.PortalKey) + if portal.deleted.IsSet() { + return nil + } + err := portal.safeDBDelete(ctx) if err != nil { return err } @@ -3736,10 +5386,18 @@ func (portal *Portal) unlockedDelete(ctx context.Context) error { } func (portal *Portal) unlockedDeleteCache() { + if portal.deleted.IsSet() { + return + } delete(portal.Bridge.portalsByKey, portal.PortalKey) if portal.MXID != "" { delete(portal.Bridge.portalsByMXID, portal.MXID) } + portal.deleted.Set() + if portal.events != nil { + // TODO there's a small risk of this racing with a queueEvent call + close(portal.events) + } } func (portal *Portal) Save(ctx context.Context) error { @@ -3747,6 +5405,9 @@ func (portal *Portal) Save(ctx context.Context) error { } func (portal *Portal) SetRelay(ctx context.Context, relay *UserLogin) error { + if portal.Receiver != "" && relay.ID != portal.Receiver { + return fmt.Errorf("can't set non-receiver login as relay") + } portal.Relay = relay if relay == nil { portal.RelayLoginID = "" @@ -3759,3 +5420,17 @@ func (portal *Portal) SetRelay(ctx context.Context, relay *UserLogin) error { } return nil } + +func (portal *Portal) PerMessageProfileForSender(ctx context.Context, sender networkid.UserID) (profile event.BeeperPerMessageProfile, err error) { + var ghost *Ghost + ghost, err = portal.Bridge.GetGhostByID(ctx, sender) + if err != nil { + return + } + profile.ID = string(ghost.Intent.GetMXID()) + profile.Displayname = ghost.Name + if ghost.AvatarMXC != "" { + profile.AvatarURL = &ghost.AvatarMXC + } + return +} diff --git a/bridgev2/portalbackfill.go b/bridgev2/portalbackfill.go index 55225efc..879f07ae 100644 --- a/bridgev2/portalbackfill.go +++ b/bridgev2/portalbackfill.go @@ -61,6 +61,9 @@ func (portal *Portal) doForwardBackfill(ctx context.Context, source *UserLogin, return } else if len(resp.Messages) == 0 { log.Debug().Msg("No messages to backfill") + if resp.CompleteCallback != nil { + resp.CompleteCallback() + } return } log.Debug(). @@ -191,6 +194,9 @@ func (portal *Portal) doThreadBackfill(ctx context.Context, source *UserLogin, t if err != nil { log.Err(err).Msg("Failed to get last thread message") return + } else if anchorMessage == nil { + log.Warn().Msg("No messages found in thread?") + return } resp := portal.fetchThreadBackfill(ctx, source, anchorMessage) if resp != nil { @@ -320,8 +326,13 @@ func (portal *Portal) compileBatchMessage(ctx context.Context, source *UserLogin if len(msg.Parts) == 0 { return } - intent := portal.GetIntentFor(ctx, msg.Sender, source, RemoteEventMessage) - replyTo, threadRoot, prevThreadEvent := portal.getRelationMeta(ctx, msg.ID, msg.ReplyTo, msg.ThreadRoot, true) + intent, ok := portal.GetIntentFor(ctx, msg.Sender, source, RemoteEventMessage) + if !ok { + return + } + replyTo, threadRoot, prevThreadEvent := portal.getRelationMeta( + ctx, msg.ID, msg.ConvertedMessage, true, + ) if threadRoot != nil && out.PrevThreadEvents[*msg.ThreadRoot] != "" { prevThreadEvent.MXID = out.PrevThreadEvents[*msg.ThreadRoot] } @@ -330,19 +341,21 @@ func (portal *Portal) compileBatchMessage(ctx context.Context, source *UserLogin var firstPart *database.Message for i, part := range msg.Parts { partIDs = append(partIDs, part.ID) - portal.applyRelationMeta(part.Content, replyTo, threadRoot, prevThreadEvent) + portal.applyRelationMeta(ctx, part.Content, replyTo, threadRoot, prevThreadEvent) + part.Content.BeeperDisappearingTimer = msg.Disappear.ToEventContent() evtID := portal.Bridge.Matrix.GenerateDeterministicEventID(portal.MXID, portal.PortalKey, msg.ID, part.ID) dbMessage := &database.Message{ - ID: msg.ID, - PartID: part.ID, - MXID: evtID, - Room: portal.PortalKey, - SenderID: msg.Sender.Sender, - SenderMXID: intent.GetMXID(), - Timestamp: msg.Timestamp, - ThreadRoot: ptr.Val(msg.ThreadRoot), - ReplyTo: ptr.Val(msg.ReplyTo), - Metadata: part.DBMetadata, + ID: msg.ID, + PartID: part.ID, + MXID: evtID, + Room: portal.PortalKey, + SenderID: msg.Sender.Sender, + SenderMXID: intent.GetMXID(), + Timestamp: msg.Timestamp, + ThreadRoot: ptr.Val(msg.ThreadRoot), + ReplyTo: ptr.Val(msg.ReplyTo), + Metadata: part.DBMetadata, + IsDoublePuppeted: intent.IsDoublePuppet(), } if part.DontBridge { dbMessage.SetFakeMXID() @@ -370,26 +383,34 @@ func (portal *Portal) compileBatchMessage(ctx context.Context, source *UserLogin prevThreadEvent.MXID = evtID out.PrevThreadEvents[*msg.ThreadRoot] = evtID } - if msg.Disappear.Type != database.DisappearingTypeNone { - if msg.Disappear.Type == database.DisappearingTypeAfterSend && msg.Disappear.DisappearAt.IsZero() { + if msg.Disappear.Type != event.DisappearingTypeNone { + if msg.Disappear.Type == event.DisappearingTypeAfterSend && msg.Disappear.DisappearAt.IsZero() { msg.Disappear.DisappearAt = msg.Timestamp.Add(msg.Disappear.Timer) } out.Disappear = append(out.Disappear, &database.DisappearingMessage{ RoomID: portal.MXID, EventID: evtID, + Timestamp: msg.Timestamp, DisappearingSetting: msg.Disappear, }) } } slices.Sort(partIDs) for _, reaction := range msg.Reactions { - reactionIntent := portal.GetIntentFor(ctx, reaction.Sender, source, RemoteEventReactionRemove) + if reaction == nil { + continue + } + reactionIntent, ok := portal.GetIntentFor(ctx, reaction.Sender, source, RemoteEventReactionRemove) + if !ok { + continue + } if reaction.TargetPart == nil { reaction.TargetPart = &partIDs[0] } if reaction.Timestamp.IsZero() { reaction.Timestamp = msg.Timestamp.Add(10 * time.Millisecond) } + //lint:ignore SA4006 it's a todo targetPart, ok := partMap[*reaction.TargetPart] if !ok { // TODO warning log and/or skip reaction? @@ -509,8 +530,11 @@ func (portal *Portal) sendBatch(ctx context.Context, source *UserLogin, messages func (portal *Portal) sendLegacyBackfill(ctx context.Context, source *UserLogin, messages []*BackfillMessage, markRead bool) { var lastPart id.EventID for _, msg := range messages { - intent := portal.GetIntentFor(ctx, msg.Sender, source, RemoteEventMessage) - dbMessages := portal.sendConvertedMessage(ctx, msg.ID, intent, msg.Sender.Sender, msg.ConvertedMessage, msg.Timestamp, msg.StreamOrder, func(z *zerolog.Event) *zerolog.Event { + intent, ok := portal.GetIntentFor(ctx, msg.Sender, source, RemoteEventMessage) + if !ok { + continue + } + dbMessages, _ := portal.sendConvertedMessage(ctx, msg.ID, intent, msg.Sender.Sender, msg.ConvertedMessage, msg.Timestamp, msg.StreamOrder, func(z *zerolog.Event) *zerolog.Event { return z. Str("message_id", string(msg.ID)). Any("sender_id", msg.Sender). @@ -519,7 +543,10 @@ func (portal *Portal) sendLegacyBackfill(ctx context.Context, source *UserLogin, if len(dbMessages) > 0 { lastPart = dbMessages[len(dbMessages)-1].MXID for _, reaction := range msg.Reactions { - reactionIntent := portal.GetIntentFor(ctx, reaction.Sender, source, RemoteEventReaction) + reactionIntent, ok := portal.GetIntentFor(ctx, reaction.Sender, source, RemoteEventReaction) + if !ok { + continue + } targetPart := dbMessages[0] if reaction.TargetPart != nil { targetPartIdx := slices.IndexFunc(dbMessages, func(dbMsg *database.Message) bool { diff --git a/bridgev2/portalinternal.go b/bridgev2/portalinternal.go index a5da077b..4c7e2447 100644 --- a/bridgev2/portalinternal.go +++ b/bridgev2/portalinternal.go @@ -29,26 +29,30 @@ func (portal *PortalInternals) UpdateLogger() { (*Portal)(portal).updateLogger() } -func (portal *PortalInternals) QueueEvent(ctx context.Context, evt portalEvent) { - (*Portal)(portal).queueEvent(ctx, evt) +func (portal *PortalInternals) QueueEvent(ctx context.Context, evt portalEvent) EventHandlingResult { + return (*Portal)(portal).queueEvent(ctx, evt) } func (portal *PortalInternals) EventLoop() { (*Portal)(portal).eventLoop() } -func (portal *PortalInternals) HandleSingleEventAsync(idx int, rawEvt any) { - (*Portal)(portal).handleSingleEventAsync(idx, rawEvt) +func (portal *PortalInternals) HandleSingleEventWithDelayLogging(idx int, rawEvt any) (outerRes EventHandlingResult) { + return (*Portal)(portal).handleSingleEventWithDelayLogging(idx, rawEvt) } func (portal *PortalInternals) GetEventCtxWithLog(rawEvt any, idx int) context.Context { return (*Portal)(portal).getEventCtxWithLog(rawEvt, idx) } -func (portal *PortalInternals) HandleSingleEvent(ctx context.Context, rawEvt any, doneCallback func()) { +func (portal *PortalInternals) HandleSingleEvent(ctx context.Context, rawEvt any, doneCallback func(EventHandlingResult)) { (*Portal)(portal).handleSingleEvent(ctx, rawEvt, doneCallback) } +func (portal *PortalInternals) UnwrapBeeperSendState(ctx context.Context, evt *event.Event) error { + return (*Portal)(portal).unwrapBeeperSendState(ctx, evt) +} + func (portal *PortalInternals) SendSuccessStatus(ctx context.Context, evt *event.Event, streamOrder int64, newEventID id.EventID) { (*Portal)(portal).sendSuccessStatus(ctx, evt, streamOrder, newEventID) } @@ -61,20 +65,24 @@ func (portal *PortalInternals) CheckConfusableName(ctx context.Context, userID i return (*Portal)(portal).checkConfusableName(ctx, userID, name) } -func (portal *PortalInternals) HandleMatrixEvent(ctx context.Context, sender *User, evt *event.Event) { - (*Portal)(portal).handleMatrixEvent(ctx, sender, evt) +func (portal *PortalInternals) HandleMatrixEvent(ctx context.Context, sender *User, evt *event.Event, isStateRequest bool) EventHandlingResult { + return (*Portal)(portal).handleMatrixEvent(ctx, sender, evt, isStateRequest) } -func (portal *PortalInternals) HandleMatrixReceipts(ctx context.Context, evt *event.Event) { - (*Portal)(portal).handleMatrixReceipts(ctx, evt) +func (portal *PortalInternals) HandleMatrixReceipts(ctx context.Context, evt *event.Event) EventHandlingResult { + return (*Portal)(portal).handleMatrixReceipts(ctx, evt) } func (portal *PortalInternals) HandleMatrixReadReceipt(ctx context.Context, user *User, eventID id.EventID, receipt event.ReadReceipt) { (*Portal)(portal).handleMatrixReadReceipt(ctx, user, eventID, receipt) } -func (portal *PortalInternals) HandleMatrixTyping(ctx context.Context, evt *event.Event) { - (*Portal)(portal).handleMatrixTyping(ctx, evt) +func (portal *PortalInternals) CallReadReceiptHandler(ctx context.Context, login *UserLogin, rrClient ReadReceiptHandlingNetworkAPI, evt *MatrixReadReceipt, userPortal *database.UserPortal) { + (*Portal)(portal).callReadReceiptHandler(ctx, login, rrClient, evt, userPortal) +} + +func (portal *PortalInternals) HandleMatrixTyping(ctx context.Context, evt *event.Event) EventHandlingResult { + return (*Portal)(portal).handleMatrixTyping(ctx, evt) } func (portal *PortalInternals) SendTypings(ctx context.Context, userIDs []id.UserID, typing bool) { @@ -85,55 +93,83 @@ func (portal *PortalInternals) PeriodicTypingUpdater() { (*Portal)(portal).periodicTypingUpdater() } -func (portal *PortalInternals) CheckMessageContentCaps(ctx context.Context, caps *NetworkRoomCapabilities, content *event.MessageEventContent, evt *event.Event) bool { - return (*Portal)(portal).checkMessageContentCaps(ctx, caps, content, evt) +func (portal *PortalInternals) CheckMessageContentCaps(caps *event.RoomFeatures, content *event.MessageEventContent) error { + return (*Portal)(portal).checkMessageContentCaps(caps, content) } -func (portal *PortalInternals) HandleMatrixMessage(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event) { - (*Portal)(portal).handleMatrixMessage(ctx, sender, origSender, evt) +func (portal *PortalInternals) ParseInputTransactionID(origSender *OrigSender, evt *event.Event) networkid.RawTransactionID { + return (*Portal)(portal).parseInputTransactionID(origSender, evt) } -func (portal *PortalInternals) HandleMatrixEdit(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event, content *event.MessageEventContent, caps *NetworkRoomCapabilities) { - (*Portal)(portal).handleMatrixEdit(ctx, sender, origSender, evt, content, caps) +func (portal *PortalInternals) HandleMatrixMessage(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event) EventHandlingResult { + return (*Portal)(portal).handleMatrixMessage(ctx, sender, origSender, evt) } -func (portal *PortalInternals) HandleMatrixReaction(ctx context.Context, sender *UserLogin, evt *event.Event) { - (*Portal)(portal).handleMatrixReaction(ctx, sender, evt) +func (portal *PortalInternals) PendingMessageTimeoutLoop(ctx context.Context, cfg *OutgoingTimeoutConfig) { + (*Portal)(portal).pendingMessageTimeoutLoop(ctx, cfg) +} + +func (portal *PortalInternals) CheckPendingMessages(ctx context.Context, cfg *OutgoingTimeoutConfig) { + (*Portal)(portal).checkPendingMessages(ctx, cfg) +} + +func (portal *PortalInternals) HandleMatrixEdit(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event, content *event.MessageEventContent, caps *event.RoomFeatures) EventHandlingResult { + return (*Portal)(portal).handleMatrixEdit(ctx, sender, origSender, evt, content, caps) +} + +func (portal *PortalInternals) HandleMatrixReaction(ctx context.Context, sender *UserLogin, evt *event.Event) EventHandlingResult { + return (*Portal)(portal).handleMatrixReaction(ctx, sender, evt) } func (portal *PortalInternals) GetTargetUser(ctx context.Context, userID id.UserID) (GhostOrUserLogin, error) { return (*Portal)(portal).getTargetUser(ctx, userID) } -func (portal *PortalInternals) HandleMatrixMembership(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event) { - (*Portal)(portal).handleMatrixMembership(ctx, sender, origSender, evt) +func (portal *PortalInternals) HandleMatrixDeleteChat(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event) EventHandlingResult { + return (*Portal)(portal).handleMatrixDeleteChat(ctx, sender, origSender, evt) } -func (portal *PortalInternals) HandleMatrixPowerLevels(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event) { - (*Portal)(portal).handleMatrixPowerLevels(ctx, sender, origSender, evt) +func (portal *PortalInternals) HandleMatrixMembership(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event, isStateRequest bool) EventHandlingResult { + return (*Portal)(portal).handleMatrixMembership(ctx, sender, origSender, evt, isStateRequest) } -func (portal *PortalInternals) HandleMatrixRedaction(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event) { - (*Portal)(portal).handleMatrixRedaction(ctx, sender, origSender, evt) +func (portal *PortalInternals) HandleMatrixPowerLevels(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event, isStateRequest bool) EventHandlingResult { + return (*Portal)(portal).handleMatrixPowerLevels(ctx, sender, origSender, evt, isStateRequest) } -func (portal *PortalInternals) HandleRemoteEvent(ctx context.Context, source *UserLogin, evtType RemoteEventType, evt RemoteEvent) { - (*Portal)(portal).handleRemoteEvent(ctx, source, evtType, evt) +func (portal *PortalInternals) HandleMatrixTombstone(ctx context.Context, evt *event.Event) EventHandlingResult { + return (*Portal)(portal).handleMatrixTombstone(ctx, evt) } -func (portal *PortalInternals) GetIntentAndUserMXIDFor(ctx context.Context, sender EventSender, source *UserLogin, otherLogins []*UserLogin, evtType RemoteEventType) (intent MatrixAPI, extraUserID id.UserID) { +func (portal *PortalInternals) UpdateInfoAfterTombstone(ctx context.Context, senderUser *User) { + (*Portal)(portal).updateInfoAfterTombstone(ctx, senderUser) +} + +func (portal *PortalInternals) HandleMatrixRedaction(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event) EventHandlingResult { + return (*Portal)(portal).handleMatrixRedaction(ctx, sender, origSender, evt) +} + +func (portal *PortalInternals) HandleRemoteEvent(ctx context.Context, source *UserLogin, evtType RemoteEventType, evt RemoteEvent) (res EventHandlingResult) { + return (*Portal)(portal).handleRemoteEvent(ctx, source, evtType, evt) +} + +func (portal *PortalInternals) EnsureFunctionalMember(ctx context.Context, ghost *Ghost) { + (*Portal)(portal).ensureFunctionalMember(ctx, ghost) +} + +func (portal *PortalInternals) GetIntentAndUserMXIDFor(ctx context.Context, sender EventSender, source *UserLogin, otherLogins []*UserLogin, evtType RemoteEventType) (intent MatrixAPI, extraUserID id.UserID, err error) { return (*Portal)(portal).getIntentAndUserMXIDFor(ctx, sender, source, otherLogins, evtType) } -func (portal *PortalInternals) GetRelationMeta(ctx context.Context, currentMsg networkid.MessageID, replyToPtr *networkid.MessageOptionalPartID, threadRootPtr *networkid.MessageID, isBatchSend bool) (replyTo, threadRoot, prevThreadEvent *database.Message) { - return (*Portal)(portal).getRelationMeta(ctx, currentMsg, replyToPtr, threadRootPtr, isBatchSend) +func (portal *PortalInternals) GetRelationMeta(ctx context.Context, currentMsgID networkid.MessageID, currentMsg *ConvertedMessage, isBatchSend bool) (replyTo, threadRoot, prevThreadEvent *database.Message) { + return (*Portal)(portal).getRelationMeta(ctx, currentMsgID, currentMsg, isBatchSend) } -func (portal *PortalInternals) ApplyRelationMeta(content *event.MessageEventContent, replyTo, threadRoot, prevThreadEvent *database.Message) { - (*Portal)(portal).applyRelationMeta(content, replyTo, threadRoot, prevThreadEvent) +func (portal *PortalInternals) ApplyRelationMeta(ctx context.Context, content *event.MessageEventContent, replyTo, threadRoot, prevThreadEvent *database.Message) { + (*Portal)(portal).applyRelationMeta(ctx, content, replyTo, threadRoot, prevThreadEvent) } -func (portal *PortalInternals) SendConvertedMessage(ctx context.Context, id networkid.MessageID, intent MatrixAPI, senderID networkid.UserID, converted *ConvertedMessage, ts time.Time, streamOrder int64, logContext func(*zerolog.Event) *zerolog.Event) []*database.Message { +func (portal *PortalInternals) SendConvertedMessage(ctx context.Context, id networkid.MessageID, intent MatrixAPI, senderID networkid.UserID, converted *ConvertedMessage, ts time.Time, streamOrder int64, logContext func(*zerolog.Event) *zerolog.Event) ([]*database.Message, EventHandlingResult) { return (*Portal)(portal).sendConvertedMessage(ctx, id, intent, senderID, converted, ts, streamOrder, logContext) } @@ -141,24 +177,24 @@ func (portal *PortalInternals) CheckPendingMessage(ctx context.Context, evt Remo return (*Portal)(portal).checkPendingMessage(ctx, evt) } -func (portal *PortalInternals) HandleRemoteUpsert(ctx context.Context, source *UserLogin, evt RemoteMessageUpsert, existing []*database.Message) bool { +func (portal *PortalInternals) HandleRemoteUpsert(ctx context.Context, source *UserLogin, evt RemoteMessageUpsert, existing []*database.Message) (handleRes EventHandlingResult, continueHandling bool) { return (*Portal)(portal).handleRemoteUpsert(ctx, source, evt, existing) } -func (portal *PortalInternals) HandleRemoteMessage(ctx context.Context, source *UserLogin, evt RemoteMessage) { - (*Portal)(portal).handleRemoteMessage(ctx, source, evt) +func (portal *PortalInternals) HandleRemoteMessage(ctx context.Context, source *UserLogin, evt RemoteMessage) (res EventHandlingResult) { + return (*Portal)(portal).handleRemoteMessage(ctx, source, evt) } func (portal *PortalInternals) SendRemoteErrorNotice(ctx context.Context, intent MatrixAPI, err error, ts time.Time, evtTypeName string) { (*Portal)(portal).sendRemoteErrorNotice(ctx, intent, err, ts, evtTypeName) } -func (portal *PortalInternals) HandleRemoteEdit(ctx context.Context, source *UserLogin, evt RemoteEdit) { - (*Portal)(portal).handleRemoteEdit(ctx, source, evt) +func (portal *PortalInternals) HandleRemoteEdit(ctx context.Context, source *UserLogin, evt RemoteEdit) EventHandlingResult { + return (*Portal)(portal).handleRemoteEdit(ctx, source, evt) } -func (portal *PortalInternals) SendConvertedEdit(ctx context.Context, targetID networkid.MessageID, senderID networkid.UserID, converted *ConvertedEdit, intent MatrixAPI, ts time.Time, streamOrder int64) { - (*Portal)(portal).sendConvertedEdit(ctx, targetID, senderID, converted, intent, ts, streamOrder) +func (portal *PortalInternals) SendConvertedEdit(ctx context.Context, targetID networkid.MessageID, senderID networkid.UserID, converted *ConvertedEdit, intent MatrixAPI, ts time.Time, streamOrder int64) EventHandlingResult { + return (*Portal)(portal).sendConvertedEdit(ctx, targetID, senderID, converted, intent, ts, streamOrder) } func (portal *PortalInternals) GetTargetMessagePart(ctx context.Context, evt RemoteEventWithTargetMessage) (*database.Message, error) { @@ -169,76 +205,84 @@ func (portal *PortalInternals) GetTargetReaction(ctx context.Context, evt Remote return (*Portal)(portal).getTargetReaction(ctx, evt) } -func (portal *PortalInternals) HandleRemoteReactionSync(ctx context.Context, source *UserLogin, evt RemoteReactionSync) { - (*Portal)(portal).handleRemoteReactionSync(ctx, source, evt) +func (portal *PortalInternals) HandleRemoteReactionSync(ctx context.Context, source *UserLogin, evt RemoteReactionSync) EventHandlingResult { + return (*Portal)(portal).handleRemoteReactionSync(ctx, source, evt) } -func (portal *PortalInternals) HandleRemoteReaction(ctx context.Context, source *UserLogin, evt RemoteReaction) { - (*Portal)(portal).handleRemoteReaction(ctx, source, evt) +func (portal *PortalInternals) HandleRemoteReaction(ctx context.Context, source *UserLogin, evt RemoteReaction) EventHandlingResult { + return (*Portal)(portal).handleRemoteReaction(ctx, source, evt) } -func (portal *PortalInternals) SendConvertedReaction(ctx context.Context, senderID networkid.UserID, intent MatrixAPI, targetMessage *database.Message, emojiID networkid.EmojiID, emoji string, ts time.Time, dbMetadata any, extraContent map[string]any, logContext func(*zerolog.Event) *zerolog.Event) { - (*Portal)(portal).sendConvertedReaction(ctx, senderID, intent, targetMessage, emojiID, emoji, ts, dbMetadata, extraContent, logContext) +func (portal *PortalInternals) SendConvertedReaction(ctx context.Context, senderID networkid.UserID, intent MatrixAPI, targetMessage *database.Message, emojiID networkid.EmojiID, emoji string, ts time.Time, dbMetadata any, extraContent map[string]any, logContext func(*zerolog.Event) *zerolog.Event) EventHandlingResult { + return (*Portal)(portal).sendConvertedReaction(ctx, senderID, intent, targetMessage, emojiID, emoji, ts, dbMetadata, extraContent, logContext) } func (portal *PortalInternals) GetIntentForMXID(ctx context.Context, userID id.UserID) (MatrixAPI, error) { return (*Portal)(portal).getIntentForMXID(ctx, userID) } -func (portal *PortalInternals) HandleRemoteReactionRemove(ctx context.Context, source *UserLogin, evt RemoteReactionRemove) { - (*Portal)(portal).handleRemoteReactionRemove(ctx, source, evt) +func (portal *PortalInternals) HandleRemoteReactionRemove(ctx context.Context, source *UserLogin, evt RemoteReactionRemove) EventHandlingResult { + return (*Portal)(portal).handleRemoteReactionRemove(ctx, source, evt) } -func (portal *PortalInternals) HandleRemoteMessageRemove(ctx context.Context, source *UserLogin, evt RemoteMessageRemove) { - (*Portal)(portal).handleRemoteMessageRemove(ctx, source, evt) +func (portal *PortalInternals) HandleRemoteMessageRemove(ctx context.Context, source *UserLogin, evt RemoteMessageRemove) EventHandlingResult { + return (*Portal)(portal).handleRemoteMessageRemove(ctx, source, evt) } -func (portal *PortalInternals) RedactMessageParts(ctx context.Context, parts []*database.Message, intent MatrixAPI, ts time.Time) { - (*Portal)(portal).redactMessageParts(ctx, parts, intent, ts) +func (portal *PortalInternals) RedactMessageParts(ctx context.Context, parts []*database.Message, intent MatrixAPI, ts time.Time) EventHandlingResult { + return (*Portal)(portal).redactMessageParts(ctx, parts, intent, ts) } -func (portal *PortalInternals) HandleRemoteReadReceipt(ctx context.Context, source *UserLogin, evt RemoteReadReceipt) { - (*Portal)(portal).handleRemoteReadReceipt(ctx, source, evt) +func (portal *PortalInternals) HandleRemoteReadReceipt(ctx context.Context, source *UserLogin, evt RemoteReadReceipt) EventHandlingResult { + return (*Portal)(portal).handleRemoteReadReceipt(ctx, source, evt) } -func (portal *PortalInternals) HandleRemoteMarkUnread(ctx context.Context, source *UserLogin, evt RemoteMarkUnread) { - (*Portal)(portal).handleRemoteMarkUnread(ctx, source, evt) +func (portal *PortalInternals) HandleRemoteMarkUnread(ctx context.Context, source *UserLogin, evt RemoteMarkUnread) EventHandlingResult { + return (*Portal)(portal).handleRemoteMarkUnread(ctx, source, evt) } -func (portal *PortalInternals) HandleRemoteDeliveryReceipt(ctx context.Context, source *UserLogin, evt RemoteDeliveryReceipt) { - (*Portal)(portal).handleRemoteDeliveryReceipt(ctx, source, evt) +func (portal *PortalInternals) HandleRemoteDeliveryReceipt(ctx context.Context, source *UserLogin, evt RemoteDeliveryReceipt) EventHandlingResult { + return (*Portal)(portal).handleRemoteDeliveryReceipt(ctx, source, evt) } -func (portal *PortalInternals) HandleRemoteTyping(ctx context.Context, source *UserLogin, evt RemoteTyping) { - (*Portal)(portal).handleRemoteTyping(ctx, source, evt) +func (portal *PortalInternals) HandleRemoteTyping(ctx context.Context, source *UserLogin, evt RemoteTyping) EventHandlingResult { + return (*Portal)(portal).handleRemoteTyping(ctx, source, evt) } -func (portal *PortalInternals) HandleRemoteChatInfoChange(ctx context.Context, source *UserLogin, evt RemoteChatInfoChange) { - (*Portal)(portal).handleRemoteChatInfoChange(ctx, source, evt) +func (portal *PortalInternals) HandleRemoteChatInfoChange(ctx context.Context, source *UserLogin, evt RemoteChatInfoChange) EventHandlingResult { + return (*Portal)(portal).handleRemoteChatInfoChange(ctx, source, evt) } -func (portal *PortalInternals) HandleRemoteChatResync(ctx context.Context, source *UserLogin, evt RemoteChatResync) { - (*Portal)(portal).handleRemoteChatResync(ctx, source, evt) +func (portal *PortalInternals) HandleRemoteChatResync(ctx context.Context, source *UserLogin, evt RemoteChatResync) EventHandlingResult { + return (*Portal)(portal).handleRemoteChatResync(ctx, source, evt) } -func (portal *PortalInternals) HandleRemoteChatDelete(ctx context.Context, source *UserLogin, evt RemoteChatDelete) { - (*Portal)(portal).handleRemoteChatDelete(ctx, source, evt) +func (portal *PortalInternals) FindOtherLogins(ctx context.Context, source *UserLogin) (ownUP *database.UserPortal, others []*database.UserPortal, err error) { + return (*Portal)(portal).findOtherLogins(ctx, source) } -func (portal *PortalInternals) HandleRemoteBackfill(ctx context.Context, source *UserLogin, backfill RemoteBackfill) { - (*Portal)(portal).handleRemoteBackfill(ctx, source, backfill) +func (portal *PortalInternals) HandleRemoteChatDelete(ctx context.Context, source *UserLogin, evt RemoteChatDelete) EventHandlingResult { + return (*Portal)(portal).handleRemoteChatDelete(ctx, source, evt) } -func (portal *PortalInternals) UpdateName(ctx context.Context, name string, sender MatrixAPI, ts time.Time) bool { - return (*Portal)(portal).updateName(ctx, name, sender, ts) +func (portal *PortalInternals) HandleRemoteBackfill(ctx context.Context, source *UserLogin, backfill RemoteBackfill) (res EventHandlingResult) { + return (*Portal)(portal).handleRemoteBackfill(ctx, source, backfill) } -func (portal *PortalInternals) UpdateTopic(ctx context.Context, topic string, sender MatrixAPI, ts time.Time) bool { - return (*Portal)(portal).updateTopic(ctx, topic, sender, ts) +func (portal *PortalInternals) UpdateName(ctx context.Context, name string, sender MatrixAPI, ts time.Time, excludeFromTimeline bool) bool { + return (*Portal)(portal).updateName(ctx, name, sender, ts, excludeFromTimeline) } -func (portal *PortalInternals) UpdateAvatar(ctx context.Context, avatar *Avatar, sender MatrixAPI, ts time.Time) bool { - return (*Portal)(portal).updateAvatar(ctx, avatar, sender, ts) +func (portal *PortalInternals) UpdateTopic(ctx context.Context, topic string, sender MatrixAPI, ts time.Time, excludeFromTimeline bool) bool { + return (*Portal)(portal).updateTopic(ctx, topic, sender, ts, excludeFromTimeline) +} + +func (portal *PortalInternals) UpdateAvatar(ctx context.Context, avatar *Avatar, sender MatrixAPI, ts time.Time, excludeFromTimeline bool) bool { + return (*Portal)(portal).updateAvatar(ctx, avatar, sender, ts, excludeFromTimeline) +} + +func (portal *PortalInternals) GetBridgeInfoStateKey() string { + return (*Portal)(portal).getBridgeInfoStateKey() } func (portal *PortalInternals) GetBridgeInfo() (string, event.BridgeEventContent) { @@ -249,8 +293,12 @@ func (portal *PortalInternals) SendStateWithIntentOrBot(ctx context.Context, sen return (*Portal)(portal).sendStateWithIntentOrBot(ctx, sender, eventType, stateKey, content, ts) } -func (portal *PortalInternals) SendRoomMeta(ctx context.Context, sender MatrixAPI, ts time.Time, eventType event.Type, stateKey string, content any) bool { - return (*Portal)(portal).sendRoomMeta(ctx, sender, ts, eventType, stateKey, content) +func (portal *PortalInternals) SendRoomMeta(ctx context.Context, sender MatrixAPI, ts time.Time, eventType event.Type, stateKey string, content any, excludeFromTimeline bool, extra map[string]any) bool { + return (*Portal)(portal).sendRoomMeta(ctx, sender, ts, eventType, stateKey, content, excludeFromTimeline, extra) +} + +func (portal *PortalInternals) RevertRoomMeta(ctx context.Context, evt *event.Event) { + (*Portal)(portal).revertRoomMeta(ctx, evt) } func (portal *PortalInternals) GetInitialMemberList(ctx context.Context, members *ChatMemberList, source *UserLogin, pl *event.PowerLevelsEventContent) (invite, functional []id.UserID, err error) { @@ -261,6 +309,10 @@ func (portal *PortalInternals) UpdateOtherUser(ctx context.Context, members *Cha return (*Portal)(portal).updateOtherUser(ctx, members) } +func (portal *PortalInternals) RoomIsPublic(ctx context.Context) bool { + return (*Portal)(portal).roomIsPublic(ctx) +} + func (portal *PortalInternals) SyncParticipants(ctx context.Context, members *ChatMemberList, source *UserLogin, sender MatrixAPI, ts time.Time) error { return (*Portal)(portal).syncParticipants(ctx, members, source, sender, ts) } @@ -281,6 +333,10 @@ func (portal *PortalInternals) CreateMatrixRoomInLoop(ctx context.Context, sourc return (*Portal)(portal).createMatrixRoomInLoop(ctx, source, info, backfillBundle) } +func (portal *PortalInternals) AddToUserSpaces(ctx context.Context) { + (*Portal)(portal).addToUserSpaces(ctx) +} + func (portal *PortalInternals) RemoveInPortalCache(ctx context.Context) { (*Portal)(portal).removeInPortalCache(ctx) } @@ -344,7 +400,3 @@ func (portal *PortalInternals) AddToParentSpaceAndSave(ctx context.Context, save func (portal *PortalInternals) ToggleSpace(ctx context.Context, spaceID id.RoomID, canonical, remove bool) error { return (*Portal)(portal).toggleSpace(ctx, spaceID, canonical, remove) } - -func (portal *PortalInternals) SetMXIDToExistingRoom(roomID id.RoomID) bool { - return (*Portal)(portal).setMXIDToExistingRoom(roomID) -} diff --git a/bridgev2/portalreid.go b/bridgev2/portalreid.go index a25fe820..c976d97c 100644 --- a/bridgev2/portalreid.go +++ b/bridgev2/portalreid.go @@ -32,21 +32,40 @@ func (br *Bridge) ReIDPortal(ctx context.Context, source, target networkid.Porta if source == target { return ReIDResultError, nil, fmt.Errorf("illegal re-ID call: source and target are the same") } - log := zerolog.Ctx(ctx) - log.Debug().Msg("Re-ID'ing portal") + log := zerolog.Ctx(ctx).With(). + Str("action", "re-id portal"). + Stringer("source_portal_key", source). + Stringer("target_portal_key", target). + Logger() + ctx = log.WithContext(ctx) defer func() { log.Debug().Msg("Finished handling portal re-ID") }() - br.cacheLock.Lock() - defer br.cacheLock.Unlock() - sourcePortal, err := br.UnlockedGetPortalByKey(ctx, source, true) + acquireCacheLock := func() { + if !br.cacheLock.TryLock() { + log.Debug().Msg("Waiting for global cache lock") + br.cacheLock.Lock() + log.Debug().Msg("Acquired global cache lock after waiting") + } else { + log.Trace().Msg("Acquired global cache lock without waiting") + } + } + log.Debug().Msg("Re-ID'ing portal") + sourcePortal, err := br.GetExistingPortalByKey(ctx, source) if err != nil { return ReIDResultError, nil, fmt.Errorf("failed to get source portal: %w", err) } else if sourcePortal == nil { log.Debug().Msg("Source portal not found, re-ID is no-op") return ReIDResultNoOp, nil, nil } - sourcePortal.roomCreateLock.Lock() + if !sourcePortal.roomCreateLock.TryLock() { + if cancelCreate := sourcePortal.cancelRoomCreate.Swap(nil); cancelCreate != nil { + (*cancelCreate)() + } + log.Debug().Msg("Waiting for source portal room creation lock") + sourcePortal.roomCreateLock.Lock() + log.Debug().Msg("Acquired source portal room creation lock after waiting") + } defer sourcePortal.roomCreateLock.Unlock() if sourcePortal.MXID == "" { log.Info().Msg("Source portal doesn't have Matrix room, deleting row") @@ -59,22 +78,37 @@ func (br *Bridge) ReIDPortal(ctx context.Context, source, target networkid.Porta log.UpdateContext(func(c zerolog.Context) zerolog.Context { return c.Stringer("source_portal_mxid", sourcePortal.MXID) }) + + acquireCacheLock() targetPortal, err := br.UnlockedGetPortalByKey(ctx, target, true) if err != nil { + br.cacheLock.Unlock() return ReIDResultError, nil, fmt.Errorf("failed to get target portal: %w", err) } if targetPortal == nil { log.Info().Msg("Target portal doesn't exist, re-ID'ing source portal") err = sourcePortal.unlockedReID(ctx, target) + br.cacheLock.Unlock() if err != nil { return ReIDResultError, nil, fmt.Errorf("failed to re-ID source portal: %w", err) } return ReIDResultSourceReIDd, sourcePortal, nil } - targetPortal.roomCreateLock.Lock() + br.cacheLock.Unlock() + + if !targetPortal.roomCreateLock.TryLock() { + if cancelCreate := targetPortal.cancelRoomCreate.Swap(nil); cancelCreate != nil { + (*cancelCreate)() + } + log.Debug().Msg("Waiting for target portal room creation lock") + targetPortal.roomCreateLock.Lock() + log.Debug().Msg("Acquired target portal room creation lock after waiting") + } defer targetPortal.roomCreateLock.Unlock() if targetPortal.MXID == "" { log.Info().Msg("Target portal row exists, but doesn't have a Matrix room. Deleting target portal row and re-ID'ing source portal") + acquireCacheLock() + defer br.cacheLock.Unlock() err = targetPortal.unlockedDelete(ctx) if err != nil { return ReIDResultError, nil, fmt.Errorf("failed to delete target portal: %w", err) @@ -89,6 +123,9 @@ func (br *Bridge) ReIDPortal(ctx context.Context, source, target networkid.Porta return c.Stringer("target_portal_mxid", targetPortal.MXID) }) log.Info().Msg("Both target and source portals have Matrix rooms, tombstoning source portal") + sourcePortal.removeInPortalCache(ctx) + acquireCacheLock() + defer br.cacheLock.Unlock() err = sourcePortal.unlockedDelete(ctx) if err != nil { return ReIDResultError, nil, fmt.Errorf("failed to delete source portal row: %w", err) @@ -96,7 +133,7 @@ func (br *Bridge) ReIDPortal(ctx context.Context, source, target networkid.Porta go func() { _, err := br.Bot.SendState(ctx, sourcePortal.MXID, event.StateTombstone, "", &event.Content{ Parsed: &event.TombstoneEventContent{ - Body: fmt.Sprintf("This room has been merged"), + Body: "This room has been merged", ReplacementRoom: targetPortal.MXID, }, }, time.Now()) diff --git a/bridgev2/provisionutil/creategroup.go b/bridgev2/provisionutil/creategroup.go new file mode 100644 index 00000000..72bacaff --- /dev/null +++ b/bridgev2/provisionutil/creategroup.go @@ -0,0 +1,149 @@ +// Copyright (c) 2025 Tulir Asokan +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/. + +package provisionutil + +import ( + "context" + + "github.com/rs/zerolog" + "go.mau.fi/util/ptr" + + "maunium.net/go/mautrix" + "maunium.net/go/mautrix/bridgev2" + "maunium.net/go/mautrix/bridgev2/networkid" + "maunium.net/go/mautrix/event" + "maunium.net/go/mautrix/id" +) + +type RespCreateGroup struct { + ID networkid.PortalID `json:"id"` + MXID id.RoomID `json:"mxid"` + Portal *bridgev2.Portal `json:"-"` + + FailedParticipants map[networkid.UserID]*bridgev2.CreateChatFailedParticipant `json:"failed_participants,omitempty"` +} + +func CreateGroup(ctx context.Context, login *bridgev2.UserLogin, params *bridgev2.GroupCreateParams) (*RespCreateGroup, error) { + api, ok := login.Client.(bridgev2.GroupCreatingNetworkAPI) + if !ok { + return nil, bridgev2.RespError(mautrix.MUnrecognized.WithMessage("This bridge does not support creating groups")) + } + zerolog.Ctx(ctx).Debug(). + Any("create_params", params). + Msg("Creating group chat on remote network") + caps := login.Bridge.Network.GetCapabilities() + typeSpec, validType := caps.Provisioning.GroupCreation[params.Type] + if !validType { + return nil, bridgev2.RespError(mautrix.MUnrecognized.WithMessage("Unrecognized group type %s", params.Type)) + } + if len(params.Participants) < typeSpec.Participants.MinLength { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Must have at least %d members", typeSpec.Participants.MinLength)) + } else if typeSpec.Participants.MaxLength > 0 && len(params.Participants) > typeSpec.Participants.MaxLength { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Must have at most %d members", typeSpec.Participants.MaxLength)) + } + userIDValidatingNetwork, uidValOK := login.Bridge.Network.(bridgev2.IdentifierValidatingNetwork) + for i, participant := range params.Participants { + parsedParticipant, ok := login.Bridge.Matrix.ParseGhostMXID(id.UserID(participant)) + if ok { + participant = parsedParticipant + params.Participants[i] = participant + } + if !typeSpec.Participants.SkipIdentifierValidation { + if uidValOK && !userIDValidatingNetwork.ValidateUserID(participant) { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("User ID %q is not valid on this network", participant)) + } + } + if api.IsThisUser(ctx, participant) { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("You can't include yourself in the participants list", participant)) + } + } + if (params.Name == nil || params.Name.Name == "") && typeSpec.Name.Required { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Name is required")) + } else if nameLen := len(ptr.Val(params.Name).Name); nameLen > 0 && nameLen < typeSpec.Name.MinLength { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Name must be at least %d characters", typeSpec.Name.MinLength)) + } else if typeSpec.Name.MaxLength > 0 && nameLen > typeSpec.Name.MaxLength { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Name must be at most %d characters", typeSpec.Name.MaxLength)) + } + if (params.Avatar == nil || params.Avatar.URL == "") && typeSpec.Avatar.Required { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Avatar is required")) + } + if (params.Topic == nil || params.Topic.Topic == "") && typeSpec.Topic.Required { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Topic is required")) + } else if topicLen := len(ptr.Val(params.Topic).Topic); topicLen > 0 && topicLen < typeSpec.Topic.MinLength { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Topic must be at least %d characters", typeSpec.Topic.MinLength)) + } else if typeSpec.Topic.MaxLength > 0 && topicLen > typeSpec.Topic.MaxLength { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Topic must be at most %d characters", typeSpec.Topic.MaxLength)) + } + if (params.Disappear == nil || params.Disappear.Timer.Duration == 0) && typeSpec.Disappear.Required { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Disappearing timer is required")) + } else if !typeSpec.Disappear.DisappearSettings.Supports(params.Disappear) { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Unsupported value for disappearing timer")) + } + if params.Username == "" && typeSpec.Username.Required { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Username is required")) + } else if len(params.Username) > 0 && len(params.Username) < typeSpec.Username.MinLength { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Username must be at least %d characters", typeSpec.Username.MinLength)) + } else if typeSpec.Username.MaxLength > 0 && len(params.Username) > typeSpec.Username.MaxLength { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Username must be at most %d characters", typeSpec.Username.MaxLength)) + } + if params.Parent == nil && typeSpec.Parent.Required { + return nil, bridgev2.RespError(mautrix.MInvalidParam.WithMessage("Parent is required")) + } + resp, err := api.CreateGroup(ctx, params) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to create group") + return nil, err + } + if resp.PortalKey.IsEmpty() { + return nil, ErrNoPortalKey + } + zerolog.Ctx(ctx).Debug(). + Object("portal_key", resp.PortalKey). + Msg("Successfully created group on remote network") + if resp.Portal == nil { + resp.Portal, err = login.Bridge.GetPortalByKey(ctx, resp.PortalKey) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to get portal") + return nil, bridgev2.RespError(mautrix.MUnknown.WithMessage("Failed to get portal")) + } + } + if resp.Portal.MXID == "" { + err = resp.Portal.CreateMatrixRoom(ctx, login, resp.PortalInfo) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to create portal room") + return nil, bridgev2.RespError(mautrix.MUnknown.WithMessage("Failed to create portal room")) + } + } + for key, fp := range resp.FailedParticipants { + if fp.InviteEventType == "" { + fp.InviteEventType = event.EventMessage.Type + } + if fp.UserMXID == "" { + ghost, err := login.Bridge.GetGhostByID(ctx, key) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to get ghost for failed participant") + } else if ghost != nil { + fp.UserMXID = ghost.Intent.GetMXID() + } + } + if fp.DMRoomMXID == "" { + portal, err := login.Bridge.GetDMPortal(ctx, login.ID, key) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to get DM portal for failed participant") + } else if portal != nil { + fp.DMRoomMXID = portal.MXID + } + } + } + return &RespCreateGroup{ + ID: resp.Portal.ID, + MXID: resp.Portal.MXID, + Portal: resp.Portal, + + FailedParticipants: resp.FailedParticipants, + }, nil +} diff --git a/bridgev2/provisionutil/listcontacts.go b/bridgev2/provisionutil/listcontacts.go new file mode 100644 index 00000000..ce163e67 --- /dev/null +++ b/bridgev2/provisionutil/listcontacts.go @@ -0,0 +1,98 @@ +// Copyright (c) 2025 Tulir Asokan +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/. + +package provisionutil + +import ( + "context" + + "github.com/rs/zerolog" + + "maunium.net/go/mautrix" + "maunium.net/go/mautrix/bridgev2" +) + +type RespGetContactList struct { + Contacts []*RespResolveIdentifier `json:"contacts"` +} + +type RespSearchUsers struct { + Results []*RespResolveIdentifier `json:"results"` +} + +func GetContactList(ctx context.Context, login *bridgev2.UserLogin) (*RespGetContactList, error) { + api, ok := login.Client.(bridgev2.ContactListingNetworkAPI) + if !ok { + return nil, bridgev2.RespError(mautrix.MUnrecognized.WithMessage("This bridge does not support listing contacts")) + } + resp, err := api.GetContactList(ctx) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to get contact list") + return nil, err + } + return &RespGetContactList{ + Contacts: processResolveIdentifiers(ctx, login.Bridge, resp, false), + }, nil +} + +func SearchUsers(ctx context.Context, login *bridgev2.UserLogin, query string) (*RespSearchUsers, error) { + api, ok := login.Client.(bridgev2.UserSearchingNetworkAPI) + if !ok { + return nil, bridgev2.RespError(mautrix.MUnrecognized.WithMessage("This bridge does not support searching for users")) + } + resp, err := api.SearchUsers(ctx, query) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to get contact list") + return nil, err + } + return &RespSearchUsers{ + Results: processResolveIdentifiers(ctx, login.Bridge, resp, true), + }, nil +} + +func processResolveIdentifiers(ctx context.Context, br *bridgev2.Bridge, resp []*bridgev2.ResolveIdentifierResponse, syncInfo bool) (apiResp []*RespResolveIdentifier) { + apiResp = make([]*RespResolveIdentifier, len(resp)) + for i, contact := range resp { + apiContact := &RespResolveIdentifier{ + ID: contact.UserID, + } + apiResp[i] = apiContact + if contact.UserInfo != nil { + if contact.UserInfo.Name != nil { + apiContact.Name = *contact.UserInfo.Name + } + if contact.UserInfo.Identifiers != nil { + apiContact.Identifiers = contact.UserInfo.Identifiers + } + } + if contact.Ghost != nil { + if syncInfo && contact.UserInfo != nil { + contact.Ghost.UpdateInfo(ctx, contact.UserInfo) + } + if contact.Ghost.Name != "" { + apiContact.Name = contact.Ghost.Name + } + if len(contact.Ghost.Identifiers) >= len(apiContact.Identifiers) { + apiContact.Identifiers = contact.Ghost.Identifiers + } + apiContact.AvatarURL = contact.Ghost.AvatarMXC + apiContact.MXID = contact.Ghost.Intent.GetMXID() + } + if contact.Chat != nil { + if contact.Chat.Portal == nil { + var err error + contact.Chat.Portal, err = br.GetPortalByKey(ctx, contact.Chat.PortalKey) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to get portal") + } + } + if contact.Chat.Portal != nil { + apiContact.DMRoomID = contact.Chat.Portal.MXID + } + } + } + return +} diff --git a/bridgev2/provisionutil/resolveidentifier.go b/bridgev2/provisionutil/resolveidentifier.go new file mode 100644 index 00000000..cfc388d0 --- /dev/null +++ b/bridgev2/provisionutil/resolveidentifier.go @@ -0,0 +1,125 @@ +// Copyright (c) 2025 Tulir Asokan +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/. + +package provisionutil + +import ( + "context" + "errors" + + "github.com/rs/zerolog" + + "maunium.net/go/mautrix" + "maunium.net/go/mautrix/bridgev2" + "maunium.net/go/mautrix/bridgev2/networkid" + "maunium.net/go/mautrix/id" +) + +type RespResolveIdentifier struct { + ID networkid.UserID `json:"id"` + Name string `json:"name,omitempty"` + AvatarURL id.ContentURIString `json:"avatar_url,omitempty"` + Identifiers []string `json:"identifiers,omitempty"` + MXID id.UserID `json:"mxid,omitempty"` + DMRoomID id.RoomID `json:"dm_room_mxid,omitempty"` + + Portal *bridgev2.Portal `json:"-"` + Ghost *bridgev2.Ghost `json:"-"` + JustCreated bool `json:"-"` +} + +var ErrNoPortalKey = errors.New("network API didn't return portal key for createChat request") + +func ResolveIdentifier( + ctx context.Context, + login *bridgev2.UserLogin, + identifier string, + createChat bool, +) (*RespResolveIdentifier, error) { + api, ok := login.Client.(bridgev2.IdentifierResolvingNetworkAPI) + if !ok { + return nil, bridgev2.RespError(mautrix.MUnrecognized.WithMessage("This bridge does not support resolving identifiers")) + } + var resp *bridgev2.ResolveIdentifierResponse + parsedUserID, ok := login.Bridge.Matrix.ParseGhostMXID(id.UserID(identifier)) + validator, vOK := login.Bridge.Network.(bridgev2.IdentifierValidatingNetwork) + if ok && (!vOK || validator.ValidateUserID(parsedUserID)) { + ghost, err := login.Bridge.GetGhostByID(ctx, parsedUserID) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to get ghost by ID") + return nil, err + } + resp = &bridgev2.ResolveIdentifierResponse{ + Ghost: ghost, + UserID: parsedUserID, + } + gdcAPI, ok := api.(bridgev2.GhostDMCreatingNetworkAPI) + if ok && createChat { + resp.Chat, err = gdcAPI.CreateChatWithGhost(ctx, ghost) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to create chat") + return nil, err + } + } else if createChat || ghost.Name == "" { + zerolog.Ctx(ctx).Debug(). + Bool("create_chat", createChat). + Bool("has_name", ghost.Name != ""). + Msg("Falling back to resolving identifier") + resp = nil + identifier = string(parsedUserID) + } + } + if resp == nil { + var err error + resp, err = api.ResolveIdentifier(ctx, identifier, createChat) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to resolve identifier") + return nil, err + } else if resp == nil { + return nil, nil + } + } + apiResp := &RespResolveIdentifier{ + ID: resp.UserID, + Ghost: resp.Ghost, + } + if resp.Ghost != nil { + if resp.UserInfo != nil { + resp.Ghost.UpdateInfo(ctx, resp.UserInfo) + } + apiResp.Name = resp.Ghost.Name + apiResp.AvatarURL = resp.Ghost.AvatarMXC + apiResp.Identifiers = resp.Ghost.Identifiers + apiResp.MXID = resp.Ghost.Intent.GetMXID() + } else if resp.UserInfo != nil && resp.UserInfo.Name != nil { + apiResp.Name = *resp.UserInfo.Name + } + if resp.Chat != nil { + if resp.Chat.PortalKey.IsEmpty() { + return nil, ErrNoPortalKey + } + if resp.Chat.Portal == nil { + var err error + resp.Chat.Portal, err = login.Bridge.GetPortalByKey(ctx, resp.Chat.PortalKey) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to get portal") + return nil, bridgev2.RespError(mautrix.MUnknown.WithMessage("Failed to get portal")) + } + } + resp.Chat.Portal.CleanupOrphanedDM(ctx, login.UserMXID) + if createChat && resp.Chat.Portal.MXID == "" { + apiResp.JustCreated = true + err := resp.Chat.Portal.CreateMatrixRoom(ctx, login, resp.Chat.PortalInfo) + if err != nil { + zerolog.Ctx(ctx).Err(err).Msg("Failed to create portal room") + return nil, bridgev2.RespError(mautrix.MUnknown.WithMessage("Failed to create portal room")) + } + } + apiResp.Portal = resp.Chat.Portal + apiResp.DMRoomID = resp.Chat.Portal.MXID + } + return apiResp, nil +} diff --git a/bridgev2/queue.go b/bridgev2/queue.go index 38895953..3775c825 100644 --- a/bridgev2/queue.go +++ b/bridgev2/queue.go @@ -63,7 +63,14 @@ func (br *Bridge) rejectInviteOnNoPermission(ctx context.Context, evt *event.Eve return true } -func (br *Bridge) QueueMatrixEvent(ctx context.Context, evt *event.Event) { +var ( + ErrEventSenderUserNotFound = WrapErrorInStatus(errors.New("sender not found for event")).WithIsCertain(true).WithErrorAsMessage() + ErrNoPermissionToInteract = WrapErrorInStatus(errors.New("you don't have permission to send messages")).WithIsCertain(true).WithSendNotice(false).WithErrorAsMessage() + ErrNoPermissionForCommands = WrapErrorInStatus(WrapErrorInStatus(errors.New("you don't have permission to use commands")).WithIsCertain(true).WithSendNotice(false).WithErrorAsMessage()) + ErrCantRelayStateRequest = WrapErrorInStatus(errors.New("relayed users can't use beeper state requests")).WithIsCertain(true).WithErrorAsMessage() +) + +func (br *Bridge) QueueMatrixEvent(ctx context.Context, evt *event.Event) EventHandlingResult { // TODO maybe HandleMatrixEvent would be more appropriate as this also handles bot invites and commands log := zerolog.Ctx(ctx) @@ -75,37 +82,34 @@ func (br *Bridge) QueueMatrixEvent(ctx context.Context, evt *event.Event) { log.Err(err).Msg("Failed to get sender user for incoming Matrix event") status := WrapErrorInStatus(fmt.Errorf("%w: failed to get sender user: %w", ErrDatabaseError, err)) br.Matrix.SendMessageStatus(ctx, &status, StatusEventInfoFromEvent(evt)) - return + return EventHandlingResultFailed } else if sender == nil { log.Error().Msg("Couldn't get sender for incoming non-ephemeral Matrix event") - status := WrapErrorInStatus(errors.New("sender not found for event")).WithIsCertain(true).WithErrorAsMessage() - br.Matrix.SendMessageStatus(ctx, &status, StatusEventInfoFromEvent(evt)) - return + br.Matrix.SendMessageStatus(ctx, &ErrEventSenderUserNotFound, StatusEventInfoFromEvent(evt)) + return EventHandlingResultFailed } else if !sender.Permissions.SendEvents { if !br.rejectInviteOnNoPermission(ctx, evt, "interact with") { - status := WrapErrorInStatus(errors.New("you don't have permission to send messages")).WithIsCertain(true).WithSendNotice(false).WithErrorAsMessage() - br.Matrix.SendMessageStatus(ctx, &status, StatusEventInfoFromEvent(evt)) + br.Matrix.SendMessageStatus(ctx, &ErrNoPermissionToInteract, StatusEventInfoFromEvent(evt)) } - return + return EventHandlingResultIgnored } else if !sender.Permissions.Commands && br.rejectInviteOnNoPermission(ctx, evt, "send commands to") { - return + return EventHandlingResultIgnored } } else if evt.Type.Class != event.EphemeralEventType { log.Error().Msg("Missing sender for incoming non-ephemeral Matrix event") - status := WrapErrorInStatus(errors.New("sender not found for event")).WithIsCertain(true).WithErrorAsMessage() - br.Matrix.SendMessageStatus(ctx, &status, StatusEventInfoFromEvent(evt)) - return + br.Matrix.SendMessageStatus(ctx, &ErrEventSenderUserNotFound, StatusEventInfoFromEvent(evt)) + return EventHandlingResultIgnored } if evt.Type == event.EventMessage && sender != nil { msg := evt.Content.AsMessage() msg.RemoveReplyFallback() + msg.RemovePerMessageProfileFallback() if strings.HasPrefix(msg.Body, br.Config.CommandPrefix) || evt.RoomID == sender.ManagementRoom { if !sender.Permissions.Commands { - status := WrapErrorInStatus(errors.New("you don't have permission to use commands")).WithIsCertain(true).WithSendNotice(false).WithErrorAsMessage() - br.Matrix.SendMessageStatus(ctx, &status, StatusEventInfoFromEvent(evt)) - return + br.Matrix.SendMessageStatus(ctx, &ErrNoPermissionForCommands, StatusEventInfoFromEvent(evt)) + return EventHandlingResultIgnored } - br.Commands.Handle( + go br.Commands.Handle( ctx, evt.RoomID, evt.ID, @@ -113,39 +117,112 @@ func (br *Bridge) QueueMatrixEvent(ctx context.Context, evt *event.Event) { strings.TrimPrefix(msg.Body, br.Config.CommandPrefix+" "), msg.RelatesTo.GetReplyTo(), ) - return + return EventHandlingResultQueued } } if evt.Type == event.StateMember && evt.GetStateKey() == br.Bot.GetMXID().String() && evt.Content.AsMember().Membership == event.MembershipInvite && sender != nil { - br.handleBotInvite(ctx, evt, sender) - return + return br.handleBotInvite(ctx, evt, sender) + } else if sender != nil && evt.RoomID == sender.ManagementRoom { + if evt.Type == event.StateMember && evt.Content.AsMember().Membership == event.MembershipLeave && (evt.GetStateKey() == br.Bot.GetMXID().String() || evt.GetStateKey() == sender.MXID.String()) { + sender.ManagementRoom = "" + err := br.DB.User.Update(ctx, sender.User) + if err != nil { + log.Err(err).Msg("Failed to clear user's management room in database") + return EventHandlingResultFailed + } else { + log.Debug().Msg("Cleared user's management room due to leave event") + } + } + return EventHandlingResultSuccess } portal, err := br.GetPortalByMXID(ctx, evt.RoomID) if err != nil { log.Err(err).Msg("Failed to get portal for incoming Matrix event") status := WrapErrorInStatus(fmt.Errorf("%w: failed to get portal: %w", ErrDatabaseError, err)) br.Matrix.SendMessageStatus(ctx, &status, StatusEventInfoFromEvent(evt)) - return + return EventHandlingResultFailed } else if portal != nil { - portal.queueEvent(ctx, &portalMatrixEvent{ + return portal.queueEvent(ctx, &portalMatrixEvent{ evt: evt, sender: sender, }) } else if evt.Type == event.StateMember && br.IsGhostMXID(id.UserID(evt.GetStateKey())) && evt.Content.AsMember().Membership == event.MembershipInvite && evt.Content.AsMember().IsDirect { - br.handleGhostDMInvite(ctx, evt, sender) + return br.handleGhostDMInvite(ctx, evt, sender) } else { status := WrapErrorInStatus(ErrNoPortal) br.Matrix.SendMessageStatus(ctx, &status, StatusEventInfoFromEvent(evt)) + return EventHandlingResultIgnored } } -func (ul *UserLogin) QueueRemoteEvent(evt RemoteEvent) { - ul.Bridge.QueueRemoteEvent(ul, evt) +type EventHandlingResult struct { + Success bool + Ignored bool + Queued bool + + SkipStateEcho bool + + // Error is an optional reason for failure. It is not required, Success may be false even without a specific error. + Error error + // Whether the Error should be sent as a MSS event. + SendMSS bool + + // EventID from the network + EventID id.EventID + // Stream order from the network + StreamOrder int64 } -func (br *Bridge) QueueRemoteEvent(login *UserLogin, evt RemoteEvent) { +func (ehr EventHandlingResult) WithEventID(id id.EventID) EventHandlingResult { + ehr.EventID = id + return ehr +} + +func (ehr EventHandlingResult) WithStreamOrder(order int64) EventHandlingResult { + ehr.StreamOrder = order + return ehr +} + +func (ehr EventHandlingResult) WithError(err error) EventHandlingResult { + if err == nil { + return ehr + } + ehr.Error = err + ehr.Success = false + return ehr +} + +func (ehr EventHandlingResult) WithMSS() EventHandlingResult { + ehr.SendMSS = true + return ehr +} + +func (ehr EventHandlingResult) WithSkipStateEcho(skip bool) EventHandlingResult { + ehr.SkipStateEcho = skip + return ehr +} + +func (ehr EventHandlingResult) WithMSSError(err error) EventHandlingResult { + if err == nil { + return ehr + } + return ehr.WithError(err).WithMSS() +} + +var ( + EventHandlingResultFailed = EventHandlingResult{} + EventHandlingResultQueued = EventHandlingResult{Success: true, Queued: true} + EventHandlingResultSuccess = EventHandlingResult{Success: true} + EventHandlingResultIgnored = EventHandlingResult{Success: true, Ignored: true} +) + +func (ul *UserLogin) QueueRemoteEvent(evt RemoteEvent) EventHandlingResult { + return ul.Bridge.QueueRemoteEvent(ul, evt) +} + +func (br *Bridge) QueueRemoteEvent(login *UserLogin, evt RemoteEvent) EventHandlingResult { log := login.Log - ctx := log.WithContext(context.TODO()) + ctx := log.WithContext(br.BackgroundCtx) maybeUncertain, ok := evt.(RemoteEventWithUncertainPortalReceiver) isUncertain := ok && maybeUncertain.PortalReceiverIsUncertain() key := evt.GetPortalKey() @@ -159,18 +236,18 @@ func (br *Bridge) QueueRemoteEvent(login *UserLogin, evt RemoteEvent) { if err != nil { log.Err(err).Object("portal_key", key).Bool("uncertain_receiver", isUncertain). Msg("Failed to get portal to handle remote event") - return + return EventHandlingResultFailed.WithError(fmt.Errorf("failed to get portal: %w", err)) } else if portal == nil { log.Warn(). Stringer("event_type", evt.GetType()). Object("portal_key", key). Bool("uncertain_receiver", isUncertain). Msg("Portal not found to handle remote event") - return + return EventHandlingResultFailed.WithError(ErrPortalNotFoundInEventHandler) } // TODO put this in a better place, and maybe cache to avoid constant db queries login.MarkInPortal(ctx, portal) - portal.queueEvent(ctx, &portalRemoteEvent{ + return portal.queueEvent(ctx, &portalRemoteEvent{ evt: evt, source: login, }) diff --git a/bridgev2/simplevent/chat.go b/bridgev2/simplevent/chat.go index c725141b..56e3a6b1 100644 --- a/bridgev2/simplevent/chat.go +++ b/bridgev2/simplevent/chat.go @@ -65,14 +65,19 @@ func (evt *ChatResync) GetChatInfo(ctx context.Context, portal *bridgev2.Portal) type ChatDelete struct { EventMeta OnlyForMe bool + Children bool } -var _ bridgev2.RemoteChatDelete = (*ChatDelete)(nil) +var _ bridgev2.RemoteChatDeleteWithChildren = (*ChatDelete)(nil) func (evt *ChatDelete) DeleteOnlyForMe() bool { return evt.OnlyForMe } +func (evt *ChatDelete) DeleteChildren() bool { + return evt.Children +} + // ChatInfoChange is a simple implementation of [bridgev2.RemoteChatInfoChange]. type ChatInfoChange struct { EventMeta diff --git a/bridgev2/simplevent/message.go b/bridgev2/simplevent/message.go index f648ab12..f8f8d7e1 100644 --- a/bridgev2/simplevent/message.go +++ b/bridgev2/simplevent/message.go @@ -59,6 +59,41 @@ func (evt *Message[T]) GetTransactionID() networkid.TransactionID { return evt.TransactionID } +// PreConvertedMessage is a simple implementation of [bridgev2.RemoteMessage] with pre-converted data. +type PreConvertedMessage struct { + EventMeta + Data *bridgev2.ConvertedMessage + ID networkid.MessageID + TransactionID networkid.TransactionID + + HandleExistingFunc func(ctx context.Context, portal *bridgev2.Portal, intent bridgev2.MatrixAPI, existing []*database.Message) (bridgev2.UpsertResult, error) +} + +var ( + _ bridgev2.RemoteMessage = (*PreConvertedMessage)(nil) + _ bridgev2.RemoteMessageUpsert = (*PreConvertedMessage)(nil) + _ bridgev2.RemoteMessageWithTransactionID = (*PreConvertedMessage)(nil) +) + +func (evt *PreConvertedMessage) ConvertMessage(ctx context.Context, portal *bridgev2.Portal, intent bridgev2.MatrixAPI) (*bridgev2.ConvertedMessage, error) { + return evt.Data, nil +} + +func (evt *PreConvertedMessage) GetID() networkid.MessageID { + return evt.ID +} + +func (evt *PreConvertedMessage) GetTransactionID() networkid.TransactionID { + return evt.TransactionID +} + +func (evt *PreConvertedMessage) HandleExisting(ctx context.Context, portal *bridgev2.Portal, intent bridgev2.MatrixAPI, existing []*database.Message) (bridgev2.UpsertResult, error) { + if evt.HandleExistingFunc == nil { + return bridgev2.UpsertResult{}, nil + } + return evt.HandleExistingFunc(ctx, portal, intent, existing) +} + type MessageRemove struct { EventMeta diff --git a/bridgev2/simplevent/meta.go b/bridgev2/simplevent/meta.go index a6b278fc..449a8773 100644 --- a/bridgev2/simplevent/meta.go +++ b/bridgev2/simplevent/meta.go @@ -7,6 +7,7 @@ package simplevent import ( + "context" "time" "github.com/rs/zerolog" @@ -25,6 +26,9 @@ type EventMeta struct { CreatePortal bool Timestamp time.Time StreamOrder int64 + + PreHandleFunc func(context.Context, *bridgev2.Portal) + PostHandleFunc func(context.Context, *bridgev2.Portal) } var ( @@ -33,6 +37,8 @@ var ( _ bridgev2.RemoteEventThatMayCreatePortal = (*EventMeta)(nil) _ bridgev2.RemoteEventWithTimestamp = (*EventMeta)(nil) _ bridgev2.RemoteEventWithStreamOrder = (*EventMeta)(nil) + _ bridgev2.RemotePreHandler = (*EventMeta)(nil) + _ bridgev2.RemotePostHandler = (*EventMeta)(nil) ) func (evt *EventMeta) AddLogContext(c zerolog.Context) zerolog.Context { @@ -72,3 +78,67 @@ func (evt *EventMeta) GetType() bridgev2.RemoteEventType { func (evt *EventMeta) ShouldCreatePortal() bool { return evt.CreatePortal } + +func (evt *EventMeta) PreHandle(ctx context.Context, portal *bridgev2.Portal) { + if evt.PreHandleFunc != nil { + evt.PreHandleFunc(ctx, portal) + } +} + +func (evt *EventMeta) PostHandle(ctx context.Context, portal *bridgev2.Portal) { + if evt.PostHandleFunc != nil { + evt.PostHandleFunc(ctx, portal) + } +} + +func (evt EventMeta) WithType(t bridgev2.RemoteEventType) EventMeta { + evt.Type = t + return evt +} + +func (evt EventMeta) WithLogContext(f func(c zerolog.Context) zerolog.Context) EventMeta { + evt.LogContext = f + return evt +} + +func (evt EventMeta) WithMoreLogContext(f func(c zerolog.Context) zerolog.Context) EventMeta { + origFunc := evt.LogContext + if origFunc == nil { + evt.LogContext = f + return evt + } + evt.LogContext = func(c zerolog.Context) zerolog.Context { + return f(origFunc(c)) + } + return evt +} + +func (evt EventMeta) WithPortalKey(p networkid.PortalKey) EventMeta { + evt.PortalKey = p + return evt +} + +func (evt EventMeta) WithUncertainReceiver(u bool) EventMeta { + evt.UncertainReceiver = u + return evt +} + +func (evt EventMeta) WithSender(s bridgev2.EventSender) EventMeta { + evt.Sender = s + return evt +} + +func (evt EventMeta) WithCreatePortal(c bool) EventMeta { + evt.CreatePortal = c + return evt +} + +func (evt EventMeta) WithTimestamp(t time.Time) EventMeta { + evt.Timestamp = t + return evt +} + +func (evt EventMeta) WithStreamOrder(s int64) EventMeta { + evt.StreamOrder = s + return evt +} diff --git a/bridgev2/simplevent/receipt.go b/bridgev2/simplevent/receipt.go index 3565986b..41614e40 100644 --- a/bridgev2/simplevent/receipt.go +++ b/bridgev2/simplevent/receipt.go @@ -19,6 +19,8 @@ type Receipt struct { LastTarget networkid.MessageID Targets []networkid.MessageID ReadUpTo time.Time + + ReadUpToStreamOrder int64 } var ( @@ -38,6 +40,10 @@ func (evt *Receipt) GetReadUpTo() time.Time { return evt.ReadUpTo } +func (evt *Receipt) GetReadUpToStreamOrder() int64 { + return evt.ReadUpToStreamOrder +} + type MarkUnread struct { EventMeta Unread bool diff --git a/bridgev2/space.go b/bridgev2/space.go index 17388f3e..2ca2bce3 100644 --- a/bridgev2/space.go +++ b/bridgev2/space.go @@ -43,7 +43,7 @@ func (ul *UserLogin) MarkInPortal(ctx context.Context, portal *Portal) { } } if ul.Bridge.Config.PersonalFilteringSpaces && (userPortal.InSpace == nil || !*userPortal.InSpace) { - go ul.tryAddPortalToSpace(ctx, portal, userPortal.CopyWithoutValues()) + go ul.tryAddPortalToSpace(context.WithoutCancel(ctx), portal, userPortal.CopyWithoutValues()) } } } @@ -171,6 +171,10 @@ func (ul *UserLogin) GetSpaceRoom(ctx context.Context) (id.RoomID, error) { // TODO remove this after initial_members is supported in hungryserv req.BeeperAutoJoinInvites = true } + pfc, ok := ul.Client.(PersonalFilteringCustomizingNetworkAPI) + if ok { + pfc.CustomizePersonalFilteringSpace(req) + } ul.SpaceRoom, err = ul.Bridge.Bot.CreateRoom(ctx, req) if err != nil { return "", fmt.Errorf("failed to create space room: %w", err) diff --git a/bridge/status/bridgestate.go b/bridgev2/status/bridgestate.go similarity index 75% rename from bridge/status/bridgestate.go rename to bridgev2/status/bridgestate.go index 1aa4bb1f..5925dd4f 100644 --- a/bridge/status/bridgestate.go +++ b/bridgev2/status/bridgestate.go @@ -12,16 +12,17 @@ import ( "encoding/json" "fmt" "io" + "maps" "net/http" "reflect" "time" "github.com/tidwall/sjson" "go.mau.fi/util/jsontime" - "go.mau.fi/util/ptr" - "golang.org/x/exp/maps" "maunium.net/go/mautrix" + "maunium.net/go/mautrix/bridgev2/networkid" + "maunium.net/go/mautrix/event" "maunium.net/go/mautrix/id" ) @@ -53,12 +54,42 @@ const ( StateLoggedOut BridgeStateEvent = "LOGGED_OUT" ) +func (e BridgeStateEvent) IsValid() bool { + switch e { + case + StateStarting, + StateUnconfigured, + StateRunning, + StateBridgeUnreachable, + StateConnecting, + StateBackfilling, + StateConnected, + StateTransientDisconnect, + StateBadCredentials, + StateUnknownError, + StateLoggedOut: + return true + default: + return false + } +} + +type BridgeStateUserAction string + +const ( + UserActionOpenNative BridgeStateUserAction = "OPEN_NATIVE" + UserActionRelogin BridgeStateUserAction = "RELOGIN" + UserActionRestart BridgeStateUserAction = "RESTART" +) + type RemoteProfile struct { Phone string `json:"phone,omitempty"` Email string `json:"email,omitempty"` Username string `json:"username,omitempty"` Name string `json:"name,omitempty"` Avatar id.ContentURIString `json:"avatar,omitempty"` + + AvatarFile *event.EncryptedFileInfo `json:"avatar_file,omitempty"` } func coalesce[T ~string](a, b T) T { @@ -74,11 +105,14 @@ func (rp *RemoteProfile) Merge(other RemoteProfile) RemoteProfile { other.Username = coalesce(rp.Username, other.Username) other.Name = coalesce(rp.Name, other.Name) other.Avatar = coalesce(rp.Avatar, other.Avatar) + if rp.AvatarFile != nil { + other.AvatarFile = rp.AvatarFile + } return other } -func (rp *RemoteProfile) IsEmpty() bool { - return rp == nil || (rp.Phone == "" && rp.Email == "" && rp.Username == "" && rp.Name == "" && rp.Avatar == "") +func (rp *RemoteProfile) IsZero() bool { + return rp == nil || (rp.Phone == "" && rp.Email == "" && rp.Username == "" && rp.Name == "" && rp.Avatar == "" && rp.AvatarFile == nil) } type BridgeState struct { @@ -90,10 +124,12 @@ type BridgeState struct { Error BridgeStateErrorCode `json:"error,omitempty"` Message string `json:"message,omitempty"` - UserID id.UserID `json:"user_id,omitempty"` - RemoteID string `json:"remote_id,omitempty"` - RemoteName string `json:"remote_name,omitempty"` - RemoteProfile *RemoteProfile `json:"remote_profile,omitempty"` + UserAction BridgeStateUserAction `json:"user_action,omitempty"` + + UserID id.UserID `json:"user_id,omitempty"` + RemoteID networkid.UserLoginID `json:"remote_id,omitempty"` + RemoteName string `json:"remote_name,omitempty"` + RemoteProfile RemoteProfile `json:"remote_profile,omitzero"` Reason string `json:"reason,omitempty"` Info map[string]interface{} `json:"info,omitempty"` @@ -105,31 +141,15 @@ type GlobalBridgeState struct { } type BridgeStateFiller interface { - GetMXID() id.UserID - GetRemoteID() string - GetRemoteName() string -} - -type StandaloneCustomBridgeStateFiller interface { FillBridgeState(BridgeState) BridgeState } -type CustomBridgeStateFiller interface { - BridgeStateFiller - StandaloneCustomBridgeStateFiller -} +// Deprecated: use BridgeStateFiller instead +type StandaloneCustomBridgeStateFiller = BridgeStateFiller -func (pong BridgeState) Fill(user any) BridgeState { +func (pong BridgeState) Fill(user BridgeStateFiller) BridgeState { if user != nil { - if std, ok := user.(BridgeStateFiller); ok { - pong.UserID = std.GetMXID() - pong.RemoteID = std.GetRemoteID() - pong.RemoteName = std.GetRemoteName() - } - - if custom, ok := user.(StandaloneCustomBridgeStateFiller); ok { - pong = custom.FillBridgeState(pong) - } + pong = user.FillBridgeState(pong) } pong.Timestamp = jsontime.UnixNow() @@ -188,7 +208,8 @@ func (pong *BridgeState) ShouldDeduplicate(newPong *BridgeState) bool { return pong != nil && pong.StateEvent == newPong.StateEvent && pong.RemoteName == newPong.RemoteName && - ptr.Val(pong.RemoteProfile) == ptr.Val(newPong.RemoteProfile) && + pong.UserAction == newPong.UserAction && + pong.RemoteProfile == newPong.RemoteProfile && pong.Error == newPong.Error && maps.EqualFunc(pong.Info, newPong.Info, reflect.DeepEqual) && pong.Timestamp.Add(time.Duration(pong.TTL)*time.Second).After(time.Now()) diff --git a/bridgev2/status/localbridgestate.go b/bridgev2/status/localbridgestate.go new file mode 100644 index 00000000..3ad66538 --- /dev/null +++ b/bridgev2/status/localbridgestate.go @@ -0,0 +1,23 @@ +package status + +type LocalBridgeAccountState string + +const ( + // LocalBridgeAccountStateSetup means the user wants this account to be setup and connected + LocalBridgeAccountStateSetup LocalBridgeAccountState = "SETUP" + // LocalBridgeAccountStateDeleted means the user wants this account to be deleted + LocalBridgeAccountStateDeleted LocalBridgeAccountState = "DELETED" +) + +type LocalBridgeDeviceState string + +const ( + // LocalBridgeDeviceStateSetup means this device is setup to be connected to this account + LocalBridgeDeviceStateSetup LocalBridgeDeviceState = "SETUP" + // LocalBridgeDeviceStateLoggedOut means the user has logged this particular device out while wanting their other devices to remain setup + LocalBridgeDeviceStateLoggedOut LocalBridgeDeviceState = "LOGGED_OUT" + // LocalBridgeDeviceStateError means this particular device has fallen into a persistent error state that may need user intervention to fix + LocalBridgeDeviceStateError LocalBridgeDeviceState = "ERROR" + // LocalBridgeDeviceStateDeleted means this particular device has cleaned up after the account as a whole was requested to be deleted + LocalBridgeDeviceStateDeleted LocalBridgeDeviceState = "DELETED" +) diff --git a/bridge/status/messagecheckpoint.go b/bridgev2/status/messagecheckpoint.go similarity index 96% rename from bridge/status/messagecheckpoint.go rename to bridgev2/status/messagecheckpoint.go index ea859b84..b3c05f4f 100644 --- a/bridge/status/messagecheckpoint.go +++ b/bridgev2/status/messagecheckpoint.go @@ -169,13 +169,13 @@ type CheckpointsJSON struct { Checkpoints []*MessageCheckpoint `json:"checkpoints"` } -func (cj *CheckpointsJSON) SendHTTP(endpoint string, token string) error { +func (cj *CheckpointsJSON) SendHTTP(ctx context.Context, cli *http.Client, endpoint string, token string) error { var body bytes.Buffer if err := json.NewEncoder(&body).Encode(cj); err != nil { return fmt.Errorf("failed to encode message checkpoint JSON: %w", err) } - ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + ctx, cancel := context.WithTimeout(ctx, 5*time.Second) defer cancel() req, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint, &body) if err != nil { @@ -186,7 +186,10 @@ func (cj *CheckpointsJSON) SendHTTP(endpoint string, token string) error { req.Header.Set("User-Agent", mautrix.DefaultUserAgent+" (checkpoint sender)") req.Header.Set("Content-Type", "application/json") - resp, err := http.DefaultClient.Do(req) + if cli == nil { + cli = http.DefaultClient + } + resp, err := cli.Do(req) if err != nil { return mautrix.HTTPError{ Request: req, diff --git a/bridgev2/user.go b/bridgev2/user.go index 993eda92..9a7896d6 100644 --- a/bridgev2/user.go +++ b/bridgev2/user.go @@ -176,11 +176,15 @@ func (user *User) GetUserLogins() []*UserLogin { return maps.Values(user.logins) } +func (user *User) HasTooManyLogins() bool { + return user.Permissions.MaxLogins > 0 && len(user.GetUserLoginIDs()) >= user.Permissions.MaxLogins +} + func (user *User) GetFormattedUserLogins() string { user.Bridge.cacheLock.Lock() logins := make([]string, len(user.logins)) for key, val := range user.logins { - logins = append(logins, fmt.Sprintf("* `%s` (%s)", key, val.RemoteName)) + logins = append(logins, fmt.Sprintf("* `%s` (%s) - `%s`", key, val.RemoteName, val.BridgeState.GetPrev().StateEvent)) } user.Bridge.cacheLock.Unlock() return strings.Join(logins, "\n") diff --git a/bridgev2/userlogin.go b/bridgev2/userlogin.go index f9b8f7b1..d56dc4cc 100644 --- a/bridgev2/userlogin.go +++ b/bridgev2/userlogin.go @@ -10,6 +10,7 @@ import ( "cmp" "context" "fmt" + "maps" "slices" "sync" "time" @@ -17,10 +18,10 @@ import ( "github.com/rs/zerolog" "go.mau.fi/util/exsync" - "maunium.net/go/mautrix/bridge/status" "maunium.net/go/mautrix/bridgev2/bridgeconfig" "maunium.net/go/mautrix/bridgev2/database" "maunium.net/go/mautrix/bridgev2/networkid" + "maunium.net/go/mautrix/bridgev2/status" "maunium.net/go/mautrix/event" ) @@ -37,6 +38,7 @@ type UserLogin struct { spaceCreateLock sync.Mutex deleteLock sync.Mutex + disconnectOnce sync.Once } func (br *Bridge) loadUserLogin(ctx context.Context, user *User, dbUserLogin *database.UserLogin) (*UserLogin, error) { @@ -49,6 +51,8 @@ func (br *Bridge) loadUserLogin(ctx context.Context, user *User, dbUserLogin *da if err != nil { return nil, fmt.Errorf("failed to get user: %w", err) } + // TODO if loading the user caused the provided userlogin to be loaded, cancel here? + // Currently this will double-load it } userLogin := &UserLogin{ UserLogin: dbUserLogin, @@ -62,6 +66,9 @@ func (br *Bridge) loadUserLogin(ctx context.Context, user *User, dbUserLogin *da if err != nil { userLogin.Log.Err(err).Msg("Failed to load user login") return nil, nil + } else if userLogin.Client == nil { + userLogin.Log.Error().Msg("LoadUserLogin didn't fill Client") + return nil, nil } userLogin.BridgeState = br.NewBridgeStateQueue(userLogin) user.logins[userLogin.ID] = userLogin @@ -136,6 +143,12 @@ func (br *Bridge) GetCachedUserLoginByID(id networkid.UserLoginID) *UserLogin { return br.userLoginsByID[id] } +func (br *Bridge) GetAllCachedUserLogins() (logins []*UserLogin) { + br.cacheLock.Lock() + defer br.cacheLock.Unlock() + return slices.Collect(maps.Values(br.userLoginsByID)) +} + func (br *Bridge) GetCurrentBridgeStates() (states []status.BridgeState) { br.cacheLock.Lock() defer br.cacheLock.Unlock() @@ -224,19 +237,23 @@ func (user *User) NewLogin(ctx context.Context, data *database.UserLogin, params } ul.BridgeState = user.Bridge.NewBridgeStateQueue(ul) } - err = params.LoadUserLogin(ul.Log.WithContext(context.Background()), ul) + noCancelCtx := ul.Log.WithContext(user.Bridge.BackgroundCtx) + err = params.LoadUserLogin(noCancelCtx, ul) if err != nil { return nil, err + } else if ul.Client == nil { + ul.Log.Error().Msg("LoadUserLogin didn't fill Client in NewLogin") + return nil, fmt.Errorf("client not filled by LoadUserLogin") } if doInsert { - err = user.Bridge.DB.UserLogin.Insert(ctx, ul.UserLogin) + err = user.Bridge.DB.UserLogin.Insert(noCancelCtx, ul.UserLogin) if err != nil { return nil, err } user.Bridge.userLoginsByID[ul.ID] = ul user.logins[ul.ID] = ul } else { - err = ul.Save(ctx) + err = ul.Save(noCancelCtx) if err != nil { return nil, err } @@ -255,6 +272,7 @@ func (ul *UserLogin) Logout(ctx context.Context) { type DeleteOpts struct { LogoutRemote bool DontCleanupRooms bool + BlockingCleanup bool unlocked bool } @@ -272,7 +290,8 @@ func (ul *UserLogin) Delete(ctx context.Context, state status.BridgeState, opts if opts.LogoutRemote { ul.Client.LogoutRemote(ctx) } else { - ul.Disconnect(nil) + // we probably shouldn't delete the login if disconnect isn't finished + ul.Disconnect() } var portals []*database.UserPortal var err error @@ -294,10 +313,18 @@ func (ul *UserLogin) Delete(ctx context.Context, state status.BridgeState, opts if !opts.unlocked { ul.Bridge.cacheLock.Unlock() } - backgroundCtx := context.WithoutCancel(ctx) - go ul.deleteSpace(backgroundCtx) + backgroundCtx := zerolog.Ctx(ctx).WithContext(ul.Bridge.BackgroundCtx) + if !opts.BlockingCleanup { + go ul.deleteSpace(backgroundCtx) + } else { + ul.deleteSpace(backgroundCtx) + } if portals != nil { - go ul.kickUserFromPortals(backgroundCtx, portals, state.StateEvent == status.StateBadCredentials, false) + if !opts.BlockingCleanup { + go ul.kickUserFromPortals(backgroundCtx, portals, state.StateEvent == status.StateBadCredentials, false) + } else { + ul.kickUserFromPortals(backgroundCtx, portals, state.StateEvent == status.StateBadCredentials, false) + } } if state.StateEvent != "" { ul.BridgeState.Send(state) @@ -479,36 +506,66 @@ func (ul *UserLogin) MarkAsPreferredIn(ctx context.Context, portal *Portal) erro return ul.Bridge.DB.UserPortal.MarkAsPreferred(ctx, ul.UserLogin, portal.PortalKey) } -var _ status.StandaloneCustomBridgeStateFiller = (*UserLogin)(nil) +var _ status.BridgeStateFiller = (*UserLogin)(nil) func (ul *UserLogin) FillBridgeState(state status.BridgeState) status.BridgeState { state.UserID = ul.UserMXID - state.RemoteID = string(ul.ID) + state.RemoteID = ul.ID state.RemoteName = ul.RemoteName - state.RemoteProfile = &ul.RemoteProfile - filler, ok := ul.Client.(status.StandaloneCustomBridgeStateFiller) + state.RemoteProfile = ul.RemoteProfile + filler, ok := ul.Client.(status.BridgeStateFiller) if ok { return filler.FillBridgeState(state) } return state } -func (ul *UserLogin) Disconnect(done func()) { - if done != nil { - defer done() +func (ul *UserLogin) Disconnect() { + ul.DisconnectWithTimeout(0) +} + +func (ul *UserLogin) DisconnectWithTimeout(timeout time.Duration) { + ul.disconnectOnce.Do(func() { + ul.disconnectInternal(timeout) + }) +} + +func (ul *UserLogin) disconnectInternal(timeout time.Duration) { + ul.BridgeState.StopUnknownErrorReconnect() + disconnected := make(chan struct{}) + go func() { + ul.Client.Disconnect() + close(disconnected) + }() + + var timeoutC <-chan time.Time + if timeout > 0 { + timeoutC = time.After(timeout) } - client := ul.Client - if client != nil { - ul.Client = nil - disconnected := make(chan struct{}) - go func() { - client.Disconnect() - close(disconnected) - }() + for { select { case <-disconnected: - case <-time.After(5 * time.Second): - ul.Log.Warn().Msg("Client disconnection timed out") + return + case <-time.After(2 * time.Second): + ul.Log.Warn().Msg("Client disconnection taking long") + case <-timeoutC: + ul.Log.Error().Msg("Client disconnection timed out") + return } } } + +func (ul *UserLogin) recreateClient(ctx context.Context) error { + oldClient := ul.Client + err := ul.Bridge.Network.LoadUserLogin(ctx, ul) + if err != nil { + return err + } + if ul.Client == oldClient { + zerolog.Ctx(ctx).Warn().Msg("LoadUserLogin didn't update client") + } else { + zerolog.Ctx(ctx).Debug().Msg("Recreated user login client") + } + ul.disconnectOnce = sync.Once{} + return nil +} diff --git a/client.go b/client.go index b85d86fb..7062d9b9 100644 --- a/client.go +++ b/client.go @@ -13,6 +13,7 @@ import ( "net/http" "net/url" "os" + "runtime" "slices" "strconv" "strings" @@ -21,6 +22,7 @@ import ( "github.com/rs/zerolog" "go.mau.fi/util/ptr" + "go.mau.fi/util/random" "go.mau.fi/util/retryafter" "golang.org/x/exp/maps" @@ -75,18 +77,19 @@ type VerificationHelper interface { // Client represents a Matrix client. type Client struct { - HomeserverURL *url.URL // The base homeserver URL - UserID id.UserID // The user ID of the client. Used for forming HTTP paths which use the client's user ID. - DeviceID id.DeviceID // The device ID of the client. - AccessToken string // The access_token for the client. - UserAgent string // The value for the User-Agent header - Client *http.Client // The underlying HTTP client which will be used to make HTTP requests. - Syncer Syncer // The thing which can process /sync responses - Store SyncStore // The thing which can store tokens/ids - StateStore StateStore - Crypto CryptoHelper - Verification VerificationHelper - SpecVersions *RespVersions + HomeserverURL *url.URL // The base homeserver URL + UserID id.UserID // The user ID of the client. Used for forming HTTP paths which use the client's user ID. + DeviceID id.DeviceID // The device ID of the client. + AccessToken string // The access_token for the client. + UserAgent string // The value for the User-Agent header + Client *http.Client // The underlying HTTP client which will be used to make HTTP requests. + Syncer Syncer // The thing which can process /sync responses + Store SyncStore // The thing which can store tokens/ids + StateStore StateStore + Crypto CryptoHelper + Verification VerificationHelper + SpecVersions *RespVersions + ExternalClient *http.Client // The HTTP client used for external (not matrix) media HTTP requests. Log zerolog.Logger @@ -108,6 +111,8 @@ type Client struct { // Set to true to disable automatically sleeping on 429 errors. IgnoreRateLimit bool + ResponseSizeLimit int64 + txnID int32 // Should the ?user_id= query parameter be set in requests? @@ -137,6 +142,12 @@ type IdentityServerInfo struct { // Use ParseUserID to extract the server name from a user ID. // https://spec.matrix.org/v1.2/client-server-api/#server-discovery func DiscoverClientAPI(ctx context.Context, serverName string) (*ClientWellKnown, error) { + return DiscoverClientAPIWithClient(ctx, &http.Client{Timeout: 30 * time.Second}, serverName) +} + +const WellKnownMaxSize = 64 * 1024 + +func DiscoverClientAPIWithClient(ctx context.Context, client *http.Client, serverName string) (*ClientWellKnown, error) { wellKnownURL := url.URL{ Scheme: "https", Host: serverName, @@ -148,10 +159,11 @@ func DiscoverClientAPI(ctx context.Context, serverName string) (*ClientWellKnown return nil, err } - req.Header.Set("Accept", "application/json") - req.Header.Set("User-Agent", DefaultUserAgent+" (.well-known fetcher)") + if runtime.GOOS != "js" { + req.Header.Set("Accept", "application/json") + req.Header.Set("User-Agent", DefaultUserAgent+" (.well-known fetcher)") + } - client := &http.Client{Timeout: 30 * time.Second} resp, err := client.Do(req) if err != nil { return nil, err @@ -160,11 +172,15 @@ func DiscoverClientAPI(ctx context.Context, serverName string) (*ClientWellKnown if resp.StatusCode == http.StatusNotFound { return nil, nil + } else if resp.ContentLength > WellKnownMaxSize { + return nil, errors.New(".well-known response too large") } - data, err := io.ReadAll(resp.Body) + data, err := io.ReadAll(io.LimitReader(resp.Body, WellKnownMaxSize)) if err != nil { return nil, err + } else if len(data) >= WellKnownMaxSize { + return nil, errors.New(".well-known response too large") } var wellKnown ClientWellKnown @@ -240,7 +256,7 @@ func (cli *Client) SyncWithContext(ctx context.Context) error { streamResp = true } timeout := 30000 - if isFailing { + if isFailing || nextBatch == "" { timeout = 0 } resSync, err := cli.FullSyncRequest(ctx, ReqSync{ @@ -314,15 +330,28 @@ type contextKey int const ( LogBodyContextKey contextKey = iota LogRequestIDContextKey + MaxAttemptsContextKey + SyncTokenContextKey ) func (cli *Client) RequestStart(req *http.Request) { - if cli.RequestHook != nil { + if cli != nil && cli.RequestHook != nil { cli.RequestHook(req) } } +// WithMaxRetries updates the context to set the maximum number of retries for any HTTP requests made with the context. +// +// 0 means the request will only be attempted once and will not be retried. +// Negative values will remove the override and fallback to the defaults. +func WithMaxRetries(ctx context.Context, maxRetries int) context.Context { + return context.WithValue(ctx, MaxAttemptsContextKey, maxRetries+1) +} + func (cli *Client) LogRequestDone(req *http.Request, resp *http.Response, err error, handlerErr error, contentLength int, duration time.Duration) { + if cli == nil { + return + } var evt *zerolog.Event if errors.Is(err, context.Canceled) { evt = zerolog.Ctx(req.Context()).Warn() @@ -357,7 +386,14 @@ func (cli *Client) LogRequestDone(req *http.Request, resp *http.Response, err er } } if body := req.Context().Value(LogBodyContextKey); body != nil { - evt.Interface("req_body", body) + switch typedLogBody := body.(type) { + case json.RawMessage: + evt.RawJSON("req_body", typedLogBody) + case string: + evt.Str("req_body", typedLogBody) + default: + panic(fmt.Errorf("invalid type for LogBodyContextKey: %T", body)) + } } if errors.Is(err, context.Canceled) { evt.Msg("Request canceled") @@ -374,32 +410,43 @@ func (cli *Client) MakeRequest(ctx context.Context, method string, httpURL strin return cli.MakeFullRequest(ctx, FullRequest{Method: method, URL: httpURL, RequestJSON: reqBody, ResponseJSON: resBody}) } -type ClientResponseHandler = func(req *http.Request, res *http.Response, responseJSON interface{}) ([]byte, error) +type ClientResponseHandler = func(req *http.Request, res *http.Response, responseJSON any, sizeLimit int64) ([]byte, error) type FullRequest struct { - Method string - URL string - Headers http.Header - RequestJSON interface{} - RequestBytes []byte - RequestBody io.Reader - RequestLength int64 - ResponseJSON interface{} - MaxAttempts int - BackoffDuration time.Duration - SensitiveContent bool - Handler ClientResponseHandler - DontReadResponse bool - Logger *zerolog.Logger - Client *http.Client + Method string + URL string + Headers http.Header + RequestJSON interface{} + RequestBytes []byte + RequestBody io.Reader + RequestLength int64 + ResponseJSON interface{} + MaxAttempts int + BackoffDuration time.Duration + SensitiveContent bool + Handler ClientResponseHandler + DontReadResponse bool + ResponseSizeLimit int64 + Logger *zerolog.Logger + Client *http.Client } var requestID int32 var logSensitiveContent = os.Getenv("MAUTRIX_LOG_SENSITIVE_CONTENT") == "yes" func (params *FullRequest) compileRequest(ctx context.Context) (*http.Request, error) { + reqID := atomic.AddInt32(&requestID, 1) + logger := zerolog.Ctx(ctx) + if logger.GetLevel() == zerolog.Disabled || logger == zerolog.DefaultContextLogger { + logger = params.Logger + } + ctx = logger.With(). + Int32("req_id", reqID). + Logger().WithContext(ctx) + var logBody any - reqBody := params.RequestBody + var reqBody io.Reader + var reqLen int64 if params.RequestJSON != nil { jsonStr, err := json.Marshal(params.RequestJSON) if err != nil { @@ -410,33 +457,38 @@ func (params *FullRequest) compileRequest(ctx context.Context) (*http.Request, e } if params.SensitiveContent && !logSensitiveContent { logBody = "
+ Blockquote = "blockquote", // blockquote
+ InlineLink = "inline_link", // a
+ UserLink = "user_link", //
+ RoomLink = "room_link", //
+ EventLink = "event_link", //
+ AtRoomMention = "at_room_mention", // @room (no html tag)
+ UnorderedList = "unordered_list", // ul + li
+ OrderedList = "ordered_list", // ol + li
+ ListStart = "ordered_list.start", //
+ ListJumpValue = "ordered_list.jump_value", // -
+ CustomEmoji = "custom_emoji", //
![]()
+ Spoiler = "spoiler", //
+ SpoilerReason = "spoiler.reason", //
+ TextForegroundColor = "color.foreground", //
+ TextBackgroundColor = "color.background", //
+ HorizontalLine = "horizontal_line", // hr
+ Headers = "headers", // h1, h2, h3, h4, h5, h6
+ Superscript = "superscript", // sup
+ Subscript = "subscript", // sub
+ Math = "math", //
+ DetailsSummary = "details_summary", // ...
...
+ Table = "table", // table, thead, tbody, tr, th, td
+}
diff --git a/event/capabilities.go b/event/capabilities.go
new file mode 100644
index 00000000..a86c726b
--- /dev/null
+++ b/event/capabilities.go
@@ -0,0 +1,414 @@
+// Copyright (c) 2024 Tulir Asokan
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package event
+
+import (
+ "crypto/sha256"
+ "encoding/base64"
+ "encoding/binary"
+ "fmt"
+ "io"
+ "mime"
+ "slices"
+ "strings"
+
+ "go.mau.fi/util/exerrors"
+ "go.mau.fi/util/jsontime"
+ "go.mau.fi/util/ptr"
+ "golang.org/x/exp/constraints"
+ "golang.org/x/exp/maps"
+)
+
+type RoomFeatures struct {
+ ID string `json:"id,omitempty"`
+
+ // N.B. New fields need to be added to the Hash function to be included in the deduplication hash.
+
+ Formatting FormattingFeatureMap `json:"formatting,omitempty"`
+ File FileFeatureMap `json:"file,omitempty"`
+ State StateFeatureMap `json:"state,omitempty"`
+ MemberActions MemberFeatureMap `json:"member_actions,omitempty"`
+
+ MaxTextLength int `json:"max_text_length,omitempty"`
+
+ LocationMessage CapabilitySupportLevel `json:"location_message,omitempty"`
+ Poll CapabilitySupportLevel `json:"poll,omitempty"`
+ Thread CapabilitySupportLevel `json:"thread,omitempty"`
+ Reply CapabilitySupportLevel `json:"reply,omitempty"`
+
+ Edit CapabilitySupportLevel `json:"edit,omitempty"`
+ EditMaxCount int `json:"edit_max_count,omitempty"`
+ EditMaxAge *jsontime.Seconds `json:"edit_max_age,omitempty"`
+ Delete CapabilitySupportLevel `json:"delete,omitempty"`
+ DeleteForMe bool `json:"delete_for_me,omitempty"`
+ DeleteMaxAge *jsontime.Seconds `json:"delete_max_age,omitempty"`
+
+ DisappearingTimer *DisappearingTimerCapability `json:"disappearing_timer,omitempty"`
+
+ Reaction CapabilitySupportLevel `json:"reaction,omitempty"`
+ ReactionCount int `json:"reaction_count,omitempty"`
+ AllowedReactions []string `json:"allowed_reactions,omitempty"`
+ CustomEmojiReactions bool `json:"custom_emoji_reactions,omitempty"`
+
+ ReadReceipts bool `json:"read_receipts,omitempty"`
+ TypingNotifications bool `json:"typing_notifications,omitempty"`
+ Archive bool `json:"archive,omitempty"`
+ MarkAsUnread bool `json:"mark_as_unread,omitempty"`
+ DeleteChat bool `json:"delete_chat,omitempty"`
+ DeleteChatForEveryone bool `json:"delete_chat_for_everyone,omitempty"`
+
+ MessageRequest *MessageRequestFeatures `json:"message_request,omitempty"`
+
+ PerMessageProfileRelay bool `json:"-"`
+}
+
+func (rf *RoomFeatures) GetID() string {
+ if rf.ID != "" {
+ return rf.ID
+ }
+ return base64.RawURLEncoding.EncodeToString(rf.Hash())
+}
+
+func (rf *RoomFeatures) Clone() *RoomFeatures {
+ if rf == nil {
+ return nil
+ }
+ clone := *rf
+ clone.File = clone.File.Clone()
+ clone.Formatting = maps.Clone(clone.Formatting)
+ clone.State = clone.State.Clone()
+ clone.MemberActions = clone.MemberActions.Clone()
+ clone.EditMaxAge = ptr.Clone(clone.EditMaxAge)
+ clone.DeleteMaxAge = ptr.Clone(clone.DeleteMaxAge)
+ clone.DisappearingTimer = clone.DisappearingTimer.Clone()
+ clone.AllowedReactions = slices.Clone(clone.AllowedReactions)
+ clone.MessageRequest = clone.MessageRequest.Clone()
+ return &clone
+}
+
+type MemberFeatureMap map[MemberAction]CapabilitySupportLevel
+
+func (mfm MemberFeatureMap) Clone() MemberFeatureMap {
+ return maps.Clone(mfm)
+}
+
+type MemberAction string
+
+const (
+ MemberActionBan MemberAction = "ban"
+ MemberActionKick MemberAction = "kick"
+ MemberActionLeave MemberAction = "leave"
+ MemberActionRevokeInvite MemberAction = "revoke_invite"
+ MemberActionInvite MemberAction = "invite"
+)
+
+type StateFeatureMap map[string]*StateFeatures
+
+func (sfm StateFeatureMap) Clone() StateFeatureMap {
+ dup := maps.Clone(sfm)
+ for key, value := range dup {
+ dup[key] = value.Clone()
+ }
+ return dup
+}
+
+type StateFeatures struct {
+ Level CapabilitySupportLevel `json:"level"`
+}
+
+func (sf *StateFeatures) Clone() *StateFeatures {
+ if sf == nil {
+ return nil
+ }
+ clone := *sf
+ return &clone
+}
+
+func (sf *StateFeatures) Hash() []byte {
+ return sf.Level.Hash()
+}
+
+type FormattingFeatureMap map[FormattingFeature]CapabilitySupportLevel
+
+type FileFeatureMap map[CapabilityMsgType]*FileFeatures
+
+func (ffm FileFeatureMap) Clone() FileFeatureMap {
+ dup := maps.Clone(ffm)
+ for key, value := range dup {
+ dup[key] = value.Clone()
+ }
+ return dup
+}
+
+type DisappearingTimerCapability struct {
+ Types []DisappearingType `json:"types"`
+ Timers []jsontime.Milliseconds `json:"timers,omitempty"`
+
+ OmitEmptyTimer bool `json:"omit_empty_timer,omitempty"`
+}
+
+func (dtc *DisappearingTimerCapability) Clone() *DisappearingTimerCapability {
+ if dtc == nil {
+ return nil
+ }
+ clone := *dtc
+ clone.Types = slices.Clone(clone.Types)
+ clone.Timers = slices.Clone(clone.Timers)
+ return &clone
+}
+
+func (dtc *DisappearingTimerCapability) Supports(content *BeeperDisappearingTimer) bool {
+ if dtc == nil || content == nil || content.Type == DisappearingTypeNone {
+ return true
+ }
+ return slices.Contains(dtc.Types, content.Type) && (dtc.Timers == nil || slices.Contains(dtc.Timers, content.Timer))
+}
+
+type MessageRequestFeatures struct {
+ AcceptWithMessage CapabilitySupportLevel `json:"accept_with_message,omitempty"`
+ AcceptWithButton CapabilitySupportLevel `json:"accept_with_button,omitempty"`
+}
+
+func (mrf *MessageRequestFeatures) Clone() *MessageRequestFeatures {
+ return ptr.Clone(mrf)
+}
+
+func (mrf *MessageRequestFeatures) Hash() []byte {
+ if mrf == nil {
+ return nil
+ }
+ hasher := sha256.New()
+ hashValue(hasher, "accept_with_message", mrf.AcceptWithMessage)
+ hashValue(hasher, "accept_with_button", mrf.AcceptWithButton)
+ return hasher.Sum(nil)
+}
+
+type CapabilityMsgType = MessageType
+
+// Message types which are used for event capability signaling, but aren't real values for the msgtype field.
+const (
+ CapMsgVoice CapabilityMsgType = "org.matrix.msc3245.voice"
+ CapMsgGIF CapabilityMsgType = "fi.mau.gif"
+ CapMsgSticker CapabilityMsgType = "m.sticker"
+)
+
+type CapabilitySupportLevel int
+
+func (csl CapabilitySupportLevel) Partial() bool {
+ return csl >= CapLevelPartialSupport
+}
+
+func (csl CapabilitySupportLevel) Full() bool {
+ return csl >= CapLevelFullySupported
+}
+
+func (csl CapabilitySupportLevel) Reject() bool {
+ return csl <= CapLevelRejected
+}
+
+const (
+ CapLevelRejected CapabilitySupportLevel = -2 // The feature is unsupported and messages using it will be rejected.
+ CapLevelDropped CapabilitySupportLevel = -1 // The feature is unsupported and has no fallback. The message will go through, but data may be lost.
+ CapLevelUnsupported CapabilitySupportLevel = 0 // The feature is unsupported, but may have a fallback.
+ CapLevelPartialSupport CapabilitySupportLevel = 1 // The feature is partially supported (e.g. it may be converted to a different format).
+ CapLevelFullySupported CapabilitySupportLevel = 2 // The feature is fully supported and can be safely used.
+)
+
+type FormattingFeature string
+
+const (
+ FmtBold FormattingFeature = "bold" // strong, b
+ FmtItalic FormattingFeature = "italic" // em, i
+ FmtUnderline FormattingFeature = "underline" // u
+ FmtStrikethrough FormattingFeature = "strikethrough" // del, s
+ FmtInlineCode FormattingFeature = "inline_code" // code
+ FmtCodeBlock FormattingFeature = "code_block" // pre + code
+ FmtSyntaxHighlighting FormattingFeature = "code_block.syntax_highlighting" //
+ FmtBlockquote FormattingFeature = "blockquote" // blockquote
+ FmtInlineLink FormattingFeature = "inline_link" // a
+ FmtUserLink FormattingFeature = "user_link" //
+ FmtRoomLink FormattingFeature = "room_link" //
+ FmtEventLink FormattingFeature = "event_link" //
+ FmtAtRoomMention FormattingFeature = "at_room_mention" // @room (no html tag)
+ FmtUnorderedList FormattingFeature = "unordered_list" // ul + li
+ FmtOrderedList FormattingFeature = "ordered_list" // ol + li
+ FmtListStart FormattingFeature = "ordered_list.start" //
+ FmtListJumpValue FormattingFeature = "ordered_list.jump_value" // -
+ FmtCustomEmoji FormattingFeature = "custom_emoji" //
![]()
+ FmtSpoiler FormattingFeature = "spoiler" //
+ FmtSpoilerReason FormattingFeature = "spoiler.reason" //
+ FmtTextForegroundColor FormattingFeature = "color.foreground" //
+ FmtTextBackgroundColor FormattingFeature = "color.background" //
+ FmtHorizontalLine FormattingFeature = "horizontal_line" // hr
+ FmtHeaders FormattingFeature = "headers" // h1, h2, h3, h4, h5, h6
+ FmtSuperscript FormattingFeature = "superscript" // sup
+ FmtSubscript FormattingFeature = "subscript" // sub
+ FmtMath FormattingFeature = "math" //
+ FmtDetailsSummary FormattingFeature = "details_summary" // ...
...
+ FmtTable FormattingFeature = "table" // table, thead, tbody, tr, th, td
+)
+
+type FileFeatures struct {
+ // N.B. New fields need to be added to the Hash function to be included in the deduplication hash.
+
+ MimeTypes map[string]CapabilitySupportLevel `json:"mime_types"`
+
+ Caption CapabilitySupportLevel `json:"caption,omitempty"`
+ MaxCaptionLength int `json:"max_caption_length,omitempty"`
+
+ MaxSize int64 `json:"max_size,omitempty"`
+ MaxWidth int `json:"max_width,omitempty"`
+ MaxHeight int `json:"max_height,omitempty"`
+ MaxDuration *jsontime.Seconds `json:"max_duration,omitempty"`
+
+ ViewOnce bool `json:"view_once,omitempty"`
+}
+
+func (ff *FileFeatures) GetMimeSupport(inputType string) CapabilitySupportLevel {
+ match, ok := ff.MimeTypes[inputType]
+ if ok {
+ return match
+ }
+ if strings.IndexByte(inputType, ';') != -1 {
+ plainMime, _, _ := mime.ParseMediaType(inputType)
+ if plainMime != "" {
+ if match, ok = ff.MimeTypes[plainMime]; ok {
+ return match
+ }
+ }
+ }
+ if slash := strings.IndexByte(inputType, '/'); slash > 0 {
+ generalType := fmt.Sprintf("%s/*", inputType[:slash])
+ if match, ok = ff.MimeTypes[generalType]; ok {
+ return match
+ }
+ }
+ match, ok = ff.MimeTypes["*/*"]
+ if ok {
+ return match
+ }
+ return CapLevelRejected
+}
+
+type hashable interface {
+ Hash() []byte
+}
+
+func hashMap[Key ~string, Value hashable](w io.Writer, name string, data map[Key]Value) {
+ keys := maps.Keys(data)
+ slices.Sort(keys)
+ exerrors.Must(w.Write([]byte(name)))
+ for _, key := range keys {
+ exerrors.Must(w.Write([]byte(key)))
+ exerrors.Must(w.Write(data[key].Hash()))
+ exerrors.Must(w.Write([]byte{0}))
+ }
+}
+
+func hashValue(w io.Writer, name string, data hashable) {
+ exerrors.Must(w.Write([]byte(name)))
+ exerrors.Must(w.Write(data.Hash()))
+}
+
+func hashInt[T constraints.Integer](w io.Writer, name string, data T) {
+ exerrors.Must(w.Write(binary.BigEndian.AppendUint64([]byte(name), uint64(data))))
+}
+
+func hashBool[T ~bool](w io.Writer, name string, data T) {
+ exerrors.Must(w.Write([]byte(name)))
+ if data {
+ exerrors.Must(w.Write([]byte{1}))
+ } else {
+ exerrors.Must(w.Write([]byte{0}))
+ }
+}
+
+func (csl CapabilitySupportLevel) Hash() []byte {
+ return []byte{byte(csl + 128)}
+}
+
+func (rf *RoomFeatures) Hash() []byte {
+ hasher := sha256.New()
+
+ hashMap(hasher, "formatting", rf.Formatting)
+ hashMap(hasher, "file", rf.File)
+ hashMap(hasher, "state", rf.State)
+ hashMap(hasher, "member_actions", rf.MemberActions)
+
+ hashInt(hasher, "max_text_length", rf.MaxTextLength)
+
+ hashValue(hasher, "location_message", rf.LocationMessage)
+ hashValue(hasher, "poll", rf.Poll)
+ hashValue(hasher, "thread", rf.Thread)
+ hashValue(hasher, "reply", rf.Reply)
+
+ hashValue(hasher, "edit", rf.Edit)
+ hashInt(hasher, "edit_max_count", rf.EditMaxCount)
+ hashInt(hasher, "edit_max_age", rf.EditMaxAge.Get())
+
+ hashValue(hasher, "delete", rf.Delete)
+ hashBool(hasher, "delete_for_me", rf.DeleteForMe)
+ hashInt(hasher, "delete_max_age", rf.DeleteMaxAge.Get())
+ hashValue(hasher, "disappearing_timer", rf.DisappearingTimer)
+
+ hashValue(hasher, "reaction", rf.Reaction)
+ hashInt(hasher, "reaction_count", rf.ReactionCount)
+ hasher.Write([]byte("allowed_reactions"))
+ for _, reaction := range rf.AllowedReactions {
+ hasher.Write([]byte(reaction))
+ }
+ hashBool(hasher, "custom_emoji_reactions", rf.CustomEmojiReactions)
+
+ hashBool(hasher, "read_receipts", rf.ReadReceipts)
+ hashBool(hasher, "typing_notifications", rf.TypingNotifications)
+ hashBool(hasher, "archive", rf.Archive)
+ hashBool(hasher, "mark_as_unread", rf.MarkAsUnread)
+ hashBool(hasher, "delete_chat", rf.DeleteChat)
+ hashBool(hasher, "delete_chat_for_everyone", rf.DeleteChatForEveryone)
+ hashValue(hasher, "message_request", rf.MessageRequest)
+
+ return hasher.Sum(nil)
+}
+
+func (dtc *DisappearingTimerCapability) Hash() []byte {
+ if dtc == nil {
+ return nil
+ }
+ hasher := sha256.New()
+ hasher.Write([]byte("types"))
+ for _, t := range dtc.Types {
+ hasher.Write([]byte(t))
+ }
+ hasher.Write([]byte("timers"))
+ for _, timer := range dtc.Timers {
+ hashInt(hasher, "", timer.Milliseconds())
+ }
+ return hasher.Sum(nil)
+}
+
+func (ff *FileFeatures) Hash() []byte {
+ hasher := sha256.New()
+ hashMap(hasher, "mime_types", ff.MimeTypes)
+ hashValue(hasher, "caption", ff.Caption)
+ hashInt(hasher, "max_caption_length", ff.MaxCaptionLength)
+ hashInt(hasher, "max_size", ff.MaxSize)
+ hashInt(hasher, "max_width", ff.MaxWidth)
+ hashInt(hasher, "max_height", ff.MaxHeight)
+ hashInt(hasher, "max_duration", ff.MaxDuration.Get())
+ hashBool(hasher, "view_once", ff.ViewOnce)
+ return hasher.Sum(nil)
+}
+
+func (ff *FileFeatures) Clone() *FileFeatures {
+ if ff == nil {
+ return nil
+ }
+ clone := *ff
+ clone.MimeTypes = maps.Clone(clone.MimeTypes)
+ clone.MaxDuration = ptr.Clone(clone.MaxDuration)
+ return &clone
+}
diff --git a/event/cmdschema/content.go b/event/cmdschema/content.go
new file mode 100644
index 00000000..ce07c4c0
--- /dev/null
+++ b/event/cmdschema/content.go
@@ -0,0 +1,78 @@
+// Copyright (c) 2026 Tulir Asokan
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package cmdschema
+
+import (
+ "crypto/sha256"
+ "encoding/base64"
+ "fmt"
+ "reflect"
+ "slices"
+
+ "go.mau.fi/util/exsync"
+ "go.mau.fi/util/ptr"
+
+ "maunium.net/go/mautrix/event"
+ "maunium.net/go/mautrix/id"
+)
+
+type EventContent struct {
+ Command string `json:"command"`
+ Aliases []string `json:"aliases,omitempty"`
+ Parameters []*Parameter `json:"parameters,omitempty"`
+ Description *event.ExtensibleTextContainer `json:"description,omitempty"`
+ TailParam string `json:"fi.mau.tail_parameter,omitempty"`
+}
+
+func (ec *EventContent) Validate() error {
+ if ec == nil {
+ return fmt.Errorf("event content is nil")
+ } else if ec.Command == "" {
+ return fmt.Errorf("command is empty")
+ }
+ var tailFound bool
+ dupMap := exsync.NewSet[string]()
+ for i, p := range ec.Parameters {
+ if err := p.Validate(); err != nil {
+ return fmt.Errorf("parameter %q (#%d) is invalid: %w", ptr.Val(p).Key, i+1, err)
+ } else if !dupMap.Add(p.Key) {
+ return fmt.Errorf("duplicate parameter key %q at #%d", p.Key, i+1)
+ } else if p.Key == ec.TailParam {
+ tailFound = true
+ } else if tailFound && !p.Optional {
+ return fmt.Errorf("required parameter %q (#%d) is after tail parameter %q", p.Key, i+1, ec.TailParam)
+ }
+ }
+ if ec.TailParam != "" && !tailFound {
+ return fmt.Errorf("tail parameter %q not found in parameters", ec.TailParam)
+ }
+ return nil
+}
+
+func (ec *EventContent) IsValid() bool {
+ return ec.Validate() == nil
+}
+
+func (ec *EventContent) StateKey(owner id.UserID) string {
+ hash := sha256.Sum256([]byte(ec.Command + owner.String()))
+ return base64.StdEncoding.EncodeToString(hash[:])
+}
+
+func (ec *EventContent) Equals(other *EventContent) bool {
+ if ec == nil || other == nil {
+ return ec == other
+ }
+ return ec.Command == other.Command &&
+ slices.Equal(ec.Aliases, other.Aliases) &&
+ slices.EqualFunc(ec.Parameters, other.Parameters, (*Parameter).Equals) &&
+ ec.Description.Equals(other.Description) &&
+ ec.TailParam == other.TailParam
+}
+
+func init() {
+ event.TypeMap[event.StateMSC4391BotCommand] = reflect.TypeOf(EventContent{})
+}
diff --git a/event/cmdschema/parameter.go b/event/cmdschema/parameter.go
new file mode 100644
index 00000000..4193b297
--- /dev/null
+++ b/event/cmdschema/parameter.go
@@ -0,0 +1,286 @@
+// Copyright (c) 2026 Tulir Asokan
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package cmdschema
+
+import (
+ "encoding/json"
+ "fmt"
+ "slices"
+
+ "go.mau.fi/util/exslices"
+
+ "maunium.net/go/mautrix/event"
+)
+
+type Parameter struct {
+ Key string `json:"key"`
+ Schema *ParameterSchema `json:"schema"`
+ Optional bool `json:"optional,omitempty"`
+ Description *event.ExtensibleTextContainer `json:"description,omitempty"`
+ DefaultValue any `json:"fi.mau.default_value,omitempty"`
+}
+
+func (p *Parameter) Equals(other *Parameter) bool {
+ if p == nil || other == nil {
+ return p == other
+ }
+ return p.Key == other.Key &&
+ p.Schema.Equals(other.Schema) &&
+ p.Optional == other.Optional &&
+ p.Description.Equals(other.Description) &&
+ p.DefaultValue == other.DefaultValue // TODO this won't work for room/event ID values
+}
+
+func (p *Parameter) Validate() error {
+ if p == nil {
+ return fmt.Errorf("parameter is nil")
+ } else if p.Key == "" {
+ return fmt.Errorf("key is empty")
+ }
+ return p.Schema.Validate()
+}
+
+func (p *Parameter) IsValid() bool {
+ return p.Validate() == nil
+}
+
+func (p *Parameter) GetDefaultValue() any {
+ if p != nil && p.DefaultValue != nil {
+ return p.DefaultValue
+ } else if p == nil || p.Optional {
+ return nil
+ }
+ return p.Schema.GetDefaultValue()
+}
+
+type PrimitiveType string
+
+const (
+ PrimitiveTypeString PrimitiveType = "string"
+ PrimitiveTypeInteger PrimitiveType = "integer"
+ PrimitiveTypeBoolean PrimitiveType = "boolean"
+ PrimitiveTypeServerName PrimitiveType = "server_name"
+ PrimitiveTypeUserID PrimitiveType = "user_id"
+ PrimitiveTypeRoomID PrimitiveType = "room_id"
+ PrimitiveTypeRoomAlias PrimitiveType = "room_alias"
+ PrimitiveTypeEventID PrimitiveType = "event_id"
+)
+
+func (pt PrimitiveType) Schema() *ParameterSchema {
+ return &ParameterSchema{
+ SchemaType: SchemaTypePrimitive,
+ Type: pt,
+ }
+}
+
+func (pt PrimitiveType) IsValid() bool {
+ switch pt {
+ case PrimitiveTypeString,
+ PrimitiveTypeInteger,
+ PrimitiveTypeBoolean,
+ PrimitiveTypeServerName,
+ PrimitiveTypeUserID,
+ PrimitiveTypeRoomID,
+ PrimitiveTypeRoomAlias,
+ PrimitiveTypeEventID:
+ return true
+ default:
+ return false
+ }
+}
+
+type SchemaType string
+
+const (
+ SchemaTypePrimitive SchemaType = "primitive"
+ SchemaTypeArray SchemaType = "array"
+ SchemaTypeUnion SchemaType = "union"
+ SchemaTypeLiteral SchemaType = "literal"
+)
+
+type ParameterSchema struct {
+ SchemaType SchemaType `json:"schema_type"`
+ Type PrimitiveType `json:"type,omitempty"` // Only for primitive
+ Items *ParameterSchema `json:"items,omitempty"` // Only for array
+ Variants []*ParameterSchema `json:"variants,omitempty"` // Only for union
+ Value any `json:"value,omitempty"` // Only for literal
+}
+
+func Literal(value any) *ParameterSchema {
+ return &ParameterSchema{
+ SchemaType: SchemaTypeLiteral,
+ Value: value,
+ }
+}
+
+func Enum(values ...any) *ParameterSchema {
+ return Union(exslices.CastFunc(values, Literal)...)
+}
+
+func flattenUnion(variants []*ParameterSchema) []*ParameterSchema {
+ var flattened []*ParameterSchema
+ for _, variant := range variants {
+ switch variant.SchemaType {
+ case SchemaTypeArray:
+ panic(fmt.Errorf("illegal array schema in union"))
+ case SchemaTypeUnion:
+ flattened = append(flattened, flattenUnion(variant.Variants)...)
+ default:
+ flattened = append(flattened, variant)
+ }
+ }
+ return flattened
+}
+
+func Union(variants ...*ParameterSchema) *ParameterSchema {
+ needsFlattening := false
+ for _, variant := range variants {
+ if variant.SchemaType == SchemaTypeArray {
+ panic(fmt.Errorf("illegal array schema in union"))
+ } else if variant.SchemaType == SchemaTypeUnion {
+ needsFlattening = true
+ }
+ }
+ if needsFlattening {
+ variants = flattenUnion(variants)
+ }
+ return &ParameterSchema{
+ SchemaType: SchemaTypeUnion,
+ Variants: variants,
+ }
+}
+
+func Array(items *ParameterSchema) *ParameterSchema {
+ if items.SchemaType == SchemaTypeArray {
+ panic(fmt.Errorf("illegal array schema in array"))
+ }
+ return &ParameterSchema{
+ SchemaType: SchemaTypeArray,
+ Items: items,
+ }
+}
+
+func (ps *ParameterSchema) GetDefaultValue() any {
+ if ps == nil {
+ return nil
+ }
+ switch ps.SchemaType {
+ case SchemaTypePrimitive:
+ switch ps.Type {
+ case PrimitiveTypeInteger:
+ return 0
+ case PrimitiveTypeBoolean:
+ return false
+ default:
+ return ""
+ }
+ case SchemaTypeArray:
+ return []any{}
+ case SchemaTypeUnion:
+ if len(ps.Variants) > 0 {
+ return ps.Variants[0].GetDefaultValue()
+ }
+ return nil
+ case SchemaTypeLiteral:
+ return ps.Value
+ default:
+ return nil
+ }
+}
+
+func (ps *ParameterSchema) IsValid() bool {
+ return ps.validate("") == nil
+}
+
+func (ps *ParameterSchema) Validate() error {
+ return ps.validate("")
+}
+
+func (ps *ParameterSchema) validate(parent SchemaType) error {
+ if ps == nil {
+ return fmt.Errorf("schema is nil")
+ }
+ switch ps.SchemaType {
+ case SchemaTypePrimitive:
+ if !ps.Type.IsValid() {
+ return fmt.Errorf("invalid primitive type %s", ps.Type)
+ } else if ps.Items != nil || ps.Variants != nil || ps.Value != nil {
+ return fmt.Errorf("primitive schema has extra fields")
+ }
+ return nil
+ case SchemaTypeArray:
+ if parent != "" {
+ return fmt.Errorf("arrays can't be nested in other types")
+ } else if err := ps.Items.validate(ps.SchemaType); err != nil {
+ return fmt.Errorf("item schema is invalid: %w", err)
+ } else if ps.Type != "" || ps.Variants != nil || ps.Value != nil {
+ return fmt.Errorf("array schema has extra fields")
+ }
+ return nil
+ case SchemaTypeUnion:
+ if len(ps.Variants) == 0 {
+ return fmt.Errorf("no variants specified for union")
+ } else if parent != "" && parent != SchemaTypeArray {
+ return fmt.Errorf("unions can't be nested in anything other than arrays")
+ }
+ for i, v := range ps.Variants {
+ if err := v.validate(ps.SchemaType); err != nil {
+ return fmt.Errorf("variant #%d is invalid: %w", i+1, err)
+ }
+ }
+ if ps.Type != "" || ps.Items != nil || ps.Value != nil {
+ return fmt.Errorf("union schema has extra fields")
+ }
+ return nil
+ case SchemaTypeLiteral:
+ switch typedVal := ps.Value.(type) {
+ case string, float64, int, int64, json.Number, bool, RoomIDValue, *RoomIDValue:
+ // ok
+ case map[string]any:
+ if typedVal["type"] != "event_id" && typedVal["type"] != "room_id" {
+ return fmt.Errorf("literal value has invalid map data")
+ }
+ default:
+ return fmt.Errorf("literal value has unsupported type %T", ps.Value)
+ }
+ if ps.Type != "" || ps.Items != nil || ps.Variants != nil {
+ return fmt.Errorf("literal schema has extra fields")
+ }
+ return nil
+ default:
+ return fmt.Errorf("invalid schema type %s", ps.SchemaType)
+ }
+}
+
+func (ps *ParameterSchema) Equals(other *ParameterSchema) bool {
+ if ps == nil || other == nil {
+ return ps == other
+ }
+ return ps.SchemaType == other.SchemaType &&
+ ps.Type == other.Type &&
+ ps.Items.Equals(other.Items) &&
+ slices.EqualFunc(ps.Variants, other.Variants, (*ParameterSchema).Equals) &&
+ ps.Value == other.Value // TODO this won't work for room/event ID values
+}
+
+func (ps *ParameterSchema) AllowsPrimitive(prim PrimitiveType) bool {
+ switch ps.SchemaType {
+ case SchemaTypePrimitive:
+ return ps.Type == prim
+ case SchemaTypeUnion:
+ for _, variant := range ps.Variants {
+ if variant.AllowsPrimitive(prim) {
+ return true
+ }
+ }
+ return false
+ case SchemaTypeArray:
+ return ps.Items.AllowsPrimitive(prim)
+ default:
+ return false
+ }
+}
diff --git a/event/cmdschema/parse.go b/event/cmdschema/parse.go
new file mode 100644
index 00000000..92e69b60
--- /dev/null
+++ b/event/cmdschema/parse.go
@@ -0,0 +1,478 @@
+// Copyright (c) 2026 Tulir Asokan
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package cmdschema
+
+import (
+ "encoding/json"
+ "errors"
+ "fmt"
+ "regexp"
+ "strconv"
+ "strings"
+
+ "maunium.net/go/mautrix/event"
+ "maunium.net/go/mautrix/id"
+)
+
+const botArrayOpener = "<"
+const botArrayCloser = ">"
+
+func parseQuoted(val string) (parsed, remaining string, quoted bool) {
+ if len(val) == 0 {
+ return
+ }
+ if !strings.HasPrefix(val, `"`) {
+ spaceIdx := strings.IndexByte(val, ' ')
+ if spaceIdx == -1 {
+ parsed = val
+ } else {
+ parsed = val[:spaceIdx]
+ remaining = strings.TrimLeft(val[spaceIdx+1:], " ")
+ }
+ return
+ }
+ val = val[1:]
+ var buf strings.Builder
+ for {
+ quoteIdx := strings.IndexByte(val, '"')
+ var valUntilQuote string
+ if quoteIdx == -1 {
+ valUntilQuote = val
+ } else {
+ valUntilQuote = val[:quoteIdx]
+ }
+ escapeIdx := strings.IndexByte(valUntilQuote, '\\')
+ if escapeIdx >= 0 {
+ buf.WriteString(val[:escapeIdx])
+ if len(val) > escapeIdx+1 {
+ buf.WriteByte(val[escapeIdx+1])
+ }
+ val = val[min(escapeIdx+2, len(val)):]
+ } else if quoteIdx >= 0 {
+ buf.WriteString(val[:quoteIdx])
+ val = val[quoteIdx+1:]
+ break
+ } else if buf.Len() == 0 {
+ // Unterminated quote, no escape characters, val is the whole input
+ return val, "", true
+ } else {
+ // Unterminated quote, but there were escape characters previously
+ buf.WriteString(val)
+ val = ""
+ break
+ }
+ }
+ return buf.String(), strings.TrimLeft(val, " "), true
+}
+
+// ParseInput tries to parse the given text into a bot command event matching this command definition.
+//
+// If the prefix doesn't match, this will return a nil content and nil error.
+// If the prefix does match, some content is always returned, but there may still be an error if parsing failed.
+func (ec *EventContent) ParseInput(owner id.UserID, sigils []string, input string) (content *event.MessageEventContent, err error) {
+ prefix := ec.parsePrefix(input, sigils, owner.String())
+ if prefix == "" {
+ return nil, nil
+ }
+ content = &event.MessageEventContent{
+ MsgType: event.MsgText,
+ Body: input,
+ Mentions: &event.Mentions{UserIDs: []id.UserID{owner}},
+ MSC4391BotCommand: &event.MSC4391BotCommandInput{
+ Command: ec.Command,
+ },
+ }
+ content.MSC4391BotCommand.Arguments, err = ec.ParseArguments(input[len(prefix):])
+ return content, err
+}
+
+func (ec *EventContent) ParseArguments(input string) (json.RawMessage, error) {
+ args := make(map[string]any)
+ var retErr error
+ setError := func(err error) {
+ if err != nil && retErr == nil {
+ retErr = err
+ }
+ }
+ processParameter := func(param *Parameter, isLast, isTail, isNamed bool) {
+ origInput := input
+ var nextVal string
+ var wasQuoted bool
+ if param.Schema.SchemaType == SchemaTypeArray {
+ hasOpener := strings.HasPrefix(input, botArrayOpener)
+ arrayClosed := false
+ if hasOpener {
+ input = input[len(botArrayOpener):]
+ if strings.HasPrefix(input, botArrayCloser) {
+ input = strings.TrimLeft(input[len(botArrayCloser):], " ")
+ arrayClosed = true
+ }
+ }
+ var collector []any
+ for len(input) > 0 && !arrayClosed {
+ //origInput = input
+ nextVal, input, wasQuoted = parseQuoted(input)
+ if !wasQuoted && hasOpener && strings.HasSuffix(nextVal, botArrayCloser) {
+ // The value wasn't quoted and has the array delimiter at the end, close the array
+ nextVal = strings.TrimRight(nextVal, botArrayCloser)
+ arrayClosed = true
+ } else if hasOpener && strings.HasPrefix(input, botArrayCloser) {
+ // The value was quoted or there was a space, and the next character is the
+ // array delimiter, close the array
+ input = strings.TrimLeft(input[len(botArrayCloser):], " ")
+ arrayClosed = true
+ } else if !hasOpener && !isLast {
+ // For array arguments in the middle without the <> delimiters, stop after the first item
+ arrayClosed = true
+ }
+ parsedVal, err := param.Schema.Items.ParseString(nextVal)
+ if err == nil {
+ collector = append(collector, parsedVal)
+ } else if hasOpener || isLast {
+ setError(fmt.Errorf("failed to parse item #%d of array %s: %w", len(collector)+1, param.Key, err))
+ } else {
+ //input = origInput
+ }
+ }
+ args[param.Key] = collector
+ } else {
+ nextVal, input, wasQuoted = parseQuoted(input)
+ if (isLast || isTail) && !wasQuoted && len(input) > 0 {
+ // If the last argument is not quoted, just treat the rest of the string
+ // as the argument without escapes (arguments with escapes should be quoted).
+ nextVal += " " + input
+ input = ""
+ }
+ // Special case for named boolean parameters: if no value is given, treat it as true
+ if nextVal == "" && !wasQuoted && isNamed && param.Schema.AllowsPrimitive(PrimitiveTypeBoolean) {
+ args[param.Key] = true
+ return
+ }
+ if nextVal == "" && !wasQuoted && !isNamed && !param.Optional {
+ setError(fmt.Errorf("missing value for required parameter %s", param.Key))
+ }
+ parsedVal, err := param.Schema.ParseString(nextVal)
+ if err != nil {
+ args[param.Key] = param.GetDefaultValue()
+ // For optional parameters that fail to parse, restore the input and try passing it as the next parameter
+ if param.Optional && !isLast && !isNamed {
+ input = strings.TrimLeft(origInput, " ")
+ } else if !param.Optional || isNamed {
+ setError(fmt.Errorf("failed to parse %s: %w", param.Key, err))
+ }
+ } else {
+ args[param.Key] = parsedVal
+ }
+ }
+ }
+ skipParams := make([]bool, len(ec.Parameters))
+ for i, param := range ec.Parameters {
+ for strings.HasPrefix(input, "--") {
+ nameEndIdx := strings.IndexAny(input, " =")
+ if nameEndIdx == -1 {
+ nameEndIdx = len(input)
+ }
+ overrideParam, paramIdx := ec.parameterByName(input[2:nameEndIdx])
+ if overrideParam != nil {
+ // Trim the equals sign, but leave spaces alone to let parseQuoted treat it as empty input
+ input = strings.TrimPrefix(input[nameEndIdx:], "=")
+ skipParams[paramIdx] = true
+ processParameter(overrideParam, false, false, true)
+ } else {
+ break
+ }
+ }
+ isTail := param.Key == ec.TailParam
+ if skipParams[i] || (param.Optional && !isTail) {
+ continue
+ }
+ processParameter(param, i == len(ec.Parameters)-1, isTail, false)
+ }
+ jsonArgs, marshalErr := json.Marshal(args)
+ if marshalErr != nil {
+ return nil, fmt.Errorf("failed to marshal arguments: %w", marshalErr)
+ }
+ return jsonArgs, retErr
+}
+
+func (ec *EventContent) parameterByName(name string) (*Parameter, int) {
+ for i, param := range ec.Parameters {
+ if strings.EqualFold(param.Key, name) {
+ return param, i
+ }
+ }
+ return nil, -1
+}
+
+func (ec *EventContent) parsePrefix(origInput string, sigils []string, owner string) (prefix string) {
+ input := origInput
+ var chosenSigil string
+ for _, sigil := range sigils {
+ if strings.HasPrefix(input, sigil) {
+ chosenSigil = sigil
+ break
+ }
+ }
+ if chosenSigil == "" {
+ return ""
+ }
+ input = input[len(chosenSigil):]
+ var chosenAlias string
+ if !strings.HasPrefix(input, ec.Command) {
+ for _, alias := range ec.Aliases {
+ if strings.HasPrefix(input, alias) {
+ chosenAlias = alias
+ break
+ }
+ }
+ if chosenAlias == "" {
+ return ""
+ }
+ } else {
+ chosenAlias = ec.Command
+ }
+ input = strings.TrimPrefix(input[len(chosenAlias):], owner)
+ if input == "" || input[0] == ' ' {
+ input = strings.TrimLeft(input, " ")
+ return origInput[:len(origInput)-len(input)]
+ }
+ return ""
+}
+
+func (pt PrimitiveType) ValidateValue(value any) bool {
+ _, err := pt.NormalizeValue(value)
+ return err == nil
+}
+
+func normalizeNumber(value any) (int, error) {
+ switch typedValue := value.(type) {
+ case int:
+ return typedValue, nil
+ case int64:
+ return int(typedValue), nil
+ case float64:
+ return int(typedValue), nil
+ case json.Number:
+ if i, err := typedValue.Int64(); err != nil {
+ return 0, fmt.Errorf("failed to parse json.Number: %w", err)
+ } else {
+ return int(i), nil
+ }
+ default:
+ return 0, fmt.Errorf("unsupported type %T for integer", value)
+ }
+}
+
+func (pt PrimitiveType) NormalizeValue(value any) (any, error) {
+ switch pt {
+ case PrimitiveTypeInteger:
+ return normalizeNumber(value)
+ case PrimitiveTypeBoolean:
+ bv, ok := value.(bool)
+ if !ok {
+ return nil, fmt.Errorf("unsupported type %T for boolean", value)
+ }
+ return bv, nil
+ case PrimitiveTypeString, PrimitiveTypeServerName:
+ str, ok := value.(string)
+ if !ok {
+ return nil, fmt.Errorf("unsupported type %T for string", value)
+ }
+ return str, pt.validateStringValue(str)
+ case PrimitiveTypeUserID, PrimitiveTypeRoomAlias:
+ str, ok := value.(string)
+ if !ok {
+ return nil, fmt.Errorf("unsupported type %T for user ID or room alias", value)
+ } else if plainErr := pt.validateStringValue(str); plainErr == nil {
+ return str, nil
+ } else if parsed, err := id.ParseMatrixURIOrMatrixToURL(str); err != nil {
+ return nil, fmt.Errorf("couldn't parse %q as plain ID nor matrix URI: %w / %w", value, plainErr, err)
+ } else if parsed.Sigil1 == '@' && pt == PrimitiveTypeUserID {
+ return parsed.UserID(), nil
+ } else if parsed.Sigil1 == '#' && pt == PrimitiveTypeRoomAlias {
+ return parsed.RoomAlias(), nil
+ } else {
+ return nil, fmt.Errorf("unexpected sigil %c for user ID or room alias", parsed.Sigil1)
+ }
+ case PrimitiveTypeRoomID, PrimitiveTypeEventID:
+ riv, err := NormalizeRoomIDValue(value)
+ if err != nil {
+ return nil, err
+ }
+ return riv, riv.Validate()
+ default:
+ return nil, fmt.Errorf("cannot normalize value for argument type %s", pt)
+ }
+}
+
+func (pt PrimitiveType) validateStringValue(value string) error {
+ switch pt {
+ case PrimitiveTypeString:
+ return nil
+ case PrimitiveTypeServerName:
+ if !id.ValidateServerName(value) {
+ return fmt.Errorf("invalid server name: %q", value)
+ }
+ return nil
+ case PrimitiveTypeUserID:
+ _, _, err := id.UserID(value).ParseAndValidateRelaxed()
+ return err
+ case PrimitiveTypeRoomAlias:
+ sigil, localpart, serverName := id.ParseCommonIdentifier(value)
+ if sigil != '#' || localpart == "" || serverName == "" {
+ return fmt.Errorf("invalid room alias: %q", value)
+ } else if !id.ValidateServerName(serverName) {
+ return fmt.Errorf("invalid server name in room alias: %q", serverName)
+ }
+ return nil
+ default:
+ panic(fmt.Errorf("validateStringValue called with invalid type %s", pt))
+ }
+}
+
+func parseBoolean(val string) (bool, error) {
+ if len(val) == 0 {
+ return false, fmt.Errorf("cannot parse empty string as boolean")
+ }
+ switch strings.ToLower(val) {
+ case "t", "true", "y", "yes", "1":
+ return true, nil
+ case "f", "false", "n", "no", "0":
+ return false, nil
+ default:
+ return false, fmt.Errorf("invalid boolean string: %q", val)
+ }
+}
+
+var markdownLinkRegex = regexp.MustCompile(`^\[.+]\(([^)]+)\)$`)
+
+func parseRoomOrEventID(value string) (*RoomIDValue, error) {
+ if strings.HasPrefix(value, "[") && strings.Contains(value, "](") && strings.HasSuffix(value, ")") {
+ matches := markdownLinkRegex.FindStringSubmatch(value)
+ if len(matches) == 2 {
+ value = matches[1]
+ }
+ }
+ parsed, err := id.ParseMatrixURIOrMatrixToURL(value)
+ if err != nil && strings.HasPrefix(value, "!") {
+ return &RoomIDValue{
+ Type: PrimitiveTypeRoomID,
+ RoomID: id.RoomID(value),
+ }, nil
+ }
+ if err != nil {
+ return nil, err
+ } else if parsed.Sigil1 != '!' {
+ return nil, fmt.Errorf("unexpected sigil %c for room ID", parsed.Sigil1)
+ } else if parsed.MXID2 != "" && parsed.Sigil2 != '$' {
+ return nil, fmt.Errorf("unexpected sigil %c for event ID", parsed.Sigil2)
+ }
+ valType := PrimitiveTypeRoomID
+ if parsed.MXID2 != "" {
+ valType = PrimitiveTypeEventID
+ }
+ return &RoomIDValue{
+ Type: valType,
+ RoomID: parsed.RoomID(),
+ Via: parsed.Via,
+ EventID: parsed.EventID(),
+ }, nil
+}
+
+func (pt PrimitiveType) ParseString(value string) (any, error) {
+ switch pt {
+ case PrimitiveTypeInteger:
+ return strconv.Atoi(value)
+ case PrimitiveTypeBoolean:
+ return parseBoolean(value)
+ case PrimitiveTypeString, PrimitiveTypeServerName, PrimitiveTypeUserID:
+ return value, pt.validateStringValue(value)
+ case PrimitiveTypeRoomAlias:
+ plainErr := pt.validateStringValue(value)
+ if plainErr == nil {
+ return value, nil
+ }
+ parsed, err := id.ParseMatrixURIOrMatrixToURL(value)
+ if err != nil {
+ return nil, fmt.Errorf("couldn't parse %q as plain room alias nor matrix URI: %w / %w", value, plainErr, err)
+ } else if parsed.Sigil1 != '#' {
+ return nil, fmt.Errorf("unexpected sigil %c for room alias", parsed.Sigil1)
+ }
+ return parsed.RoomAlias(), nil
+ case PrimitiveTypeRoomID, PrimitiveTypeEventID:
+ parsed, err := parseRoomOrEventID(value)
+ if err != nil {
+ return nil, err
+ } else if pt != parsed.Type {
+ return nil, fmt.Errorf("mismatching argument type: expected %s but got %s", pt, parsed.Type)
+ }
+ return parsed, nil
+ default:
+ return nil, fmt.Errorf("cannot parse string for argument type %s", pt)
+ }
+}
+
+func (ps *ParameterSchema) ParseString(value string) (any, error) {
+ if ps == nil {
+ return nil, fmt.Errorf("parameter schema is nil")
+ }
+ switch ps.SchemaType {
+ case SchemaTypePrimitive:
+ return ps.Type.ParseString(value)
+ case SchemaTypeLiteral:
+ switch typedValue := ps.Value.(type) {
+ case string:
+ if value == typedValue {
+ return typedValue, nil
+ } else {
+ return nil, fmt.Errorf("literal value %q does not match %q", typedValue, value)
+ }
+ case int, int64, float64, json.Number:
+ expectedVal, _ := normalizeNumber(typedValue)
+ intVal, err := strconv.Atoi(value)
+ if err != nil {
+ return nil, fmt.Errorf("failed to parse integer literal: %w", err)
+ } else if intVal != expectedVal {
+ return nil, fmt.Errorf("literal value %d does not match %d", expectedVal, intVal)
+ }
+ return intVal, nil
+ case bool:
+ boolVal, err := parseBoolean(value)
+ if err != nil {
+ return nil, fmt.Errorf("failed to parse boolean literal: %w", err)
+ } else if boolVal != typedValue {
+ return nil, fmt.Errorf("literal value %t does not match %t", typedValue, boolVal)
+ }
+ return boolVal, nil
+ case RoomIDValue, *RoomIDValue, map[string]any, json.RawMessage:
+ expectedVal, _ := NormalizeRoomIDValue(typedValue)
+ parsed, err := parseRoomOrEventID(value)
+ if err != nil {
+ return nil, fmt.Errorf("failed to parse room or event ID literal: %w", err)
+ } else if !parsed.Equals(expectedVal) {
+ return nil, fmt.Errorf("literal value %s does not match %s", expectedVal, parsed)
+ }
+ return parsed, nil
+ default:
+ return nil, fmt.Errorf("unsupported literal type %T", ps.Value)
+ }
+ case SchemaTypeUnion:
+ var errs []error
+ for _, variant := range ps.Variants {
+ if parsed, err := variant.ParseString(value); err == nil {
+ return parsed, nil
+ } else {
+ errs = append(errs, err)
+ }
+ }
+ return nil, fmt.Errorf("no union variant matched: %w", errors.Join(errs...))
+ case SchemaTypeArray:
+ return nil, fmt.Errorf("cannot parse string for array schema type")
+ default:
+ return nil, fmt.Errorf("unknown schema type %s", ps.SchemaType)
+ }
+}
diff --git a/event/cmdschema/parse_test.go b/event/cmdschema/parse_test.go
new file mode 100644
index 00000000..1e0d1817
--- /dev/null
+++ b/event/cmdschema/parse_test.go
@@ -0,0 +1,118 @@
+// Copyright (c) 2026 Tulir Asokan
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package cmdschema
+
+import (
+ "bytes"
+ "encoding/json"
+ "strings"
+ "testing"
+
+ "github.com/stretchr/testify/assert"
+ "go.mau.fi/util/exbytes"
+ "go.mau.fi/util/exerrors"
+
+ "maunium.net/go/mautrix/event/cmdschema/testdata"
+)
+
+type QuoteParseOutput struct {
+ Parsed string
+ Remaining string
+ Quoted bool
+}
+
+func (qpo *QuoteParseOutput) UnmarshalJSON(data []byte) error {
+ var arr []any
+ if err := json.Unmarshal(data, &arr); err != nil {
+ return err
+ }
+ qpo.Parsed = arr[0].(string)
+ qpo.Remaining = arr[1].(string)
+ qpo.Quoted = arr[2].(bool)
+ return nil
+}
+
+type QuoteParseTestData struct {
+ Name string `json:"name"`
+ Input string `json:"input"`
+ Output QuoteParseOutput `json:"output"`
+}
+
+func loadFile[T any](name string) (into T) {
+ quoteData := exerrors.Must(testdata.FS.ReadFile(name))
+ exerrors.PanicIfNotNil(json.Unmarshal(quoteData, &into))
+ return
+}
+
+func TestParseQuoted(t *testing.T) {
+ qptd := loadFile[[]QuoteParseTestData]("parse_quote.json")
+ for _, test := range qptd {
+ t.Run(test.Name, func(t *testing.T) {
+ parsed, remaining, quoted := parseQuoted(test.Input)
+ assert.Equalf(t, test.Output, QuoteParseOutput{
+ Parsed: parsed,
+ Remaining: remaining,
+ Quoted: quoted,
+ }, "Failed with input `%s`", test.Input)
+ // Note: can't just test that requoted == input, because some inputs
+ // have unnecessary escapes which won't survive roundtripping
+ t.Run("roundtrip", func(t *testing.T) {
+ requoted := quoteString(parsed) + " " + remaining
+ reparsed, newRemaining, _ := parseQuoted(requoted)
+ assert.Equal(t, parsed, reparsed)
+ assert.Equal(t, remaining, newRemaining)
+ })
+ })
+ }
+}
+
+type CommandTestData struct {
+ Spec *EventContent
+ Tests []*CommandTestUnit
+}
+
+type CommandTestUnit struct {
+ Name string `json:"name"`
+ Input string `json:"input"`
+ Broken string `json:"broken,omitempty"`
+ Error bool `json:"error"`
+ Output json.RawMessage `json:"output"`
+}
+
+func compactJSON(input json.RawMessage) json.RawMessage {
+ var buf bytes.Buffer
+ exerrors.PanicIfNotNil(json.Compact(&buf, input))
+ return buf.Bytes()
+}
+
+func TestMSC4391BotCommandEventContent_ParseInput(t *testing.T) {
+ for _, cmd := range exerrors.Must(testdata.FS.ReadDir("commands")) {
+ t.Run(strings.TrimSuffix(cmd.Name(), ".json"), func(t *testing.T) {
+ ctd := loadFile[CommandTestData]("commands/" + cmd.Name())
+ for _, test := range ctd.Tests {
+ outputStr := exbytes.UnsafeString(compactJSON(test.Output))
+ t.Run(test.Name, func(t *testing.T) {
+ if test.Broken != "" {
+ t.Skip(test.Broken)
+ }
+ output, err := ctd.Spec.ParseInput("@testbot", []string{"/"}, test.Input)
+ if test.Error {
+ assert.Error(t, err)
+ } else {
+ assert.NoError(t, err)
+ }
+ if outputStr == "null" {
+ assert.Nil(t, output)
+ } else {
+ assert.Equal(t, ctd.Spec.Command, output.MSC4391BotCommand.Command)
+ assert.Equalf(t, outputStr, exbytes.UnsafeString(output.MSC4391BotCommand.Arguments), "Input: %s", test.Input)
+ }
+ })
+ }
+ })
+ }
+}
diff --git a/event/cmdschema/roomid.go b/event/cmdschema/roomid.go
new file mode 100644
index 00000000..98c421fc
--- /dev/null
+++ b/event/cmdschema/roomid.go
@@ -0,0 +1,135 @@
+// Copyright (c) 2026 Tulir Asokan
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package cmdschema
+
+import (
+ "encoding/json"
+ "fmt"
+ "slices"
+ "strings"
+
+ "maunium.net/go/mautrix/id"
+)
+
+var ParameterSchemaJoinableRoom = Union(
+ PrimitiveTypeRoomID.Schema(),
+ PrimitiveTypeRoomAlias.Schema(),
+)
+
+type RoomIDValue struct {
+ Type PrimitiveType `json:"type"`
+ RoomID id.RoomID `json:"id"`
+ Via []string `json:"via,omitempty"`
+ EventID id.EventID `json:"event_id,omitempty"`
+}
+
+func NormalizeRoomIDValue(input any) (riv *RoomIDValue, err error) {
+ switch typedValue := input.(type) {
+ case map[string]any, json.RawMessage:
+ var raw json.RawMessage
+ if raw, err = json.Marshal(input); err != nil {
+ err = fmt.Errorf("failed to roundtrip room ID value: %w", err)
+ } else if err = json.Unmarshal(raw, &riv); err != nil {
+ err = fmt.Errorf("failed to roundtrip room ID value: %w", err)
+ }
+ case *RoomIDValue:
+ riv = typedValue
+ case RoomIDValue:
+ riv = &typedValue
+ default:
+ err = fmt.Errorf("unsupported type %T for room or event ID", input)
+ }
+ return
+}
+
+func (riv *RoomIDValue) String() string {
+ return riv.URI().String()
+}
+
+func (riv *RoomIDValue) URI() *id.MatrixURI {
+ if riv == nil {
+ return nil
+ }
+ switch riv.Type {
+ case PrimitiveTypeRoomID:
+ return riv.RoomID.URI(riv.Via...)
+ case PrimitiveTypeEventID:
+ return riv.RoomID.EventURI(riv.EventID, riv.Via...)
+ default:
+ return nil
+ }
+}
+
+func (riv *RoomIDValue) Equals(other *RoomIDValue) bool {
+ if riv == nil || other == nil {
+ return riv == other
+ }
+ return riv.Type == other.Type &&
+ riv.RoomID == other.RoomID &&
+ riv.EventID == other.EventID &&
+ slices.Equal(riv.Via, other.Via)
+}
+
+func (riv *RoomIDValue) Validate() error {
+ if riv == nil {
+ return fmt.Errorf("value is nil")
+ }
+ switch riv.Type {
+ case PrimitiveTypeRoomID:
+ if riv.EventID != "" {
+ return fmt.Errorf("event ID must be empty for room ID type")
+ }
+ case PrimitiveTypeEventID:
+ if !strings.HasPrefix(riv.EventID.String(), "$") {
+ return fmt.Errorf("event ID not valid: %q", riv.EventID)
+ }
+ default:
+ return fmt.Errorf("unexpected type %s for room/event ID value", riv.Type)
+ }
+ for _, via := range riv.Via {
+ if !id.ValidateServerName(via) {
+ return fmt.Errorf("invalid server name %q in vias", via)
+ }
+ }
+ sigil, localpart, serverName := id.ParseCommonIdentifier(riv.RoomID)
+ if sigil != '!' {
+ return fmt.Errorf("room ID does not start with !: %q", riv.RoomID)
+ } else if localpart == "" && serverName == "" {
+ return fmt.Errorf("room ID has empty localpart and server name: %q", riv.RoomID)
+ } else if serverName != "" && !id.ValidateServerName(serverName) {
+ return fmt.Errorf("invalid server name %q in room ID", serverName)
+ }
+ return nil
+}
+
+func (riv *RoomIDValue) IsValid() bool {
+ return riv.Validate() == nil
+}
+
+type RoomIDOrString string
+
+func (ros *RoomIDOrString) UnmarshalJSON(data []byte) error {
+ if len(data) == 0 {
+ return fmt.Errorf("empty data for room ID or string")
+ }
+ if data[0] == '"' {
+ var str string
+ if err := json.Unmarshal(data, &str); err != nil {
+ return err
+ }
+ *ros = RoomIDOrString(str)
+ return nil
+ }
+ var riv RoomIDValue
+ if err := json.Unmarshal(data, &riv); err != nil {
+ return err
+ } else if err = riv.Validate(); err != nil {
+ return err
+ }
+ *ros = RoomIDOrString(riv.String())
+ return nil
+}
diff --git a/event/cmdschema/stringify.go b/event/cmdschema/stringify.go
new file mode 100644
index 00000000..c5c57c53
--- /dev/null
+++ b/event/cmdschema/stringify.go
@@ -0,0 +1,122 @@
+// Copyright (c) 2026 Tulir Asokan
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package cmdschema
+
+import (
+ "encoding/json"
+ "strconv"
+ "strings"
+)
+
+var quoteEscaper = strings.NewReplacer(
+ `"`, `\"`,
+ `\`, `\\`,
+)
+
+const charsToQuote = ` \` + botArrayOpener + botArrayCloser
+
+func quoteString(val string) string {
+ if val == "" {
+ return `""`
+ }
+ val = quoteEscaper.Replace(val)
+ if strings.ContainsAny(val, charsToQuote) {
+ return `"` + val + `"`
+ }
+ return val
+}
+
+func (ec *EventContent) StringifyArgs(args any) string {
+ var argMap map[string]any
+ switch typedArgs := args.(type) {
+ case json.RawMessage:
+ err := json.Unmarshal(typedArgs, &argMap)
+ if err != nil {
+ return ""
+ }
+ case map[string]any:
+ argMap = typedArgs
+ default:
+ if b, err := json.Marshal(args); err != nil {
+ return ""
+ } else if err = json.Unmarshal(b, &argMap); err != nil {
+ return ""
+ }
+ }
+ parts := make([]string, 0, len(ec.Parameters))
+ for i, param := range ec.Parameters {
+ isLast := i == len(ec.Parameters)-1
+ val := argMap[param.Key]
+ if val == nil {
+ val = param.DefaultValue
+ if val == nil && !param.Optional {
+ val = param.Schema.GetDefaultValue()
+ }
+ }
+ if val == nil {
+ continue
+ }
+ var stringified string
+ if param.Schema.SchemaType == SchemaTypeArray {
+ stringified = arrayArgumentToString(val, isLast)
+ } else {
+ stringified = singleArgumentToString(val)
+ }
+ if stringified != "" {
+ parts = append(parts, stringified)
+ }
+ }
+ return strings.Join(parts, " ")
+}
+
+func arrayArgumentToString(val any, isLast bool) string {
+ valArr, ok := val.([]any)
+ if !ok {
+ return ""
+ }
+ parts := make([]string, 0, len(valArr))
+ for _, elem := range valArr {
+ stringified := singleArgumentToString(elem)
+ if stringified != "" {
+ parts = append(parts, stringified)
+ }
+ }
+ joinedParts := strings.Join(parts, " ")
+ if isLast && len(parts) > 0 {
+ return joinedParts
+ }
+ return botArrayOpener + joinedParts + botArrayCloser
+}
+
+func singleArgumentToString(val any) string {
+ switch typedVal := val.(type) {
+ case string:
+ return quoteString(typedVal)
+ case json.Number:
+ return typedVal.String()
+ case bool:
+ return strconv.FormatBool(typedVal)
+ case int:
+ return strconv.Itoa(typedVal)
+ case int64:
+ return strconv.FormatInt(typedVal, 10)
+ case float64:
+ return strconv.FormatInt(int64(typedVal), 10)
+ case map[string]any, json.RawMessage, RoomIDValue, *RoomIDValue:
+ normalized, err := NormalizeRoomIDValue(typedVal)
+ if err != nil {
+ return ""
+ }
+ uri := normalized.URI()
+ if uri == nil {
+ return ""
+ }
+ return quoteString(uri.String())
+ default:
+ return ""
+ }
+}
diff --git a/event/cmdschema/testdata/commands.schema.json b/event/cmdschema/testdata/commands.schema.json
new file mode 100644
index 00000000..e53382db
--- /dev/null
+++ b/event/cmdschema/testdata/commands.schema.json
@@ -0,0 +1,281 @@
+{
+ "$schema": "https://json-schema.org/draft/2020-12/schema#",
+ "$id": "commands.schema.json",
+ "title": "ParseInput test cases",
+ "description": "JSON schema for test case files containing command specifications and test cases",
+ "type": "object",
+ "required": [
+ "spec",
+ "tests"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "spec": {
+ "title": "MSC4391 Command Description",
+ "description": "JSON schema defining the structure of a bot command event content",
+ "type": "object",
+ "required": [
+ "command"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "command": {
+ "type": "string",
+ "description": "The command name that triggers this bot command"
+ },
+ "aliases": {
+ "type": "array",
+ "description": "Alternative names/aliases for this command",
+ "items": {
+ "type": "string"
+ }
+ },
+ "parameters": {
+ "type": "array",
+ "description": "List of parameters accepted by this command",
+ "items": {
+ "$ref": "#/$defs/Parameter"
+ }
+ },
+ "description": {
+ "$ref": "#/$defs/ExtensibleTextContainer",
+ "description": "Human-readable description of the command"
+ },
+ "fi.mau.tail_parameter": {
+ "type": "string",
+ "description": "The key of the parameter that accepts remaining arguments as tail text"
+ },
+ "source": {
+ "type": "string",
+ "description": "The user ID of the bot that responds to this command"
+ }
+ }
+ },
+ "tests": {
+ "type": "array",
+ "description": "Array of test cases for the command",
+ "items": {
+ "type": "object",
+ "description": "A single test case for command parsing",
+ "required": [
+ "name",
+ "input"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the test case"
+ },
+ "input": {
+ "type": "string",
+ "description": "The command input string to parse"
+ },
+ "output": {
+ "description": "The expected parsed parameter values, or null if the parsing is expected to fail",
+ "oneOf": [
+ {
+ "type": "object",
+ "additionalProperties": true
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "error": {
+ "type": "boolean",
+ "description": "Whether parsing should result in an error. May still produce output.",
+ "default": false
+ }
+ }
+ }
+ }
+ },
+ "$defs": {
+ "ExtensibleTextContainer": {
+ "type": "object",
+ "description": "Container for text that can have multiple representations",
+ "required": [
+ "m.text"
+ ],
+ "properties": {
+ "m.text": {
+ "type": "array",
+ "description": "Array of text representations in different formats",
+ "items": {
+ "$ref": "#/$defs/ExtensibleText"
+ }
+ }
+ }
+ },
+ "ExtensibleText": {
+ "type": "object",
+ "description": "A text representation with a specific MIME type",
+ "required": [
+ "body"
+ ],
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The text content"
+ },
+ "mimetype": {
+ "type": "string",
+ "description": "The MIME type of the text (e.g., text/plain, text/html)",
+ "default": "text/plain",
+ "examples": [
+ "text/plain",
+ "text/html"
+ ]
+ }
+ }
+ },
+ "Parameter": {
+ "type": "object",
+ "description": "A parameter definition for a command",
+ "required": [
+ "key",
+ "schema"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "The identifier for this parameter"
+ },
+ "schema": {
+ "$ref": "#/$defs/ParameterSchema",
+ "description": "The schema defining the type and structure of this parameter"
+ },
+ "optional": {
+ "type": "boolean",
+ "description": "Whether this parameter is optional",
+ "default": false
+ },
+ "description": {
+ "$ref": "#/$defs/ExtensibleTextContainer",
+ "description": "Human-readable description of this parameter"
+ },
+ "fi.mau.default_value": {
+ "description": "Default value for this parameter if not provided"
+ }
+ }
+ },
+ "ParameterSchema": {
+ "type": "object",
+ "description": "Schema definition for a parameter value",
+ "required": [
+ "schema_type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "schema_type": {
+ "type": "string",
+ "enum": [
+ "primitive",
+ "array",
+ "union",
+ "literal"
+ ],
+ "description": "The type of schema"
+ }
+ },
+ "allOf": [
+ {
+ "if": {
+ "properties": {
+ "schema_type": {
+ "const": "primitive"
+ }
+ }
+ },
+ "then": {
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "string",
+ "integer",
+ "boolean",
+ "server_name",
+ "user_id",
+ "room_id",
+ "room_alias",
+ "event_id"
+ ],
+ "description": "The primitive type (only for schema_type: primitive)"
+ }
+ }
+ }
+ },
+ {
+ "if": {
+ "properties": {
+ "schema_type": {
+ "const": "array"
+ }
+ }
+ },
+ "then": {
+ "required": [
+ "items"
+ ],
+ "properties": {
+ "items": {
+ "$ref": "#/$defs/ParameterSchema",
+ "description": "The schema for array items (only for schema_type: array)"
+ }
+ }
+ }
+ },
+ {
+ "if": {
+ "properties": {
+ "schema_type": {
+ "const": "union"
+ }
+ }
+ },
+ "then": {
+ "required": [
+ "variants"
+ ],
+ "properties": {
+ "variants": {
+ "type": "array",
+ "description": "The possible variants (only for schema_type: union)",
+ "items": {
+ "$ref": "#/$defs/ParameterSchema"
+ },
+ "minItems": 1
+ }
+ }
+ }
+ },
+ {
+ "if": {
+ "properties": {
+ "schema_type": {
+ "const": "literal"
+ }
+ }
+ },
+ "then": {
+ "required": [
+ "value"
+ ],
+ "properties": {
+ "value": {
+ "description": "The literal value (only for schema_type: literal)"
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+}
diff --git a/event/cmdschema/testdata/commands/flags.json b/event/cmdschema/testdata/commands/flags.json
new file mode 100644
index 00000000..6ce1f4da
--- /dev/null
+++ b/event/cmdschema/testdata/commands/flags.json
@@ -0,0 +1,126 @@
+{
+ "$schema": "../commands.schema.json#",
+ "spec": {
+ "command": "flag",
+ "source": "@testbot",
+ "parameters": [
+ {
+ "key": "meow",
+ "schema": {
+ "schema_type": "primitive",
+ "type": "string"
+ }
+ },
+ {
+ "key": "user",
+ "schema": {
+ "schema_type": "primitive",
+ "type": "user_id"
+ },
+ "optional": true
+ },
+ {
+ "key": "woof",
+ "schema": {
+ "schema_type": "primitive",
+ "type": "boolean"
+ },
+ "optional": true,
+ "fi.mau.default_value": false
+ }
+ ],
+ "fi.mau.tail_parameter": "user"
+ },
+ "tests": [
+ {
+ "name": "no flags",
+ "input": "/flag mrrp",
+ "output": {
+ "meow": "mrrp",
+ "user": null
+ }
+ },
+ {
+ "name": "no flags, has tail",
+ "input": "/flag mrrp @user:example.com",
+ "output": {
+ "meow": "mrrp",
+ "user": "@user:example.com"
+ }
+ },
+ {
+ "name": "named flag at start",
+ "input": "/flag --woof=yes mrrp @user:example.com",
+ "output": {
+ "meow": "mrrp",
+ "user": "@user:example.com",
+ "woof": true
+ }
+ },
+ {
+ "name": "boolean flag without value",
+ "input": "/flag --woof mrrp @user:example.com",
+ "output": {
+ "meow": "mrrp",
+ "user": "@user:example.com",
+ "woof": true
+ }
+ },
+ {
+ "name": "user id flag without value",
+ "input": "/flag --user --woof mrrp",
+ "error": true,
+ "output": {
+ "meow": "mrrp",
+ "user": null,
+ "woof": true
+ }
+ },
+ {
+ "name": "named flag in the middle",
+ "input": "/flag mrrp --woof=yes @user:example.com",
+ "output": {
+ "meow": "mrrp",
+ "user": "@user:example.com",
+ "woof": true
+ }
+ },
+ {
+ "name": "named flag in the middle with different value",
+ "input": "/flag mrrp --woof=no @user:example.com",
+ "output": {
+ "meow": "mrrp",
+ "user": "@user:example.com",
+ "woof": false
+ }
+ },
+ {
+ "name": "all variables named",
+ "input": "/flag --woof=no --meow=mrrp --user=@user:example.com",
+ "output": {
+ "meow": "mrrp",
+ "user": "@user:example.com",
+ "woof": false
+ }
+ },
+ {
+ "name": "all variables named with quotes",
+ "input": "/flag --woof --meow=\"meow meow mrrp\" --user=\"@user:example.com\"",
+ "output": {
+ "meow": "meow meow mrrp",
+ "user": "@user:example.com",
+ "woof": true
+ }
+ },
+ {
+ "name": "invalid value for named parameter",
+ "input": "/flag --user=meowings mrrp --woof",
+ "error": true,
+ "output": {
+ "meow": "mrrp",
+ "user": null,
+ "woof": true
+ }
+ }
+ ]
+}
diff --git a/event/cmdschema/testdata/commands/room_id_or_alias.json b/event/cmdschema/testdata/commands/room_id_or_alias.json
new file mode 100644
index 00000000..1351c292
--- /dev/null
+++ b/event/cmdschema/testdata/commands/room_id_or_alias.json
@@ -0,0 +1,85 @@
+{
+ "$schema": "../commands.schema.json#",
+ "spec": {
+ "command": "test room reference",
+ "source": "@testbot",
+ "parameters": [
+ {
+ "key": "room",
+ "schema": {
+ "schema_type": "union",
+ "variants": [
+ {
+ "schema_type": "primitive",
+ "type": "room_id"
+ },
+ {
+ "schema_type": "primitive",
+ "type": "room_alias"
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "tests": [
+ {
+ "name": "room alias",
+ "input": "/test room reference #test:matrix.org",
+ "output": {
+ "room": "#test:matrix.org"
+ }
+ },
+ {
+ "name": "room id",
+ "input": "/test room reference !aiwVrNhPwbGBNjqlNu:matrix.org",
+ "output": {
+ "room": {
+ "type": "room_id",
+ "id": "!aiwVrNhPwbGBNjqlNu:matrix.org"
+ }
+ }
+ },
+ {
+ "name": "room id matrix.to link",
+ "input": "/test room reference https://matrix.to/#/!aiwVrNhPwbGBNjqlNu:matrix.org?via=example.com",
+ "output": {
+ "room": {
+ "type": "room_id",
+ "id": "!aiwVrNhPwbGBNjqlNu:matrix.org",
+ "via": [
+ "example.com"
+ ]
+ }
+ }
+ },
+ {
+ "name": "room id matrix.to link with url encoding",
+ "input": "/test room reference https://matrix.to/#/!%23test%2Froom%0Aversion%20%3Cu%3E11%3C%2Fu%3E%2C%20with%20%40%F0%9F%90%88%EF%B8%8F%3Amaunium.net?via=maunium.net",
+ "broken": "Go's url.URL does url decoding on the fragment, which breaks splitting the path segments properly",
+ "output": {
+ "room": {
+ "type": "room_id",
+ "id": "!#test/room\nversion 11, with @🐈️:maunium.net",
+ "via": [
+ "maunium.net"
+ ]
+ }
+ }
+ },
+ {
+ "name": "room id matrix: URI",
+ "input": "/test room reference matrix:roomid/mauT12AzsoqxV7Abvy_ApA-HNPK1LcT4GbP70_AOPyQ?via=maunium.net&via=matrix.org",
+ "output": {
+ "room": {
+ "type": "room_id",
+ "id": "!mauT12AzsoqxV7Abvy_ApA-HNPK1LcT4GbP70_AOPyQ",
+ "via": [
+ "maunium.net",
+ "matrix.org"
+ ]
+ }
+ }
+ }
+ ]
+}
diff --git a/event/cmdschema/testdata/commands/room_reference_list.json b/event/cmdschema/testdata/commands/room_reference_list.json
new file mode 100644
index 00000000..aa266054
--- /dev/null
+++ b/event/cmdschema/testdata/commands/room_reference_list.json
@@ -0,0 +1,106 @@
+{
+ "$schema": "../commands.schema.json#",
+ "spec": {
+ "command": "test room reference",
+ "source": "@testbot",
+ "parameters": [
+ {
+ "key": "rooms",
+ "schema": {
+ "schema_type": "array",
+ "items": {
+ "schema_type": "union",
+ "variants": [
+ {
+ "schema_type": "primitive",
+ "type": "room_id"
+ },
+ {
+ "schema_type": "primitive",
+ "type": "room_alias"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ "tests": [
+ {
+ "name": "room alias",
+ "input": "/test room reference #test:matrix.org",
+ "output": {
+ "rooms": [
+ "#test:matrix.org"
+ ]
+ }
+ },
+ {
+ "name": "room id",
+ "input": "/test room reference !aiwVrNhPwbGBNjqlNu:matrix.org",
+ "output": {
+ "rooms": [
+ {
+ "type": "room_id",
+ "id": "!aiwVrNhPwbGBNjqlNu:matrix.org"
+ }
+ ]
+ }
+ },
+ {
+ "name": "two room ids",
+ "input": "/test room reference !mauT12AzsoqxV7Abvy_ApA-HNPK1LcT4GbP70_AOPyQ !aiwVrNhPwbGBNjqlNu:matrix.org",
+ "output": {
+ "rooms": [
+ {
+ "type": "room_id",
+ "id": "!mauT12AzsoqxV7Abvy_ApA-HNPK1LcT4GbP70_AOPyQ"
+ },
+ {
+ "type": "room_id",
+ "id": "!aiwVrNhPwbGBNjqlNu:matrix.org"
+ }
+ ]
+ }
+ },
+ {
+ "name": "room id matrix: URI",
+ "input": "/test room reference matrix:roomid/mauT12AzsoqxV7Abvy_ApA-HNPK1LcT4GbP70_AOPyQ?via=maunium.net&via=matrix.org",
+ "output": {
+ "rooms": [
+ {
+ "type": "room_id",
+ "id": "!mauT12AzsoqxV7Abvy_ApA-HNPK1LcT4GbP70_AOPyQ",
+ "via": [
+ "maunium.net",
+ "matrix.org"
+ ]
+ }
+ ]
+ }
+ },
+ {
+ "name": "room id matrix: URI and matrix.to URL",
+ "input": "/test room reference https://matrix.to/#/!aiwVrNhPwbGBNjqlNu:matrix.org?via=example.com matrix:roomid/mauT12AzsoqxV7Abvy_ApA-HNPK1LcT4GbP70_AOPyQ?via=maunium.net&via=matrix.org",
+ "output": {
+ "rooms": [
+ {
+ "type": "room_id",
+ "id": "!aiwVrNhPwbGBNjqlNu:matrix.org",
+ "via": [
+ "example.com"
+ ]
+ },
+ {
+ "type": "room_id",
+ "id": "!mauT12AzsoqxV7Abvy_ApA-HNPK1LcT4GbP70_AOPyQ",
+ "via": [
+ "maunium.net",
+ "matrix.org"
+ ]
+ }
+ ]
+ }
+ }
+ ]
+}
diff --git a/event/cmdschema/testdata/commands/simple.json b/event/cmdschema/testdata/commands/simple.json
new file mode 100644
index 00000000..94667323
--- /dev/null
+++ b/event/cmdschema/testdata/commands/simple.json
@@ -0,0 +1,46 @@
+{
+ "$schema": "../commands.schema.json#",
+ "spec": {
+ "command": "test simple",
+ "source": "@testbot",
+ "parameters": [
+ {
+ "key": "meow",
+ "schema": {
+ "schema_type": "primitive",
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "tests": [
+ {
+ "name": "success",
+ "input": "/test simple mrrp",
+ "output": {
+ "meow": "mrrp"
+ }
+ },
+ {
+ "name": "directed success",
+ "input": "/test simple@testbot mrrp",
+ "output": {
+ "meow": "mrrp"
+ }
+ },
+ {
+ "name": "missing parameter",
+ "input": "/test simple",
+ "error": true,
+ "output": {
+ "meow": ""
+ }
+ },
+ {
+ "name": "directed at another bot",
+ "input": "/test simple@anotherbot mrrp",
+ "error": false,
+ "output": null
+ }
+ ]
+}
diff --git a/event/cmdschema/testdata/commands/tail.json b/event/cmdschema/testdata/commands/tail.json
new file mode 100644
index 00000000..9782f8ec
--- /dev/null
+++ b/event/cmdschema/testdata/commands/tail.json
@@ -0,0 +1,60 @@
+{
+ "$schema": "../commands.schema.json#",
+ "spec": {
+ "command": "tail",
+ "source": "@testbot",
+ "parameters": [
+ {
+ "key": "meow",
+ "schema": {
+ "schema_type": "primitive",
+ "type": "string"
+ }
+ },
+ {
+ "key": "reason",
+ "schema": {
+ "schema_type": "primitive",
+ "type": "string"
+ },
+ "optional": true
+ },
+ {
+ "key": "woof",
+ "schema": {
+ "schema_type": "primitive",
+ "type": "boolean"
+ },
+ "optional": true
+ }
+ ],
+ "fi.mau.tail_parameter": "reason"
+ },
+ "tests": [
+ {
+ "name": "no tail or flag",
+ "input": "/tail mrrp",
+ "output": {
+ "meow": "mrrp",
+ "reason": ""
+ }
+ },
+ {
+ "name": "tail, no flag",
+ "input": "/tail mrrp meow meow",
+ "output": {
+ "meow": "mrrp",
+ "reason": "meow meow"
+ }
+ },
+ {
+ "name": "flag before tail",
+ "input": "/tail mrrp --woof meow meow",
+ "output": {
+ "meow": "mrrp",
+ "reason": "meow meow",
+ "woof": true
+ }
+ }
+ ]
+}
diff --git a/hicli/database/upgrades/upgrades.go b/event/cmdschema/testdata/data.go
similarity index 54%
rename from hicli/database/upgrades/upgrades.go
rename to event/cmdschema/testdata/data.go
index 9d0bd1a0..eceea3d2 100644
--- a/hicli/database/upgrades/upgrades.go
+++ b/event/cmdschema/testdata/data.go
@@ -1,22 +1,14 @@
-// Copyright (c) 2024 Tulir Asokan
+// Copyright (c) 2026 Tulir Asokan
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-package upgrades
+package testdata
import (
"embed"
-
- "go.mau.fi/util/dbutil"
)
-var Table dbutil.UpgradeTable
-
-//go:embed *.sql
-var upgrades embed.FS
-
-func init() {
- Table.RegisterFS(upgrades)
-}
+//go:embed *
+var FS embed.FS
diff --git a/event/cmdschema/testdata/parse_quote.json b/event/cmdschema/testdata/parse_quote.json
new file mode 100644
index 00000000..8f52b7f5
--- /dev/null
+++ b/event/cmdschema/testdata/parse_quote.json
@@ -0,0 +1,30 @@
+[
+ {"name": "empty string", "input": "", "output": ["", "", false]},
+ {"name": "single word", "input": "meow", "output": ["meow", "", false]},
+ {"name": "two words", "input": "meow woof", "output": ["meow", "woof", false]},
+ {"name": "many words", "input": "meow meow mrrp", "output": ["meow", "meow mrrp", false]},
+ {"name": "extra spaces", "input": "meow meow mrrp", "output": ["meow", "meow mrrp", false]},
+ {"name": "trailing space", "input": "meow ", "output": ["meow", "", false]},
+ {"name": "only spaces", "input": " ", "output": ["", "", false]},
+ {"name": "leading spaces", "input": " meow woof", "output": ["", "meow woof", false]},
+ {"name": "backslash at end unquoted", "input": "meow\\ woof", "output": ["meow\\", "woof", false]},
+ {"name": "quoted word", "input": "\"meow\" meow mrrp", "output": ["meow", "meow mrrp", true]},
+ {"name": "quoted words", "input": "\"meow meow\" mrrp", "output": ["meow meow", "mrrp", true]},
+ {"name": "spaces in quotes", "input": "\" meow meow \" mrrp", "output": [" meow meow ", "mrrp", true]},
+ {"name": "empty quoted string", "input": "\"\"", "output": ["", "", true]},
+ {"name": "empty quoted with trailing", "input": "\"\" meow", "output": ["", "meow", true]},
+ {"name": "quote no space before next", "input": "\"meow\"woof", "output": ["meow", "woof", true]},
+ {"name": "just opening quote", "input": "\"", "output": ["", "", true]},
+ {"name": "quote then space then text", "input": "\" meow", "output": [" meow", "", true]},
+ {"name": "quotes after word", "input": "meow \" meow mrrp \"", "output": ["meow", "\" meow mrrp \"", false]},
+ {"name": "escaped quote", "input": "\"meow\\\" meow\" mrrp", "output": ["meow\" meow", "mrrp", true]},
+ {"name": "missing end quote", "input": "\"meow meow mrrp", "output": ["meow meow mrrp", "", true]},
+ {"name": "missing end quote with escaped quote", "input": "\"meow\\\" meow mrrp", "output": ["meow\" meow mrrp", "", true]},
+ {"name": "quote in the middle", "input": "me\"ow meow mrrp", "output": ["me\"ow", "meow mrrp", false]},
+ {"name": "backslash in the middle", "input": "me\\ow meow mrrp", "output": ["me\\ow", "meow mrrp", false]},
+ {"name": "other escaped character", "input": "\"m\\eow\" meow mrrp", "output": ["meow", "meow mrrp", true]},
+ {"name": "escaped backslashes", "input": "\"m\\\\e\\\"ow\\\\\" meow mrrp", "output": ["m\\e\"ow\\", "meow mrrp", true]},
+ {"name": "just quotes", "input": "\"\\\"\\\"\\\\\\\"\" meow", "output": ["\"\"\\\"", "meow", true]},
+ {"name": "escape at eof", "input": "\"meow\\", "output": ["meow", "", true]},
+ {"name": "escaped backslash at eof", "input": "\"meow\\\\", "output": ["meow\\", "", true]}
+]
diff --git a/event/cmdschema/testdata/parse_quote.schema.json b/event/cmdschema/testdata/parse_quote.schema.json
new file mode 100644
index 00000000..9f249116
--- /dev/null
+++ b/event/cmdschema/testdata/parse_quote.schema.json
@@ -0,0 +1,46 @@
+{
+ "$schema": "https://json-schema.org/draft/2020-12/schema#",
+ "$id": "parse_quote.schema.json",
+ "title": "parseQuote test cases",
+ "description": "Test cases for the parseQuoted function",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": [
+ "name",
+ "input",
+ "output"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the test case"
+ },
+ "input": {
+ "type": "string",
+ "description": "Input string to be parsed"
+ },
+ "output": {
+ "type": "array",
+ "description": "Expected output of parsing: [first word, remaining text, was quoted]",
+ "minItems": 3,
+ "maxItems": 3,
+ "prefixItems": [
+ {
+ "type": "string",
+ "description": "First parsed word"
+ },
+ {
+ "type": "string",
+ "description": "Remaining text after the first word"
+ },
+ {
+ "type": "boolean",
+ "description": "Whether the first word was quoted"
+ }
+ ]
+ }
+ },
+ "additionalProperties": false
+ }
+}
diff --git a/event/content.go b/event/content.go
index 882d3368..814aeec4 100644
--- a/event/content.go
+++ b/event/content.go
@@ -18,6 +18,7 @@ import (
// This is used by Content.ParseRaw() for creating the correct type of struct.
var TypeMap = map[Type]reflect.Type{
StateMember: reflect.TypeOf(MemberEventContent{}),
+ StateThirdPartyInvite: reflect.TypeOf(ThirdPartyInviteEventContent{}),
StatePowerLevels: reflect.TypeOf(PowerLevelsEventContent{}),
StateCanonicalAlias: reflect.TypeOf(CanonicalAliasEventContent{}),
StateRoomName: reflect.TypeOf(RoomNameEventContent{}),
@@ -38,7 +39,9 @@ var TypeMap = map[Type]reflect.Type{
StateHalfShotBridge: reflect.TypeOf(BridgeEventContent{}),
StateSpaceParent: reflect.TypeOf(SpaceParentEventContent{}),
StateSpaceChild: reflect.TypeOf(SpaceChildEventContent{}),
- StateInsertionMarker: reflect.TypeOf(InsertionMarkerContent{}),
+
+ StateRoomPolicy: reflect.TypeOf(RoomPolicyEventContent{}),
+ StateUnstableRoomPolicy: reflect.TypeOf(RoomPolicyEventContent{}),
StateLegacyPolicyRoom: reflect.TypeOf(ModPolicyContent{}),
StateLegacyPolicyServer: reflect.TypeOf(ModPolicyContent{}),
@@ -48,6 +51,8 @@ var TypeMap = map[Type]reflect.Type{
StateUnstablePolicyUser: reflect.TypeOf(ModPolicyContent{}),
StateElementFunctionalMembers: reflect.TypeOf(ElementFunctionalMembersContent{}),
+ StateBeeperRoomFeatures: reflect.TypeOf(RoomFeatures{}),
+ StateBeeperDisappearingTimer: reflect.TypeOf(BeeperDisappearingTimer{}),
EventMessage: reflect.TypeOf(MessageEventContent{}),
EventSticker: reflect.TypeOf(MessageEventContent{}),
@@ -58,7 +63,11 @@ var TypeMap = map[Type]reflect.Type{
EventUnstablePollStart: reflect.TypeOf(PollStartEventContent{}),
EventUnstablePollResponse: reflect.TypeOf(PollResponseEventContent{}),
- BeeperMessageStatus: reflect.TypeOf(BeeperMessageStatusEventContent{}),
+ BeeperMessageStatus: reflect.TypeOf(BeeperMessageStatusEventContent{}),
+ BeeperTranscription: reflect.TypeOf(BeeperTranscriptionEventContent{}),
+ BeeperDeleteChat: reflect.TypeOf(BeeperChatDeleteEventContent{}),
+ BeeperAcceptMessageRequest: reflect.TypeOf(BeeperAcceptMessageRequestEventContent{}),
+ BeeperSendState: reflect.TypeOf(BeeperSendStateEventContent{}),
AccountDataRoomTags: reflect.TypeOf(TagEventContent{}),
AccountDataDirectChats: reflect.TypeOf(DirectChatsEventContent{}),
@@ -67,9 +76,11 @@ var TypeMap = map[Type]reflect.Type{
AccountDataMarkedUnread: reflect.TypeOf(MarkedUnreadEventContent{}),
AccountDataBeeperMute: reflect.TypeOf(BeeperMuteEventContent{}),
- EphemeralEventTyping: reflect.TypeOf(TypingEventContent{}),
- EphemeralEventReceipt: reflect.TypeOf(ReceiptEventContent{}),
- EphemeralEventPresence: reflect.TypeOf(PresenceEventContent{}),
+ EphemeralEventTyping: reflect.TypeOf(TypingEventContent{}),
+ EphemeralEventReceipt: reflect.TypeOf(ReceiptEventContent{}),
+ EphemeralEventPresence: reflect.TypeOf(PresenceEventContent{}),
+ EphemeralEventEncrypted: reflect.TypeOf(EncryptedEventContent{}),
+ BeeperEphemeralEventAIStream: reflect.TypeOf(BeeperAIStreamEventContent{}),
InRoomVerificationReady: reflect.TypeOf(VerificationReadyEventContent{}),
InRoomVerificationStart: reflect.TypeOf(VerificationStartEventContent{}),
@@ -121,7 +132,7 @@ var TypeMap = map[Type]reflect.Type{
// When being marshaled into JSON, the data in Parsed will be marshaled first and then recursively merged
// with the data in Raw. Values in Raw are preferred, but nested objects will be recursed into before merging,
// rather than overriding the whole object with the one in Raw).
-// If one of them is nil, the only the other is used. If both (Parsed and Raw) are nil, VeryRaw is used instead.
+// If one of them is nil, then only the other is used. If both (Parsed and Raw) are nil, VeryRaw is used instead.
type Content struct {
VeryRaw json.RawMessage
Raw map[string]interface{}
@@ -188,6 +199,13 @@ func IsUnsupportedContentType(err error) bool {
var ErrContentAlreadyParsed = errors.New("content is already parsed")
var ErrUnsupportedContentType = errors.New("unsupported event type")
+func (content *Content) GetRaw() map[string]interface{} {
+ if content.Raw == nil {
+ content.Raw = make(map[string]interface{})
+ }
+ return content.Raw
+}
+
func (content *Content) ParseRaw(evtType Type) error {
if content.Parsed != nil {
return ErrContentAlreadyParsed
diff --git a/event/delayed.go b/event/delayed.go
new file mode 100644
index 00000000..fefb62af
--- /dev/null
+++ b/event/delayed.go
@@ -0,0 +1,70 @@
+package event
+
+import (
+ "encoding/json"
+
+ "go.mau.fi/util/jsontime"
+
+ "maunium.net/go/mautrix/id"
+)
+
+type ScheduledDelayedEvent struct {
+ DelayID id.DelayID `json:"delay_id"`
+ RoomID id.RoomID `json:"room_id"`
+ Type Type `json:"type"`
+ StateKey *string `json:"state_key,omitempty"`
+ Delay int64 `json:"delay"`
+ RunningSince jsontime.UnixMilli `json:"running_since"`
+ Content Content `json:"content"`
+}
+
+func (e ScheduledDelayedEvent) AsEvent(eventID id.EventID, ts jsontime.UnixMilli) (*Event, error) {
+ evt := &Event{
+ ID: eventID,
+ RoomID: e.RoomID,
+ Type: e.Type,
+ StateKey: e.StateKey,
+ Content: e.Content,
+ Timestamp: ts.UnixMilli(),
+ }
+ return evt, evt.Content.ParseRaw(evt.Type)
+}
+
+type FinalisedDelayedEvent struct {
+ DelayedEvent *ScheduledDelayedEvent `json:"scheduled_event"`
+ Outcome DelayOutcome `json:"outcome"`
+ Reason DelayReason `json:"reason"`
+ Error json.RawMessage `json:"error,omitempty"`
+ EventID id.EventID `json:"event_id,omitempty"`
+ Timestamp jsontime.UnixMilli `json:"origin_server_ts"`
+}
+
+type DelayStatus string
+
+var (
+ DelayStatusScheduled DelayStatus = "scheduled"
+ DelayStatusFinalised DelayStatus = "finalised"
+)
+
+type DelayAction string
+
+var (
+ DelayActionSend DelayAction = "send"
+ DelayActionCancel DelayAction = "cancel"
+ DelayActionRestart DelayAction = "restart"
+)
+
+type DelayOutcome string
+
+var (
+ DelayOutcomeSend DelayOutcome = "send"
+ DelayOutcomeCancel DelayOutcome = "cancel"
+)
+
+type DelayReason string
+
+var (
+ DelayReasonAction DelayReason = "action"
+ DelayReasonError DelayReason = "error"
+ DelayReasonDelay DelayReason = "delay"
+)
diff --git a/event/encryption.go b/event/encryption.go
index cf9c2814..c60cb91a 100644
--- a/event/encryption.go
+++ b/event/encryption.go
@@ -63,7 +63,7 @@ func (content *EncryptedEventContent) UnmarshalJSON(data []byte) error {
return json.Unmarshal(content.Ciphertext, &content.OlmCiphertext)
case id.AlgorithmMegolmV1:
if len(content.Ciphertext) == 0 || content.Ciphertext[0] != '"' || content.Ciphertext[len(content.Ciphertext)-1] != '"' {
- return id.InputNotJSONString
+ return fmt.Errorf("ciphertext %w", id.ErrInputNotJSONString)
}
content.MegolmCiphertext = content.Ciphertext[1 : len(content.Ciphertext)-1]
}
@@ -132,8 +132,9 @@ type RoomKeyRequestEventContent struct {
type RequestedKeyInfo struct {
Algorithm id.Algorithm `json:"algorithm"`
RoomID id.RoomID `json:"room_id"`
- SenderKey id.SenderKey `json:"sender_key"`
SessionID id.SessionID `json:"session_id"`
+ // Deprecated: Matrix v1.3
+ SenderKey id.SenderKey `json:"sender_key"`
}
type RoomKeyWithheldCode string
diff --git a/event/events.go b/event/events.go
index 23769ae8..72c1e161 100644
--- a/event/events.go
+++ b/event/events.go
@@ -118,6 +118,9 @@ type MautrixInfo struct {
DecryptionDuration time.Duration
CheckpointSent bool
+ // When using MSC4222 and the state_after field, this field is set
+ // for timeline events to indicate they shouldn't update room state.
+ IgnoreState bool
}
func (evt *Event) GetStateKey() string {
@@ -127,30 +130,29 @@ func (evt *Event) GetStateKey() string {
return ""
}
-type StrippedState struct {
- Content Content `json:"content"`
- Type Type `json:"type"`
- StateKey string `json:"state_key"`
- Sender id.UserID `json:"sender"`
-}
-
type Unsigned struct {
- PrevContent *Content `json:"prev_content,omitempty"`
- PrevSender id.UserID `json:"prev_sender,omitempty"`
- ReplacesState id.EventID `json:"replaces_state,omitempty"`
- Age int64 `json:"age,omitempty"`
- TransactionID string `json:"transaction_id,omitempty"`
- Relations *Relations `json:"m.relations,omitempty"`
- RedactedBecause *Event `json:"redacted_because,omitempty"`
- InviteRoomState []StrippedState `json:"invite_room_state,omitempty"`
+ PrevContent *Content `json:"prev_content,omitempty"`
+ PrevSender id.UserID `json:"prev_sender,omitempty"`
+ Membership Membership `json:"membership,omitempty"`
+ ReplacesState id.EventID `json:"replaces_state,omitempty"`
+ Age int64 `json:"age,omitempty"`
+ TransactionID string `json:"transaction_id,omitempty"`
+ Relations *Relations `json:"m.relations,omitempty"`
+ RedactedBecause *Event `json:"redacted_because,omitempty"`
+ InviteRoomState []*Event `json:"invite_room_state,omitempty"`
- BeeperHSOrder int64 `json:"com.beeper.hs.order,omitempty"`
- BeeperHSSuborder int64 `json:"com.beeper.hs.suborder,omitempty"`
- BeeperFromBackup bool `json:"com.beeper.from_backup,omitempty"`
+ BeeperHSOrder int64 `json:"com.beeper.hs.order,omitempty"`
+ BeeperHSSuborder int16 `json:"com.beeper.hs.suborder,omitempty"`
+ BeeperHSOrderString *BeeperEncodedOrder `json:"com.beeper.hs.order_string,omitempty"`
+ BeeperFromBackup bool `json:"com.beeper.from_backup,omitempty"`
+
+ ElementSoftFailed bool `json:"io.element.synapse.soft_failed,omitempty"`
+ ElementPolicyServerSpammy bool `json:"io.element.synapse.policy_server_spammy,omitempty"`
}
func (us *Unsigned) IsEmpty() bool {
- return us.PrevContent == nil && us.PrevSender == "" && us.ReplacesState == "" && us.Age == 0 &&
+ return us.PrevContent == nil && us.PrevSender == "" && us.ReplacesState == "" && us.Age == 0 && us.Membership == "" &&
us.TransactionID == "" && us.RedactedBecause == nil && us.InviteRoomState == nil && us.Relations == nil &&
- us.BeeperHSOrder == 0 && us.BeeperHSSuborder == 0
+ us.BeeperHSOrder == 0 && us.BeeperHSSuborder == 0 && us.BeeperHSOrderString.IsZero() &&
+ !us.ElementSoftFailed
}
diff --git a/event/member.go b/event/member.go
index ebafdcb7..9956a36b 100644
--- a/event/member.go
+++ b/event/member.go
@@ -7,8 +7,6 @@
package event
import (
- "encoding/json"
-
"maunium.net/go/mautrix/id"
)
@@ -35,19 +33,37 @@ const (
// MemberEventContent represents the content of a m.room.member state event.
// https://spec.matrix.org/v1.2/client-server-api/#mroommember
type MemberEventContent struct {
- Membership Membership `json:"membership"`
- AvatarURL id.ContentURIString `json:"avatar_url,omitempty"`
- Displayname string `json:"displayname,omitempty"`
- IsDirect bool `json:"is_direct,omitempty"`
- ThirdPartyInvite *ThirdPartyInvite `json:"third_party_invite,omitempty"`
- Reason string `json:"reason,omitempty"`
+ Membership Membership `json:"membership"`
+ AvatarURL id.ContentURIString `json:"avatar_url,omitempty"`
+ Displayname string `json:"displayname,omitempty"`
+ IsDirect bool `json:"is_direct,omitempty"`
+ ThirdPartyInvite *ThirdPartyInvite `json:"third_party_invite,omitempty"`
+ Reason string `json:"reason,omitempty"`
+ JoinAuthorisedViaUsersServer id.UserID `json:"join_authorised_via_users_server,omitempty"`
+ MSC3414File *EncryptedFileInfo `json:"org.matrix.msc3414.file,omitempty"`
+
+ MSC4293RedactEvents bool `json:"org.matrix.msc4293.redact_events,omitempty"`
+}
+
+type SignedThirdPartyInvite struct {
+ Token string `json:"token"`
+ Signatures map[string]map[id.KeyID]string `json:"signatures,omitempty"`
+ MXID string `json:"mxid"`
}
type ThirdPartyInvite struct {
- DisplayName string `json:"display_name"`
- Signed struct {
- Token string `json:"token"`
- Signatures json.RawMessage `json:"signatures"`
- MXID string `json:"mxid"`
- }
+ DisplayName string `json:"display_name"`
+ Signed SignedThirdPartyInvite `json:"signed"`
+}
+
+type ThirdPartyInviteEventContent struct {
+ DisplayName string `json:"display_name"`
+ KeyValidityURL string `json:"key_validity_url"`
+ PublicKey id.Ed25519 `json:"public_key"`
+ PublicKeys []ThirdPartyInviteKey `json:"public_keys,omitempty"`
+}
+
+type ThirdPartyInviteKey struct {
+ KeyValidityURL string `json:"key_validity_url,omitempty"`
+ PublicKey id.Ed25519 `json:"public_key"`
}
diff --git a/event/message.go b/event/message.go
index 9badd9a2..3fb3dc82 100644
--- a/event/message.go
+++ b/event/message.go
@@ -8,12 +8,11 @@ package event
import (
"encoding/json"
+ "html"
"slices"
"strconv"
"strings"
- "golang.org/x/net/html"
-
"maunium.net/go/mautrix/crypto/attachment"
"maunium.net/go/mautrix/id"
)
@@ -33,7 +32,7 @@ func (mt MessageType) IsText() bool {
func (mt MessageType) IsMedia() bool {
switch mt {
- case MsgImage, MsgVideo, MsgAudio, MsgFile, MessageType(EventSticker.Type):
+ case MsgImage, MsgVideo, MsgAudio, MsgFile, CapMsgSticker:
return true
default:
return false
@@ -136,11 +135,42 @@ type MessageEventContent struct {
BeeperGalleryCaption string `json:"com.beeper.gallery.caption,omitempty"`
BeeperGalleryCaptionHTML string `json:"com.beeper.gallery.caption_html,omitempty"`
BeeperPerMessageProfile *BeeperPerMessageProfile `json:"com.beeper.per_message_profile,omitempty"`
+ BeeperActionMessage *BeeperActionMessage `json:"com.beeper.action_message,omitempty"`
BeeperLinkPreviews []*BeeperLinkPreview `json:"com.beeper.linkpreviews,omitempty"`
+ BeeperDisappearingTimer *BeeperDisappearingTimer `json:"com.beeper.disappearing_timer,omitempty"`
+
MSC1767Audio *MSC1767Audio `json:"org.matrix.msc1767.audio,omitempty"`
MSC3245Voice *MSC3245Voice `json:"org.matrix.msc3245.voice,omitempty"`
+
+ MSC4391BotCommand *MSC4391BotCommandInput `json:"org.matrix.msc4391.command,omitempty"`
+}
+
+func (content *MessageEventContent) GetCapMsgType() CapabilityMsgType {
+ switch content.MsgType {
+ case CapMsgSticker:
+ return CapMsgSticker
+ case "":
+ if content.URL != "" || content.File != nil {
+ return CapMsgSticker
+ }
+ case MsgImage:
+ return MsgImage
+ case MsgAudio:
+ if content.MSC3245Voice != nil {
+ return CapMsgVoice
+ }
+ return MsgAudio
+ case MsgVideo:
+ if content.Info != nil && content.Info.MauGIF {
+ return CapMsgGIF
+ }
+ return MsgVideo
+ case MsgFile:
+ return MsgFile
+ }
+ return ""
}
func (content *MessageEventContent) GetFileName() string {
@@ -185,6 +215,7 @@ func (content *MessageEventContent) SetEdit(original id.EventID) {
content.RelatesTo = (&RelatesTo{}).SetReplace(original)
if content.MsgType == MsgText || content.MsgType == MsgNotice {
content.Body = "* " + content.Body
+ content.Mentions = &Mentions{}
if content.Format == FormatHTML && len(content.FormattedBody) > 0 {
content.FormattedBody = "* " + content.FormattedBody
}
@@ -245,24 +276,46 @@ func (m *Mentions) Has(userID id.UserID) bool {
return m != nil && slices.Contains(m.UserIDs, userID)
}
+func (m *Mentions) Merge(other *Mentions) *Mentions {
+ if m == nil {
+ return other
+ } else if other == nil {
+ return m
+ }
+ return &Mentions{
+ UserIDs: slices.Concat(m.UserIDs, other.UserIDs),
+ Room: m.Room || other.Room,
+ }
+}
+
+type MSC4391BotCommandInputCustom[T any] struct {
+ Command string `json:"command"`
+ Arguments T `json:"arguments,omitempty"`
+}
+
+type MSC4391BotCommandInput = MSC4391BotCommandInputCustom[json.RawMessage]
+
type EncryptedFileInfo struct {
attachment.EncryptedFile
URL id.ContentURIString `json:"url"`
}
type FileInfo struct {
- MimeType string `json:"mimetype,omitempty"`
- ThumbnailInfo *FileInfo `json:"thumbnail_info,omitempty"`
- ThumbnailURL id.ContentURIString `json:"thumbnail_url,omitempty"`
- ThumbnailFile *EncryptedFileInfo `json:"thumbnail_file,omitempty"`
+ MimeType string
+ ThumbnailInfo *FileInfo
+ ThumbnailURL id.ContentURIString
+ ThumbnailFile *EncryptedFileInfo
- Blurhash string `json:"blurhash,omitempty"`
- AnoaBlurhash string `json:"xyz.amorgan.blurhash,omitempty"`
+ Blurhash string
+ AnoaBlurhash string
- Width int `json:"-"`
- Height int `json:"-"`
- Duration int `json:"-"`
- Size int `json:"-"`
+ MauGIF bool
+ IsAnimated bool
+
+ Width int
+ Height int
+ Duration int
+ Size int
}
type serializableFileInfo struct {
@@ -274,6 +327,9 @@ type serializableFileInfo struct {
Blurhash string `json:"blurhash,omitempty"`
AnoaBlurhash string `json:"xyz.amorgan.blurhash,omitempty"`
+ MauGIF bool `json:"fi.mau.gif,omitempty"`
+ IsAnimated bool `json:"is_animated,omitempty"`
+
Width json.Number `json:"w,omitempty"`
Height json.Number `json:"h,omitempty"`
Duration json.Number `json:"duration,omitempty"`
@@ -290,6 +346,9 @@ func (sfi *serializableFileInfo) CopyFrom(fileInfo *FileInfo) *serializableFileI
ThumbnailInfo: (&serializableFileInfo{}).CopyFrom(fileInfo.ThumbnailInfo),
ThumbnailFile: fileInfo.ThumbnailFile,
+ MauGIF: fileInfo.MauGIF,
+ IsAnimated: fileInfo.IsAnimated,
+
Blurhash: fileInfo.Blurhash,
AnoaBlurhash: fileInfo.AnoaBlurhash,
}
@@ -318,6 +377,8 @@ func (sfi *serializableFileInfo) CopyTo(fileInfo *FileInfo) {
MimeType: sfi.MimeType,
ThumbnailURL: sfi.ThumbnailURL,
ThumbnailFile: sfi.ThumbnailFile,
+ MauGIF: sfi.MauGIF,
+ IsAnimated: sfi.IsAnimated,
Blurhash: sfi.Blurhash,
AnoaBlurhash: sfi.AnoaBlurhash,
}
diff --git a/event/message_test.go b/event/message_test.go
index 562a6622..c721df35 100644
--- a/event/message_test.go
+++ b/event/message_test.go
@@ -33,7 +33,7 @@ const invalidMessageEvent = `{
func TestMessageEventContent__ParseInvalid(t *testing.T) {
var evt *event.Event
err := json.Unmarshal([]byte(invalidMessageEvent), &evt)
- assert.Nil(t, err)
+ assert.NoError(t, err)
assert.Equal(t, id.UserID("@tulir:maunium.net"), evt.Sender)
assert.Equal(t, event.EventMessage, evt.Type)
@@ -42,7 +42,7 @@ func TestMessageEventContent__ParseInvalid(t *testing.T) {
assert.Equal(t, id.RoomID("!bar"), evt.RoomID)
err = evt.Content.ParseRaw(evt.Type)
- assert.NotNil(t, err)
+ assert.Error(t, err)
}
const messageEvent = `{
@@ -68,7 +68,7 @@ const messageEvent = `{
func TestMessageEventContent__ParseEdit(t *testing.T) {
var evt *event.Event
err := json.Unmarshal([]byte(messageEvent), &evt)
- assert.Nil(t, err)
+ assert.NoError(t, err)
assert.Equal(t, id.UserID("@tulir:maunium.net"), evt.Sender)
assert.Equal(t, event.EventMessage, evt.Type)
@@ -110,7 +110,7 @@ const imageMessageEvent = `{
func TestMessageEventContent__ParseMedia(t *testing.T) {
var evt *event.Event
err := json.Unmarshal([]byte(imageMessageEvent), &evt)
- assert.Nil(t, err)
+ assert.NoError(t, err)
assert.Equal(t, id.UserID("@tulir:maunium.net"), evt.Sender)
assert.Equal(t, event.EventMessage, evt.Type)
@@ -125,7 +125,7 @@ func TestMessageEventContent__ParseMedia(t *testing.T) {
content := evt.Content.Parsed.(*event.MessageEventContent)
assert.Equal(t, event.MsgImage, content.MsgType)
parsedURL, err := content.URL.Parse()
- assert.Nil(t, err)
+ assert.NoError(t, err)
assert.Equal(t, id.ContentURI{Homeserver: "example.com", FileID: "image"}, parsedURL)
assert.Nil(t, content.NewContent)
assert.Equal(t, "image/png", content.GetInfo().MimeType)
@@ -145,7 +145,7 @@ const expectedMarshalResult = `{"msgtype":"m.text","body":"test"}`
func TestMessageEventContent__Marshal(t *testing.T) {
data, err := json.Marshal(parsedMessage)
- assert.Nil(t, err)
+ assert.NoError(t, err)
assert.Equal(t, expectedMarshalResult, string(data))
}
@@ -163,6 +163,6 @@ const expectedCustomMarshalResult = `{"body":"test","msgtype":"m.text","net.maun
func TestMessageEventContent__Marshal_Custom(t *testing.T) {
data, err := json.Marshal(customParsedMessage)
- assert.Nil(t, err)
+ assert.NoError(t, err)
assert.Equal(t, expectedCustomMarshalResult, string(data))
}
diff --git a/event/poll.go b/event/poll.go
index 37333015..9082f65e 100644
--- a/event/poll.go
+++ b/event/poll.go
@@ -29,16 +29,13 @@ func (content *PollResponseEventContent) SetRelatesTo(rel *RelatesTo) {
}
type MSC1767Message struct {
- Text string `json:"org.matrix.msc1767.text,omitempty"`
- HTML string `json:"org.matrix.msc1767.html,omitempty"`
- Message []struct {
- MimeType string `json:"mimetype"`
- Body string `json:"body"`
- } `json:"org.matrix.msc1767.message,omitempty"`
+ Text string `json:"org.matrix.msc1767.text,omitempty"`
+ HTML string `json:"org.matrix.msc1767.html,omitempty"`
+ Message []ExtensibleText `json:"org.matrix.msc1767.message,omitempty"`
}
type PollStartEventContent struct {
- RelatesTo *RelatesTo `json:"m.relates_to"`
+ RelatesTo *RelatesTo `json:"m.relates_to,omitempty"`
Mentions *Mentions `json:"m.mentions,omitempty"`
PollStart struct {
Kind string `json:"kind"`
diff --git a/event/powerlevels.go b/event/powerlevels.go
index 2f4d4573..668eb6d3 100644
--- a/event/powerlevels.go
+++ b/event/powerlevels.go
@@ -7,6 +7,8 @@
package event
import (
+ "math"
+ "slices"
"sync"
"go.mau.fi/util/ptr"
@@ -26,6 +28,9 @@ type PowerLevelsEventContent struct {
Events map[string]int `json:"events,omitempty"`
EventsDefault int `json:"events_default,omitempty"`
+ beeperEphemeralLock sync.RWMutex
+ BeeperEphemeral map[string]int `json:"com.beeper.ephemeral,omitempty"`
+
Notifications *NotificationPowerLevels `json:"notifications,omitempty"`
StateDefaultPtr *int `json:"state_default,omitempty"`
@@ -34,6 +39,12 @@ type PowerLevelsEventContent struct {
KickPtr *int `json:"kick,omitempty"`
BanPtr *int `json:"ban,omitempty"`
RedactPtr *int `json:"redact,omitempty"`
+
+ BeeperEphemeralDefaultPtr *int `json:"com.beeper.ephemeral_default,omitempty"`
+
+ // This is not a part of power levels, it's added by mautrix-go internally in certain places
+ // in order to detect creator power accurately.
+ CreateEvent *Event `json:"-"`
}
func (pl *PowerLevelsEventContent) Clone() *PowerLevelsEventContent {
@@ -45,6 +56,7 @@ func (pl *PowerLevelsEventContent) Clone() *PowerLevelsEventContent {
UsersDefault: pl.UsersDefault,
Events: maps.Clone(pl.Events),
EventsDefault: pl.EventsDefault,
+ BeeperEphemeral: maps.Clone(pl.BeeperEphemeral),
StateDefaultPtr: ptr.Clone(pl.StateDefaultPtr),
Notifications: pl.Notifications.Clone(),
@@ -53,6 +65,10 @@ func (pl *PowerLevelsEventContent) Clone() *PowerLevelsEventContent {
KickPtr: ptr.Clone(pl.KickPtr),
BanPtr: ptr.Clone(pl.BanPtr),
RedactPtr: ptr.Clone(pl.RedactPtr),
+
+ BeeperEphemeralDefaultPtr: ptr.Clone(pl.BeeperEphemeralDefaultPtr),
+
+ CreateEvent: pl.CreateEvent,
}
}
@@ -111,7 +127,17 @@ func (pl *PowerLevelsEventContent) StateDefault() int {
return 50
}
+func (pl *PowerLevelsEventContent) BeeperEphemeralDefault() int {
+ if pl.BeeperEphemeralDefaultPtr != nil {
+ return *pl.BeeperEphemeralDefaultPtr
+ }
+ return pl.EventsDefault
+}
+
func (pl *PowerLevelsEventContent) GetUserLevel(userID id.UserID) int {
+ if pl.isCreator(userID) {
+ return math.MaxInt
+ }
pl.usersLock.RLock()
defer pl.usersLock.RUnlock()
level, ok := pl.Users[userID]
@@ -121,9 +147,19 @@ func (pl *PowerLevelsEventContent) GetUserLevel(userID id.UserID) int {
return level
}
+const maxPL = 1<<53 - 1
+
func (pl *PowerLevelsEventContent) SetUserLevel(userID id.UserID, level int) {
pl.usersLock.Lock()
defer pl.usersLock.Unlock()
+ if pl.isCreator(userID) {
+ return
+ }
+ if level == math.MaxInt && maxPL < math.MaxInt {
+ // Hack to avoid breaking on 32-bit systems (they're only slightly supported)
+ x := int64(maxPL)
+ level = int(x)
+ }
if level == pl.UsersDefault {
delete(pl.Users, userID)
} else {
@@ -138,9 +174,24 @@ func (pl *PowerLevelsEventContent) EnsureUserLevel(target id.UserID, level int)
return pl.EnsureUserLevelAs("", target, level)
}
+func (pl *PowerLevelsEventContent) createContent() *CreateEventContent {
+ if pl.CreateEvent == nil {
+ return &CreateEventContent{}
+ }
+ return pl.CreateEvent.Content.AsCreate()
+}
+
+func (pl *PowerLevelsEventContent) isCreator(userID id.UserID) bool {
+ cc := pl.createContent()
+ return cc.SupportsCreatorPower() && (userID == pl.CreateEvent.Sender || slices.Contains(cc.AdditionalCreators, userID))
+}
+
func (pl *PowerLevelsEventContent) EnsureUserLevelAs(actor, target id.UserID, level int) bool {
+ if pl.isCreator(target) {
+ return false
+ }
existingLevel := pl.GetUserLevel(target)
- if actor != "" {
+ if actor != "" && !pl.isCreator(actor) {
actorLevel := pl.GetUserLevel(actor)
if actorLevel <= existingLevel || actorLevel < level {
return false
@@ -166,6 +217,29 @@ func (pl *PowerLevelsEventContent) GetEventLevel(eventType Type) int {
return level
}
+func (pl *PowerLevelsEventContent) GetBeeperEphemeralLevel(eventType Type) int {
+ pl.beeperEphemeralLock.RLock()
+ defer pl.beeperEphemeralLock.RUnlock()
+ level, ok := pl.BeeperEphemeral[eventType.String()]
+ if !ok {
+ return pl.BeeperEphemeralDefault()
+ }
+ return level
+}
+
+func (pl *PowerLevelsEventContent) SetBeeperEphemeralLevel(eventType Type, level int) {
+ pl.beeperEphemeralLock.Lock()
+ defer pl.beeperEphemeralLock.Unlock()
+ if level == pl.BeeperEphemeralDefault() {
+ delete(pl.BeeperEphemeral, eventType.String())
+ } else {
+ if pl.BeeperEphemeral == nil {
+ pl.BeeperEphemeral = make(map[string]int)
+ }
+ pl.BeeperEphemeral[eventType.String()] = level
+ }
+}
+
func (pl *PowerLevelsEventContent) SetEventLevel(eventType Type, level int) {
pl.eventsLock.Lock()
defer pl.eventsLock.Unlock()
@@ -185,7 +259,7 @@ func (pl *PowerLevelsEventContent) EnsureEventLevel(eventType Type, level int) b
func (pl *PowerLevelsEventContent) EnsureEventLevelAs(actor id.UserID, eventType Type, level int) bool {
existingLevel := pl.GetEventLevel(eventType)
- if actor != "" {
+ if actor != "" && !pl.isCreator(actor) {
actorLevel := pl.GetUserLevel(actor)
if existingLevel > actorLevel || level > actorLevel {
return false
diff --git a/event/powerlevels_ephemeral_test.go b/event/powerlevels_ephemeral_test.go
new file mode 100644
index 00000000..f5861583
--- /dev/null
+++ b/event/powerlevels_ephemeral_test.go
@@ -0,0 +1,67 @@
+// Copyright (c) 2026 Tulir Asokan
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package event_test
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
+
+ "maunium.net/go/mautrix/event"
+)
+
+func TestPowerLevelsEventContent_BeeperEphemeralDefaultFallsBackToEventsDefault(t *testing.T) {
+ pl := &event.PowerLevelsEventContent{
+ EventsDefault: 45,
+ }
+
+ assert.Equal(t, 45, pl.BeeperEphemeralDefault())
+
+ override := 60
+ pl.BeeperEphemeralDefaultPtr = &override
+ assert.Equal(t, 60, pl.BeeperEphemeralDefault())
+}
+
+func TestPowerLevelsEventContent_GetSetBeeperEphemeralLevel(t *testing.T) {
+ pl := &event.PowerLevelsEventContent{
+ EventsDefault: 25,
+ }
+ evtType := event.Type{Type: "com.example.ephemeral", Class: event.EphemeralEventType}
+
+ assert.Equal(t, 25, pl.GetBeeperEphemeralLevel(evtType))
+
+ pl.SetBeeperEphemeralLevel(evtType, 50)
+ assert.Equal(t, 50, pl.GetBeeperEphemeralLevel(evtType))
+ require.NotNil(t, pl.BeeperEphemeral)
+ assert.Equal(t, 50, pl.BeeperEphemeral[evtType.String()])
+
+ pl.SetBeeperEphemeralLevel(evtType, 25)
+ _, exists := pl.BeeperEphemeral[evtType.String()]
+ assert.False(t, exists)
+}
+
+func TestPowerLevelsEventContent_CloneCopiesBeeperEphemeralFields(t *testing.T) {
+ override := 70
+ pl := &event.PowerLevelsEventContent{
+ EventsDefault: 35,
+ BeeperEphemeral: map[string]int{"com.example.ephemeral": 90},
+ BeeperEphemeralDefaultPtr: &override,
+ }
+
+ cloned := pl.Clone()
+ require.NotNil(t, cloned)
+ require.NotNil(t, cloned.BeeperEphemeralDefaultPtr)
+ assert.Equal(t, 70, *cloned.BeeperEphemeralDefaultPtr)
+ assert.Equal(t, 90, cloned.BeeperEphemeral["com.example.ephemeral"])
+
+ cloned.BeeperEphemeral["com.example.ephemeral"] = 99
+ *cloned.BeeperEphemeralDefaultPtr = 71
+
+ assert.Equal(t, 90, pl.BeeperEphemeral["com.example.ephemeral"])
+ assert.Equal(t, 70, *pl.BeeperEphemeralDefaultPtr)
+}
diff --git a/event/relations.go b/event/relations.go
index ea40cc06..2316cbc7 100644
--- a/event/relations.go
+++ b/event/relations.go
@@ -15,10 +15,11 @@ import (
type RelationType string
const (
- RelReplace RelationType = "m.replace"
- RelReference RelationType = "m.reference"
- RelAnnotation RelationType = "m.annotation"
- RelThread RelationType = "m.thread"
+ RelReplace RelationType = "m.replace"
+ RelReference RelationType = "m.reference"
+ RelAnnotation RelationType = "m.annotation"
+ RelThread RelationType = "m.thread"
+ RelBeeperTranscription RelationType = "com.beeper.transcription"
)
type RelatesTo struct {
@@ -33,7 +34,7 @@ type RelatesTo struct {
type InReplyTo struct {
EventID id.EventID `json:"event_id,omitempty"`
- UnstableRoomID id.RoomID `json:"room_id,omitempty"`
+ UnstableRoomID id.RoomID `json:"com.beeper.cross_room_id,omitempty"`
}
func (rel *RelatesTo) Copy() *RelatesTo {
@@ -100,6 +101,10 @@ func (rel *RelatesTo) SetReplace(mxid id.EventID) *RelatesTo {
}
func (rel *RelatesTo) SetReplyTo(mxid id.EventID) *RelatesTo {
+ if rel.Type != RelThread {
+ rel.Type = ""
+ rel.EventID = ""
+ }
rel.InReplyTo = &InReplyTo{EventID: mxid}
rel.IsFallingBack = false
return rel
diff --git a/event/reply.go b/event/reply.go
index 73f8cfc7..5f55bb80 100644
--- a/event/reply.go
+++ b/event/reply.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2020 Tulir Asokan
+// Copyright (c) 2024 Tulir Asokan
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -7,7 +7,6 @@
package event
import (
- "fmt"
"regexp"
"strings"
@@ -33,12 +32,13 @@ func TrimReplyFallbackText(text string) string {
}
func (content *MessageEventContent) RemoveReplyFallback() {
- if len(content.RelatesTo.GetReplyTo()) > 0 && !content.replyFallbackRemoved {
- if content.Format == FormatHTML {
- content.FormattedBody = TrimReplyFallbackHTML(content.FormattedBody)
+ if len(content.RelatesTo.GetReplyTo()) > 0 && !content.replyFallbackRemoved && content.Format == FormatHTML {
+ origHTML := content.FormattedBody
+ content.FormattedBody = TrimReplyFallbackHTML(content.FormattedBody)
+ if content.FormattedBody != origHTML {
+ content.Body = TrimReplyFallbackText(content.Body)
+ content.replyFallbackRemoved = true
}
- content.Body = TrimReplyFallbackText(content.Body)
- content.replyFallbackRemoved = true
}
}
@@ -47,52 +47,28 @@ func (content *MessageEventContent) GetReplyTo() id.EventID {
return content.RelatesTo.GetReplyTo()
}
-const ReplyFormat = `In reply to %s
%s
"
@@ -39,6 +42,55 @@ func UnwrapSingleParagraph(html string) string {
return html
}
+var mdEscapeRegex = regexp.MustCompile("([\\\\`*_[\\]()])")
+
+func EscapeMarkdown(text string) string {
+ text = mdEscapeRegex.ReplaceAllString(text, "\\$1")
+ text = strings.ReplaceAll(text, ">", ">")
+ text = strings.ReplaceAll(text, "<", "<")
+ return text
+}
+
+type uriAble interface {
+ String() string
+ URI() *id.MatrixURI
+}
+
+func MarkdownMention(id uriAble) string {
+ return MarkdownMentionWithName(id.String(), id)
+}
+
+func MarkdownMentionWithName(name string, id uriAble) string {
+ return MarkdownLink(name, id.URI().MatrixToURL())
+}
+
+func MarkdownMentionRoomID(name string, id id.RoomID, via ...string) string {
+ if name == "" {
+ name = id.String()
+ }
+ return MarkdownLink(name, id.URI(via...).MatrixToURL())
+}
+
+func MarkdownLink(name string, url string) string {
+ return fmt.Sprintf("[%s](%s)", EscapeMarkdown(name), EscapeMarkdown(url))
+}
+
+func SafeMarkdownCode[T ~string](textInput T) string {
+ if textInput == "" {
+ return "` `"
+ }
+ text := strings.ReplaceAll(string(textInput), "\n", " ")
+ backtickCount := exstrings.LongestSequenceOf(text, '`')
+ if backtickCount == 0 {
+ return fmt.Sprintf("`%s`", text)
+ }
+ quotes := strings.Repeat("`", backtickCount+1)
+ if text[0] == '`' || text[len(text)-1] == '`' {
+ return fmt.Sprintf("%s %s %s", quotes, text, quotes)
+ }
+ return fmt.Sprintf("%s%s%s", quotes, text, quotes)
+}
+
func RenderMarkdownCustom(text string, renderer goldmark.Markdown) event.MessageEventContent {
var buf strings.Builder
err := renderer.Convert([]byte(text), &buf)
@@ -49,8 +101,16 @@ func RenderMarkdownCustom(text string, renderer goldmark.Markdown) event.Message
return HTMLToContent(htmlBody)
}
-func HTMLToContent(html string) event.MessageEventContent {
- text, mentions := HTMLToMarkdownAndMentions(html)
+func TextToContent(text string) event.MessageEventContent {
+ return event.MessageEventContent{
+ MsgType: event.MsgText,
+ Body: text,
+ Mentions: &event.Mentions{},
+ }
+}
+
+func HTMLToContentFull(renderer *HTMLParser, html string) event.MessageEventContent {
+ text, mentions := HTMLToMarkdownFull(renderer, html)
if html != text {
return event.MessageEventContent{
FormattedBody: html,
@@ -60,11 +120,11 @@ func HTMLToContent(html string) event.MessageEventContent {
Mentions: mentions,
}
}
- return event.MessageEventContent{
- MsgType: event.MsgText,
- Body: text,
- Mentions: &event.Mentions{},
- }
+ return TextToContent(text)
+}
+
+func HTMLToContent(html string) event.MessageEventContent {
+ return HTMLToContentFull(nil, html)
}
func RenderMarkdown(text string, allowMarkdown, allowHTML bool) event.MessageEventContent {
@@ -80,10 +140,6 @@ func RenderMarkdown(text string, allowMarkdown, allowHTML bool) event.MessageEve
htmlBody = strings.Replace(text, "\n", "
", -1)
return HTMLToContent(htmlBody)
} else {
- return event.MessageEventContent{
- MsgType: event.MsgText,
- Body: text,
- Mentions: &event.Mentions{},
- }
+ return TextToContent(text)
}
}
diff --git a/format/markdown_test.go b/format/markdown_test.go
index 10ae270c..46ea4886 100644
--- a/format/markdown_test.go
+++ b/format/markdown_test.go
@@ -158,3 +158,56 @@ func TestRenderMarkdown_DiscordUnderline(t *testing.T) {
assert.Equal(t, html, strings.ReplaceAll(rendered, "\n", ""))
}
}
+
+var mathTests = map[string]string{
+ "$foo$": `foo`,
+ "hello $foo$ world": `hello foo world`,
+ "$$\nfoo\nbar\n$$": `
foo
bar`,
+ "`$foo$`": `$foo$`,
+ "```\n$foo$\n```": `$foo$\n
`,
+ "~~meow $foo$ asd~~": `meow foo asd`,
+ "$5 or $10": `$5 or $10`,
+ "5$ or 10$": `5$ or 10$`,
+ "$5 or 10$": `5 or 10`,
+ "$*500*$": `*500*`,
+ "$$\n*500*\n$$": `*500*`,
+
+ // TODO: This doesn't work :(
+ // Maybe same reason as the spoiler wrapping not working?
+ //"~~$foo$~~": `foo
`,
+}
+
+func TestRenderMarkdown_CustomEmoji(t *testing.T) {
+ renderer := goldmark.New(goldmark.WithExtensions(mdext.CustomEmoji), format.HTMLOptions)
+ for markdown, html := range customEmojiTests {
+ rendered := format.UnwrapSingleParagraph(render(renderer, markdown))
+ assert.Equal(t, html, rendered, "with input %q", markdown)
+ }
+}
+
+var codeTests = map[string]string{
+ "meow": "`meow`",
+ "me`ow": "``me`ow``",
+ "`me`ow": "`` `me`ow ``",
+ "me`ow`": "`` me`ow` ``",
+ "`meow`": "`` `meow` ``",
+ "`````````": "`````````` ````````` ``````````",
+}
+
+func TestSafeMarkdownCode(t *testing.T) {
+ for input, expected := range codeTests {
+ assert.Equal(t, expected, format.SafeMarkdownCode(input), "with input %q", input)
+ }
+}
diff --git a/format/mdext/customemoji.go b/format/mdext/customemoji.go
new file mode 100644
index 00000000..2884a5ea
--- /dev/null
+++ b/format/mdext/customemoji.go
@@ -0,0 +1,73 @@
+// Copyright (c) 2024 Tulir Asokan
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package mdext
+
+import (
+ "bytes"
+
+ "github.com/yuin/goldmark"
+ "github.com/yuin/goldmark/ast"
+ "github.com/yuin/goldmark/renderer"
+ "github.com/yuin/goldmark/util"
+)
+
+type extCustomEmoji struct{}
+type customEmojiRenderer struct {
+ funcs functionCapturer
+}
+
+// CustomEmoji is an extension that converts certain markdown images into Matrix custom emojis.
+var CustomEmoji = &extCustomEmoji{}
+
+type functionCapturer struct {
+ renderImage renderer.NodeRendererFunc
+ renderText renderer.NodeRendererFunc
+ renderString renderer.NodeRendererFunc
+}
+
+func (fc *functionCapturer) Register(kind ast.NodeKind, rendererFunc renderer.NodeRendererFunc) {
+ switch kind {
+ case ast.KindImage:
+ fc.renderImage = rendererFunc
+ case ast.KindText:
+ fc.renderText = rendererFunc
+ case ast.KindString:
+ fc.renderString = rendererFunc
+ }
+}
+
+var (
+ _ renderer.NodeRendererFuncRegisterer = (*functionCapturer)(nil)
+ _ renderer.Option = (*functionCapturer)(nil)
+)
+
+func (fc *functionCapturer) SetConfig(cfg *renderer.Config) {
+ cfg.NodeRenderers[0].Value.(renderer.NodeRenderer).RegisterFuncs(fc)
+}
+
+func (eeh *extCustomEmoji) Extend(m goldmark.Markdown) {
+ var fc functionCapturer
+ m.Renderer().AddOptions(&fc)
+ m.Renderer().AddOptions(renderer.WithNodeRenderers(util.Prioritized(&customEmojiRenderer{fc}, 0)))
+}
+
+func (cer *customEmojiRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer) {
+ reg.Register(ast.KindImage, cer.renderImage)
+}
+
+var emojiPrefix = []byte("Emoji: ")
+var mxcPrefix = []byte("mxc://")
+
+func (cer *customEmojiRenderer) renderImage(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) {
+ n, ok := node.(*ast.Image)
+ if ok && entering && bytes.HasPrefix(n.Title, emojiPrefix) && bytes.HasPrefix(n.Destination, mxcPrefix) {
+ n.Title = bytes.TrimPrefix(n.Title, emojiPrefix)
+ n.SetAttributeString("data-mx-emoticon", nil)
+ n.SetAttributeString("height", "32")
+ }
+ return cer.funcs.renderImage(w, source, node, entering)
+}
diff --git a/format/mdext/math.go b/format/mdext/math.go
new file mode 100644
index 00000000..e6a6ecc5
--- /dev/null
+++ b/format/mdext/math.go
@@ -0,0 +1,240 @@
+// Copyright (c) 2024 Tulir Asokan
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package mdext
+
+import (
+ "bytes"
+ "fmt"
+ stdhtml "html"
+ "regexp"
+ "strings"
+ "unicode"
+
+ "github.com/yuin/goldmark"
+ "github.com/yuin/goldmark/ast"
+ "github.com/yuin/goldmark/parser"
+ "github.com/yuin/goldmark/renderer"
+ "github.com/yuin/goldmark/renderer/html"
+ "github.com/yuin/goldmark/text"
+ "github.com/yuin/goldmark/util"
+)
+
+var astKindMath = ast.NewNodeKind("Math")
+
+type astMath struct {
+ ast.BaseInline
+ value []byte
+}
+
+func (n *astMath) Dump(source []byte, level int) {
+ ast.DumpHelper(n, source, level, nil, nil)
+}
+
+func (n *astMath) Kind() ast.NodeKind {
+ return astKindMath
+}
+
+type astMathBlock struct {
+ ast.BaseBlock
+}
+
+func (n *astMathBlock) Dump(source []byte, level int) {
+ ast.DumpHelper(n, source, level, nil, nil)
+}
+
+func (n *astMathBlock) Kind() ast.NodeKind {
+ return astKindMath
+}
+
+type inlineMathParser struct{}
+
+var defaultInlineMathParser = &inlineMathParser{}
+
+func NewInlineMathParser() parser.InlineParser {
+ return defaultInlineMathParser
+}
+
+const mathDelimiter = '$'
+
+func (s *inlineMathParser) Trigger() []byte {
+ return []byte{mathDelimiter}
+}
+
+// This ignores lines where there's no space after the closing $ to avoid false positives
+var latexInlineRegexp = regexp.MustCompile(`^(\$[^$]*\$)(?:$|\s)`)
+
+func (s *inlineMathParser) Parse(parent ast.Node, block text.Reader, pc parser.Context) ast.Node {
+ before := block.PrecendingCharacter()
+ // Ignore lines where the opening $ comes after a letter or number to avoid false positives
+ if unicode.IsLetter(before) || unicode.IsNumber(before) {
+ return nil
+ }
+ line, segment := block.PeekLine()
+ idx := latexInlineRegexp.FindSubmatchIndex(line)
+ if idx == nil {
+ return nil
+ }
+ block.Advance(idx[3])
+ return &astMath{
+ value: block.Value(text.NewSegment(segment.Start+1, segment.Start+idx[3]-1)),
+ }
+}
+
+func (s *inlineMathParser) CloseBlock(parent ast.Node, pc parser.Context) {
+ // nothing to do
+}
+
+type blockMathParser struct{}
+
+var defaultBlockMathParser = &blockMathParser{}
+
+func NewBlockMathParser() parser.BlockParser {
+ return defaultBlockMathParser
+}
+
+var mathBlockInfoKey = parser.NewContextKey()
+
+type mathBlockData struct {
+ indent int
+ length int
+ node ast.Node
+}
+
+func (b *blockMathParser) Trigger() []byte {
+ return []byte{'$'}
+}
+
+func (b *blockMathParser) Open(parent ast.Node, reader text.Reader, pc parser.Context) (ast.Node, parser.State) {
+ line, _ := reader.PeekLine()
+ pos := pc.BlockOffset()
+ if pos < 0 || (line[pos] != mathDelimiter) {
+ return nil, parser.NoChildren
+ }
+ findent := pos
+ i := pos
+ for ; i < len(line) && line[i] == mathDelimiter; i++ {
+ }
+ oFenceLength := i - pos
+ if oFenceLength < 2 {
+ return nil, parser.NoChildren
+ }
+ if i < len(line)-1 {
+ rest := line[i:]
+ left := util.TrimLeftSpaceLength(rest)
+ right := util.TrimRightSpaceLength(rest)
+ if left < len(rest)-right {
+ value := rest[left : len(rest)-right]
+ if bytes.IndexByte(value, mathDelimiter) > -1 {
+ return nil, parser.NoChildren
+ }
+ }
+ }
+ node := &astMathBlock{}
+ pc.Set(mathBlockInfoKey, &mathBlockData{findent, oFenceLength, node})
+ return node, parser.NoChildren
+
+}
+
+func (b *blockMathParser) Continue(node ast.Node, reader text.Reader, pc parser.Context) parser.State {
+ line, segment := reader.PeekLine()
+ fdata := pc.Get(mathBlockInfoKey).(*mathBlockData)
+
+ w, pos := util.IndentWidth(line, reader.LineOffset())
+ if w < 4 {
+ i := pos
+ for ; i < len(line) && line[i] == mathDelimiter; i++ {
+ }
+ length := i - pos
+ if length >= fdata.length && util.IsBlank(line[i:]) {
+ newline := 1
+ if line[len(line)-1] != '\n' {
+ newline = 0
+ }
+ reader.Advance(segment.Stop - segment.Start - newline + segment.Padding)
+ return parser.Close
+ }
+ }
+ pos, padding := util.IndentPositionPadding(line, reader.LineOffset(), segment.Padding, fdata.indent)
+ if pos < 0 {
+ pos = util.FirstNonSpacePosition(line)
+ if pos < 0 {
+ pos = 0
+ }
+ padding = 0
+ }
+ seg := text.NewSegmentPadding(segment.Start+pos, segment.Stop, padding)
+ seg.ForceNewline = true // EOF as newline
+ node.Lines().Append(seg)
+ reader.AdvanceAndSetPadding(segment.Stop-segment.Start-pos-1, padding)
+ return parser.Continue | parser.NoChildren
+}
+
+func (b *blockMathParser) Close(node ast.Node, reader text.Reader, pc parser.Context) {
+ fdata := pc.Get(mathBlockInfoKey).(*mathBlockData)
+ if fdata.node == node {
+ pc.Set(mathBlockInfoKey, nil)
+ }
+}
+
+func (b *blockMathParser) CanInterruptParagraph() bool {
+ return true
+}
+
+func (b *blockMathParser) CanAcceptIndentedLine() bool {
+ return false
+}
+
+type mathHTMLRenderer struct {
+ html.Config
+}
+
+func NewMathHTMLRenderer(opts ...html.Option) renderer.NodeRenderer {
+ r := &mathHTMLRenderer{
+ Config: html.NewConfig(),
+ }
+ for _, opt := range opts {
+ opt.SetHTMLOption(&r.Config)
+ }
+ return r
+}
+
+func (r *mathHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer) {
+ reg.Register(astKindMath, r.renderMath)
+}
+
+func (r *mathHTMLRenderer) renderMath(w util.BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) {
+ if entering {
+ tag := "span"
+ var tex string
+ switch typed := n.(type) {
+ case *astMathBlock:
+ tag = "div"
+ tex = string(n.Lines().Value(source))
+ case *astMath:
+ tex = string(typed.value)
+ }
+ tex = stdhtml.EscapeString(strings.TrimSpace(tex))
+ _, _ = fmt.Fprintf(w, `<%s data-mx-maths="%s">%s`, tag, tex, strings.ReplaceAll(tex, "\n", "
"), tag)
+ }
+ return ast.WalkSkipChildren, nil
+}
+
+type math struct{}
+
+// Math is an extension that allow you to use math like '$$text$$'.
+var Math = &math{}
+
+func (e *math) Extend(m goldmark.Markdown) {
+ m.Parser().AddOptions(parser.WithInlineParsers(
+ util.Prioritized(NewInlineMathParser(), 500),
+ ), parser.WithBlockParsers(
+ util.Prioritized(NewBlockMathParser(), 850),
+ ))
+ m.Renderer().AddOptions(renderer.WithNodeRenderers(
+ util.Prioritized(NewMathHTMLRenderer(), 500),
+ ))
+}
diff --git a/format/mdext/rainbow/goldmark.go b/format/mdext/rainbow/goldmark.go
deleted file mode 100644
index 59a36178..00000000
--- a/format/mdext/rainbow/goldmark.go
+++ /dev/null
@@ -1,120 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package rainbow
-
-import (
- "fmt"
- "unicode"
-
- "github.com/rivo/uniseg"
- "github.com/yuin/goldmark"
- "github.com/yuin/goldmark/ast"
- "github.com/yuin/goldmark/renderer"
- "github.com/yuin/goldmark/renderer/html"
- "github.com/yuin/goldmark/util"
- "go.mau.fi/util/random"
-)
-
-// Extension is a goldmark extension that adds rainbow text coloring to the HTML renderer.
-var Extension = &extRainbow{}
-
-type extRainbow struct{}
-type rainbowRenderer struct {
- HardWraps bool
- ColorID string
-}
-
-var defaultRB = &rainbowRenderer{HardWraps: true, ColorID: random.String(16)}
-
-func (er *extRainbow) Extend(m goldmark.Markdown) {
- m.Renderer().AddOptions(renderer.WithNodeRenderers(util.Prioritized(defaultRB, 0)))
-}
-
-func (rb *rainbowRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer) {
- reg.Register(ast.KindText, rb.renderText)
- reg.Register(ast.KindString, rb.renderString)
-}
-
-type rainbowBufWriter struct {
- util.BufWriter
- ColorID string
-}
-
-func (rbw rainbowBufWriter) WriteString(s string) (int, error) {
- i := 0
- graphemes := uniseg.NewGraphemes(s)
- for graphemes.Next() {
- runes := graphemes.Runes()
- if len(runes) == 1 && unicode.IsSpace(runes[0]) {
- i2, err := rbw.BufWriter.WriteRune(runes[0])
- i += i2
- if err != nil {
- return i, err
- }
- continue
- }
- i2, err := fmt.Fprintf(rbw.BufWriter, "%s", rbw.ColorID, graphemes.Str())
- i += i2
- if err != nil {
- return i, err
- }
- }
- return i, nil
-}
-
-func (rbw rainbowBufWriter) Write(data []byte) (int, error) {
- return rbw.WriteString(string(data))
-}
-
-func (rbw rainbowBufWriter) WriteByte(c byte) error {
- _, err := rbw.WriteRune(rune(c))
- return err
-}
-
-func (rbw rainbowBufWriter) WriteRune(r rune) (int, error) {
- if unicode.IsSpace(r) {
- return rbw.BufWriter.WriteRune(r)
- } else {
- return fmt.Fprintf(rbw.BufWriter, "%c", rbw.ColorID, r)
- }
-}
-
-func (rb *rainbowRenderer) renderText(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) {
- if !entering {
- return ast.WalkContinue, nil
- }
- n := node.(*ast.Text)
- segment := n.Segment
- if n.IsRaw() {
- html.DefaultWriter.RawWrite(rainbowBufWriter{w, rb.ColorID}, segment.Value(source))
- } else {
- html.DefaultWriter.Write(rainbowBufWriter{w, rb.ColorID}, segment.Value(source))
- if n.HardLineBreak() || (n.SoftLineBreak() && rb.HardWraps) {
- _, _ = w.WriteString("
\n")
- } else if n.SoftLineBreak() {
- _ = w.WriteByte('\n')
- }
- }
- return ast.WalkContinue, nil
-}
-
-func (rb *rainbowRenderer) renderString(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) {
- if !entering {
- return ast.WalkContinue, nil
- }
- n := node.(*ast.String)
- if n.IsCode() {
- _, _ = w.Write(n.Value)
- } else {
- if n.IsRaw() {
- html.DefaultWriter.RawWrite(rainbowBufWriter{w, rb.ColorID}, n.Value)
- } else {
- html.DefaultWriter.Write(rainbowBufWriter{w, rb.ColorID}, n.Value)
- }
- }
- return ast.WalkContinue, nil
-}
diff --git a/format/mdext/rainbow/gradient.go b/format/mdext/rainbow/gradient.go
deleted file mode 100644
index 34c499e6..00000000
--- a/format/mdext/rainbow/gradient.go
+++ /dev/null
@@ -1,56 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package rainbow
-
-import (
- "regexp"
- "strings"
-
- "github.com/lucasb-eyer/go-colorful"
-)
-
-// GradientTable from https://github.com/lucasb-eyer/go-colorful/blob/master/doc/gradientgen/gradientgen.go
-type GradientTable []struct {
- Col colorful.Color
- Pos float64
-}
-
-func (gt GradientTable) GetInterpolatedColorFor(t float64) colorful.Color {
- for i := 0; i < len(gt)-1; i++ {
- c1 := gt[i]
- c2 := gt[i+1]
- if c1.Pos <= t && t <= c2.Pos {
- t := (t - c1.Pos) / (c2.Pos - c1.Pos)
- return c1.Col.BlendHcl(c2.Col, t).Clamped()
- }
- }
- return gt[len(gt)-1].Col
-}
-
-var Gradient = GradientTable{
- {colorful.LinearRgb(1, 0, 0), 0 / 11.0},
- {colorful.LinearRgb(1, 0.5, 0), 1 / 11.0},
- {colorful.LinearRgb(1, 1, 0), 2 / 11.0},
- {colorful.LinearRgb(0.5, 1, 0), 3 / 11.0},
- {colorful.LinearRgb(0, 1, 0), 4 / 11.0},
- {colorful.LinearRgb(0, 1, 0.5), 5 / 11.0},
- {colorful.LinearRgb(0, 1, 1), 6 / 11.0},
- {colorful.LinearRgb(0, 0.5, 1), 7 / 11.0},
- {colorful.LinearRgb(0, 0, 1), 8 / 11.0},
- {colorful.LinearRgb(0.5, 0, 1), 9 / 11.0},
- {colorful.LinearRgb(1, 0, 1), 10 / 11.0},
- {colorful.LinearRgb(1, 0, 0.5), 11 / 11.0},
-}
-
-func ApplyColor(htmlBody string) string {
- count := strings.Count(htmlBody, defaultRB.ColorID)
- i := -1
- return regexp.MustCompile(defaultRB.ColorID).ReplaceAllStringFunc(htmlBody, func(match string) string {
- i++
- return Gradient.GetInterpolatedColorFor(float64(i) / float64(count)).Hex()
- })
-}
diff --git a/go.mod b/go.mod
index f45b8990..49a1d4e4 100644
--- a/go.mod
+++ b/go.mod
@@ -1,45 +1,42 @@
module maunium.net/go/mautrix
-go 1.22.0
+go 1.25.0
-toolchain go1.23.2
+toolchain go1.26.0
require (
- filippo.io/edwards25519 v1.1.0
+ filippo.io/edwards25519 v1.2.0
github.com/chzyer/readline v1.5.1
- github.com/gorilla/mux v1.8.0
- github.com/gorilla/websocket v1.5.0
- github.com/lib/pq v1.10.9
- github.com/lucasb-eyer/go-colorful v1.2.0
- github.com/mattn/go-sqlite3 v1.14.24
- github.com/rivo/uniseg v0.4.7
+ github.com/coder/websocket v1.8.14
+ github.com/lib/pq v1.11.2
+ github.com/mattn/go-sqlite3 v1.14.34
github.com/rs/xid v1.6.0
- github.com/rs/zerolog v1.33.0
+ github.com/rs/zerolog v1.34.0
github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
- github.com/stretchr/testify v1.9.0
+ github.com/stretchr/testify v1.11.1
github.com/tidwall/gjson v1.18.0
github.com/tidwall/sjson v1.2.5
- github.com/yuin/goldmark v1.7.7
- go.mau.fi/util v0.8.1
- go.mau.fi/zeroconfig v0.1.3
- golang.org/x/crypto v0.28.0
- golang.org/x/exp v0.0.0-20241009180824-f66d83c29e7c
- golang.org/x/net v0.30.0
- golang.org/x/sync v0.8.0
+ github.com/yuin/goldmark v1.7.16
+ go.mau.fi/util v0.9.6
+ go.mau.fi/zeroconfig v0.2.0
+ golang.org/x/crypto v0.48.0
+ golang.org/x/exp v0.0.0-20260218203240-3dfff04db8fa
+ golang.org/x/net v0.50.0
+ golang.org/x/sync v0.19.0
gopkg.in/yaml.v3 v3.0.1
maunium.net/go/mauflag v1.0.0
)
require (
- github.com/coreos/go-systemd/v22 v22.5.0 // indirect
+ github.com/coreos/go-systemd/v22 v22.6.0 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
- github.com/mattn/go-colorable v0.1.13 // indirect
- github.com/mattn/go-isatty v0.0.19 // indirect
- github.com/petermattis/goid v0.0.0-20240813172612-4fcff4a6cae7 // indirect
+ github.com/mattn/go-colorable v0.1.14 // indirect
+ github.com/mattn/go-isatty v0.0.20 // indirect
+ github.com/petermattis/goid v0.0.0-20260113132338-7c7de50cc741 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/tidwall/match v1.1.1 // indirect
- github.com/tidwall/pretty v1.2.0 // indirect
- golang.org/x/sys v0.26.0 // indirect
- golang.org/x/text v0.19.0 // indirect
+ github.com/tidwall/pretty v1.2.1 // indirect
+ golang.org/x/sys v0.41.0 // indirect
+ golang.org/x/text v0.34.0 // indirect
gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect
)
diff --git a/go.sum b/go.sum
index e7a58076..871a5156 100644
--- a/go.sum
+++ b/go.sum
@@ -1,5 +1,5 @@
-filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA=
-filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4=
+filippo.io/edwards25519 v1.2.0 h1:crnVqOiS4jqYleHd9vaKZ+HKtHfllngJIiOpNpoJsjo=
+filippo.io/edwards25519 v1.2.0/go.mod h1:xzAOLCNug/yB62zG1bQ8uziwrIqIuxhctzJT18Q77mc=
github.com/DATA-DOG/go-sqlmock v1.5.2 h1:OcvFkGmslmlZibjAjaHm3L//6LiuBgolP7OputlJIzU=
github.com/DATA-DOG/go-sqlmock v1.5.2/go.mod h1:88MAG/4G7SMwSE3CeA0ZKzrT5CiOU3OJ+JlNzwDqpNU=
github.com/chzyer/logex v1.2.1 h1:XHDu3E6q+gdHgsdTPH6ImJMIp436vR6MPtH8gP05QzM=
@@ -8,73 +8,70 @@ github.com/chzyer/readline v1.5.1 h1:upd/6fQk4src78LMRzh5vItIt361/o4uq553V8B5sGI
github.com/chzyer/readline v1.5.1/go.mod h1:Eh+b79XXUwfKfcPLepksvw2tcLE/Ct21YObkaSkeBlk=
github.com/chzyer/test v1.0.0 h1:p3BQDXSxOhOG0P9z6/hGnII4LGiEPOYBhs8asl/fC04=
github.com/chzyer/test v1.0.0/go.mod h1:2JlltgoNkt4TW/z9V/IzDdFaMTM2JPIi26O1pF38GC8=
-github.com/coreos/go-systemd/v22 v22.5.0 h1:RrqgGjYQKalulkV8NGVIfkXQf6YYmOyiJKk8iXXhfZs=
+github.com/coder/websocket v1.8.14 h1:9L0p0iKiNOibykf283eHkKUHHrpG7f65OE3BhhO7v9g=
+github.com/coder/websocket v1.8.14/go.mod h1:NX3SzP+inril6yawo5CQXx8+fk145lPDC6pumgx0mVg=
github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
+github.com/coreos/go-systemd/v22 v22.6.0 h1:aGVa/v8B7hpb0TKl0MWoAavPDmHvobFe5R5zn0bCJWo=
+github.com/coreos/go-systemd/v22 v22.6.0/go.mod h1:iG+pp635Fo7ZmV/j14KUcmEyWF+0X7Lua8rrTWzYgWU=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
-github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
-github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
-github.com/gorilla/websocket v1.5.0 h1:PPwGk2jz7EePpoHN/+ClbZu8SPxiqlu12wZP/3sWmnc=
-github.com/gorilla/websocket v1.5.0/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
-github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw=
-github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
-github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
-github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
-github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
+github.com/lib/pq v1.11.2 h1:x6gxUeu39V0BHZiugWe8LXZYZ+Utk7hSJGThs8sdzfs=
+github.com/lib/pq v1.11.2/go.mod h1:/p+8NSbOcwzAEI7wiMXFlgydTwcgTr3OSKMsD2BitpA=
github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
+github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE=
+github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8=
github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
-github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA=
github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
-github.com/mattn/go-sqlite3 v1.14.24 h1:tpSp2G2KyMnnQu99ngJ47EIkWVmliIizyZBfPrBWDRM=
-github.com/mattn/go-sqlite3 v1.14.24/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y=
-github.com/petermattis/goid v0.0.0-20240813172612-4fcff4a6cae7 h1:Dx7Ovyv/SFnMFw3fD4oEoeorXc6saIiQ23LrGLth0Gw=
-github.com/petermattis/goid v0.0.0-20240813172612-4fcff4a6cae7/go.mod h1:pxMtw7cyUw6B2bRH0ZBANSPg+AoSud1I1iyJHI69jH4=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+github.com/mattn/go-sqlite3 v1.14.34 h1:3NtcvcUnFBPsuRcno8pUtupspG/GM+9nZ88zgJcp6Zk=
+github.com/mattn/go-sqlite3 v1.14.34/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y=
+github.com/petermattis/goid v0.0.0-20260113132338-7c7de50cc741 h1:KPpdlQLZcHfTMQRi6bFQ7ogNO0ltFT4PmtwTLW4W+14=
+github.com/petermattis/goid v0.0.0-20260113132338-7c7de50cc741/go.mod h1:pxMtw7cyUw6B2bRH0ZBANSPg+AoSud1I1iyJHI69jH4=
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
-github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
-github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
github.com/rs/xid v1.6.0 h1:fV591PaemRlL6JfRxGDEPl69wICngIQ3shQtzfy2gxU=
github.com/rs/xid v1.6.0/go.mod h1:7XoLgs4eV+QndskICGsho+ADou8ySMSjJKDIan90Nz0=
-github.com/rs/zerolog v1.33.0 h1:1cU2KZkvPxNyfgEmhHAz/1A9Bz+llsdYzklWFzgp0r8=
-github.com/rs/zerolog v1.33.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
+github.com/rs/zerolog v1.34.0 h1:k43nTLIwcTVQAncfCw4KZ2VY6ukYoZaBPNOE8txlOeY=
+github.com/rs/zerolog v1.34.0/go.mod h1:bJsvje4Z08ROH4Nhs5iH600c3IkWhwp44iRc54W6wYQ=
github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e h1:MRM5ITcdelLK2j1vwZ3Je0FKVCfqOLp5zO6trqMLYs0=
github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e/go.mod h1:XV66xRDqSt+GTGFMVlhk3ULuV0y9ZmzeVGR4mloJI3M=
-github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
-github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
+github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
github.com/tidwall/gjson v1.14.2/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
github.com/tidwall/gjson v1.18.0 h1:FIDeeyB800efLX89e5a8Y0BNH+LOngJyGrIWxG2FKQY=
github.com/tidwall/gjson v1.18.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=
github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=
-github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs=
github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
+github.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4=
+github.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
github.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY=
github.com/tidwall/sjson v1.2.5/go.mod h1:Fvgq9kS/6ociJEDnK0Fk1cpYF4FIW6ZF7LAe+6jwd28=
-github.com/yuin/goldmark v1.7.7 h1:5m9rrB1sW3JUMToKFQfb+FGt1U7r57IHu5GrYrG2nqU=
-github.com/yuin/goldmark v1.7.7/go.mod h1:uzxRWxtg69N339t3louHJ7+O03ezfj6PlliRlaOzY1E=
-go.mau.fi/util v0.8.1 h1:Ga43cz6esQBYqcjZ/onRoVnYWoUwjWbsxVeJg2jOTSo=
-go.mau.fi/util v0.8.1/go.mod h1:T1u/rD2rzidVrBLyaUdPpZiJdP/rsyi+aTzn0D+Q6wc=
-go.mau.fi/zeroconfig v0.1.3 h1:As9wYDKmktjmNZW5i1vn8zvJlmGKHeVxHVIBMXsm4kM=
-go.mau.fi/zeroconfig v0.1.3/go.mod h1:NcSJkf180JT+1IId76PcMuLTNa1CzsFFZ0nBygIQM70=
-golang.org/x/crypto v0.28.0 h1:GBDwsMXVQi34v5CCYUm2jkJvu4cbtru2U4TN2PSyQnw=
-golang.org/x/crypto v0.28.0/go.mod h1:rmgy+3RHxRZMyY0jjAJShp2zgEdOqj2AO7U0pYmeQ7U=
-golang.org/x/exp v0.0.0-20241009180824-f66d83c29e7c h1:7dEasQXItcW1xKJ2+gg5VOiBnqWrJc+rq0DPKyvvdbY=
-golang.org/x/exp v0.0.0-20241009180824-f66d83c29e7c/go.mod h1:NQtJDoLvd6faHhE7m4T/1IY708gDefGGjR/iUW8yQQ8=
-golang.org/x/net v0.30.0 h1:AcW1SDZMkb8IpzCdQUaIq2sP4sZ4zw+55h6ynffypl4=
-golang.org/x/net v0.30.0/go.mod h1:2wGyMJ5iFasEhkwi13ChkO/t1ECNC4X4eBKkVFyYFlU=
-golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ=
-golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
+github.com/yuin/goldmark v1.7.16 h1:n+CJdUxaFMiDUNnWC3dMWCIQJSkxH4uz3ZwQBkAlVNE=
+github.com/yuin/goldmark v1.7.16/go.mod h1:ip/1k0VRfGynBgxOz0yCqHrbZXhcjxyuS66Brc7iBKg=
+go.mau.fi/util v0.9.6 h1:2nsvxm49KhI3wrFltr0+wSUBlnQ4CMtykuELjpIU+ts=
+go.mau.fi/util v0.9.6/go.mod h1:sIJpRH7Iy5Ad1SBuxQoatxtIeErgzxCtjd/2hCMkYMI=
+go.mau.fi/zeroconfig v0.2.0 h1:e/OGEERqVRRKlgaro7E6bh8xXiKFSXB3eNNIud7FUjU=
+go.mau.fi/zeroconfig v0.2.0/go.mod h1:J0Vn0prHNOm493oZoQ84kq83ZaNCYZnq+noI1b1eN8w=
+golang.org/x/crypto v0.48.0 h1:/VRzVqiRSggnhY7gNRxPauEQ5Drw9haKdM0jqfcCFts=
+golang.org/x/crypto v0.48.0/go.mod h1:r0kV5h3qnFPlQnBSrULhlsRfryS2pmewsg+XfMgkVos=
+golang.org/x/exp v0.0.0-20260218203240-3dfff04db8fa h1:Zt3DZoOFFYkKhDT3v7Lm9FDMEV06GpzjG2jrqW+QTE0=
+golang.org/x/exp v0.0.0-20260218203240-3dfff04db8fa/go.mod h1:K79w1Vqn7PoiZn+TkNpx3BUWUQksGO3JcVX6qIjytmA=
+golang.org/x/net v0.50.0 h1:ucWh9eiCGyDR3vtzso0WMQinm2Dnt8cFMuQa9K33J60=
+golang.org/x/net v0.50.0/go.mod h1:UgoSli3F/pBgdJBHCTc+tp3gmrU4XswgGRgtnwWTfyM=
+golang.org/x/sync v0.19.0 h1:vV+1eWNmZ5geRlYjzm2adRgW2/mcpevXNg50YZtPCE4=
+golang.org/x/sync v0.19.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
golang.org/x/sys v0.0.0-20220310020820-b874c991c1a5/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.26.0 h1:KHjCJyddX0LoSTb3J+vWpupP9p0oznkqVk/IfjymZbo=
-golang.org/x/sys v0.26.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-golang.org/x/text v0.19.0 h1:kTxAhCbGbxhK0IwgSKiMO5awPoDQ0RpfiVYBfK860YM=
-golang.org/x/text v0.19.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
+golang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k=
+golang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
+golang.org/x/text v0.34.0 h1:oL/Qq0Kdaqxa1KbNeMKwQq0reLCCaFtqu2eNuSeNHbk=
+golang.org/x/text v0.34.0/go.mod h1:homfLqTYRFyVYemLBFl5GgL/DWEiH5wcsQ5gSh1yziA=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/natefinch/lumberjack.v2 v2.2.1 h1:bBRl1b0OH9s/DuPhuXpNl+VtCaJXFZ5/uEFST95x9zc=
diff --git a/hicli/cryptohelper.go b/hicli/cryptohelper.go
deleted file mode 100644
index 2a2e9626..00000000
--- a/hicli/cryptohelper.go
+++ /dev/null
@@ -1,65 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package hicli
-
-import (
- "context"
- "fmt"
- "time"
-
- "github.com/rs/zerolog"
-
- "maunium.net/go/mautrix"
- "maunium.net/go/mautrix/event"
- "maunium.net/go/mautrix/id"
-)
-
-type hiCryptoHelper HiClient
-
-var _ mautrix.CryptoHelper = (*hiCryptoHelper)(nil)
-
-func (h *hiCryptoHelper) Encrypt(ctx context.Context, roomID id.RoomID, evtType event.Type, content any) (*event.EncryptedEventContent, error) {
- roomMeta, err := h.DB.Room.Get(ctx, roomID)
- if err != nil {
- return nil, fmt.Errorf("failed to get room metadata: %w", err)
- } else if roomMeta == nil {
- return nil, fmt.Errorf("unknown room")
- }
- return (*HiClient)(h).Encrypt(ctx, roomMeta, evtType, content)
-}
-
-func (h *hiCryptoHelper) Decrypt(ctx context.Context, evt *event.Event) (*event.Event, error) {
- return h.Crypto.DecryptMegolmEvent(ctx, evt)
-}
-
-func (h *hiCryptoHelper) WaitForSession(ctx context.Context, roomID id.RoomID, senderKey id.SenderKey, sessionID id.SessionID, timeout time.Duration) bool {
- return h.Crypto.WaitForSession(ctx, roomID, senderKey, sessionID, timeout)
-}
-
-func (h *hiCryptoHelper) RequestSession(ctx context.Context, roomID id.RoomID, senderKey id.SenderKey, sessionID id.SessionID, userID id.UserID, deviceID id.DeviceID) {
- err := h.Crypto.SendRoomKeyRequest(ctx, roomID, senderKey, sessionID, "", map[id.UserID][]id.DeviceID{
- userID: {deviceID},
- h.Account.UserID: {"*"},
- })
- if err != nil {
- zerolog.Ctx(ctx).Err(err).
- Stringer("room_id", roomID).
- Stringer("session_id", sessionID).
- Stringer("user_id", userID).
- Msg("Failed to send room key request")
- } else {
- zerolog.Ctx(ctx).Debug().
- Stringer("room_id", roomID).
- Stringer("session_id", sessionID).
- Stringer("user_id", userID).
- Msg("Sent room key request")
- }
-}
-
-func (h *hiCryptoHelper) Init(ctx context.Context) error {
- return nil
-}
diff --git a/hicli/database/account.go b/hicli/database/account.go
deleted file mode 100644
index 1dde74fd..00000000
--- a/hicli/database/account.go
+++ /dev/null
@@ -1,74 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package database
-
-import (
- "context"
- "database/sql"
- "errors"
-
- "go.mau.fi/util/dbutil"
-
- "maunium.net/go/mautrix/id"
-)
-
-const (
- getAccountQuery = `SELECT user_id, device_id, access_token, homeserver_url, next_batch FROM account WHERE user_id = $1`
- putNextBatchQuery = `UPDATE account SET next_batch = $1 WHERE user_id = $2`
- upsertAccountQuery = `
- INSERT INTO account (user_id, device_id, access_token, homeserver_url, next_batch)
- VALUES ($1, $2, $3, $4, $5) ON CONFLICT (user_id)
- DO UPDATE SET device_id = excluded.device_id,
- access_token = excluded.access_token,
- homeserver_url = excluded.homeserver_url,
- next_batch = excluded.next_batch
- `
-)
-
-type AccountQuery struct {
- *dbutil.QueryHelper[*Account]
-}
-
-func (aq *AccountQuery) GetFirstUserID(ctx context.Context) (userID id.UserID, err error) {
- var exists bool
- if exists, err = aq.GetDB().TableExists(ctx, "account"); err != nil || !exists {
- return
- }
- err = aq.GetDB().QueryRow(ctx, `SELECT user_id FROM account LIMIT 1`).Scan(&userID)
- if errors.Is(err, sql.ErrNoRows) {
- err = nil
- }
- return
-}
-
-func (aq *AccountQuery) Get(ctx context.Context, userID id.UserID) (*Account, error) {
- return aq.QueryOne(ctx, getAccountQuery, userID)
-}
-
-func (aq *AccountQuery) PutNextBatch(ctx context.Context, userID id.UserID, nextBatch string) error {
- return aq.Exec(ctx, putNextBatchQuery, nextBatch, userID)
-}
-
-func (aq *AccountQuery) Put(ctx context.Context, account *Account) error {
- return aq.Exec(ctx, upsertAccountQuery, account.sqlVariables()...)
-}
-
-type Account struct {
- UserID id.UserID
- DeviceID id.DeviceID
- AccessToken string
- HomeserverURL string
- NextBatch string
-}
-
-func (a *Account) Scan(row dbutil.Scannable) (*Account, error) {
- return dbutil.ValueOrErr(a, row.Scan(&a.UserID, &a.DeviceID, &a.AccessToken, &a.HomeserverURL, &a.NextBatch))
-}
-
-func (a *Account) sqlVariables() []any {
- return []any{a.UserID, a.DeviceID, a.AccessToken, a.HomeserverURL, a.NextBatch}
-}
diff --git a/hicli/database/accountdata.go b/hicli/database/accountdata.go
deleted file mode 100644
index 8723b595..00000000
--- a/hicli/database/accountdata.go
+++ /dev/null
@@ -1,71 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package database
-
-import (
- "context"
- "database/sql"
- "encoding/json"
- "unsafe"
-
- "go.mau.fi/util/dbutil"
-
- "maunium.net/go/mautrix/event"
- "maunium.net/go/mautrix/id"
-)
-
-const (
- upsertAccountDataQuery = `
- INSERT INTO account_data (user_id, type, content) VALUES ($1, $2, $3)
- ON CONFLICT (user_id, type) DO UPDATE SET content = excluded.content
- `
- upsertRoomAccountDataQuery = `
- INSERT INTO room_account_data (user_id, room_id, type, content) VALUES ($1, $2, $3, $4)
- ON CONFLICT (user_id, room_id, type) DO UPDATE SET content = excluded.content
- `
-)
-
-type AccountDataQuery struct {
- *dbutil.QueryHelper[*AccountData]
-}
-
-func unsafeJSONString(content json.RawMessage) *string {
- if content == nil {
- return nil
- }
- str := unsafe.String(unsafe.SliceData(content), len(content))
- return &str
-}
-
-func (adq *AccountDataQuery) Put(ctx context.Context, userID id.UserID, eventType event.Type, content json.RawMessage) error {
- return adq.Exec(ctx, upsertAccountDataQuery, userID, eventType.Type, unsafeJSONString(content))
-}
-
-func (adq *AccountDataQuery) PutRoom(ctx context.Context, userID id.UserID, roomID id.RoomID, eventType event.Type, content json.RawMessage) error {
- return adq.Exec(ctx, upsertRoomAccountDataQuery, userID, roomID, eventType.Type, unsafeJSONString(content))
-}
-
-type AccountData struct {
- UserID id.UserID `json:"user_id"`
- RoomID id.RoomID `json:"room_id,omitempty"`
- Type string `json:"type"`
- Content json.RawMessage `json:"content"`
-}
-
-func (a *AccountData) Scan(row dbutil.Scannable) (*AccountData, error) {
- var roomID sql.NullString
- err := row.Scan(&a.UserID, &roomID, &a.Type, (*[]byte)(&a.Content))
- if err != nil {
- return nil, err
- }
- a.RoomID = id.RoomID(roomID.String)
- return a, nil
-}
-
-func (a *AccountData) sqlVariables() []any {
- return []any{a.UserID, dbutil.StrPtr(a.RoomID), a.Type, unsafeJSONString(a.Content)}
-}
diff --git a/hicli/database/cachedmedia.go b/hicli/database/cachedmedia.go
deleted file mode 100644
index 2ccaca3b..00000000
--- a/hicli/database/cachedmedia.go
+++ /dev/null
@@ -1,150 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package database
-
-import (
- "context"
- "database/sql"
- "net/http"
- "time"
-
- "go.mau.fi/util/dbutil"
- "go.mau.fi/util/jsontime"
- "golang.org/x/exp/slices"
-
- "maunium.net/go/mautrix"
- "maunium.net/go/mautrix/crypto/attachment"
- "maunium.net/go/mautrix/id"
-)
-
-const (
- insertCachedMediaQuery = `
- INSERT INTO cached_media (mxc, event_rowid, enc_file, file_name, mime_type, size, hash, error)
- VALUES ($1, $2, $3, $4, $5, $6, $7, $8)
- ON CONFLICT (mxc) DO NOTHING
- `
- upsertCachedMediaQuery = `
- INSERT INTO cached_media (mxc, event_rowid, enc_file, file_name, mime_type, size, hash, error)
- VALUES ($1, $2, $3, $4, $5, $6, $7, $8)
- ON CONFLICT (mxc) DO UPDATE
- SET enc_file = excluded.enc_file,
- file_name = excluded.file_name,
- mime_type = excluded.mime_type,
- size = excluded.size,
- hash = excluded.hash,
- error = excluded.error
- WHERE excluded.error IS NULL OR cached_media.hash IS NULL
- `
- getCachedMediaQuery = `
- SELECT mxc, event_rowid, enc_file, file_name, mime_type, size, hash, error
- FROM cached_media
- WHERE mxc = $1
- `
-)
-
-type CachedMediaQuery struct {
- *dbutil.QueryHelper[*CachedMedia]
-}
-
-func (cmq *CachedMediaQuery) Add(ctx context.Context, cm *CachedMedia) error {
- return cmq.Exec(ctx, insertCachedMediaQuery, cm.sqlVariables()...)
-}
-
-func (cmq *CachedMediaQuery) Put(ctx context.Context, cm *CachedMedia) error {
- return cmq.Exec(ctx, upsertCachedMediaQuery, cm.sqlVariables()...)
-}
-
-func (cmq *CachedMediaQuery) Get(ctx context.Context, mxc id.ContentURI) (*CachedMedia, error) {
- return cmq.QueryOne(ctx, getCachedMediaQuery, &mxc)
-}
-
-type MediaError struct {
- Matrix *mautrix.RespError `json:"data"`
- StatusCode int `json:"status_code"`
- ReceivedAt jsontime.UnixMilli `json:"received_at"`
- Attempts int `json:"attempts"`
-}
-
-const MaxMediaBackoff = 7 * 24 * time.Hour
-
-func (me *MediaError) backoff() time.Duration {
- return min(time.Duration(2< 0 {
- err = eq.Exec(ctx, updateReactionCountsQuery, evtID, dbutil.JSON{Data: &res.Counts})
- if err != nil {
- return err
- }
- }
- }
- return nil
- })
-}
-
-type EventRowID int64
-
-func (m EventRowID) GetMassInsertValues() [1]any {
- return [1]any{m}
-}
-
-type Event struct {
- RowID EventRowID `json:"rowid"`
- TimelineRowID TimelineRowID `json:"timeline_rowid"`
-
- RoomID id.RoomID `json:"room_id"`
- ID id.EventID `json:"event_id"`
- Sender id.UserID `json:"sender"`
- Type string `json:"type"`
- StateKey *string `json:"state_key,omitempty"`
- Timestamp jsontime.UnixMilli `json:"timestamp"`
-
- Content json.RawMessage `json:"content"`
- Decrypted json.RawMessage `json:"decrypted,omitempty"`
- DecryptedType string `json:"decrypted_type,omitempty"`
- Unsigned json.RawMessage `json:"unsigned,omitempty"`
-
- TransactionID string `json:"transaction_id,omitempty"`
-
- RedactedBy id.EventID `json:"redacted_by,omitempty"`
- RelatesTo id.EventID `json:"relates_to,omitempty"`
- RelationType event.RelationType `json:"relation_type,omitempty"`
-
- MegolmSessionID id.SessionID `json:"-,omitempty"`
- DecryptionError string `json:"decryption_error,omitempty"`
- SendError string `json:"send_error,omitempty"`
-
- Reactions map[string]int `json:"reactions,omitempty"`
- LastEditRowID *EventRowID `json:"last_edit_rowid,omitempty"`
-}
-
-func MautrixToEvent(evt *event.Event) *Event {
- dbEvt := &Event{
- RoomID: evt.RoomID,
- ID: evt.ID,
- Sender: evt.Sender,
- Type: evt.Type.Type,
- StateKey: evt.StateKey,
- Timestamp: jsontime.UM(time.UnixMilli(evt.Timestamp)),
- Content: evt.Content.VeryRaw,
- MegolmSessionID: getMegolmSessionID(evt),
- TransactionID: evt.Unsigned.TransactionID,
- }
- if !strings.HasPrefix(dbEvt.TransactionID, "hicli-mautrix-go_") {
- dbEvt.TransactionID = ""
- }
- dbEvt.RelatesTo, dbEvt.RelationType = getRelatesToFromEvent(evt)
- dbEvt.Unsigned, _ = json.Marshal(&evt.Unsigned)
- if evt.Unsigned.RedactedBecause != nil {
- dbEvt.RedactedBy = evt.Unsigned.RedactedBecause.ID
- }
- return dbEvt
-}
-
-func (e *Event) AsRawMautrix() *event.Event {
- evt := &event.Event{
- RoomID: e.RoomID,
- ID: e.ID,
- Sender: e.Sender,
- Type: event.Type{Type: e.Type, Class: event.MessageEventType},
- StateKey: e.StateKey,
- Timestamp: e.Timestamp.UnixMilli(),
- Content: event.Content{VeryRaw: e.Content},
- }
- if e.Decrypted != nil {
- evt.Content.VeryRaw = e.Decrypted
- evt.Type.Type = e.DecryptedType
- evt.Mautrix.WasEncrypted = true
- }
- if e.StateKey != nil {
- evt.Type.Class = event.StateEventType
- }
- _ = json.Unmarshal(e.Unsigned, &evt.Unsigned)
- return evt
-}
-
-func (e *Event) Scan(row dbutil.Scannable) (*Event, error) {
- var timestamp int64
- var transactionID, redactedBy, relatesTo, relationType, megolmSessionID, decryptionError, sendError, decryptedType sql.NullString
- err := row.Scan(
- &e.RowID,
- &e.TimelineRowID,
- &e.RoomID,
- &e.ID,
- &e.Sender,
- &e.Type,
- &e.StateKey,
- ×tamp,
- (*[]byte)(&e.Content),
- (*[]byte)(&e.Decrypted),
- &decryptedType,
- (*[]byte)(&e.Unsigned),
- &transactionID,
- &redactedBy,
- &relatesTo,
- &relationType,
- &megolmSessionID,
- &decryptionError,
- &sendError,
- dbutil.JSON{Data: &e.Reactions},
- &e.LastEditRowID,
- )
- if err != nil {
- return nil, err
- }
- e.Timestamp = jsontime.UM(time.UnixMilli(timestamp))
- e.TransactionID = transactionID.String
- e.RedactedBy = id.EventID(redactedBy.String)
- e.RelatesTo = id.EventID(relatesTo.String)
- e.RelationType = event.RelationType(relationType.String)
- e.MegolmSessionID = id.SessionID(megolmSessionID.String)
- e.DecryptedType = decryptedType.String
- e.DecryptionError = decryptionError.String
- e.SendError = sendError.String
- return e, nil
-}
-
-var relatesToPath = exgjson.Path("m.relates_to", "event_id")
-var relationTypePath = exgjson.Path("m.relates_to", "rel_type")
-
-func getRelatesToFromEvent(evt *event.Event) (id.EventID, event.RelationType) {
- if evt.StateKey != nil {
- return "", ""
- }
- return GetRelatesToFromBytes(evt.Content.VeryRaw)
-}
-
-func GetRelatesToFromBytes(content []byte) (id.EventID, event.RelationType) {
- results := gjson.GetManyBytes(content, relatesToPath, relationTypePath)
- if len(results) == 2 && results[0].Exists() && results[1].Exists() && results[0].Type == gjson.String && results[1].Type == gjson.String {
- return id.EventID(results[0].Str), event.RelationType(results[1].Str)
- }
- return "", ""
-}
-
-func getMegolmSessionID(evt *event.Event) id.SessionID {
- if evt.Type != event.EventEncrypted {
- return ""
- }
- res := gjson.GetBytes(evt.Content.VeryRaw, "session_id")
- if res.Exists() && res.Type == gjson.String {
- return id.SessionID(res.Str)
- }
- return ""
-}
-
-func (e *Event) sqlVariables() []any {
- var reactions any
- if e.Reactions != nil {
- reactions = e.Reactions
- }
- return []any{
- e.RoomID,
- e.ID,
- e.Sender,
- e.Type,
- e.StateKey,
- e.Timestamp.UnixMilli(),
- unsafeJSONString(e.Content),
- unsafeJSONString(e.Decrypted),
- dbutil.StrPtr(e.DecryptedType),
- unsafeJSONString(e.Unsigned),
- dbutil.StrPtr(e.TransactionID),
- dbutil.StrPtr(e.RedactedBy),
- dbutil.StrPtr(e.RelatesTo),
- dbutil.StrPtr(e.RelationType),
- dbutil.StrPtr(e.MegolmSessionID),
- dbutil.StrPtr(e.DecryptionError),
- dbutil.StrPtr(e.SendError),
- dbutil.JSON{Data: reactions},
- e.LastEditRowID,
- }
-}
-
-func (e *Event) CanUseForPreview() bool {
- return (e.Type == event.EventMessage.Type || e.Type == event.EventSticker.Type ||
- (e.Type == event.EventEncrypted.Type &&
- (e.DecryptedType == event.EventMessage.Type || e.DecryptedType == event.EventSticker.Type))) &&
- e.RelationType != event.RelReplace && e.RedactedBy == ""
-}
-
-func (e *Event) BumpsSortingTimestamp() bool {
- return (e.Type == event.EventMessage.Type || e.Type == event.EventSticker.Type || e.Type == event.EventEncrypted.Type) &&
- e.RelationType != event.RelReplace
-}
diff --git a/hicli/database/receipt.go b/hicli/database/receipt.go
deleted file mode 100644
index 8830efc7..00000000
--- a/hicli/database/receipt.go
+++ /dev/null
@@ -1,82 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package database
-
-import (
- "context"
- "time"
-
- "go.mau.fi/util/dbutil"
- "go.mau.fi/util/exslices"
- "go.mau.fi/util/jsontime"
-
- "maunium.net/go/mautrix/event"
- "maunium.net/go/mautrix/id"
-)
-
-const (
- upsertReceiptQuery = `
- INSERT INTO receipt (room_id, user_id, receipt_type, thread_id, event_id, timestamp)
- VALUES ($1, $2, $3, $4, $5, $6)
- ON CONFLICT (room_id, user_id, receipt_type, thread_id) DO UPDATE
- SET event_id = excluded.event_id,
- timestamp = excluded.timestamp
- `
-)
-
-var receiptMassInserter = dbutil.NewMassInsertBuilder[*Receipt, [1]any](upsertReceiptQuery, "($1, $%d, $%d, $%d, $%d, $%d)")
-
-type ReceiptQuery struct {
- *dbutil.QueryHelper[*Receipt]
-}
-
-func (rq *ReceiptQuery) Put(ctx context.Context, receipt *Receipt) error {
- return rq.Exec(ctx, upsertReceiptQuery, receipt.sqlVariables()...)
-}
-
-func (rq *ReceiptQuery) PutMany(ctx context.Context, roomID id.RoomID, receipts ...*Receipt) error {
- if len(receipts) > 1000 {
- return rq.GetDB().DoTxn(ctx, nil, func(ctx context.Context) error {
- for _, receiptChunk := range exslices.Chunk(receipts, 200) {
- err := rq.PutMany(ctx, roomID, receiptChunk...)
- if err != nil {
- return err
- }
- }
- return nil
- })
- }
- query, params := receiptMassInserter.Build([1]any{roomID}, receipts)
- return rq.Exec(ctx, query, params...)
-}
-
-type Receipt struct {
- RoomID id.RoomID `json:"room_id"`
- UserID id.UserID `json:"user_id"`
- ReceiptType event.ReceiptType `json:"receipt_type"`
- ThreadID event.ThreadID `json:"thread_id"`
- EventID id.EventID `json:"event_id"`
- Timestamp jsontime.UnixMilli `json:"timestamp"`
-}
-
-func (r *Receipt) Scan(row dbutil.Scannable) (*Receipt, error) {
- var ts int64
- err := row.Scan(&r.RoomID, &r.UserID, &r.ReceiptType, &r.ThreadID, &r.EventID, &ts)
- if err != nil {
- return nil, err
- }
- r.Timestamp = jsontime.UM(time.UnixMilli(ts))
- return r, nil
-}
-
-func (r *Receipt) sqlVariables() []any {
- return []any{r.RoomID, r.UserID, r.ReceiptType, r.ThreadID, r.EventID, r.Timestamp.UnixMilli()}
-}
-
-func (r *Receipt) GetMassInsertValues() [5]any {
- return [5]any{r.UserID, r.ReceiptType, r.ThreadID, r.EventID, r.Timestamp.UnixMilli()}
-}
diff --git a/hicli/database/room.go b/hicli/database/room.go
deleted file mode 100644
index d9293cf8..00000000
--- a/hicli/database/room.go
+++ /dev/null
@@ -1,255 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package database
-
-import (
- "context"
- "database/sql"
- "errors"
- "time"
-
- "go.mau.fi/util/dbutil"
- "go.mau.fi/util/jsontime"
-
- "maunium.net/go/mautrix"
- "maunium.net/go/mautrix/event"
- "maunium.net/go/mautrix/id"
-)
-
-const (
- getRoomBaseQuery = `
- SELECT room_id, creation_content, name, name_quality, avatar, explicit_avatar, topic, canonical_alias,
- lazy_load_summary, encryption_event, has_member_list,
- preview_event_rowid, sorting_timestamp, prev_batch
- FROM room
- `
- getRoomsBySortingTimestampQuery = getRoomBaseQuery + `WHERE sorting_timestamp < $1 AND sorting_timestamp > 0 ORDER BY sorting_timestamp DESC LIMIT $2`
- getRoomByIDQuery = getRoomBaseQuery + `WHERE room_id = $1`
- ensureRoomExistsQuery = `
- INSERT INTO room (room_id) VALUES ($1)
- ON CONFLICT (room_id) DO NOTHING
- `
- upsertRoomFromSyncQuery = `
- UPDATE room
- SET creation_content = COALESCE(room.creation_content, $2),
- name = COALESCE($3, room.name),
- name_quality = CASE WHEN $3 IS NOT NULL THEN $4 ELSE room.name_quality END,
- avatar = COALESCE($5, room.avatar),
- explicit_avatar = CASE WHEN $5 IS NOT NULL THEN $6 ELSE room.explicit_avatar END,
- topic = COALESCE($7, room.topic),
- canonical_alias = COALESCE($8, room.canonical_alias),
- lazy_load_summary = COALESCE($9, room.lazy_load_summary),
- encryption_event = COALESCE($10, room.encryption_event),
- has_member_list = room.has_member_list OR $11,
- preview_event_rowid = COALESCE($12, room.preview_event_rowid),
- sorting_timestamp = COALESCE($13, room.sorting_timestamp),
- prev_batch = COALESCE($14, room.prev_batch)
- WHERE room_id = $1
- `
- setRoomPrevBatchQuery = `
- UPDATE room SET prev_batch = $2 WHERE room_id = $1
- `
- updateRoomPreviewIfLaterOnTimelineQuery = `
- UPDATE room
- SET preview_event_rowid = $2
- WHERE room_id = $1
- AND COALESCE((SELECT rowid FROM timeline WHERE event_rowid = $2), -1)
- > COALESCE((SELECT rowid FROM timeline WHERE event_rowid = preview_event_rowid), 0)
- RETURNING preview_event_rowid
- `
- recalculateRoomPreviewEventQuery = `
- SELECT rowid
- FROM event
- WHERE
- room_id = $1
- AND (type IN ('m.room.message', 'm.sticker')
- OR (type = 'm.room.encrypted'
- AND decrypted_type IN ('m.room.message', 'm.sticker')))
- AND relation_type <> 'm.replace'
- AND redacted_by IS NULL
- ORDER BY timestamp DESC
- LIMIT 1
- `
-)
-
-type RoomQuery struct {
- *dbutil.QueryHelper[*Room]
-}
-
-func (rq *RoomQuery) Get(ctx context.Context, roomID id.RoomID) (*Room, error) {
- return rq.QueryOne(ctx, getRoomByIDQuery, roomID)
-}
-
-func (rq *RoomQuery) GetBySortTS(ctx context.Context, maxTS time.Time, limit int) ([]*Room, error) {
- return rq.QueryMany(ctx, getRoomsBySortingTimestampQuery, maxTS.UnixMilli(), limit)
-}
-
-func (rq *RoomQuery) Upsert(ctx context.Context, room *Room) error {
- return rq.Exec(ctx, upsertRoomFromSyncQuery, room.sqlVariables()...)
-}
-
-func (rq *RoomQuery) CreateRow(ctx context.Context, roomID id.RoomID) error {
- return rq.Exec(ctx, ensureRoomExistsQuery, roomID)
-}
-
-func (rq *RoomQuery) SetPrevBatch(ctx context.Context, roomID id.RoomID, prevBatch string) error {
- return rq.Exec(ctx, setRoomPrevBatchQuery, roomID, prevBatch)
-}
-
-func (rq *RoomQuery) UpdatePreviewIfLaterOnTimeline(ctx context.Context, roomID id.RoomID, rowID EventRowID) (previewChanged bool, err error) {
- var newPreviewRowID EventRowID
- err = rq.GetDB().QueryRow(ctx, updateRoomPreviewIfLaterOnTimelineQuery, roomID, rowID).Scan(&newPreviewRowID)
- if errors.Is(err, sql.ErrNoRows) {
- err = nil
- } else if err == nil {
- previewChanged = newPreviewRowID == rowID
- }
- return
-}
-
-func (rq *RoomQuery) RecalculatePreview(ctx context.Context, roomID id.RoomID) (rowID EventRowID, err error) {
- err = rq.GetDB().QueryRow(ctx, recalculateRoomPreviewEventQuery, roomID).Scan(&rowID)
- return
-}
-
-type NameQuality int
-
-const (
- NameQualityNil NameQuality = iota
- NameQualityParticipants
- NameQualityCanonicalAlias
- NameQualityExplicit
-)
-
-const PrevBatchPaginationComplete = "fi.mau.gomuks.pagination_complete"
-
-type Room struct {
- ID id.RoomID `json:"room_id"`
- CreationContent *event.CreateEventContent `json:"creation_content,omitempty"`
-
- Name *string `json:"name,omitempty"`
- NameQuality NameQuality `json:"name_quality"`
- Avatar *id.ContentURI `json:"avatar,omitempty"`
- ExplicitAvatar bool `json:"explicit_avatar"`
- Topic *string `json:"topic,omitempty"`
- CanonicalAlias *id.RoomAlias `json:"canonical_alias,omitempty"`
-
- LazyLoadSummary *mautrix.LazyLoadSummary `json:"lazy_load_summary,omitempty"`
-
- EncryptionEvent *event.EncryptionEventContent `json:"encryption_event,omitempty"`
- HasMemberList bool `json:"has_member_list"`
-
- PreviewEventRowID EventRowID `json:"preview_event_rowid"`
- SortingTimestamp jsontime.UnixMilli `json:"sorting_timestamp"`
-
- PrevBatch string `json:"prev_batch"`
-}
-
-func (r *Room) CheckChangesAndCopyInto(other *Room) (hasChanges bool) {
- if r.Name != nil && r.NameQuality >= other.NameQuality {
- other.Name = r.Name
- other.NameQuality = r.NameQuality
- hasChanges = true
- }
- if r.Avatar != nil {
- other.Avatar = r.Avatar
- other.ExplicitAvatar = r.ExplicitAvatar
- hasChanges = true
- }
- if r.Topic != nil {
- other.Topic = r.Topic
- hasChanges = true
- }
- if r.CanonicalAlias != nil {
- other.CanonicalAlias = r.CanonicalAlias
- hasChanges = true
- }
- if r.LazyLoadSummary != nil {
- other.LazyLoadSummary = r.LazyLoadSummary
- hasChanges = true
- }
- if r.EncryptionEvent != nil && other.EncryptionEvent == nil {
- other.EncryptionEvent = r.EncryptionEvent
- hasChanges = true
- }
- if r.HasMemberList && !other.HasMemberList {
- hasChanges = true
- other.HasMemberList = true
- }
- if r.PreviewEventRowID > other.PreviewEventRowID {
- other.PreviewEventRowID = r.PreviewEventRowID
- hasChanges = true
- }
- if r.SortingTimestamp.After(other.SortingTimestamp.Time) {
- other.SortingTimestamp = r.SortingTimestamp
- hasChanges = true
- }
- if r.PrevBatch != "" && other.PrevBatch == "" {
- other.PrevBatch = r.PrevBatch
- hasChanges = true
- }
- return
-}
-
-func (r *Room) Scan(row dbutil.Scannable) (*Room, error) {
- var prevBatch sql.NullString
- var previewEventRowID, sortingTimestamp sql.NullInt64
- err := row.Scan(
- &r.ID,
- dbutil.JSON{Data: &r.CreationContent},
- &r.Name,
- &r.NameQuality,
- &r.Avatar,
- &r.ExplicitAvatar,
- &r.Topic,
- &r.CanonicalAlias,
- dbutil.JSON{Data: &r.LazyLoadSummary},
- dbutil.JSON{Data: &r.EncryptionEvent},
- &r.HasMemberList,
- &previewEventRowID,
- &sortingTimestamp,
- &prevBatch,
- )
- if err != nil {
- return nil, err
- }
- r.PrevBatch = prevBatch.String
- r.PreviewEventRowID = EventRowID(previewEventRowID.Int64)
- r.SortingTimestamp = jsontime.UM(time.UnixMilli(sortingTimestamp.Int64))
- return r, nil
-}
-
-func (r *Room) sqlVariables() []any {
- return []any{
- r.ID,
- dbutil.JSONPtr(r.CreationContent),
- r.Name,
- r.NameQuality,
- r.Avatar,
- r.ExplicitAvatar,
- r.Topic,
- r.CanonicalAlias,
- dbutil.JSONPtr(r.LazyLoadSummary),
- dbutil.JSONPtr(r.EncryptionEvent),
- r.HasMemberList,
- dbutil.NumPtr(r.PreviewEventRowID),
- dbutil.UnixMilliPtr(r.SortingTimestamp.Time),
- dbutil.StrPtr(r.PrevBatch),
- }
-}
-
-func (r *Room) BumpSortingTimestamp(evt *Event) bool {
- if !evt.BumpsSortingTimestamp() || evt.Timestamp.Before(r.SortingTimestamp.Time) {
- return false
- }
- r.SortingTimestamp = evt.Timestamp
- now := time.Now()
- if r.SortingTimestamp.After(now) {
- r.SortingTimestamp = jsontime.UM(now)
- }
- return true
-}
diff --git a/hicli/database/sessionrequest.go b/hicli/database/sessionrequest.go
deleted file mode 100644
index 6690c13f..00000000
--- a/hicli/database/sessionrequest.go
+++ /dev/null
@@ -1,69 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package database
-
-import (
- "context"
-
- "go.mau.fi/util/dbutil"
-
- "maunium.net/go/mautrix/id"
-)
-
-const (
- putSessionRequestQueueEntry = `
- INSERT INTO session_request (room_id, session_id, sender, min_index, backup_checked, request_sent)
- VALUES ($1, $2, $3, $4, $5, $6)
- ON CONFLICT (session_id) DO UPDATE
- SET min_index = MIN(excluded.min_index, session_request.min_index),
- backup_checked = excluded.backup_checked OR session_request.backup_checked,
- request_sent = excluded.request_sent OR session_request.request_sent
- `
- removeSessionRequestQuery = `
- DELETE FROM session_request WHERE session_id = $1 AND min_index >= $2
- `
- getNextSessionsToRequestQuery = `
- SELECT room_id, session_id, sender, min_index, backup_checked, request_sent
- FROM session_request
- WHERE request_sent = false OR backup_checked = false
- ORDER BY backup_checked, rowid
- LIMIT $1
- `
-)
-
-type SessionRequestQuery struct {
- *dbutil.QueryHelper[*SessionRequest]
-}
-
-func (srq *SessionRequestQuery) Next(ctx context.Context, count int) ([]*SessionRequest, error) {
- return srq.QueryMany(ctx, getNextSessionsToRequestQuery, count)
-}
-
-func (srq *SessionRequestQuery) Remove(ctx context.Context, sessionID id.SessionID, minIndex uint32) error {
- return srq.Exec(ctx, removeSessionRequestQuery, sessionID, minIndex)
-}
-
-func (srq *SessionRequestQuery) Put(ctx context.Context, sr *SessionRequest) error {
- return srq.Exec(ctx, putSessionRequestQueueEntry, sr.sqlVariables()...)
-}
-
-type SessionRequest struct {
- RoomID id.RoomID
- SessionID id.SessionID
- Sender id.UserID
- MinIndex uint32
- BackupChecked bool
- RequestSent bool
-}
-
-func (s *SessionRequest) Scan(row dbutil.Scannable) (*SessionRequest, error) {
- return dbutil.ValueOrErr(s, row.Scan(&s.RoomID, &s.SessionID, &s.Sender, &s.MinIndex, &s.BackupChecked, &s.RequestSent))
-}
-
-func (s *SessionRequest) sqlVariables() []any {
- return []any{s.RoomID, s.SessionID, s.Sender, s.MinIndex, s.BackupChecked, s.RequestSent}
-}
diff --git a/hicli/database/state.go b/hicli/database/state.go
deleted file mode 100644
index c12f9f60..00000000
--- a/hicli/database/state.go
+++ /dev/null
@@ -1,93 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package database
-
-import (
- "context"
- "fmt"
-
- "go.mau.fi/util/dbutil"
- "go.mau.fi/util/exslices"
-
- "maunium.net/go/mautrix/event"
- "maunium.net/go/mautrix/id"
-)
-
-const (
- setCurrentStateQuery = `
- INSERT INTO current_state (room_id, event_type, state_key, event_rowid, membership) VALUES ($1, $2, $3, $4, $5)
- ON CONFLICT (room_id, event_type, state_key) DO UPDATE SET event_rowid = excluded.event_rowid, membership = excluded.membership
- `
- addCurrentStateQuery = `
- INSERT INTO current_state (room_id, event_type, state_key, event_rowid, membership) VALUES ($1, $2, $3, $4, $5)
- ON CONFLICT DO NOTHING
- `
- deleteCurrentStateQuery = `
- DELETE FROM current_state WHERE room_id = $1
- `
- getCurrentRoomStateQuery = `
- SELECT event.rowid, -1, event.room_id, event.event_id, sender, event.type, event.state_key, timestamp, content, decrypted, decrypted_type, unsigned,
- transaction_id, redacted_by, relates_to, relation_type, megolm_session_id, decryption_error, send_error, reactions, last_edit_rowid
- FROM current_state cs
- JOIN event ON cs.event_rowid = event.rowid
- WHERE cs.room_id = $1
- `
- getCurrentStateEventQuery = getCurrentRoomStateQuery + `AND cs.event_type = $2 AND cs.state_key = $3`
-)
-
-var massInsertCurrentStateBuilder = dbutil.NewMassInsertBuilder[*CurrentStateEntry, [1]any](addCurrentStateQuery, "($1, $%d, $%d, $%d, $%d)")
-
-const currentStateMassInsertBatchSize = 1000
-
-type CurrentStateEntry struct {
- EventType event.Type
- StateKey string
- EventRowID EventRowID
- Membership event.Membership
-}
-
-func (cse *CurrentStateEntry) GetMassInsertValues() [4]any {
- return [4]any{cse.EventType.Type, cse.StateKey, cse.EventRowID, dbutil.StrPtr(cse.Membership)}
-}
-
-type CurrentStateQuery struct {
- *dbutil.QueryHelper[*Event]
-}
-
-func (csq *CurrentStateQuery) Set(ctx context.Context, roomID id.RoomID, eventType event.Type, stateKey string, eventRowID EventRowID, membership event.Membership) error {
- return csq.Exec(ctx, setCurrentStateQuery, roomID, eventType.Type, stateKey, eventRowID, dbutil.StrPtr(membership))
-}
-
-func (csq *CurrentStateQuery) AddMany(ctx context.Context, roomID id.RoomID, deleteOld bool, entries []*CurrentStateEntry) error {
- var err error
- if deleteOld {
- err = csq.Exec(ctx, deleteCurrentStateQuery, roomID)
- if err != nil {
- return fmt.Errorf("failed to delete old state: %w", err)
- }
- }
- for _, entryChunk := range exslices.Chunk(entries, currentStateMassInsertBatchSize) {
- query, params := massInsertCurrentStateBuilder.Build([1]any{roomID}, entryChunk)
- err = csq.Exec(ctx, query, params...)
- if err != nil {
- return err
- }
- }
- return nil
-}
-
-func (csq *CurrentStateQuery) Add(ctx context.Context, roomID id.RoomID, eventType event.Type, stateKey string, eventRowID EventRowID, membership event.Membership) error {
- return csq.Exec(ctx, addCurrentStateQuery, roomID, eventType.Type, stateKey, eventRowID, dbutil.StrPtr(membership))
-}
-
-func (csq *CurrentStateQuery) Get(ctx context.Context, roomID id.RoomID, eventType event.Type, stateKey string) (*Event, error) {
- return csq.QueryOne(ctx, getCurrentStateEventQuery, roomID, eventType.Type, stateKey)
-}
-
-func (csq *CurrentStateQuery) GetAll(ctx context.Context, roomID id.RoomID) ([]*Event, error) {
- return csq.QueryMany(ctx, getCurrentRoomStateQuery, roomID)
-}
diff --git a/hicli/database/statestore.go b/hicli/database/statestore.go
deleted file mode 100644
index fcd6aceb..00000000
--- a/hicli/database/statestore.go
+++ /dev/null
@@ -1,188 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package database
-
-import (
- "context"
- "database/sql"
- "errors"
- "fmt"
-
- "go.mau.fi/util/dbutil"
- "golang.org/x/exp/slices"
-
- "maunium.net/go/mautrix"
- "maunium.net/go/mautrix/crypto"
- "maunium.net/go/mautrix/event"
- "maunium.net/go/mautrix/id"
-)
-
-const (
- getMembershipQuery = `
- SELECT membership FROM current_state
- WHERE room_id = $1 AND event_type = 'm.room.member' AND state_key = $2
- `
- getStateEventContentQuery = `
- SELECT event.content FROM current_state cs
- LEFT JOIN event ON event.rowid = cs.event_rowid
- WHERE cs.room_id = $1 AND cs.event_type = $2 AND cs.state_key = $3
- `
- getRoomJoinedMembersQuery = `
- SELECT state_key FROM current_state
- WHERE room_id = $1 AND event_type = 'm.room.member' AND membership = 'join'
- `
- getRoomJoinedOrInvitedMembersQuery = `
- SELECT state_key FROM current_state
- WHERE room_id = $1 AND event_type = 'm.room.member' AND membership IN ('join', 'invite')
- `
- getHasFetchedMembersQuery = `
- SELECT has_member_list FROM room WHERE room_id = $1
- `
- isRoomEncryptedQuery = `
- SELECT room.encryption_event IS NOT NULL FROM room WHERE room_id = $1
- `
- getRoomEncryptionEventQuery = `
- SELECT room.encryption_event FROM room WHERE room_id = $1
- `
- findSharedRoomsQuery = `
- SELECT room_id FROM current_state
- WHERE event_type = 'm.room.member' AND state_key = $1 AND membership = 'join'
- `
-)
-
-type ClientStateStore struct {
- *Database
-}
-
-var _ mautrix.StateStore = (*ClientStateStore)(nil)
-var _ mautrix.StateStoreUpdater = (*ClientStateStore)(nil)
-var _ crypto.StateStore = (*ClientStateStore)(nil)
-
-func (c *ClientStateStore) IsInRoom(ctx context.Context, roomID id.RoomID, userID id.UserID) bool {
- return c.IsMembership(ctx, roomID, userID, event.MembershipJoin)
-}
-
-func (c *ClientStateStore) IsInvited(ctx context.Context, roomID id.RoomID, userID id.UserID) bool {
- return c.IsMembership(ctx, roomID, userID, event.MembershipInvite, event.MembershipJoin)
-}
-
-func (c *ClientStateStore) IsMembership(ctx context.Context, roomID id.RoomID, userID id.UserID, allowedMemberships ...event.Membership) bool {
- var membership event.Membership
- err := c.QueryRow(ctx, getMembershipQuery, roomID, userID).Scan(&membership)
- if errors.Is(err, sql.ErrNoRows) {
- err = nil
- membership = event.MembershipLeave
- }
- return slices.Contains(allowedMemberships, membership)
-}
-
-func (c *ClientStateStore) GetMember(ctx context.Context, roomID id.RoomID, userID id.UserID) (*event.MemberEventContent, error) {
- content, err := c.TryGetMember(ctx, roomID, userID)
- if content == nil {
- content = &event.MemberEventContent{Membership: event.MembershipLeave}
- }
- return content, err
-}
-
-func (c *ClientStateStore) TryGetMember(ctx context.Context, roomID id.RoomID, userID id.UserID) (content *event.MemberEventContent, err error) {
- err = c.QueryRow(ctx, getStateEventContentQuery, roomID, event.StateMember.Type, userID).Scan(&dbutil.JSON{Data: &content})
- if errors.Is(err, sql.ErrNoRows) {
- err = nil
- }
- return
-}
-
-func (c *ClientStateStore) IsConfusableName(ctx context.Context, roomID id.RoomID, currentUser id.UserID, name string) ([]id.UserID, error) {
- //TODO implement me
- panic("implement me")
-}
-
-func (c *ClientStateStore) GetPowerLevels(ctx context.Context, roomID id.RoomID) (content *event.PowerLevelsEventContent, err error) {
- err = c.QueryRow(ctx, getStateEventContentQuery, roomID, event.StatePowerLevels.Type, "").Scan(&dbutil.JSON{Data: &content})
- if errors.Is(err, sql.ErrNoRows) {
- err = nil
- }
- return
-}
-
-func (c *ClientStateStore) GetRoomJoinedMembers(ctx context.Context, roomID id.RoomID) ([]id.UserID, error) {
- rows, err := c.Query(ctx, getRoomJoinedMembersQuery, roomID)
- return dbutil.NewRowIterWithError(rows, dbutil.ScanSingleColumn[id.UserID], err).AsList()
-}
-
-func (c *ClientStateStore) GetRoomJoinedOrInvitedMembers(ctx context.Context, roomID id.RoomID) ([]id.UserID, error) {
- rows, err := c.Query(ctx, getRoomJoinedOrInvitedMembersQuery, roomID)
- return dbutil.NewRowIterWithError(rows, dbutil.ScanSingleColumn[id.UserID], err).AsList()
-}
-
-func (c *ClientStateStore) HasFetchedMembers(ctx context.Context, roomID id.RoomID) (hasFetched bool, err error) {
- //err = c.QueryRow(ctx, getHasFetchedMembersQuery, roomID).Scan(&hasFetched)
- //if errors.Is(err, sql.ErrNoRows) {
- // err = nil
- //}
- //return
- return false, fmt.Errorf("not implemented")
-}
-
-func (c *ClientStateStore) MarkMembersFetched(ctx context.Context, roomID id.RoomID) error {
- return fmt.Errorf("not implemented")
-}
-
-func (c *ClientStateStore) GetAllMembers(ctx context.Context, roomID id.RoomID) (map[id.UserID]*event.MemberEventContent, error) {
- return nil, fmt.Errorf("not implemented")
-}
-
-func (c *ClientStateStore) IsEncrypted(ctx context.Context, roomID id.RoomID) (isEncrypted bool, err error) {
- err = c.QueryRow(ctx, isRoomEncryptedQuery, roomID).Scan(&isEncrypted)
- if errors.Is(err, sql.ErrNoRows) {
- err = nil
- }
- return
-}
-
-func (c *ClientStateStore) GetEncryptionEvent(ctx context.Context, roomID id.RoomID) (content *event.EncryptionEventContent, err error) {
- err = c.QueryRow(ctx, getRoomEncryptionEventQuery, roomID).
- Scan(&dbutil.JSON{Data: &content})
- if errors.Is(err, sql.ErrNoRows) {
- err = nil
- }
- return
-}
-
-func (c *ClientStateStore) FindSharedRooms(ctx context.Context, userID id.UserID) ([]id.RoomID, error) {
- // TODO for multiuser support, this might need to filter by the local user's membership
- rows, err := c.Query(ctx, findSharedRoomsQuery, userID)
- return dbutil.NewRowIterWithError(rows, dbutil.ScanSingleColumn[id.RoomID], err).AsList()
-}
-
-// Update methods are all intentionally no-ops as the state store wants to have the full event
-
-func (c *ClientStateStore) SetMembership(ctx context.Context, roomID id.RoomID, userID id.UserID, membership event.Membership) error {
- return nil
-}
-
-func (c *ClientStateStore) SetMember(ctx context.Context, roomID id.RoomID, userID id.UserID, member *event.MemberEventContent) error {
- return nil
-}
-
-func (c *ClientStateStore) ClearCachedMembers(ctx context.Context, roomID id.RoomID, memberships ...event.Membership) error {
- return nil
-}
-
-func (c *ClientStateStore) SetPowerLevels(ctx context.Context, roomID id.RoomID, levels *event.PowerLevelsEventContent) error {
- return nil
-}
-
-func (c *ClientStateStore) SetEncryptionEvent(ctx context.Context, roomID id.RoomID, content *event.EncryptionEventContent) error {
- return nil
-}
-
-func (c *ClientStateStore) UpdateState(ctx context.Context, evt *event.Event) {}
-
-func (c *ClientStateStore) ReplaceCachedMembers(ctx context.Context, roomID id.RoomID, evts []*event.Event, onlyMemberships ...event.Membership) error {
- return nil
-}
diff --git a/hicli/database/timeline.go b/hicli/database/timeline.go
deleted file mode 100644
index 0a01c7f5..00000000
--- a/hicli/database/timeline.go
+++ /dev/null
@@ -1,132 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package database
-
-import (
- "context"
- "database/sql"
- "errors"
- "sync"
-
- "go.mau.fi/util/dbutil"
-
- "maunium.net/go/mautrix/id"
-)
-
-const (
- clearTimelineQuery = `
- DELETE FROM timeline WHERE room_id = $1
- `
- appendTimelineQuery = `
- INSERT INTO timeline (room_id, event_rowid) VALUES ($1, $2) RETURNING rowid, event_rowid
- `
- prependTimelineQuery = `
- INSERT INTO timeline (room_id, rowid, event_rowid) VALUES ($1, $2, $3)
- `
- checkTimelineContainsQuery = `
- SELECT EXISTS(SELECT 1 FROM timeline WHERE room_id = $1 AND event_rowid = $2)
- `
- findMinRowIDQuery = `SELECT MIN(rowid) FROM timeline`
- getTimelineQuery = `
- SELECT event.rowid, timeline.rowid, event.room_id, event_id, sender, type, state_key, timestamp, content, decrypted, decrypted_type, unsigned,
- transaction_id, redacted_by, relates_to, relation_type, megolm_session_id, decryption_error, send_error, reactions, last_edit_rowid
- FROM timeline
- JOIN event ON event.rowid = timeline.event_rowid
- WHERE timeline.room_id = $1 AND ($2 = 0 OR timeline.rowid < $2)
- ORDER BY timeline.rowid DESC
- LIMIT $3
- `
-)
-
-type TimelineRowID int64
-
-type TimelineRowTuple struct {
- Timeline TimelineRowID `json:"timeline_rowid"`
- Event EventRowID `json:"event_rowid"`
-}
-
-var timelineRowTupleScanner = dbutil.ConvertRowFn[TimelineRowTuple](func(row dbutil.Scannable) (trt TimelineRowTuple, err error) {
- err = row.Scan(&trt.Timeline, &trt.Event)
- return
-})
-
-func (trt TimelineRowTuple) GetMassInsertValues() [2]any {
- return [2]any{trt.Timeline, trt.Event}
-}
-
-var appendTimelineQueryBuilder = dbutil.NewMassInsertBuilder[EventRowID, [1]any](appendTimelineQuery, "($1, $%d)")
-var prependTimelineQueryBuilder = dbutil.NewMassInsertBuilder[TimelineRowTuple, [1]any](prependTimelineQuery, "($1, $%d, $%d)")
-
-type TimelineQuery struct {
- *dbutil.QueryHelper[*Event]
-
- minRowID TimelineRowID
- minRowIDFound bool
- prependLock sync.Mutex
-}
-
-// Clear clears the timeline of a given room.
-func (tq *TimelineQuery) Clear(ctx context.Context, roomID id.RoomID) error {
- return tq.Exec(ctx, clearTimelineQuery, roomID)
-}
-
-func (tq *TimelineQuery) reserveRowIDs(ctx context.Context, count int) (startFrom TimelineRowID, err error) {
- tq.prependLock.Lock()
- defer tq.prependLock.Unlock()
- if !tq.minRowIDFound {
- err = tq.GetDB().QueryRow(ctx, findMinRowIDQuery).Scan(&tq.minRowID)
- if err != nil && !errors.Is(err, sql.ErrNoRows) {
- return
- }
- if tq.minRowID >= 0 {
- // No negative row IDs exist, start at -2
- tq.minRowID = -2
- } else {
- // We fetched the lowest row ID, but we want the next available one, so decrement one
- tq.minRowID--
- }
- tq.minRowIDFound = true
- }
- startFrom = tq.minRowID
- tq.minRowID -= TimelineRowID(count)
- return
-}
-
-// Prepend adds the given event row IDs to the beginning of the timeline.
-// The events must be sorted in reverse chronological order (newest event first).
-func (tq *TimelineQuery) Prepend(ctx context.Context, roomID id.RoomID, rowIDs []EventRowID) (prependEntries []TimelineRowTuple, err error) {
- var startFrom TimelineRowID
- startFrom, err = tq.reserveRowIDs(ctx, len(rowIDs))
- if err != nil {
- return
- }
- prependEntries = make([]TimelineRowTuple, len(rowIDs))
- for i, rowID := range rowIDs {
- prependEntries[i] = TimelineRowTuple{
- Timeline: startFrom - TimelineRowID(i),
- Event: rowID,
- }
- }
- query, params := prependTimelineQueryBuilder.Build([1]any{roomID}, prependEntries)
- err = tq.Exec(ctx, query, params...)
- return
-}
-
-// Append adds the given event row IDs to the end of the timeline.
-func (tq *TimelineQuery) Append(ctx context.Context, roomID id.RoomID, rowIDs []EventRowID) ([]TimelineRowTuple, error) {
- query, params := appendTimelineQueryBuilder.Build([1]any{roomID}, rowIDs)
- return timelineRowTupleScanner.NewRowIter(tq.GetDB().Query(ctx, query, params...)).AsList()
-}
-
-func (tq *TimelineQuery) Get(ctx context.Context, roomID id.RoomID, limit int, before TimelineRowID) ([]*Event, error) {
- return tq.QueryMany(ctx, getTimelineQuery, roomID, before, limit)
-}
-
-func (tq *TimelineQuery) Has(ctx context.Context, roomID id.RoomID, eventRowID EventRowID) (exists bool, err error) {
- err = tq.GetDB().QueryRow(ctx, checkTimelineContainsQuery, roomID, eventRowID).Scan(&exists)
- return
-}
diff --git a/hicli/database/upgrades/00-latest-revision.sql b/hicli/database/upgrades/00-latest-revision.sql
deleted file mode 100644
index f8c84a61..00000000
--- a/hicli/database/upgrades/00-latest-revision.sql
+++ /dev/null
@@ -1,248 +0,0 @@
--- v0 -> v2 (compatible with v1+): Latest revision
-CREATE TABLE account (
- user_id TEXT NOT NULL PRIMARY KEY,
- device_id TEXT NOT NULL,
- access_token TEXT NOT NULL,
- homeserver_url TEXT NOT NULL,
-
- next_batch TEXT NOT NULL
-) STRICT;
-
-CREATE TABLE room (
- room_id TEXT NOT NULL PRIMARY KEY,
- creation_content TEXT,
-
- name TEXT,
- name_quality INTEGER NOT NULL DEFAULT 0,
- avatar TEXT,
- explicit_avatar INTEGER NOT NULL DEFAULT 0,
- topic TEXT,
- canonical_alias TEXT,
- lazy_load_summary TEXT,
-
- encryption_event TEXT,
- has_member_list INTEGER NOT NULL DEFAULT false,
-
- preview_event_rowid INTEGER,
- sorting_timestamp INTEGER,
-
- prev_batch TEXT,
-
- CONSTRAINT room_preview_event_fkey FOREIGN KEY (preview_event_rowid) REFERENCES event (rowid) ON DELETE SET NULL
-) STRICT;
-CREATE INDEX room_type_idx ON room (creation_content ->> 'type');
-CREATE INDEX room_sorting_timestamp_idx ON room (sorting_timestamp DESC);
-
-CREATE TABLE account_data (
- user_id TEXT NOT NULL,
- type TEXT NOT NULL,
- content TEXT NOT NULL,
-
- PRIMARY KEY (user_id, type)
-) STRICT;
-
-CREATE TABLE room_account_data (
- user_id TEXT NOT NULL,
- room_id TEXT NOT NULL,
- type TEXT NOT NULL,
- content TEXT NOT NULL,
-
- PRIMARY KEY (user_id, room_id, type),
- CONSTRAINT room_account_data_room_fkey FOREIGN KEY (room_id) REFERENCES room (room_id) ON DELETE CASCADE
-) STRICT;
-CREATE INDEX room_account_data_room_id_idx ON room_account_data (room_id);
-
-CREATE TABLE event (
- rowid INTEGER PRIMARY KEY,
-
- room_id TEXT NOT NULL,
- event_id TEXT NOT NULL,
- sender TEXT NOT NULL,
- type TEXT NOT NULL,
- state_key TEXT,
- timestamp INTEGER NOT NULL,
-
- content TEXT NOT NULL,
- decrypted TEXT,
- decrypted_type TEXT,
- unsigned TEXT NOT NULL,
-
- transaction_id TEXT,
-
- redacted_by TEXT,
- relates_to TEXT,
- relation_type TEXT,
-
- megolm_session_id TEXT,
- decryption_error TEXT,
- send_error TEXT,
-
- reactions TEXT,
- last_edit_rowid INTEGER,
-
- CONSTRAINT event_id_unique_key UNIQUE (event_id),
- CONSTRAINT transaction_id_unique_key UNIQUE (transaction_id),
- CONSTRAINT event_room_fkey FOREIGN KEY (room_id) REFERENCES room (room_id) ON DELETE CASCADE
-) STRICT;
-CREATE INDEX event_room_id_idx ON event (room_id);
-CREATE INDEX event_redacted_by_idx ON event (room_id, redacted_by);
-CREATE INDEX event_relates_to_idx ON event (room_id, relates_to);
-CREATE INDEX event_megolm_session_id_idx ON event (room_id, megolm_session_id);
-
-CREATE TRIGGER event_update_redacted_by
- AFTER INSERT
- ON event
- WHEN NEW.type = 'm.room.redaction'
-BEGIN
- UPDATE event SET redacted_by = NEW.event_id WHERE room_id = NEW.room_id AND event_id = NEW.content ->> 'redacts';
-END;
-
-CREATE TRIGGER event_update_last_edit_when_redacted
- AFTER UPDATE
- ON event
- WHEN OLD.redacted_by IS NULL
- AND NEW.redacted_by IS NOT NULL
- AND NEW.relation_type = 'm.replace'
- AND NEW.state_key IS NULL
-BEGIN
- UPDATE event
- SET last_edit_rowid = COALESCE(
- (SELECT rowid
- FROM event edit
- WHERE edit.room_id = event.room_id
- AND edit.relates_to = event.event_id
- AND edit.relation_type = 'm.replace'
- AND edit.type = event.type
- AND edit.sender = event.sender
- AND edit.redacted_by IS NULL
- AND edit.state_key IS NULL
- ORDER BY edit.timestamp DESC
- LIMIT 1),
- 0)
- WHERE event_id = NEW.relates_to
- AND last_edit_rowid = NEW.rowid
- AND state_key IS NULL
- AND (relation_type IS NULL OR relation_type NOT IN ('m.replace', 'm.annotation'));
-END;
-
-CREATE TRIGGER event_insert_update_last_edit
- AFTER INSERT
- ON event
- WHEN NEW.relation_type = 'm.replace'
- AND NEW.redacted_by IS NULL
- AND NEW.state_key IS NULL
-BEGIN
- UPDATE event
- SET last_edit_rowid = NEW.rowid
- WHERE event_id = NEW.relates_to
- AND type = NEW.type
- AND sender = NEW.sender
- AND state_key IS NULL
- AND (relation_type IS NULL OR relation_type NOT IN ('m.replace', 'm.annotation'))
- AND NEW.timestamp >
- COALESCE((SELECT prev_edit.timestamp FROM event prev_edit WHERE prev_edit.rowid = event.last_edit_rowid), 0);
-END;
-
-CREATE TRIGGER event_insert_fill_reactions
- AFTER INSERT
- ON event
- WHEN NEW.type = 'm.reaction'
- AND NEW.relation_type = 'm.annotation'
- AND NEW.redacted_by IS NULL
- AND typeof(NEW.content ->> '$."m.relates_to".key') = 'text'
-BEGIN
- UPDATE event
- SET reactions=json_set(
- reactions,
- '$.' || json_quote(NEW.content ->> '$."m.relates_to".key'),
- coalesce(
- reactions ->> ('$.' || json_quote(NEW.content ->> '$."m.relates_to".key')),
- 0
- ) + 1)
- WHERE event_id = NEW.relates_to
- AND reactions IS NOT NULL;
-END;
-
-CREATE TRIGGER event_redact_fill_reactions
- AFTER UPDATE
- ON event
- WHEN NEW.type = 'm.reaction'
- AND NEW.relation_type = 'm.annotation'
- AND NEW.redacted_by IS NOT NULL
- AND OLD.redacted_by IS NULL
- AND typeof(NEW.content ->> '$."m.relates_to".key') = 'text'
-BEGIN
- UPDATE event
- SET reactions=json_set(
- reactions,
- '$.' || json_quote(NEW.content ->> '$."m.relates_to".key'),
- coalesce(
- reactions ->> ('$.' || json_quote(NEW.content ->> '$."m.relates_to".key')),
- 0
- ) - 1)
- WHERE event_id = NEW.relates_to
- AND reactions IS NOT NULL;
-END;
-
-CREATE TABLE cached_media (
- mxc TEXT NOT NULL PRIMARY KEY,
- event_rowid INTEGER,
- enc_file TEXT,
- file_name TEXT,
- mime_type TEXT,
- size INTEGER,
- hash BLOB,
- error TEXT,
-
- CONSTRAINT cached_media_event_fkey FOREIGN KEY (event_rowid) REFERENCES event (rowid) ON DELETE SET NULL
-) STRICT;
-
-CREATE TABLE session_request (
- room_id TEXT NOT NULL,
- session_id TEXT NOT NULL,
- sender TEXT NOT NULL,
- min_index INTEGER NOT NULL,
- backup_checked INTEGER NOT NULL DEFAULT false,
- request_sent INTEGER NOT NULL DEFAULT false,
-
- PRIMARY KEY (session_id),
- CONSTRAINT session_request_queue_room_fkey FOREIGN KEY (room_id) REFERENCES room (room_id) ON DELETE CASCADE
-) STRICT;
-CREATE INDEX session_request_room_idx ON session_request (room_id);
-
-CREATE TABLE timeline (
- rowid INTEGER PRIMARY KEY,
- room_id TEXT NOT NULL,
- event_rowid INTEGER NOT NULL,
-
- CONSTRAINT timeline_room_fkey FOREIGN KEY (room_id) REFERENCES room (room_id) ON DELETE CASCADE,
- CONSTRAINT timeline_event_fkey FOREIGN KEY (event_rowid) REFERENCES event (rowid) ON DELETE CASCADE,
- CONSTRAINT timeline_event_unique_key UNIQUE (event_rowid)
-) STRICT;
-CREATE INDEX timeline_room_id_idx ON timeline (room_id);
-
-CREATE TABLE current_state (
- room_id TEXT NOT NULL,
- event_type TEXT NOT NULL,
- state_key TEXT NOT NULL,
- event_rowid INTEGER NOT NULL,
-
- membership TEXT,
-
- PRIMARY KEY (room_id, event_type, state_key),
- CONSTRAINT current_state_room_fkey FOREIGN KEY (room_id) REFERENCES room (room_id) ON DELETE CASCADE,
- CONSTRAINT current_state_event_fkey FOREIGN KEY (event_rowid) REFERENCES event (rowid)
-) STRICT, WITHOUT ROWID;
-
-CREATE TABLE receipt (
- room_id TEXT NOT NULL,
- user_id TEXT NOT NULL,
- receipt_type TEXT NOT NULL,
- thread_id TEXT NOT NULL,
- event_id TEXT NOT NULL,
- timestamp INTEGER NOT NULL,
-
- PRIMARY KEY (room_id, user_id, receipt_type, thread_id),
- CONSTRAINT receipt_room_fkey FOREIGN KEY (room_id) REFERENCES room (room_id) ON DELETE CASCADE
- -- note: there's no foreign key on event ID because receipts could point at events that are too far in history.
-) STRICT;
diff --git a/hicli/database/upgrades/02-explicit-avatar-flag.sql b/hicli/database/upgrades/02-explicit-avatar-flag.sql
deleted file mode 100644
index c11e8801..00000000
--- a/hicli/database/upgrades/02-explicit-avatar-flag.sql
+++ /dev/null
@@ -1,2 +0,0 @@
--- v2 (compatible with v1+): Add explicit avatar flag to rooms
-ALTER TABLE room ADD COLUMN explicit_avatar INTEGER NOT NULL DEFAULT 0;
diff --git a/hicli/decryptionqueue.go b/hicli/decryptionqueue.go
deleted file mode 100644
index 87b6b8b2..00000000
--- a/hicli/decryptionqueue.go
+++ /dev/null
@@ -1,209 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package hicli
-
-import (
- "context"
- "fmt"
- "sync"
-
- "github.com/rs/zerolog"
-
- "maunium.net/go/mautrix/crypto"
- "maunium.net/go/mautrix/event"
- "maunium.net/go/mautrix/hicli/database"
- "maunium.net/go/mautrix/id"
-)
-
-func (h *HiClient) fetchFromKeyBackup(ctx context.Context, roomID id.RoomID, sessionID id.SessionID) (*crypto.InboundGroupSession, error) {
- data, err := h.Client.GetKeyBackupForRoomAndSession(ctx, h.KeyBackupVersion, roomID, sessionID)
- if err != nil {
- return nil, err
- } else if data == nil {
- return nil, nil
- }
- decrypted, err := data.SessionData.Decrypt(h.KeyBackupKey)
- if err != nil {
- return nil, err
- }
- return h.Crypto.ImportRoomKeyFromBackup(ctx, h.KeyBackupVersion, roomID, sessionID, decrypted)
-}
-
-func (h *HiClient) handleReceivedMegolmSession(ctx context.Context, roomID id.RoomID, sessionID id.SessionID, firstKnownIndex uint32) {
- log := zerolog.Ctx(ctx)
- err := h.DB.SessionRequest.Remove(ctx, sessionID, firstKnownIndex)
- if err != nil {
- log.Warn().Err(err).Msg("Failed to remove session request after receiving megolm session")
- }
- events, err := h.DB.Event.GetFailedByMegolmSessionID(ctx, roomID, sessionID)
- if err != nil {
- log.Err(err).Msg("Failed to get events that failed to decrypt to retry decryption")
- return
- } else if len(events) == 0 {
- log.Trace().Msg("No events to retry decryption for")
- return
- }
- decrypted := events[:0]
- for _, evt := range events {
- if evt.Decrypted != nil {
- continue
- }
-
- var mautrixEvt *event.Event
- mautrixEvt, evt.Decrypted, evt.DecryptedType, err = h.decryptEvent(ctx, evt.AsRawMautrix())
- if err != nil {
- log.Warn().Err(err).Stringer("event_id", evt.ID).Msg("Failed to decrypt event even after receiving megolm session")
- } else {
- decrypted = append(decrypted, evt)
- h.cacheMedia(ctx, mautrixEvt, evt.RowID)
- }
- }
- if len(decrypted) > 0 {
- var newPreview database.EventRowID
- err = h.DB.DoTxn(ctx, nil, func(ctx context.Context) error {
- for _, evt := range decrypted {
- err = h.DB.Event.UpdateDecrypted(ctx, evt.RowID, evt.Decrypted, evt.DecryptedType)
- if err != nil {
- return fmt.Errorf("failed to save decrypted content for %s: %w", evt.ID, err)
- }
- if evt.CanUseForPreview() {
- var previewChanged bool
- previewChanged, err = h.DB.Room.UpdatePreviewIfLaterOnTimeline(ctx, evt.RoomID, evt.RowID)
- if err != nil {
- return fmt.Errorf("failed to update room %s preview to %d: %w", evt.RoomID, evt.RowID, err)
- } else if previewChanged {
- newPreview = evt.RowID
- }
- }
- }
- return nil
- })
- if err != nil {
- log.Err(err).Msg("Failed to save decrypted events")
- } else {
- h.EventHandler(&EventsDecrypted{Events: decrypted, PreviewEventRowID: newPreview, RoomID: roomID})
- }
- }
-}
-
-func (h *HiClient) WakeupRequestQueue() {
- select {
- case h.requestQueueWakeup <- struct{}{}:
- default:
- }
-}
-
-func (h *HiClient) RunRequestQueue(ctx context.Context) {
- log := zerolog.Ctx(ctx).With().Str("action", "request queue").Logger()
- ctx = log.WithContext(ctx)
- log.Info().Msg("Starting key request queue")
- defer func() {
- log.Info().Msg("Stopping key request queue")
- }()
- for {
- err := h.FetchKeysForOutdatedUsers(ctx)
- if err != nil {
- log.Err(err).Msg("Failed to fetch outdated device lists for tracked users")
- }
- madeRequests, err := h.RequestQueuedSessions(ctx)
- if err != nil {
- log.Err(err).Msg("Failed to handle session request queue")
- } else if madeRequests {
- continue
- }
- select {
- case <-ctx.Done():
- return
- case <-h.requestQueueWakeup:
- }
- }
-}
-
-func (h *HiClient) requestQueuedSession(ctx context.Context, req *database.SessionRequest, doneFunc func()) {
- defer doneFunc()
- log := zerolog.Ctx(ctx)
- if !req.BackupChecked {
- sess, err := h.fetchFromKeyBackup(ctx, req.RoomID, req.SessionID)
- if err != nil {
- log.Err(err).
- Stringer("session_id", req.SessionID).
- Msg("Failed to fetch session from key backup")
-
- // TODO should this have retries instead of just storing it's checked?
- req.BackupChecked = true
- err = h.DB.SessionRequest.Put(ctx, req)
- if err != nil {
- log.Err(err).Stringer("session_id", req.SessionID).Msg("Failed to update session request after trying to check backup")
- }
- } else if sess == nil || sess.Internal.FirstKnownIndex() > req.MinIndex {
- req.BackupChecked = true
- err = h.DB.SessionRequest.Put(ctx, req)
- if err != nil {
- log.Err(err).Stringer("session_id", req.SessionID).Msg("Failed to update session request after checking backup")
- }
- } else {
- log.Debug().Stringer("session_id", req.SessionID).
- Msg("Found session with sufficiently low first known index, removing from queue")
- err = h.DB.SessionRequest.Remove(ctx, req.SessionID, sess.Internal.FirstKnownIndex())
- if err != nil {
- log.Err(err).Stringer("session_id", req.SessionID).Msg("Failed to remove session from request queue")
- }
- }
- } else {
- err := h.Crypto.SendRoomKeyRequest(ctx, req.RoomID, "", req.SessionID, "", map[id.UserID][]id.DeviceID{
- h.Account.UserID: {"*"},
- req.Sender: {"*"},
- })
- //var err error
- if err != nil {
- log.Err(err).
- Stringer("session_id", req.SessionID).
- Msg("Failed to send key request")
- } else {
- log.Debug().Stringer("session_id", req.SessionID).Msg("Sent key request")
- req.RequestSent = true
- err = h.DB.SessionRequest.Put(ctx, req)
- if err != nil {
- log.Err(err).Stringer("session_id", req.SessionID).Msg("Failed to update session request after sending request")
- }
- }
- }
-}
-
-const MaxParallelRequests = 5
-
-func (h *HiClient) RequestQueuedSessions(ctx context.Context) (bool, error) {
- sessions, err := h.DB.SessionRequest.Next(ctx, MaxParallelRequests)
- if err != nil {
- return false, fmt.Errorf("failed to get next events to decrypt: %w", err)
- } else if len(sessions) == 0 {
- return false, nil
- }
- var wg sync.WaitGroup
- wg.Add(len(sessions))
- for _, req := range sessions {
- go h.requestQueuedSession(ctx, req, wg.Done)
- }
- wg.Wait()
-
- return true, err
-}
-
-func (h *HiClient) FetchKeysForOutdatedUsers(ctx context.Context) error {
- outdatedUsers, err := h.Crypto.CryptoStore.GetOutdatedTrackedUsers(ctx)
- if err != nil {
- return err
- } else if len(outdatedUsers) == 0 {
- return nil
- }
- _, err = h.Crypto.FetchKeys(ctx, outdatedUsers, false)
- if err != nil {
- return err
- }
- // TODO backoff for users that fail to be fetched?
- return nil
-}
diff --git a/hicli/events.go b/hicli/events.go
deleted file mode 100644
index b96fd266..00000000
--- a/hicli/events.go
+++ /dev/null
@@ -1,53 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package hicli
-
-import (
- "maunium.net/go/mautrix/event"
- "maunium.net/go/mautrix/hicli/database"
- "maunium.net/go/mautrix/id"
-)
-
-type SyncRoom struct {
- Meta *database.Room `json:"meta"`
- Timeline []database.TimelineRowTuple `json:"timeline"`
- State map[event.Type]map[string]database.EventRowID `json:"state"`
- Events []*database.Event `json:"events"`
- Reset bool `json:"reset"`
-}
-
-type SyncComplete struct {
- Rooms map[id.RoomID]*SyncRoom `json:"rooms"`
-}
-
-func (c *SyncComplete) IsEmpty() bool {
- return len(c.Rooms) == 0
-}
-
-type EventsDecrypted struct {
- RoomID id.RoomID `json:"room_id"`
- PreviewEventRowID database.EventRowID `json:"preview_event_rowid,omitempty"`
- Events []*database.Event `json:"events"`
-}
-
-type Typing struct {
- RoomID id.RoomID `json:"room_id"`
- event.TypingEventContent
-}
-
-type SendComplete struct {
- Event *database.Event `json:"event"`
- Error error `json:"error"`
-}
-
-type ClientState struct {
- IsLoggedIn bool `json:"is_logged_in"`
- IsVerified bool `json:"is_verified"`
- UserID id.UserID `json:"user_id,omitempty"`
- DeviceID id.DeviceID `json:"device_id,omitempty"`
- HomeserverURL string `json:"homeserver_url,omitempty"`
-}
diff --git a/hicli/hicli.go b/hicli/hicli.go
deleted file mode 100644
index 78a1acc0..00000000
--- a/hicli/hicli.go
+++ /dev/null
@@ -1,250 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-// Package hicli contains a highly opinionated high-level framework for developing instant messaging clients on Matrix.
-package hicli
-
-import (
- "context"
- "errors"
- "fmt"
- "net"
- "net/http"
- "net/url"
- "sync"
- "sync/atomic"
- "time"
-
- "github.com/rs/zerolog"
- "go.mau.fi/util/dbutil"
- "go.mau.fi/util/exerrors"
-
- "maunium.net/go/mautrix"
- "maunium.net/go/mautrix/crypto"
- "maunium.net/go/mautrix/crypto/backup"
- "maunium.net/go/mautrix/hicli/database"
- "maunium.net/go/mautrix/id"
- "maunium.net/go/mautrix/pushrules"
-)
-
-type HiClient struct {
- DB *database.Database
- Account *database.Account
- Client *mautrix.Client
- Crypto *crypto.OlmMachine
- CryptoStore *crypto.SQLCryptoStore
- ClientStore *database.ClientStateStore
- Log zerolog.Logger
-
- Verified bool
-
- KeyBackupVersion id.KeyBackupVersion
- KeyBackupKey *backup.MegolmBackupKey
-
- PushRules atomic.Pointer[pushrules.PushRuleset]
-
- EventHandler func(evt any)
-
- firstSyncReceived bool
- syncingID int
- syncLock sync.Mutex
- stopSync atomic.Pointer[context.CancelFunc]
- encryptLock sync.Mutex
-
- requestQueueWakeup chan struct{}
-
- jsonRequestsLock sync.Mutex
- jsonRequests map[int64]context.CancelCauseFunc
-
- paginationInterrupterLock sync.Mutex
- paginationInterrupter map[id.RoomID]context.CancelCauseFunc
-}
-
-var ErrTimelineReset = errors.New("got limited timeline sync response")
-
-func New(rawDB, cryptoDB *dbutil.Database, log zerolog.Logger, pickleKey []byte, evtHandler func(any)) *HiClient {
- if cryptoDB == nil {
- cryptoDB = rawDB
- }
- if rawDB.Owner == "" {
- rawDB.Owner = "hicli"
- rawDB.IgnoreForeignTables = true
- }
- if rawDB.Log == nil {
- rawDB.Log = dbutil.ZeroLogger(log.With().Str("db_section", "hicli").Logger())
- }
- db := database.New(rawDB)
- c := &HiClient{
- DB: db,
- Log: log,
-
- requestQueueWakeup: make(chan struct{}, 1),
- jsonRequests: make(map[int64]context.CancelCauseFunc),
- paginationInterrupter: make(map[id.RoomID]context.CancelCauseFunc),
-
- EventHandler: evtHandler,
- }
- c.ClientStore = &database.ClientStateStore{Database: db}
- c.Client = &mautrix.Client{
- UserAgent: mautrix.DefaultUserAgent,
- Client: &http.Client{
- Transport: &http.Transport{
- DialContext: (&net.Dialer{Timeout: 10 * time.Second}).DialContext,
- TLSHandshakeTimeout: 10 * time.Second,
- // This needs to be relatively high to allow initial syncs
- ResponseHeaderTimeout: 180 * time.Second,
- ForceAttemptHTTP2: true,
- },
- Timeout: 180 * time.Second,
- },
- Syncer: (*hiSyncer)(c),
- Store: (*hiStore)(c),
- StateStore: c.ClientStore,
- Log: log.With().Str("component", "mautrix client").Logger(),
- }
- c.CryptoStore = crypto.NewSQLCryptoStore(cryptoDB, dbutil.ZeroLogger(log.With().Str("db_section", "crypto").Logger()), "", "", pickleKey)
- cryptoLog := log.With().Str("component", "crypto").Logger()
- c.Crypto = crypto.NewOlmMachine(c.Client, &cryptoLog, c.CryptoStore, c.ClientStore)
- c.Crypto.SessionReceived = c.handleReceivedMegolmSession
- c.Crypto.DisableRatchetTracking = true
- c.Crypto.DisableDecryptKeyFetching = true
- c.Client.Crypto = (*hiCryptoHelper)(c)
- return c
-}
-
-func (h *HiClient) IsLoggedIn() bool {
- return h.Account != nil
-}
-
-func (h *HiClient) Start(ctx context.Context, userID id.UserID, expectedAccount *database.Account) error {
- if expectedAccount != nil && userID != expectedAccount.UserID {
- panic(fmt.Errorf("invalid parameters: different user ID in expected account and user ID"))
- }
- err := h.DB.Upgrade(ctx)
- if err != nil {
- return fmt.Errorf("failed to upgrade hicli db: %w", err)
- }
- err = h.CryptoStore.DB.Upgrade(ctx)
- if err != nil {
- return fmt.Errorf("failed to upgrade crypto db: %w", err)
- }
- account, err := h.DB.Account.Get(ctx, userID)
- if err != nil {
- return err
- } else if account == nil && expectedAccount != nil {
- err = h.DB.Account.Put(ctx, expectedAccount)
- if err != nil {
- return err
- }
- account = expectedAccount
- } else if expectedAccount != nil && expectedAccount.DeviceID != account.DeviceID {
- return fmt.Errorf("device ID mismatch: expected %s, got %s", expectedAccount.DeviceID, account.DeviceID)
- }
- if account != nil {
- zerolog.Ctx(ctx).Debug().Stringer("user_id", account.UserID).Msg("Preparing client with existing credentials")
- h.Account = account
- h.CryptoStore.AccountID = account.UserID.String()
- h.CryptoStore.DeviceID = account.DeviceID
- h.Client.UserID = account.UserID
- h.Client.DeviceID = account.DeviceID
- h.Client.AccessToken = account.AccessToken
- h.Client.HomeserverURL, err = url.Parse(account.HomeserverURL)
- if err != nil {
- return err
- }
- err = h.CheckServerVersions(ctx)
- if err != nil {
- return err
- }
- err = h.Crypto.Load(ctx)
- if err != nil {
- return fmt.Errorf("failed to load olm machine: %w", err)
- }
-
- h.Verified, err = h.checkIsCurrentDeviceVerified(ctx)
- if err != nil {
- return err
- }
- zerolog.Ctx(ctx).Debug().Bool("verified", h.Verified).Msg("Checked current device verification status")
- if h.Verified {
- err = h.loadPrivateKeys(ctx)
- if err != nil {
- return err
- }
- go h.Sync()
- }
- }
- return nil
-}
-
-var ErrFailedToCheckServerVersions = errors.New("failed to check server versions")
-var ErrOutdatedServer = errors.New("homeserver is outdated")
-var MinimumSpecVersion = mautrix.SpecV11
-
-func (h *HiClient) CheckServerVersions(ctx context.Context) error {
- versions, err := h.Client.Versions(ctx)
- if err != nil {
- return exerrors.NewDualError(ErrFailedToCheckServerVersions, err)
- } else if !versions.Contains(MinimumSpecVersion) {
- return fmt.Errorf("%w (minimum: %s, highest supported: %s)", ErrOutdatedServer, MinimumSpecVersion, versions.GetLatest())
- }
- return nil
-}
-
-func (h *HiClient) IsSyncing() bool {
- return h.stopSync.Load() != nil
-}
-
-func (h *HiClient) Sync() {
- h.Client.StopSync()
- if fn := h.stopSync.Load(); fn != nil {
- (*fn)()
- }
- h.syncLock.Lock()
- defer h.syncLock.Unlock()
- h.syncingID++
- syncingID := h.syncingID
- log := h.Log.With().
- Str("action", "sync").
- Int("sync_id", syncingID).
- Logger()
- ctx, cancel := context.WithCancel(context.Background())
- defer cancel()
- h.stopSync.Store(&cancel)
- go h.RunRequestQueue(h.Log.WithContext(ctx))
- go h.LoadPushRules(h.Log.WithContext(ctx))
- ctx = log.WithContext(ctx)
- log.Info().Msg("Starting syncing")
- err := h.Client.SyncWithContext(ctx)
- if err != nil && ctx.Err() == nil {
- log.Err(err).Msg("Fatal error in syncer")
- } else {
- log.Info().Msg("Syncing stopped")
- }
-}
-
-func (h *HiClient) LoadPushRules(ctx context.Context) {
- rules, err := h.Client.GetPushRules(ctx)
- if err != nil {
- zerolog.Ctx(ctx).Err(err).Msg("Failed to load push rules")
- return
- }
- h.PushRules.Store(rules)
- zerolog.Ctx(ctx).Debug().Msg("Updated push rules from fetch")
-}
-
-func (h *HiClient) Stop() {
- h.Client.StopSync()
- if fn := h.stopSync.Swap(nil); fn != nil {
- (*fn)()
- }
- h.syncLock.Lock()
- h.syncLock.Unlock()
- err := h.DB.Close()
- if err != nil {
- h.Log.Err(err).Msg("Failed to close database cleanly")
- }
-}
diff --git a/hicli/hitest/hitest.go b/hicli/hitest/hitest.go
deleted file mode 100644
index bdf1598f..00000000
--- a/hicli/hitest/hitest.go
+++ /dev/null
@@ -1,110 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package main
-
-import (
- "context"
- "fmt"
- "io"
- "strings"
-
- "github.com/chzyer/readline"
- _ "github.com/mattn/go-sqlite3"
- "github.com/rs/zerolog"
- "go.mau.fi/util/dbutil"
- _ "go.mau.fi/util/dbutil/litestream"
- "go.mau.fi/util/exerrors"
- "go.mau.fi/util/exzerolog"
- "go.mau.fi/zeroconfig"
-
- "maunium.net/go/mautrix"
- "maunium.net/go/mautrix/event"
- "maunium.net/go/mautrix/hicli"
- "maunium.net/go/mautrix/id"
-)
-
-var writerTypeReadline zeroconfig.WriterType = "hitest_readline"
-
-func main() {
- hicli.InitialDeviceDisplayName = "mautrix hitest"
- rl := exerrors.Must(readline.New("> "))
- defer func() {
- _ = rl.Close()
- }()
- zeroconfig.RegisterWriter(writerTypeReadline, func(config *zeroconfig.WriterConfig) (io.Writer, error) {
- return rl.Stdout(), nil
- })
- debug := zerolog.DebugLevel
- log := exerrors.Must((&zeroconfig.Config{
- MinLevel: &debug,
- Writers: []zeroconfig.WriterConfig{{
- Type: writerTypeReadline,
- Format: zeroconfig.LogFormatPrettyColored,
- }},
- }).Compile())
- exzerolog.SetupDefaults(log)
-
- rawDB := exerrors.Must(dbutil.NewWithDialect("hicli.db", "sqlite3-fk-wal"))
- ctx := log.WithContext(context.Background())
- cli := hicli.New(rawDB, nil, *log, []byte("meow"), func(a any) {
- _, _ = fmt.Fprintf(rl, "Received event of type %T\n", a)
- switch evt := a.(type) {
- case *hicli.SyncComplete:
- for _, room := range evt.Rooms {
- name := "name unset"
- if room.Meta.Name != nil {
- name = *room.Meta.Name
- }
- _, _ = fmt.Fprintf(rl, "Room %s (%s) in sync:\n", name, room.Meta.ID)
- _, _ = fmt.Fprintf(rl, " Preview: %d, sort: %v\n", room.Meta.PreviewEventRowID, room.Meta.SortingTimestamp)
- _, _ = fmt.Fprintf(rl, " Timeline: +%d %v, reset: %t\n", len(room.Timeline), room.Timeline, room.Reset)
- }
- case *hicli.EventsDecrypted:
- for _, decrypted := range evt.Events {
- _, _ = fmt.Fprintf(rl, "Delayed decryption of %s completed: %s / %s\n", decrypted.ID, decrypted.DecryptedType, decrypted.Decrypted)
- }
- if evt.PreviewEventRowID != 0 {
- _, _ = fmt.Fprintf(rl, "Room preview updated: %+v\n", evt.PreviewEventRowID)
- }
- case *hicli.Typing:
- _, _ = fmt.Fprintf(rl, "Typing list in %s: %+v\n", evt.RoomID, evt.UserIDs)
- }
- })
- userID, _ := cli.DB.Account.GetFirstUserID(ctx)
- exerrors.PanicIfNotNil(cli.Start(ctx, userID, nil))
- if !cli.IsLoggedIn() {
- rl.SetPrompt("User ID: ")
- userID := id.UserID(exerrors.Must(rl.Readline()))
- _, serverName := exerrors.Must2(userID.Parse())
- discovery := exerrors.Must(mautrix.DiscoverClientAPI(ctx, serverName))
- password := exerrors.Must(rl.ReadPassword("Password: "))
- recoveryCode := exerrors.Must(rl.ReadPassword("Recovery code: "))
- exerrors.PanicIfNotNil(cli.LoginAndVerify(ctx, discovery.Homeserver.BaseURL, userID.String(), string(password), string(recoveryCode)))
- }
- rl.SetPrompt("> ")
-
- for {
- line, err := rl.Readline()
- if err != nil {
- break
- }
- fields := strings.Fields(line)
- if len(fields) == 0 {
- continue
- }
- switch strings.ToLower(fields[0]) {
- case "send":
- resp, err := cli.Send(ctx, id.RoomID(fields[1]), event.EventMessage, &event.MessageEventContent{
- Body: strings.Join(fields[2:], " "),
- MsgType: event.MsgText,
- })
- _, _ = fmt.Fprintln(rl, err)
- _, _ = fmt.Fprintf(rl, "%+v\n", resp)
- }
- }
- cli.Stop()
-}
diff --git a/hicli/json-commands.go b/hicli/json-commands.go
deleted file mode 100644
index c9dc89d2..00000000
--- a/hicli/json-commands.go
+++ /dev/null
@@ -1,178 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package hicli
-
-import (
- "context"
- "encoding/json"
- "errors"
- "fmt"
- "time"
-
- "maunium.net/go/mautrix"
- "maunium.net/go/mautrix/event"
- "maunium.net/go/mautrix/hicli/database"
- "maunium.net/go/mautrix/id"
-)
-
-func (h *HiClient) handleJSONCommand(ctx context.Context, req *JSONCommand) (any, error) {
- switch req.Command {
- case "get_state":
- return h.State(), nil
- case "cancel":
- return unmarshalAndCall(req.Data, func(params *cancelRequestParams) (bool, error) {
- h.jsonRequestsLock.Lock()
- cancelTarget, ok := h.jsonRequests[params.RequestID]
- h.jsonRequestsLock.Unlock()
- if ok {
- return false, nil
- }
- if params.Reason == "" {
- cancelTarget(nil)
- } else {
- cancelTarget(errors.New(params.Reason))
- }
- return true, nil
- })
- case "send_message":
- return unmarshalAndCall(req.Data, func(params *sendMessageParams) (*database.Event, error) {
- return h.SendMessage(ctx, params.RoomID, params.Text, params.MediaPath, params.ReplyTo, params.Mentions)
- })
- case "send_event":
- return unmarshalAndCall(req.Data, func(params *sendEventParams) (*database.Event, error) {
- return h.Send(ctx, params.RoomID, params.EventType, params.Content)
- })
- case "mark_read":
- return unmarshalAndCall(req.Data, func(params *markReadParams) (bool, error) {
- return true, h.MarkRead(ctx, params.RoomID, params.EventID, params.ReceiptType)
- })
- case "set_typing":
- return unmarshalAndCall(req.Data, func(params *setTypingParams) (bool, error) {
- return true, h.SetTyping(ctx, params.RoomID, time.Duration(params.Timeout)*time.Millisecond)
- })
- case "get_event":
- return unmarshalAndCall(req.Data, func(params *getEventParams) (*database.Event, error) {
- return h.GetEvent(ctx, params.RoomID, params.EventID)
- })
- case "get_events_by_rowids":
- return unmarshalAndCall(req.Data, func(params *getEventsByRowIDsParams) ([]*database.Event, error) {
- return h.GetEventsByRowIDs(ctx, params.RowIDs)
- })
- case "get_room_state":
- return unmarshalAndCall(req.Data, func(params *getRoomStateParams) ([]*database.Event, error) {
- return h.GetRoomState(ctx, params.RoomID, params.FetchMembers, params.Refetch)
- })
- case "paginate":
- return unmarshalAndCall(req.Data, func(params *paginateParams) (*PaginationResponse, error) {
- return h.Paginate(ctx, params.RoomID, params.MaxTimelineID, params.Limit)
- })
- case "paginate_server":
- return unmarshalAndCall(req.Data, func(params *paginateParams) (*PaginationResponse, error) {
- return h.PaginateServer(ctx, params.RoomID, params.Limit)
- })
- case "ensure_group_session_shared":
- return unmarshalAndCall(req.Data, func(params *ensureGroupSessionSharedParams) (bool, error) {
- return true, h.EnsureGroupSessionShared(ctx, params.RoomID)
- })
- case "login":
- return unmarshalAndCall(req.Data, func(params *loginParams) (bool, error) {
- return true, h.LoginPassword(ctx, params.HomeserverURL, params.Username, params.Password)
- })
- case "verify":
- return unmarshalAndCall(req.Data, func(params *verifyParams) (bool, error) {
- return true, h.VerifyWithRecoveryKey(ctx, params.RecoveryKey)
- })
- case "discover_homeserver":
- return unmarshalAndCall(req.Data, func(params *discoverHomeserverParams) (*mautrix.ClientWellKnown, error) {
- _, homeserver, err := params.UserID.Parse()
- if err != nil {
- return nil, err
- }
- return mautrix.DiscoverClientAPI(ctx, homeserver)
- })
- default:
- return nil, fmt.Errorf("unknown command %q", req.Command)
- }
-}
-
-func unmarshalAndCall[T, O any](data json.RawMessage, fn func(*T) (O, error)) (output O, err error) {
- var input T
- err = json.Unmarshal(data, &input)
- if err != nil {
- return
- }
- return fn(&input)
-}
-
-type cancelRequestParams struct {
- RequestID int64 `json:"request_id"`
- Reason string `json:"reason"`
-}
-
-type sendMessageParams struct {
- RoomID id.RoomID `json:"room_id"`
- Text string `json:"text"`
- MediaPath string `json:"media_path"`
- ReplyTo id.EventID `json:"reply_to"`
- Mentions *event.Mentions `json:"mentions"`
-}
-
-type sendEventParams struct {
- RoomID id.RoomID `json:"room_id"`
- EventType event.Type `json:"type"`
- Content json.RawMessage `json:"content"`
-}
-
-type markReadParams struct {
- RoomID id.RoomID `json:"room_id"`
- EventID id.EventID `json:"event_id"`
- ReceiptType event.ReceiptType `json:"receipt_type"`
-}
-
-type setTypingParams struct {
- RoomID id.RoomID `json:"room_id"`
- Timeout int `json:"timeout"`
-}
-
-type getEventParams struct {
- RoomID id.RoomID `json:"room_id"`
- EventID id.EventID `json:"event_id"`
-}
-
-type getEventsByRowIDsParams struct {
- RowIDs []database.EventRowID `json:"row_ids"`
-}
-
-type getRoomStateParams struct {
- RoomID id.RoomID `json:"room_id"`
- Refetch bool `json:"refetch"`
- FetchMembers bool `json:"fetch_members"`
-}
-
-type ensureGroupSessionSharedParams struct {
- RoomID id.RoomID `json:"room_id"`
-}
-
-type loginParams struct {
- HomeserverURL string `json:"homeserver_url"`
- Username string `json:"username"`
- Password string `json:"password"`
-}
-
-type verifyParams struct {
- RecoveryKey string `json:"recovery_key"`
-}
-
-type discoverHomeserverParams struct {
- UserID id.UserID `json:"user_id"`
-}
-
-type paginateParams struct {
- RoomID id.RoomID `json:"room_id"`
- MaxTimelineID database.TimelineRowID `json:"max_timeline_id"`
- Limit int `json:"limit"`
-}
diff --git a/hicli/json.go b/hicli/json.go
deleted file mode 100644
index a27fd007..00000000
--- a/hicli/json.go
+++ /dev/null
@@ -1,119 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package hicli
-
-import (
- "context"
- "encoding/json"
- "errors"
- "fmt"
- "sync/atomic"
-
- "go.mau.fi/util/exerrors"
-)
-
-type JSONCommand struct {
- Command string `json:"command"`
- RequestID int64 `json:"request_id"`
- Data json.RawMessage `json:"data"`
-}
-
-type JSONEventHandler func(*JSONCommand)
-
-var outgoingEventCounter atomic.Int64
-
-func (jeh JSONEventHandler) HandleEvent(evt any) {
- var command string
- switch evt.(type) {
- case *SyncComplete:
- command = "sync_complete"
- case *EventsDecrypted:
- command = "events_decrypted"
- case *Typing:
- command = "typing"
- case *SendComplete:
- command = "send_complete"
- case *ClientState:
- command = "client_state"
- default:
- panic(fmt.Errorf("unknown event type %T", evt))
- }
- data, err := json.Marshal(evt)
- if err != nil {
- panic(fmt.Errorf("failed to marshal event %T: %w", evt, err))
- }
- jeh(&JSONCommand{
- Command: command,
- RequestID: -outgoingEventCounter.Add(1),
- Data: data,
- })
-}
-
-func (h *HiClient) State() *ClientState {
- state := &ClientState{}
- if acc := h.Account; acc != nil {
- state.IsLoggedIn = true
- state.UserID = acc.UserID
- state.DeviceID = acc.DeviceID
- state.HomeserverURL = acc.HomeserverURL
- state.IsVerified = h.Verified
- }
- return state
-}
-
-func (h *HiClient) dispatchCurrentState() {
- h.EventHandler(h.State())
-}
-
-func (h *HiClient) SubmitJSONCommand(ctx context.Context, req *JSONCommand) *JSONCommand {
- if req.Command == "ping" {
- return &JSONCommand{
- Command: "pong",
- RequestID: req.RequestID,
- }
- }
- log := h.Log.With().Int64("request_id", req.RequestID).Str("command", req.Command).Logger()
- ctx, cancel := context.WithCancelCause(ctx)
- defer func() {
- cancel(nil)
- h.jsonRequestsLock.Lock()
- delete(h.jsonRequests, req.RequestID)
- h.jsonRequestsLock.Unlock()
- }()
- ctx = log.WithContext(ctx)
- h.jsonRequestsLock.Lock()
- h.jsonRequests[req.RequestID] = cancel
- h.jsonRequestsLock.Unlock()
- resp, err := h.handleJSONCommand(ctx, req)
- if err != nil {
- if errors.Is(err, context.Canceled) {
- causeErr := context.Cause(ctx)
- if causeErr != ctx.Err() {
- err = fmt.Errorf("%w: %w", err, causeErr)
- }
- }
- return &JSONCommand{
- Command: "error",
- RequestID: req.RequestID,
- Data: exerrors.Must(json.Marshal(err.Error())),
- }
- }
- var respData json.RawMessage
- respData, err = json.Marshal(resp)
- if err != nil {
- return &JSONCommand{
- Command: "error",
- RequestID: req.RequestID,
- Data: exerrors.Must(json.Marshal(fmt.Sprintf("failed to marshal response json: %v", err))),
- }
- }
- return &JSONCommand{
- Command: "response",
- RequestID: req.RequestID,
- Data: respData,
- }
-}
diff --git a/hicli/login.go b/hicli/login.go
deleted file mode 100644
index 6dbaf6e6..00000000
--- a/hicli/login.go
+++ /dev/null
@@ -1,87 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package hicli
-
-import (
- "context"
- "fmt"
- "net/url"
-
- "maunium.net/go/mautrix"
- "maunium.net/go/mautrix/hicli/database"
- "maunium.net/go/mautrix/id"
-)
-
-var InitialDeviceDisplayName = "mautrix hiclient"
-
-func (h *HiClient) LoginPassword(ctx context.Context, homeserverURL, username, password string) error {
- var err error
- h.Client.HomeserverURL, err = url.Parse(homeserverURL)
- if err != nil {
- return err
- }
- return h.Login(ctx, &mautrix.ReqLogin{
- Type: mautrix.AuthTypePassword,
- Identifier: mautrix.UserIdentifier{
- Type: mautrix.IdentifierTypeUser,
- User: username,
- },
- Password: password,
- InitialDeviceDisplayName: InitialDeviceDisplayName,
- })
-}
-
-func (h *HiClient) Login(ctx context.Context, req *mautrix.ReqLogin) error {
- err := h.CheckServerVersions(ctx)
- if err != nil {
- return err
- }
- req.StoreCredentials = true
- req.StoreHomeserverURL = true
- resp, err := h.Client.Login(ctx, req)
- if err != nil {
- return err
- }
- defer h.dispatchCurrentState()
- h.Account = &database.Account{
- UserID: resp.UserID,
- DeviceID: resp.DeviceID,
- AccessToken: resp.AccessToken,
- HomeserverURL: h.Client.HomeserverURL.String(),
- }
- h.CryptoStore.AccountID = resp.UserID.String()
- h.CryptoStore.DeviceID = resp.DeviceID
- err = h.DB.Account.Put(ctx, h.Account)
- if err != nil {
- return err
- }
- err = h.Crypto.Load(ctx)
- if err != nil {
- return fmt.Errorf("failed to load olm machine: %w", err)
- }
- err = h.Crypto.ShareKeys(ctx, 0)
- if err != nil {
- return err
- }
- _, err = h.Crypto.FetchKeys(ctx, []id.UserID{h.Account.UserID}, true)
- if err != nil {
- return fmt.Errorf("failed to fetch own devices: %w", err)
- }
- return nil
-}
-
-func (h *HiClient) LoginAndVerify(ctx context.Context, homeserverURL, username, password, recoveryKey string) error {
- err := h.LoginPassword(ctx, homeserverURL, username, password)
- if err != nil {
- return err
- }
- err = h.VerifyWithRecoveryKey(ctx, recoveryKey)
- if err != nil {
- return err
- }
- return nil
-}
diff --git a/hicli/paginate.go b/hicli/paginate.go
deleted file mode 100644
index da927b9b..00000000
--- a/hicli/paginate.go
+++ /dev/null
@@ -1,240 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package hicli
-
-import (
- "context"
- "errors"
- "fmt"
-
- "github.com/rs/zerolog"
-
- "maunium.net/go/mautrix"
- "maunium.net/go/mautrix/event"
- "maunium.net/go/mautrix/hicli/database"
- "maunium.net/go/mautrix/id"
-)
-
-var ErrPaginationAlreadyInProgress = errors.New("pagination is already in progress")
-
-func (h *HiClient) GetEventsByRowIDs(ctx context.Context, rowIDs []database.EventRowID) ([]*database.Event, error) {
- events, err := h.DB.Event.GetByRowIDs(ctx, rowIDs...)
- if err != nil {
- return nil, err
- } else if len(events) == 0 {
- return events, nil
- }
- firstRoomID := events[0].RoomID
- allInSameRoom := true
- for _, evt := range events {
- if evt.RoomID != firstRoomID {
- allInSameRoom = false
- break
- }
- }
- if allInSameRoom {
- err = h.DB.Event.FillLastEditRowIDs(ctx, firstRoomID, events)
- if err != nil {
- return events, fmt.Errorf("failed to fill last edit row IDs: %w", err)
- }
- err = h.DB.Event.FillReactionCounts(ctx, firstRoomID, events)
- if err != nil {
- return events, fmt.Errorf("failed to fill reaction counts: %w", err)
- }
- } else {
- // TODO slow path where events are collected and filling is done one room at a time?
- }
- return events, nil
-}
-
-func (h *HiClient) GetEvent(ctx context.Context, roomID id.RoomID, eventID id.EventID) (*database.Event, error) {
- if evt, err := h.DB.Event.GetByID(ctx, eventID); err != nil {
- return nil, fmt.Errorf("failed to get event from database: %w", err)
- } else if evt != nil {
- return evt, nil
- } else if serverEvt, err := h.Client.GetEvent(ctx, roomID, eventID); err != nil {
- return nil, fmt.Errorf("failed to get event from server: %w", err)
- } else {
- return h.processEvent(ctx, serverEvt, nil, false)
- }
-}
-
-func (h *HiClient) GetRoomState(ctx context.Context, roomID id.RoomID, fetchMembers, refetch bool) ([]*database.Event, error) {
- var evts []*event.Event
- if refetch {
- resp, err := h.Client.StateAsArray(ctx, roomID)
- if err != nil {
- return nil, fmt.Errorf("failed to refetch state: %w", err)
- }
- evts = resp
- } else if fetchMembers {
- resp, err := h.Client.Members(ctx, roomID)
- if err != nil {
- return nil, fmt.Errorf("failed to fetch members: %w", err)
- }
- evts = resp.Chunk
- }
- if evts != nil {
- err := h.DB.DoTxn(ctx, nil, func(ctx context.Context) error {
- room, err := h.DB.Room.Get(ctx, roomID)
- if err != nil {
- return fmt.Errorf("failed to get room from database: %w", err)
- }
- updatedRoom := &database.Room{
- ID: room.ID,
- HasMemberList: true,
- }
- entries := make([]*database.CurrentStateEntry, len(evts))
- for i, evt := range evts {
- dbEvt, err := h.processEvent(ctx, evt, nil, false)
- if err != nil {
- return fmt.Errorf("failed to process event %s: %w", evt.ID, err)
- }
- entries[i] = &database.CurrentStateEntry{
- EventType: evt.Type,
- StateKey: *evt.StateKey,
- EventRowID: dbEvt.RowID,
- }
- if evt.Type == event.StateMember {
- entries[i].Membership = event.Membership(evt.Content.Raw["membership"].(string))
- } else {
- processImportantEvent(ctx, evt, room, updatedRoom)
- }
- }
- err = h.DB.CurrentState.AddMany(ctx, room.ID, refetch, entries)
- if err != nil {
- return err
- }
- roomChanged := updatedRoom.CheckChangesAndCopyInto(room)
- if roomChanged {
- err = h.DB.Room.Upsert(ctx, updatedRoom)
- if err != nil {
- return fmt.Errorf("failed to save room data: %w", err)
- }
- }
- return nil
- })
- if err != nil {
- return nil, err
- }
- }
- return h.DB.CurrentState.GetAll(ctx, roomID)
-}
-
-type PaginationResponse struct {
- Events []*database.Event `json:"events"`
- HasMore bool `json:"has_more"`
-}
-
-func (h *HiClient) Paginate(ctx context.Context, roomID id.RoomID, maxTimelineID database.TimelineRowID, limit int) (*PaginationResponse, error) {
- evts, err := h.DB.Timeline.Get(ctx, roomID, limit, maxTimelineID)
- if err != nil {
- return nil, err
- } else if len(evts) > 0 {
- return &PaginationResponse{Events: evts, HasMore: true}, nil
- } else {
- return h.PaginateServer(ctx, roomID, limit)
- }
-}
-
-func (h *HiClient) PaginateServer(ctx context.Context, roomID id.RoomID, limit int) (*PaginationResponse, error) {
- ctx, cancel := context.WithCancelCause(ctx)
- h.paginationInterrupterLock.Lock()
- if _, alreadyPaginating := h.paginationInterrupter[roomID]; alreadyPaginating {
- h.paginationInterrupterLock.Unlock()
- return nil, ErrPaginationAlreadyInProgress
- }
- h.paginationInterrupter[roomID] = cancel
- h.paginationInterrupterLock.Unlock()
- defer func() {
- h.paginationInterrupterLock.Lock()
- delete(h.paginationInterrupter, roomID)
- h.paginationInterrupterLock.Unlock()
- }()
-
- room, err := h.DB.Room.Get(ctx, roomID)
- if err != nil {
- return nil, fmt.Errorf("failed to get room from database: %w", err)
- } else if room.PrevBatch == database.PrevBatchPaginationComplete {
- return &PaginationResponse{Events: []*database.Event{}, HasMore: false}, nil
- }
- resp, err := h.Client.Messages(ctx, roomID, room.PrevBatch, "", mautrix.DirectionBackward, nil, limit)
- if err != nil {
- return nil, fmt.Errorf("failed to get messages from server: %w", err)
- }
- events := make([]*database.Event, len(resp.Chunk))
- if resp.End == "" {
- resp.End = database.PrevBatchPaginationComplete
- }
- if resp.End == database.PrevBatchPaginationComplete || len(resp.Chunk) == 0 {
- err = h.DB.Room.SetPrevBatch(ctx, room.ID, resp.End)
- if err != nil {
- return nil, fmt.Errorf("failed to set prev_batch: %w", err)
- }
- return &PaginationResponse{Events: events, HasMore: resp.End != ""}, nil
- }
- wakeupSessionRequests := false
- err = h.DB.DoTxn(ctx, nil, func(ctx context.Context) error {
- if err = ctx.Err(); err != nil {
- return err
- }
- eventRowIDs := make([]database.EventRowID, len(resp.Chunk))
- decryptionQueue := make(map[id.SessionID]*database.SessionRequest)
- iOffset := 0
- for i, evt := range resp.Chunk {
- dbEvt, err := h.processEvent(ctx, evt, decryptionQueue, true)
- if err != nil {
- return err
- } else if exists, err := h.DB.Timeline.Has(ctx, roomID, dbEvt.RowID); err != nil {
- return fmt.Errorf("failed to check if event exists in timeline: %w", err)
- } else if exists {
- zerolog.Ctx(ctx).Warn().
- Int64("row_id", int64(dbEvt.RowID)).
- Str("event_id", dbEvt.ID.String()).
- Msg("Event already exists in timeline, skipping")
- iOffset++
- continue
- }
- events[i-iOffset] = dbEvt
- eventRowIDs[i-iOffset] = events[i-iOffset].RowID
- }
- if iOffset >= len(events) {
- events = events[:0]
- return nil
- }
- events = events[:len(events)-iOffset]
- eventRowIDs = eventRowIDs[:len(eventRowIDs)-iOffset]
- wakeupSessionRequests = len(decryptionQueue) > 0
- for _, entry := range decryptionQueue {
- err = h.DB.SessionRequest.Put(ctx, entry)
- if err != nil {
- return fmt.Errorf("failed to save session request for %s: %w", entry.SessionID, err)
- }
- }
- err = h.DB.Event.FillLastEditRowIDs(ctx, roomID, events)
- if err != nil {
- return fmt.Errorf("failed to fill last edit row IDs: %w", err)
- }
- err = h.DB.Room.SetPrevBatch(ctx, room.ID, resp.End)
- if err != nil {
- return fmt.Errorf("failed to set prev_batch: %w", err)
- }
- var tuples []database.TimelineRowTuple
- tuples, err = h.DB.Timeline.Prepend(ctx, room.ID, eventRowIDs)
- if err != nil {
- return fmt.Errorf("failed to prepend events to timeline: %w", err)
- }
- for i, evt := range events {
- evt.TimelineRowID = tuples[i].Timeline
- }
- return nil
- })
- if err == nil && wakeupSessionRequests {
- h.WakeupRequestQueue()
- }
- return &PaginationResponse{Events: events, HasMore: true}, err
-}
diff --git a/hicli/send.go b/hicli/send.go
deleted file mode 100644
index 76852dde..00000000
--- a/hicli/send.go
+++ /dev/null
@@ -1,287 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package hicli
-
-import (
- "context"
- "encoding/json"
- "errors"
- "fmt"
- "strings"
- "time"
-
- "github.com/rs/zerolog"
- "github.com/yuin/goldmark"
- "go.mau.fi/util/jsontime"
- "go.mau.fi/util/ptr"
-
- "maunium.net/go/mautrix"
- "maunium.net/go/mautrix/crypto"
- "maunium.net/go/mautrix/event"
- "maunium.net/go/mautrix/format"
- "maunium.net/go/mautrix/format/mdext/rainbow"
- "maunium.net/go/mautrix/hicli/database"
- "maunium.net/go/mautrix/id"
-)
-
-var (
- rainbowWithHTML = goldmark.New(format.Extensions, format.HTMLOptions, goldmark.WithExtensions(rainbow.Extension))
-)
-
-func (h *HiClient) SendMessage(ctx context.Context, roomID id.RoomID, text, mediaPath string, replyTo id.EventID, mentions *event.Mentions) (*database.Event, error) {
- var content event.MessageEventContent
- if strings.HasPrefix(text, "/rainbow ") {
- text = strings.TrimPrefix(text, "/rainbow ")
- content = format.RenderMarkdownCustom(text, rainbowWithHTML)
- content.FormattedBody = rainbow.ApplyColor(content.FormattedBody)
- } else if strings.HasPrefix(text, "/plain ") {
- text = strings.TrimPrefix(text, "/plain ")
- content = format.RenderMarkdown(text, false, false)
- } else if strings.HasPrefix(text, "/html ") {
- text = strings.TrimPrefix(text, "/html ")
- content = format.RenderMarkdown(text, false, true)
- } else {
- content = format.RenderMarkdown(text, true, false)
- }
- if mentions != nil {
- content.Mentions.Room = mentions.Room
- for _, userID := range mentions.UserIDs {
- if userID != h.Account.UserID {
- content.Mentions.Add(userID)
- }
- }
- }
- if replyTo != "" {
- content.RelatesTo = (&event.RelatesTo{}).SetReplyTo(replyTo)
- }
- return h.Send(ctx, roomID, event.EventMessage, &content)
-}
-
-func (h *HiClient) MarkRead(ctx context.Context, roomID id.RoomID, eventID id.EventID, receiptType event.ReceiptType) error {
- content := &mautrix.ReqSetReadMarkers{
- FullyRead: eventID,
- }
- if receiptType == event.ReceiptTypeRead {
- content.Read = eventID
- } else if receiptType == event.ReceiptTypeReadPrivate {
- content.ReadPrivate = eventID
- } else {
- return fmt.Errorf("invalid receipt type: %v", receiptType)
- }
- err := h.Client.SetReadMarkers(ctx, roomID, content)
- if err != nil {
- return fmt.Errorf("failed to mark event as read: %w", err)
- }
- return nil
-}
-
-func (h *HiClient) SetTyping(ctx context.Context, roomID id.RoomID, timeout time.Duration) error {
- _, err := h.Client.UserTyping(ctx, roomID, timeout > 0, timeout)
- return err
-}
-
-func (h *HiClient) Send(ctx context.Context, roomID id.RoomID, evtType event.Type, content any) (*database.Event, error) {
- roomMeta, err := h.DB.Room.Get(ctx, roomID)
- if err != nil {
- return nil, fmt.Errorf("failed to get room metadata: %w", err)
- } else if roomMeta == nil {
- return nil, fmt.Errorf("unknown room")
- }
- var decryptedType event.Type
- var decryptedContent json.RawMessage
- var megolmSessionID id.SessionID
- if roomMeta.EncryptionEvent != nil && evtType != event.EventReaction {
- decryptedType = evtType
- decryptedContent, err = json.Marshal(content)
- if err != nil {
- return nil, fmt.Errorf("failed to marshal event content: %w", err)
- }
- encryptedContent, err := h.Encrypt(ctx, roomMeta, evtType, content)
- if err != nil {
- return nil, fmt.Errorf("failed to encrypt event: %w", err)
- }
- megolmSessionID = encryptedContent.SessionID
- content = encryptedContent
- evtType = event.EventEncrypted
- }
- mainContent, err := json.Marshal(content)
- if err != nil {
- return nil, fmt.Errorf("failed to marshal event content: %w", err)
- }
- txnID := "hicli-" + h.Client.TxnID()
- relatesTo, relationType := database.GetRelatesToFromBytes(mainContent)
- dbEvt := &database.Event{
- RoomID: roomID,
- ID: id.EventID(fmt.Sprintf("~%s", txnID)),
- Sender: h.Account.UserID,
- Type: evtType.Type,
- Timestamp: jsontime.UnixMilliNow(),
- Content: mainContent,
- Decrypted: decryptedContent,
- DecryptedType: decryptedType.Type,
- Unsigned: []byte("{}"),
- TransactionID: txnID,
- RelatesTo: relatesTo,
- RelationType: relationType,
- MegolmSessionID: megolmSessionID,
- DecryptionError: "",
- SendError: "not sent",
- Reactions: map[string]int{},
- LastEditRowID: ptr.Ptr(database.EventRowID(0)),
- }
- _, err = h.DB.Event.Insert(ctx, dbEvt)
- if err != nil {
- return nil, fmt.Errorf("failed to insert event into database: %w", err)
- }
- ctx = context.WithoutCancel(ctx)
- go func() {
- err := h.SetTyping(ctx, roomID, 0)
- if err != nil {
- zerolog.Ctx(ctx).Err(err).Msg("Failed to stop typing while sending message")
- }
- }()
- go func() {
- var err error
- defer func() {
- h.EventHandler(&SendComplete{
- Event: dbEvt,
- Error: err,
- })
- }()
- var resp *mautrix.RespSendEvent
- resp, err = h.Client.SendMessageEvent(ctx, roomID, evtType, content, mautrix.ReqSendEvent{
- Timestamp: dbEvt.Timestamp.UnixMilli(),
- TransactionID: txnID,
- DontEncrypt: true,
- })
- if err != nil {
- dbEvt.SendError = err.Error()
- err = fmt.Errorf("failed to send event: %w", err)
- err2 := h.DB.Event.UpdateSendError(ctx, dbEvt.RowID, dbEvt.SendError)
- if err2 != nil {
- zerolog.Ctx(ctx).Err(err2).AnErr("send_error", err).
- Msg("Failed to update send error in database after sending failed")
- }
- return
- }
- dbEvt.ID = resp.EventID
- err = h.DB.Event.UpdateID(ctx, dbEvt.RowID, dbEvt.ID)
- if err != nil {
- err = fmt.Errorf("failed to update event ID in database: %w", err)
- }
- }()
- return dbEvt, nil
-}
-
-func (h *HiClient) Encrypt(ctx context.Context, room *database.Room, evtType event.Type, content any) (encrypted *event.EncryptedEventContent, err error) {
- h.encryptLock.Lock()
- defer h.encryptLock.Unlock()
- encrypted, err = h.Crypto.EncryptMegolmEvent(ctx, room.ID, evtType, content)
- if errors.Is(err, crypto.SessionExpired) || errors.Is(err, crypto.NoGroupSession) || errors.Is(err, crypto.SessionNotShared) {
- if err = h.shareGroupSession(ctx, room); err != nil {
- err = fmt.Errorf("failed to share group session: %w", err)
- } else if encrypted, err = h.Crypto.EncryptMegolmEvent(ctx, room.ID, evtType, content); err != nil {
- err = fmt.Errorf("failed to encrypt event after re-sharing group session: %w", err)
- }
- }
- return
-}
-
-func (h *HiClient) EnsureGroupSessionShared(ctx context.Context, roomID id.RoomID) error {
- h.encryptLock.Lock()
- defer h.encryptLock.Unlock()
- if session, err := h.CryptoStore.GetOutboundGroupSession(ctx, roomID); err != nil {
- return fmt.Errorf("failed to get previous outbound group session: %w", err)
- } else if session != nil && session.Shared && !session.Expired() {
- return nil
- } else if roomMeta, err := h.DB.Room.Get(ctx, roomID); err != nil {
- return fmt.Errorf("failed to get room metadata: %w", err)
- } else if roomMeta == nil {
- return fmt.Errorf("unknown room")
- } else {
- return h.shareGroupSession(ctx, roomMeta)
- }
-}
-
-func (h *HiClient) loadMembers(ctx context.Context, room *database.Room) error {
- if room.HasMemberList {
- return nil
- }
- resp, err := h.Client.Members(ctx, room.ID)
- if err != nil {
- return fmt.Errorf("failed to get room member list: %w", err)
- }
- err = h.DB.DoTxn(ctx, nil, func(ctx context.Context) error {
- entries := make([]*database.CurrentStateEntry, len(resp.Chunk))
- for i, evt := range resp.Chunk {
- dbEvt, err := h.processEvent(ctx, evt, nil, true)
- if err != nil {
- return err
- }
- entries[i] = &database.CurrentStateEntry{
- EventType: evt.Type,
- StateKey: *evt.StateKey,
- EventRowID: dbEvt.RowID,
- Membership: event.Membership(evt.Content.Raw["membership"].(string)),
- }
- }
- err := h.DB.CurrentState.AddMany(ctx, room.ID, false, entries)
- if err != nil {
- return err
- }
- return h.DB.Room.Upsert(ctx, &database.Room{
- ID: room.ID,
- HasMemberList: true,
- })
- })
- if err != nil {
- return fmt.Errorf("failed to process room member list: %w", err)
- }
- return nil
-}
-
-func (h *HiClient) shareGroupSession(ctx context.Context, room *database.Room) error {
- err := h.loadMembers(ctx, room)
- if err != nil {
- return err
- }
- shareToInvited := h.shouldShareKeysToInvitedUsers(ctx, room.ID)
- var users []id.UserID
- if shareToInvited {
- users, err = h.ClientStore.GetRoomJoinedOrInvitedMembers(ctx, room.ID)
- } else {
- users, err = h.ClientStore.GetRoomJoinedMembers(ctx, room.ID)
- }
- if err != nil {
- return fmt.Errorf("failed to get room member list: %w", err)
- } else if err = h.Crypto.ShareGroupSession(ctx, room.ID, users); err != nil {
- return fmt.Errorf("failed to share group session: %w", err)
- }
- return nil
-}
-
-func (h *HiClient) shouldShareKeysToInvitedUsers(ctx context.Context, roomID id.RoomID) bool {
- historyVisibility, err := h.DB.CurrentState.Get(ctx, roomID, event.StateHistoryVisibility, "")
- if err != nil {
- zerolog.Ctx(ctx).Err(err).Msg("Failed to get history visibility event")
- return false
- }
- mautrixEvt := historyVisibility.AsRawMautrix()
- err = mautrixEvt.Content.ParseRaw(mautrixEvt.Type)
- if err != nil && !errors.Is(err, event.ErrContentAlreadyParsed) {
- zerolog.Ctx(ctx).Err(err).Msg("Failed to parse history visibility event")
- return false
- }
- hv, ok := mautrixEvt.Content.Parsed.(*event.HistoryVisibilityEventContent)
- if !ok {
- zerolog.Ctx(ctx).Warn().Msg("Unexpected parsed content type for history visibility event")
- return false
- }
- return hv.HistoryVisibility == event.HistoryVisibilityInvited ||
- hv.HistoryVisibility == event.HistoryVisibilityShared ||
- hv.HistoryVisibility == event.HistoryVisibilityWorldReadable
-}
diff --git a/hicli/sync.go b/hicli/sync.go
deleted file mode 100644
index 16930b59..00000000
--- a/hicli/sync.go
+++ /dev/null
@@ -1,744 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package hicli
-
-import (
- "context"
- "errors"
- "fmt"
- "strings"
-
- "github.com/rs/zerolog"
- "github.com/tidwall/gjson"
- "github.com/tidwall/sjson"
- "go.mau.fi/util/exzerolog"
- "go.mau.fi/util/jsontime"
- "golang.org/x/exp/slices"
-
- "maunium.net/go/mautrix"
- "maunium.net/go/mautrix/crypto"
- "maunium.net/go/mautrix/crypto/olm"
- "maunium.net/go/mautrix/event"
- "maunium.net/go/mautrix/hicli/database"
- "maunium.net/go/mautrix/id"
- "maunium.net/go/mautrix/pushrules"
-)
-
-type syncContext struct {
- shouldWakeupRequestQueue bool
-
- evt *SyncComplete
-}
-
-func (h *HiClient) preProcessSyncResponse(ctx context.Context, resp *mautrix.RespSync, since string) error {
- log := zerolog.Ctx(ctx)
- postponedToDevices := resp.ToDevice.Events[:0]
- for _, evt := range resp.ToDevice.Events {
- evt.Type.Class = event.ToDeviceEventType
- err := evt.Content.ParseRaw(evt.Type)
- if err != nil && !errors.Is(err, event.ErrContentAlreadyParsed) {
- log.Warn().Err(err).
- Stringer("event_type", &evt.Type).
- Stringer("sender", evt.Sender).
- Msg("Failed to parse to-device event, skipping")
- continue
- }
-
- switch content := evt.Content.Parsed.(type) {
- case *event.EncryptedEventContent:
- h.Crypto.HandleEncryptedEvent(ctx, evt)
- case *event.RoomKeyWithheldEventContent:
- h.Crypto.HandleRoomKeyWithheld(ctx, content)
- default:
- postponedToDevices = append(postponedToDevices, evt)
- }
- }
- resp.ToDevice.Events = postponedToDevices
-
- return nil
-}
-
-func (h *HiClient) postProcessSyncResponse(ctx context.Context, resp *mautrix.RespSync, since string) {
- h.Crypto.HandleOTKCounts(ctx, &resp.DeviceOTKCount)
- go h.asyncPostProcessSyncResponse(ctx, resp, since)
- syncCtx := ctx.Value(syncContextKey).(*syncContext)
- if syncCtx.shouldWakeupRequestQueue {
- h.WakeupRequestQueue()
- }
- h.firstSyncReceived = true
- if !syncCtx.evt.IsEmpty() {
- h.EventHandler(syncCtx.evt)
- }
-}
-
-func (h *HiClient) asyncPostProcessSyncResponse(ctx context.Context, resp *mautrix.RespSync, since string) {
- for _, evt := range resp.ToDevice.Events {
- switch content := evt.Content.Parsed.(type) {
- case *event.SecretRequestEventContent:
- h.Crypto.HandleSecretRequest(ctx, evt.Sender, content)
- case *event.RoomKeyRequestEventContent:
- h.Crypto.HandleRoomKeyRequest(ctx, evt.Sender, content)
- }
- }
-}
-
-func (h *HiClient) processSyncResponse(ctx context.Context, resp *mautrix.RespSync, since string) error {
- if len(resp.DeviceLists.Changed) > 0 {
- zerolog.Ctx(ctx).Debug().
- Array("users", exzerolog.ArrayOfStringers(resp.DeviceLists.Changed)).
- Msg("Marking changed device lists for tracked users as outdated")
- err := h.Crypto.CryptoStore.MarkTrackedUsersOutdated(ctx, resp.DeviceLists.Changed)
- if err != nil {
- return fmt.Errorf("failed to mark changed device lists as outdated: %w", err)
- }
- ctx.Value(syncContextKey).(*syncContext).shouldWakeupRequestQueue = true
- }
-
- for _, evt := range resp.AccountData.Events {
- evt.Type.Class = event.AccountDataEventType
- err := h.DB.AccountData.Put(ctx, h.Account.UserID, evt.Type, evt.Content.VeryRaw)
- if err != nil {
- return fmt.Errorf("failed to save account data event %s: %w", evt.Type.Type, err)
- }
- if evt.Type == event.AccountDataPushRules {
- err = evt.Content.ParseRaw(evt.Type)
- if err != nil && !errors.Is(err, event.ErrContentAlreadyParsed) {
- zerolog.Ctx(ctx).Warn().Err(err).Msg("Failed to parse push rules in sync")
- } else if pushRules, ok := evt.Content.Parsed.(*pushrules.EventContent); ok {
- h.PushRules.Store(pushRules.Ruleset)
- zerolog.Ctx(ctx).Debug().Msg("Updated push rules from sync")
- }
- }
- }
- for roomID, room := range resp.Rooms.Join {
- err := h.processSyncJoinedRoom(ctx, roomID, room)
- if err != nil {
- return fmt.Errorf("failed to process joined room %s: %w", roomID, err)
- }
- }
- for roomID, room := range resp.Rooms.Leave {
- err := h.processSyncLeftRoom(ctx, roomID, room)
- if err != nil {
- return fmt.Errorf("failed to process left room %s: %w", roomID, err)
- }
- }
- h.Account.NextBatch = resp.NextBatch
- err := h.DB.Account.PutNextBatch(ctx, h.Account.UserID, resp.NextBatch)
- if err != nil {
- return fmt.Errorf("failed to save next_batch: %w", err)
- }
- return nil
-}
-
-func receiptsToList(content *event.ReceiptEventContent) []*database.Receipt {
- receiptList := make([]*database.Receipt, 0)
- for eventID, receipts := range *content {
- for receiptType, users := range receipts {
- for userID, receiptInfo := range users {
- receiptList = append(receiptList, &database.Receipt{
- UserID: userID,
- ReceiptType: receiptType,
- ThreadID: receiptInfo.ThreadID,
- EventID: eventID,
- Timestamp: jsontime.UM(receiptInfo.Timestamp),
- })
- }
- }
- }
- return receiptList
-}
-
-func (h *HiClient) processSyncJoinedRoom(ctx context.Context, roomID id.RoomID, room *mautrix.SyncJoinedRoom) error {
- existingRoomData, err := h.DB.Room.Get(ctx, roomID)
- if err != nil {
- return fmt.Errorf("failed to get room data: %w", err)
- } else if existingRoomData == nil {
- err = h.DB.Room.CreateRow(ctx, roomID)
- if err != nil {
- return fmt.Errorf("failed to ensure room row exists: %w", err)
- }
- existingRoomData = &database.Room{ID: roomID, SortingTimestamp: jsontime.UnixMilliNow()}
- }
-
- for _, evt := range room.AccountData.Events {
- evt.Type.Class = event.AccountDataEventType
- evt.RoomID = roomID
- err = h.DB.AccountData.PutRoom(ctx, h.Account.UserID, roomID, evt.Type, evt.Content.VeryRaw)
- if err != nil {
- return fmt.Errorf("failed to save account data event %s: %w", evt.Type.Type, err)
- }
- }
- err = h.processStateAndTimeline(ctx, existingRoomData, &room.State, &room.Timeline, &room.Summary)
- if err != nil {
- return err
- }
- for _, evt := range room.Ephemeral.Events {
- evt.Type.Class = event.EphemeralEventType
- err = evt.Content.ParseRaw(evt.Type)
- if err != nil && !errors.Is(err, event.ErrContentAlreadyParsed) {
- zerolog.Ctx(ctx).Debug().Err(err).Msg("Failed to parse ephemeral event content")
- continue
- }
- switch evt.Type {
- case event.EphemeralEventReceipt:
- err = h.DB.Receipt.PutMany(ctx, roomID, receiptsToList(evt.Content.AsReceipt())...)
- if err != nil {
- return fmt.Errorf("failed to save receipts: %w", err)
- }
- case event.EphemeralEventTyping:
- go h.EventHandler(&Typing{
- RoomID: roomID,
- TypingEventContent: *evt.Content.AsTyping(),
- })
- }
- if evt.Type != event.EphemeralEventReceipt {
- continue
- }
- }
- return nil
-}
-
-func (h *HiClient) processSyncLeftRoom(ctx context.Context, roomID id.RoomID, room *mautrix.SyncLeftRoom) error {
- existingRoomData, err := h.DB.Room.Get(ctx, roomID)
- if err != nil {
- return fmt.Errorf("failed to get room data: %w", err)
- } else if existingRoomData == nil {
- return nil
- }
- return h.processStateAndTimeline(ctx, existingRoomData, &room.State, &room.Timeline, &room.Summary)
-}
-
-func isDecryptionErrorRetryable(err error) bool {
- return errors.Is(err, crypto.NoSessionFound) || errors.Is(err, olm.UnknownMessageIndex) || errors.Is(err, crypto.ErrGroupSessionWithheld)
-}
-
-func removeReplyFallback(evt *event.Event) []byte {
- if evt.Type != event.EventMessage && evt.Type != event.EventSticker {
- return nil
- }
- _ = evt.Content.ParseRaw(evt.Type)
- content, ok := evt.Content.Parsed.(*event.MessageEventContent)
- if ok && content.RelatesTo.GetReplyTo() != "" {
- prevFormattedBody := content.FormattedBody
- content.RemoveReplyFallback()
- if content.FormattedBody != prevFormattedBody {
- bytes, err := sjson.SetBytes(evt.Content.VeryRaw, "formatted_body", content.FormattedBody)
- bytes, err2 := sjson.SetBytes(bytes, "body", content.Body)
- if err == nil && err2 == nil {
- return bytes
- }
- }
- }
- return nil
-}
-
-func (h *HiClient) decryptEvent(ctx context.Context, evt *event.Event) (*event.Event, []byte, string, error) {
- err := evt.Content.ParseRaw(evt.Type)
- if err != nil && !errors.Is(err, event.ErrContentAlreadyParsed) {
- return nil, nil, "", err
- }
- decrypted, err := h.Crypto.DecryptMegolmEvent(ctx, evt)
- if err != nil {
- return nil, nil, "", err
- }
- withoutFallback := removeReplyFallback(decrypted)
- if withoutFallback != nil {
- return decrypted, withoutFallback, decrypted.Type.Type, nil
- }
- return decrypted, decrypted.Content.VeryRaw, decrypted.Type.Type, nil
-}
-
-func (h *HiClient) addMediaCache(
- ctx context.Context,
- eventRowID database.EventRowID,
- uri id.ContentURIString,
- file *event.EncryptedFileInfo,
- info *event.FileInfo,
- fileName string,
-) {
- parsedMXC := uri.ParseOrIgnore()
- if !parsedMXC.IsValid() {
- return
- }
- cm := &database.CachedMedia{
- MXC: parsedMXC,
- EventRowID: eventRowID,
- FileName: fileName,
- }
- if file != nil {
- cm.EncFile = &file.EncryptedFile
- }
- if info != nil {
- cm.MimeType = info.MimeType
- }
- err := h.DB.CachedMedia.Put(ctx, cm)
- if err != nil {
- zerolog.Ctx(ctx).Warn().Err(err).
- Stringer("mxc", parsedMXC).
- Int64("event_rowid", int64(eventRowID)).
- Msg("Failed to add cached media entry")
- }
-}
-
-func (h *HiClient) cacheMedia(ctx context.Context, evt *event.Event, rowID database.EventRowID) {
- switch evt.Type {
- case event.EventMessage, event.EventSticker:
- content, ok := evt.Content.Parsed.(*event.MessageEventContent)
- if !ok {
- return
- }
- if content.File != nil {
- h.addMediaCache(ctx, rowID, content.File.URL, content.File, content.Info, content.GetFileName())
- } else if content.URL != "" {
- h.addMediaCache(ctx, rowID, content.URL, nil, content.Info, content.GetFileName())
- }
- if content.GetInfo().ThumbnailFile != nil {
- h.addMediaCache(ctx, rowID, content.Info.ThumbnailFile.URL, content.Info.ThumbnailFile, content.Info.ThumbnailInfo, "")
- } else if content.GetInfo().ThumbnailURL != "" {
- h.addMediaCache(ctx, rowID, content.Info.ThumbnailURL, nil, content.Info.ThumbnailInfo, "")
- }
- case event.StateRoomAvatar:
- _ = evt.Content.ParseRaw(evt.Type)
- content, ok := evt.Content.Parsed.(*event.RoomAvatarEventContent)
- if !ok {
- return
- }
- h.addMediaCache(ctx, rowID, content.URL, nil, nil, "")
- case event.StateMember:
- _ = evt.Content.ParseRaw(evt.Type)
- content, ok := evt.Content.Parsed.(*event.MemberEventContent)
- if !ok {
- return
- }
- h.addMediaCache(ctx, rowID, content.AvatarURL, nil, nil, "")
- }
-}
-
-func (h *HiClient) processEvent(ctx context.Context, evt *event.Event, decryptionQueue map[id.SessionID]*database.SessionRequest, checkDB bool) (*database.Event, error) {
- if checkDB {
- dbEvt, err := h.DB.Event.GetByID(ctx, evt.ID)
- if err != nil {
- return nil, fmt.Errorf("failed to check if event %s exists: %w", evt.ID, err)
- } else if dbEvt != nil {
- return dbEvt, nil
- }
- }
- dbEvt := database.MautrixToEvent(evt)
- contentWithoutFallback := removeReplyFallback(evt)
- if contentWithoutFallback != nil {
- dbEvt.Content = contentWithoutFallback
- }
- var decryptionErr error
- var decryptedMautrixEvt *event.Event
- if evt.Type == event.EventEncrypted && dbEvt.RedactedBy == "" {
- decryptedMautrixEvt, dbEvt.Decrypted, dbEvt.DecryptedType, decryptionErr = h.decryptEvent(ctx, evt)
- if decryptionErr != nil {
- dbEvt.DecryptionError = decryptionErr.Error()
- }
- } else if evt.Type == event.EventRedaction {
- if evt.Redacts != "" && gjson.GetBytes(evt.Content.VeryRaw, "redacts").Str != evt.Redacts.String() {
- var err error
- evt.Content.VeryRaw, err = sjson.SetBytes(evt.Content.VeryRaw, "redacts", evt.Redacts)
- if err != nil {
- return dbEvt, fmt.Errorf("failed to set redacts field: %w", err)
- }
- } else if evt.Redacts == "" {
- evt.Redacts = id.EventID(gjson.GetBytes(evt.Content.VeryRaw, "redacts").Str)
- }
- }
- _, err := h.DB.Event.Upsert(ctx, dbEvt)
- if err != nil {
- return dbEvt, fmt.Errorf("failed to save event %s: %w", evt.ID, err)
- }
- if decryptedMautrixEvt != nil {
- h.cacheMedia(ctx, decryptedMautrixEvt, dbEvt.RowID)
- } else {
- h.cacheMedia(ctx, evt, dbEvt.RowID)
- }
- if decryptionErr != nil && isDecryptionErrorRetryable(decryptionErr) {
- req, ok := decryptionQueue[dbEvt.MegolmSessionID]
- if !ok {
- req = &database.SessionRequest{
- RoomID: evt.RoomID,
- SessionID: dbEvt.MegolmSessionID,
- Sender: evt.Sender,
- }
- }
- minIndex, _ := crypto.ParseMegolmMessageIndex(evt.Content.AsEncrypted().MegolmCiphertext)
- req.MinIndex = min(uint32(minIndex), req.MinIndex)
- if decryptionQueue != nil {
- decryptionQueue[dbEvt.MegolmSessionID] = req
- } else {
- err = h.DB.SessionRequest.Put(ctx, req)
- if err != nil {
- zerolog.Ctx(ctx).Err(err).
- Stringer("session_id", dbEvt.MegolmSessionID).
- Msg("Failed to save session request")
- } else {
- h.WakeupRequestQueue()
- }
- }
- }
- return dbEvt, err
-}
-
-func (h *HiClient) processStateAndTimeline(ctx context.Context, room *database.Room, state *mautrix.SyncEventsList, timeline *mautrix.SyncTimeline, summary *mautrix.LazyLoadSummary) error {
- updatedRoom := &database.Room{
- ID: room.ID,
-
- SortingTimestamp: room.SortingTimestamp,
- NameQuality: room.NameQuality,
- }
- heroesChanged := false
- if summary.Heroes == nil && summary.JoinedMemberCount == nil && summary.InvitedMemberCount == nil {
- summary = room.LazyLoadSummary
- } else if room.LazyLoadSummary == nil ||
- !slices.Equal(summary.Heroes, room.LazyLoadSummary.Heroes) ||
- !intPtrEqual(summary.JoinedMemberCount, room.LazyLoadSummary.JoinedMemberCount) ||
- !intPtrEqual(summary.InvitedMemberCount, room.LazyLoadSummary.InvitedMemberCount) {
- updatedRoom.LazyLoadSummary = summary
- heroesChanged = true
- }
- decryptionQueue := make(map[id.SessionID]*database.SessionRequest)
- allNewEvents := make([]*database.Event, 0, len(state.Events)+len(timeline.Events))
- recalculatePreviewEvent := false
- addOldEvent := func(rowID database.EventRowID, evtID id.EventID) (dbEvt *database.Event, err error) {
- if rowID != 0 {
- dbEvt, err = h.DB.Event.GetByRowID(ctx, rowID)
- } else {
- dbEvt, err = h.DB.Event.GetByID(ctx, evtID)
- }
- if err != nil {
- return nil, fmt.Errorf("failed to get redaction target: %w", err)
- } else if dbEvt == nil {
- return nil, nil
- }
- allNewEvents = append(allNewEvents, dbEvt)
- return dbEvt, nil
- }
- processRedaction := func(evt *event.Event) error {
- dbEvt, err := addOldEvent(0, evt.Redacts)
- if err != nil {
- return fmt.Errorf("failed to get redaction target: %w", err)
- }
- if dbEvt == nil {
- return nil
- }
- if dbEvt.RelationType == event.RelReplace || dbEvt.RelationType == event.RelAnnotation {
- _, err = addOldEvent(0, dbEvt.RelatesTo)
- if err != nil {
- return fmt.Errorf("failed to get relation target of redaction target: %w", err)
- }
- }
- if updatedRoom.PreviewEventRowID == dbEvt.RowID {
- updatedRoom.PreviewEventRowID = 0
- recalculatePreviewEvent = true
- }
- return nil
- }
- processNewEvent := func(evt *event.Event, isTimeline bool) (database.EventRowID, error) {
- evt.RoomID = room.ID
- dbEvt, err := h.processEvent(ctx, evt, decryptionQueue, false)
- if err != nil {
- return -1, err
- }
- if isTimeline {
- if dbEvt.CanUseForPreview() {
- updatedRoom.PreviewEventRowID = dbEvt.RowID
- recalculatePreviewEvent = false
- }
- updatedRoom.BumpSortingTimestamp(dbEvt)
- }
- if evt.StateKey != nil {
- var membership event.Membership
- if evt.Type == event.StateMember {
- membership = event.Membership(gjson.GetBytes(evt.Content.VeryRaw, "membership").Str)
- if summary != nil && slices.Contains(summary.Heroes, id.UserID(*evt.StateKey)) {
- heroesChanged = true
- }
- } else if evt.Type == event.StateElementFunctionalMembers {
- heroesChanged = true
- }
- err = h.DB.CurrentState.Set(ctx, room.ID, evt.Type, *evt.StateKey, dbEvt.RowID, membership)
- if err != nil {
- return -1, fmt.Errorf("failed to save current state event ID %s for %s/%s: %w", evt.ID, evt.Type.Type, *evt.StateKey, err)
- }
- processImportantEvent(ctx, evt, room, updatedRoom)
- }
- allNewEvents = append(allNewEvents, dbEvt)
- if evt.Type == event.EventRedaction && evt.Redacts != "" {
- err = processRedaction(evt)
- if err != nil {
- return -1, fmt.Errorf("failed to process redaction: %w", err)
- }
- } else if dbEvt.RelationType == event.RelReplace || dbEvt.RelationType == event.RelAnnotation {
- _, err = addOldEvent(0, dbEvt.RelatesTo)
- if err != nil {
- return -1, fmt.Errorf("failed to get relation target of event: %w", err)
- }
- }
- return dbEvt.RowID, nil
- }
- changedState := make(map[event.Type]map[string]database.EventRowID)
- setNewState := func(evtType event.Type, stateKey string, rowID database.EventRowID) {
- if _, ok := changedState[evtType]; !ok {
- changedState[evtType] = make(map[string]database.EventRowID)
- }
- changedState[evtType][stateKey] = rowID
- }
- for _, evt := range state.Events {
- evt.Type.Class = event.StateEventType
- rowID, err := processNewEvent(evt, false)
- if err != nil {
- return err
- }
- setNewState(evt.Type, *evt.StateKey, rowID)
- }
- var timelineRowTuples []database.TimelineRowTuple
- var err error
- if len(timeline.Events) > 0 {
- timelineIDs := make([]database.EventRowID, len(timeline.Events))
- for i, evt := range timeline.Events {
- if evt.StateKey != nil {
- evt.Type.Class = event.StateEventType
- } else {
- evt.Type.Class = event.MessageEventType
- }
- timelineIDs[i], err = processNewEvent(evt, true)
- if err != nil {
- return err
- }
- if evt.StateKey != nil {
- setNewState(evt.Type, *evt.StateKey, timelineIDs[i])
- }
- }
- for _, entry := range decryptionQueue {
- err = h.DB.SessionRequest.Put(ctx, entry)
- if err != nil {
- return fmt.Errorf("failed to save session request for %s: %w", entry.SessionID, err)
- }
- }
- if len(decryptionQueue) > 0 {
- ctx.Value(syncContextKey).(*syncContext).shouldWakeupRequestQueue = true
- }
- if timeline.Limited {
- err = h.DB.Timeline.Clear(ctx, room.ID)
- if err != nil {
- return fmt.Errorf("failed to clear old timeline: %w", err)
- }
- updatedRoom.PrevBatch = timeline.PrevBatch
- h.paginationInterrupterLock.Lock()
- if interrupt, ok := h.paginationInterrupter[room.ID]; ok {
- interrupt(ErrTimelineReset)
- }
- h.paginationInterrupterLock.Unlock()
- }
- timelineRowTuples, err = h.DB.Timeline.Append(ctx, room.ID, timelineIDs)
- if err != nil {
- return fmt.Errorf("failed to append timeline: %w", err)
- }
- } else {
- timelineRowTuples = make([]database.TimelineRowTuple, 0)
- }
- if recalculatePreviewEvent && updatedRoom.PreviewEventRowID == 0 {
- updatedRoom.PreviewEventRowID, err = h.DB.Room.RecalculatePreview(ctx, room.ID)
- if err != nil {
- return fmt.Errorf("failed to recalculate preview event: %w", err)
- }
- _, err = addOldEvent(updatedRoom.PreviewEventRowID, "")
- if err != nil {
- return fmt.Errorf("failed to get preview event: %w", err)
- }
- }
- // Calculate name from participants if participants changed and current name was generated from participants, or if the room name was unset
- if (heroesChanged && updatedRoom.NameQuality <= database.NameQualityParticipants) || updatedRoom.NameQuality == database.NameQualityNil {
- name, dmAvatarURL, err := h.calculateRoomParticipantName(ctx, room.ID, summary)
- if err != nil {
- return fmt.Errorf("failed to calculate room name: %w", err)
- }
- updatedRoom.Name = &name
- updatedRoom.NameQuality = database.NameQualityParticipants
- if !dmAvatarURL.IsEmpty() && !room.ExplicitAvatar {
- updatedRoom.Avatar = &dmAvatarURL
- }
- }
- if timeline.PrevBatch != "" && (room.PrevBatch == "" || timeline.Limited) {
- updatedRoom.PrevBatch = timeline.PrevBatch
- }
- roomChanged := updatedRoom.CheckChangesAndCopyInto(room)
- if roomChanged {
- err = h.DB.Room.Upsert(ctx, updatedRoom)
- if err != nil {
- return fmt.Errorf("failed to save room data: %w", err)
- }
- }
- if roomChanged || len(timelineRowTuples) > 0 || len(allNewEvents) > 0 {
- ctx.Value(syncContextKey).(*syncContext).evt.Rooms[room.ID] = &SyncRoom{
- Meta: room,
- Timeline: timelineRowTuples,
- State: changedState,
- Reset: timeline.Limited,
- Events: allNewEvents,
- }
- }
- return nil
-}
-
-func joinMemberNames(names []string, totalCount int) string {
- if len(names) == 1 {
- return names[0]
- } else if len(names) < 5 || (len(names) == 5 && totalCount <= 6) {
- return strings.Join(names[:len(names)-1], ", ") + " and " + names[len(names)-1]
- } else {
- return fmt.Sprintf("%s and %d others", strings.Join(names[:4], ", "), totalCount-5)
- }
-}
-
-func (h *HiClient) calculateRoomParticipantName(ctx context.Context, roomID id.RoomID, summary *mautrix.LazyLoadSummary) (string, id.ContentURI, error) {
- var primaryAvatarURL id.ContentURI
- if summary == nil || len(summary.Heroes) == 0 {
- return "Empty room", primaryAvatarURL, nil
- }
- var functionalMembers []id.UserID
- functionalMembersEvt, err := h.DB.CurrentState.Get(ctx, roomID, event.StateElementFunctionalMembers, "")
- if err != nil {
- return "", primaryAvatarURL, fmt.Errorf("failed to get %s event: %w", event.StateElementFunctionalMembers.Type, err)
- } else if functionalMembersEvt != nil {
- mautrixEvt := functionalMembersEvt.AsRawMautrix()
- _ = mautrixEvt.Content.ParseRaw(mautrixEvt.Type)
- content, ok := mautrixEvt.Content.Parsed.(*event.ElementFunctionalMembersContent)
- if ok {
- functionalMembers = content.ServiceMembers
- }
- }
- var members, leftMembers []string
- var memberCount int
- if summary.JoinedMemberCount != nil && *summary.JoinedMemberCount > 0 {
- memberCount = *summary.JoinedMemberCount
- } else if summary.InvitedMemberCount != nil {
- memberCount = *summary.InvitedMemberCount
- }
- for _, hero := range summary.Heroes {
- if slices.Contains(functionalMembers, hero) {
- memberCount--
- continue
- } else if len(members) >= 5 {
- break
- }
- heroEvt, err := h.DB.CurrentState.Get(ctx, roomID, event.StateMember, hero.String())
- if err != nil {
- return "", primaryAvatarURL, fmt.Errorf("failed to get %s's member event: %w", hero, err)
- } else if heroEvt == nil {
- leftMembers = append(leftMembers, hero.String())
- continue
- }
- membership := gjson.GetBytes(heroEvt.Content, "membership").Str
- name := gjson.GetBytes(heroEvt.Content, "displayname").Str
- if name == "" {
- name = hero.String()
- }
- avatarURL := gjson.GetBytes(heroEvt.Content, "avatar_url").Str
- if avatarURL != "" {
- primaryAvatarURL = id.ContentURIString(avatarURL).ParseOrIgnore()
- }
- if membership == "join" || membership == "invite" {
- members = append(members, name)
- } else {
- leftMembers = append(leftMembers, name)
- }
- }
- if len(members)+len(leftMembers) > 1 || !primaryAvatarURL.IsValid() {
- primaryAvatarURL = id.ContentURI{}
- }
- if len(members) > 0 {
- return joinMemberNames(members, memberCount), primaryAvatarURL, nil
- } else if len(leftMembers) > 0 {
- return fmt.Sprintf("Empty room (was %s)", joinMemberNames(leftMembers, memberCount)), primaryAvatarURL, nil
- } else {
- return "Empty room", primaryAvatarURL, nil
- }
-}
-
-func intPtrEqual(a, b *int) bool {
- if a == nil || b == nil {
- return a == b
- }
- return *a == *b
-}
-
-func processImportantEvent(ctx context.Context, evt *event.Event, existingRoomData, updatedRoom *database.Room) (roomDataChanged bool) {
- if evt.StateKey == nil {
- return
- }
- switch evt.Type {
- case event.StateCreate, event.StateRoomName, event.StateCanonicalAlias, event.StateRoomAvatar, event.StateTopic, event.StateEncryption:
- if *evt.StateKey != "" {
- return
- }
- default:
- return
- }
- err := evt.Content.ParseRaw(evt.Type)
- if err != nil && !errors.Is(err, event.ErrContentAlreadyParsed) {
- zerolog.Ctx(ctx).Warn().Err(err).
- Stringer("event_type", &evt.Type).
- Stringer("event_id", evt.ID).
- Msg("Failed to parse state event, skipping")
- return
- }
- switch evt.Type {
- case event.StateCreate:
- updatedRoom.CreationContent, _ = evt.Content.Parsed.(*event.CreateEventContent)
- case event.StateEncryption:
- newEncryption, _ := evt.Content.Parsed.(*event.EncryptionEventContent)
- if existingRoomData.EncryptionEvent == nil || existingRoomData.EncryptionEvent.Algorithm == newEncryption.Algorithm {
- updatedRoom.EncryptionEvent = newEncryption
- }
- case event.StateRoomName:
- content, ok := evt.Content.Parsed.(*event.RoomNameEventContent)
- if ok {
- updatedRoom.Name = &content.Name
- updatedRoom.NameQuality = database.NameQualityExplicit
- if content.Name == "" {
- if updatedRoom.CanonicalAlias != nil && *updatedRoom.CanonicalAlias != "" {
- updatedRoom.Name = (*string)(updatedRoom.CanonicalAlias)
- updatedRoom.NameQuality = database.NameQualityCanonicalAlias
- } else if existingRoomData.CanonicalAlias != nil && *existingRoomData.CanonicalAlias != "" {
- updatedRoom.Name = (*string)(existingRoomData.CanonicalAlias)
- updatedRoom.NameQuality = database.NameQualityCanonicalAlias
- } else {
- updatedRoom.NameQuality = database.NameQualityNil
- }
- }
- }
- case event.StateCanonicalAlias:
- content, ok := evt.Content.Parsed.(*event.CanonicalAliasEventContent)
- if ok {
- updatedRoom.CanonicalAlias = &content.Alias
- if updatedRoom.NameQuality <= database.NameQualityCanonicalAlias {
- updatedRoom.Name = (*string)(&content.Alias)
- updatedRoom.NameQuality = database.NameQualityCanonicalAlias
- if content.Alias == "" {
- updatedRoom.NameQuality = database.NameQualityNil
- }
- }
- }
- case event.StateRoomAvatar:
- content, ok := evt.Content.Parsed.(*event.RoomAvatarEventContent)
- if ok {
- url, _ := content.URL.Parse()
- updatedRoom.Avatar = &url
- updatedRoom.ExplicitAvatar = true
- }
- case event.StateTopic:
- content, ok := evt.Content.Parsed.(*event.TopicEventContent)
- if ok {
- updatedRoom.Topic = &content.Topic
- }
- }
- return
-}
diff --git a/hicli/syncwrap.go b/hicli/syncwrap.go
deleted file mode 100644
index 13837202..00000000
--- a/hicli/syncwrap.go
+++ /dev/null
@@ -1,96 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package hicli
-
-import (
- "context"
- "fmt"
- "time"
-
- "maunium.net/go/mautrix"
- "maunium.net/go/mautrix/id"
-)
-
-type hiSyncer HiClient
-
-var _ mautrix.Syncer = (*hiSyncer)(nil)
-
-type contextKey int
-
-const (
- syncContextKey contextKey = iota
-)
-
-func (h *hiSyncer) ProcessResponse(ctx context.Context, resp *mautrix.RespSync, since string) error {
- c := (*HiClient)(h)
- ctx = context.WithValue(ctx, syncContextKey, &syncContext{evt: &SyncComplete{Rooms: make(map[id.RoomID]*SyncRoom, len(resp.Rooms.Join))}})
- err := c.preProcessSyncResponse(ctx, resp, since)
- if err != nil {
- return err
- }
- err = c.DB.DoTxn(ctx, nil, func(ctx context.Context) error {
- return c.processSyncResponse(ctx, resp, since)
- })
- if err != nil {
- return err
- }
- c.postProcessSyncResponse(ctx, resp, since)
- return nil
-}
-
-func (h *hiSyncer) OnFailedSync(_ *mautrix.RespSync, err error) (time.Duration, error) {
- (*HiClient)(h).Log.Err(err).Msg("Sync failed, retrying in 1 second")
- return 1 * time.Second, nil
-}
-
-func (h *hiSyncer) GetFilterJSON(_ id.UserID) *mautrix.Filter {
- if !h.Verified {
- return &mautrix.Filter{
- Presence: mautrix.FilterPart{
- NotRooms: []id.RoomID{"*"},
- },
- Room: mautrix.RoomFilter{
- NotRooms: []id.RoomID{"*"},
- },
- }
- }
- return &mautrix.Filter{
- Presence: mautrix.FilterPart{
- NotRooms: []id.RoomID{"*"},
- },
- Room: mautrix.RoomFilter{
- State: mautrix.FilterPart{
- LazyLoadMembers: true,
- },
- Timeline: mautrix.FilterPart{
- Limit: 100,
- LazyLoadMembers: true,
- },
- },
- }
-}
-
-type hiStore HiClient
-
-var _ mautrix.SyncStore = (*hiStore)(nil)
-
-// Filter ID save and load are intentionally no-ops: we want to recreate filters when restarting syncing
-
-func (h *hiStore) SaveFilterID(_ context.Context, _ id.UserID, _ string) error { return nil }
-func (h *hiStore) LoadFilterID(_ context.Context, _ id.UserID) (string, error) { return "", nil }
-
-func (h *hiStore) SaveNextBatch(ctx context.Context, userID id.UserID, nextBatchToken string) error {
- // This is intentionally a no-op: we don't want to save the next batch before processing the sync
- return nil
-}
-
-func (h *hiStore) LoadNextBatch(_ context.Context, userID id.UserID) (string, error) {
- if h.Account.UserID != userID {
- return "", fmt.Errorf("mismatching user ID")
- }
- return h.Account.NextBatch, nil
-}
diff --git a/hicli/verify.go b/hicli/verify.go
deleted file mode 100644
index 6dc2a4c3..00000000
--- a/hicli/verify.go
+++ /dev/null
@@ -1,162 +0,0 @@
-// Copyright (c) 2024 Tulir Asokan
-//
-// This Source Code Form is subject to the terms of the Mozilla Public
-// License, v. 2.0. If a copy of the MPL was not distributed with this
-// file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-package hicli
-
-import (
- "context"
- "encoding/base64"
- "fmt"
-
- "github.com/rs/zerolog"
-
- "maunium.net/go/mautrix/crypto"
- "maunium.net/go/mautrix/crypto/backup"
- "maunium.net/go/mautrix/crypto/ssss"
- "maunium.net/go/mautrix/event"
- "maunium.net/go/mautrix/id"
-)
-
-func (h *HiClient) checkIsCurrentDeviceVerified(ctx context.Context) (bool, error) {
- keys := h.Crypto.GetOwnCrossSigningPublicKeys(ctx)
- if keys == nil {
- return false, fmt.Errorf("own cross-signing keys not found")
- }
- isVerified, err := h.Crypto.CryptoStore.IsKeySignedBy(ctx, h.Account.UserID, h.Crypto.GetAccount().SigningKey(), h.Account.UserID, keys.SelfSigningKey)
- if err != nil {
- return false, fmt.Errorf("failed to check if current device is signed by own self-signing key: %w", err)
- }
- return isVerified, nil
-}
-
-func (h *HiClient) fetchKeyBackupKey(ctx context.Context, ssssKey *ssss.Key) error {
- latestVersion, err := h.Client.GetKeyBackupLatestVersion(ctx)
- if err != nil {
- return fmt.Errorf("failed to get key backup latest version: %w", err)
- }
- h.KeyBackupVersion = latestVersion.Version
- data, err := h.Crypto.SSSS.GetDecryptedAccountData(ctx, event.AccountDataMegolmBackupKey, ssssKey)
- if err != nil {
- return fmt.Errorf("failed to get megolm backup key from SSSS: %w", err)
- }
- key, err := backup.MegolmBackupKeyFromBytes(data)
- if err != nil {
- return fmt.Errorf("failed to parse megolm backup key: %w", err)
- }
- err = h.CryptoStore.PutSecret(ctx, id.SecretMegolmBackupV1, base64.StdEncoding.EncodeToString(key.Bytes()))
- if err != nil {
- return fmt.Errorf("failed to store megolm backup key: %w", err)
- }
- h.KeyBackupKey = key
- return nil
-}
-
-func (h *HiClient) getAndDecodeSecret(ctx context.Context, secret id.Secret) ([]byte, error) {
- secretData, err := h.CryptoStore.GetSecret(ctx, secret)
- if err != nil {
- return nil, fmt.Errorf("failed to get secret %s: %w", secret, err)
- }
- data, err := base64.StdEncoding.DecodeString(secretData)
- if err != nil {
- return nil, fmt.Errorf("failed to decode secret %s: %w", secret, err)
- }
- return data, nil
-}
-
-func (h *HiClient) loadPrivateKeys(ctx context.Context) error {
- zerolog.Ctx(ctx).Debug().Msg("Loading cross-signing private keys")
- masterKeySeed, err := h.getAndDecodeSecret(ctx, id.SecretXSMaster)
- if err != nil {
- return fmt.Errorf("failed to get master key: %w", err)
- }
- selfSigningKeySeed, err := h.getAndDecodeSecret(ctx, id.SecretXSSelfSigning)
- if err != nil {
- return fmt.Errorf("failed to get self-signing key: %w", err)
- }
- userSigningKeySeed, err := h.getAndDecodeSecret(ctx, id.SecretXSUserSigning)
- if err != nil {
- return fmt.Errorf("failed to get user signing key: %w", err)
- }
- err = h.Crypto.ImportCrossSigningKeys(crypto.CrossSigningSeeds{
- MasterKey: masterKeySeed,
- SelfSigningKey: selfSigningKeySeed,
- UserSigningKey: userSigningKeySeed,
- })
- if err != nil {
- return fmt.Errorf("failed to import cross-signing private keys: %w", err)
- }
- zerolog.Ctx(ctx).Debug().Msg("Loading key backup key")
- keyBackupKey, err := h.getAndDecodeSecret(ctx, id.SecretMegolmBackupV1)
- if err != nil {
- return fmt.Errorf("failed to get megolm backup key: %w", err)
- }
- h.KeyBackupKey, err = backup.MegolmBackupKeyFromBytes(keyBackupKey)
- if err != nil {
- return fmt.Errorf("failed to parse megolm backup key: %w", err)
- }
- zerolog.Ctx(ctx).Debug().Msg("Fetching key backup version")
- latestVersion, err := h.Client.GetKeyBackupLatestVersion(ctx)
- if err != nil {
- return fmt.Errorf("failed to get key backup latest version: %w", err)
- }
- h.KeyBackupVersion = latestVersion.Version
- zerolog.Ctx(ctx).Debug().Msg("Secrets loaded")
- return nil
-}
-
-func (h *HiClient) storeCrossSigningPrivateKeys(ctx context.Context) error {
- keys := h.Crypto.CrossSigningKeys
- err := h.CryptoStore.PutSecret(ctx, id.SecretXSMaster, base64.StdEncoding.EncodeToString(keys.MasterKey.Seed()))
- if err != nil {
- return err
- }
- err = h.CryptoStore.PutSecret(ctx, id.SecretXSSelfSigning, base64.StdEncoding.EncodeToString(keys.SelfSigningKey.Seed()))
- if err != nil {
- return err
- }
- err = h.CryptoStore.PutSecret(ctx, id.SecretXSUserSigning, base64.StdEncoding.EncodeToString(keys.UserSigningKey.Seed()))
- if err != nil {
- return err
- }
- return nil
-}
-
-func (h *HiClient) VerifyWithRecoveryKey(ctx context.Context, code string) error {
- defer h.dispatchCurrentState()
- keyID, keyData, err := h.Crypto.SSSS.GetDefaultKeyData(ctx)
- if err != nil {
- return fmt.Errorf("failed to get default SSSS key data: %w", err)
- }
- key, err := keyData.VerifyRecoveryKey(keyID, code)
- if err != nil {
- return err
- }
- err = h.Crypto.FetchCrossSigningKeysFromSSSS(ctx, key)
- if err != nil {
- return fmt.Errorf("failed to fetch cross-signing keys from SSSS: %w", err)
- }
- err = h.Crypto.SignOwnDevice(ctx, h.Crypto.OwnIdentity())
- if err != nil {
- return fmt.Errorf("failed to sign own device: %w", err)
- }
- err = h.Crypto.SignOwnMasterKey(ctx)
- if err != nil {
- return fmt.Errorf("failed to sign own master key: %w", err)
- }
- err = h.storeCrossSigningPrivateKeys(ctx)
- if err != nil {
- return fmt.Errorf("failed to store cross-signing private keys: %w", err)
- }
- err = h.fetchKeyBackupKey(ctx, key)
- if err != nil {
- return fmt.Errorf("failed to fetch key backup key: %w", err)
- }
- h.Verified = true
- if !h.IsSyncing() {
- go h.Sync()
- }
- return nil
-}
diff --git a/id/contenturi.go b/id/contenturi.go
index e6a313f5..67127b6c 100644
--- a/id/contenturi.go
+++ b/id/contenturi.go
@@ -17,8 +17,14 @@ import (
)
var (
- InvalidContentURI = errors.New("invalid Matrix content URI")
- InputNotJSONString = errors.New("input doesn't look like a JSON string")
+ ErrInvalidContentURI = errors.New("invalid Matrix content URI")
+ ErrInputNotJSONString = errors.New("input doesn't look like a JSON string")
+)
+
+// Deprecated: use variables prefixed with Err
+var (
+ InvalidContentURI = ErrInvalidContentURI
+ InputNotJSONString = ErrInputNotJSONString
)
// ContentURIString is a string that's expected to be a Matrix content URI.
@@ -55,9 +61,9 @@ func ParseContentURI(uri string) (parsed ContentURI, err error) {
if len(uri) == 0 {
return
} else if !strings.HasPrefix(uri, "mxc://") {
- err = InvalidContentURI
+ err = ErrInvalidContentURI
} else if index := strings.IndexRune(uri[6:], '/'); index == -1 || index == len(uri)-7 {
- err = InvalidContentURI
+ err = ErrInvalidContentURI
} else {
parsed.Homeserver = uri[6 : 6+index]
parsed.FileID = uri[6+index+1:]
@@ -71,9 +77,9 @@ func ParseContentURIBytes(uri []byte) (parsed ContentURI, err error) {
if len(uri) == 0 {
return
} else if !bytes.HasPrefix(uri, mxcBytes) {
- err = InvalidContentURI
+ err = ErrInvalidContentURI
} else if index := bytes.IndexRune(uri[6:], '/'); index == -1 || index == len(uri)-7 {
- err = InvalidContentURI
+ err = ErrInvalidContentURI
} else {
parsed.Homeserver = string(uri[6 : 6+index])
parsed.FileID = string(uri[6+index+1:])
@@ -86,7 +92,7 @@ func (uri *ContentURI) UnmarshalJSON(raw []byte) (err error) {
*uri = ContentURI{}
return nil
} else if len(raw) < 2 || raw[0] != '"' || raw[len(raw)-1] != '"' {
- return InputNotJSONString
+ return fmt.Errorf("ContentURI: %w", ErrInputNotJSONString)
}
parsed, err := ParseContentURIBytes(raw[1 : len(raw)-1])
if err != nil {
diff --git a/id/crypto.go b/id/crypto.go
index 355a84a8..ee857f78 100644
--- a/id/crypto.go
+++ b/id/crypto.go
@@ -53,6 +53,34 @@ const (
KeyBackupAlgorithmMegolmBackupV1 KeyBackupAlgorithm = "m.megolm_backup.v1.curve25519-aes-sha2"
)
+type KeySource string
+
+func (source KeySource) String() string {
+ return string(source)
+}
+
+func (source KeySource) Int() int {
+ switch source {
+ case KeySourceDirect:
+ return 100
+ case KeySourceBackup:
+ return 90
+ case KeySourceImport:
+ return 80
+ case KeySourceForward:
+ return 50
+ default:
+ return 0
+ }
+}
+
+const (
+ KeySourceDirect KeySource = "direct"
+ KeySourceBackup KeySource = "backup"
+ KeySourceImport KeySource = "import"
+ KeySourceForward KeySource = "forward"
+)
+
// BackupVersion is an arbitrary string that identifies a server side key backup.
type KeyBackupVersion string
diff --git a/id/matrixuri.go b/id/matrixuri.go
index acd8e0c0..d5c78bc7 100644
--- a/id/matrixuri.go
+++ b/id/matrixuri.go
@@ -54,7 +54,7 @@ var SigilToPathSegment = map[rune]string{
func (uri *MatrixURI) getQuery() url.Values {
q := make(url.Values)
- if uri.Via != nil && len(uri.Via) > 0 {
+ if len(uri.Via) > 0 {
q["via"] = uri.Via
}
if len(uri.Action) > 0 {
@@ -210,10 +210,14 @@ func ProcessMatrixURI(uri *url.URL) (*MatrixURI, error) {
if len(parts[1]) == 0 {
return nil, ErrEmptySecondSegment
}
- parsed.MXID1 = parts[1]
+ var err error
+ parsed.MXID1, err = url.PathUnescape(parts[1])
+ if err != nil {
+ return nil, fmt.Errorf("failed to url decode second segment %q: %w", parts[1], err)
+ }
// Step 6: if the first part is a room and the URI has 4 segments, construct a second level identifier
- if (parsed.Sigil1 == '!' || parsed.Sigil1 == '#') && len(parts) == 4 {
+ if parsed.Sigil1 == '!' && len(parts) == 4 {
// a: find the sigil from the third segment
switch parts[2] {
case "e", "event":
@@ -226,7 +230,10 @@ func ProcessMatrixURI(uri *url.URL) (*MatrixURI, error) {
if len(parts[3]) == 0 {
return nil, ErrEmptyFourthSegment
}
- parsed.MXID2 = parts[3]
+ parsed.MXID2, err = url.PathUnescape(parts[3])
+ if err != nil {
+ return nil, fmt.Errorf("failed to url decode fourth segment %q: %w", parts[3], err)
+ }
}
// Step 7: parse the query and extract via and action items
diff --git a/id/matrixuri_test.go b/id/matrixuri_test.go
index d26d4bfd..90a0754d 100644
--- a/id/matrixuri_test.go
+++ b/id/matrixuri_test.go
@@ -16,12 +16,11 @@ import (
)
var (
- roomIDLink = id.MatrixURI{Sigil1: '!', MXID1: "7NdBVvkd4aLSbgKt9RXl:example.org"}
- roomIDViaLink = id.MatrixURI{Sigil1: '!', MXID1: "7NdBVvkd4aLSbgKt9RXl:example.org", Via: []string{"maunium.net", "matrix.org"}}
- roomAliasLink = id.MatrixURI{Sigil1: '#', MXID1: "someroom:example.org"}
- roomIDEventLink = id.MatrixURI{Sigil1: '!', MXID1: "7NdBVvkd4aLSbgKt9RXl:example.org", Sigil2: '$', MXID2: "uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s"}
- roomAliasEventLink = id.MatrixURI{Sigil1: '#', MXID1: "someroom:example.org", Sigil2: '$', MXID2: "uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s"}
- userLink = id.MatrixURI{Sigil1: '@', MXID1: "user:example.org"}
+ roomIDLink = id.MatrixURI{Sigil1: '!', MXID1: "7NdBVvkd4aLSbgKt9RXl:example.org"}
+ roomIDViaLink = id.MatrixURI{Sigil1: '!', MXID1: "7NdBVvkd4aLSbgKt9RXl:example.org", Via: []string{"maunium.net", "matrix.org"}}
+ roomAliasLink = id.MatrixURI{Sigil1: '#', MXID1: "someroom:example.org"}
+ roomIDEventLink = id.MatrixURI{Sigil1: '!', MXID1: "7NdBVvkd4aLSbgKt9RXl:example.org", Sigil2: '$', MXID2: "uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s"}
+ userLink = id.MatrixURI{Sigil1: '@', MXID1: "user:example.org"}
escapeRoomIDEventLink = id.MatrixURI{Sigil1: '!', MXID1: "meow & 🐈️:example.org", Sigil2: '$', MXID2: "uOH4C9cK4HhMeFWkUXMbdF/dtndJ0j9je+kIK3XpV1s"}
)
@@ -31,7 +30,6 @@ func TestMatrixURI_MatrixToURL(t *testing.T) {
assert.Equal(t, "https://matrix.to/#/%217NdBVvkd4aLSbgKt9RXl:example.org?via=maunium.net&via=matrix.org", roomIDViaLink.MatrixToURL())
assert.Equal(t, "https://matrix.to/#/%23someroom:example.org", roomAliasLink.MatrixToURL())
assert.Equal(t, "https://matrix.to/#/%217NdBVvkd4aLSbgKt9RXl:example.org/$uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s", roomIDEventLink.MatrixToURL())
- assert.Equal(t, "https://matrix.to/#/%23someroom:example.org/$uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s", roomAliasEventLink.MatrixToURL())
assert.Equal(t, "https://matrix.to/#/@user:example.org", userLink.MatrixToURL())
assert.Equal(t, "https://matrix.to/#/%21meow%20&%20%F0%9F%90%88%EF%B8%8F:example.org/$uOH4C9cK4HhMeFWkUXMbdF%2FdtndJ0j9je+kIK3XpV1s", escapeRoomIDEventLink.MatrixToURL())
}
@@ -41,7 +39,6 @@ func TestMatrixURI_String(t *testing.T) {
assert.Equal(t, "matrix:roomid/7NdBVvkd4aLSbgKt9RXl:example.org?via=maunium.net&via=matrix.org", roomIDViaLink.String())
assert.Equal(t, "matrix:r/someroom:example.org", roomAliasLink.String())
assert.Equal(t, "matrix:roomid/7NdBVvkd4aLSbgKt9RXl:example.org/e/uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s", roomIDEventLink.String())
- assert.Equal(t, "matrix:r/someroom:example.org/e/uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s", roomAliasEventLink.String())
assert.Equal(t, "matrix:u/user:example.org", userLink.String())
assert.Equal(t, "matrix:roomid/meow%20&%20%F0%9F%90%88%EF%B8%8F:example.org/e/uOH4C9cK4HhMeFWkUXMbdF%2FdtndJ0j9je+kIK3XpV1s", escapeRoomIDEventLink.String())
}
@@ -80,8 +77,12 @@ func TestParseMatrixURI_RoomID(t *testing.T) {
parsedVia, err := id.ParseMatrixURI("matrix:roomid/7NdBVvkd4aLSbgKt9RXl:example.org?via=maunium.net&via=matrix.org")
require.NoError(t, err)
require.NotNil(t, parsedVia)
+ parsedEncoded, err := id.ParseMatrixURI("matrix:roomid/7NdBVvkd4aLSbgKt9RXl%3Aexample.org")
+ require.NoError(t, err)
+ require.NotNil(t, parsedEncoded)
assert.Equal(t, roomIDLink, *parsed)
+ assert.Equal(t, roomIDLink, *parsedEncoded)
assert.Equal(t, roomIDViaLink, *parsedVia)
}
@@ -98,19 +99,11 @@ func TestParseMatrixURI_UserID(t *testing.T) {
}
func TestParseMatrixURI_EventID(t *testing.T) {
- parsed1, err := id.ParseMatrixURI("matrix:r/someroom:example.org/e/uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
+ parsed, err := id.ParseMatrixURI("matrix:roomid/7NdBVvkd4aLSbgKt9RXl:example.org/e/uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
require.NoError(t, err)
- require.NotNil(t, parsed1)
- parsed2, err := id.ParseMatrixURI("matrix:room/someroom:example.org/e/uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
- require.NoError(t, err)
- require.NotNil(t, parsed2)
- parsed3, err := id.ParseMatrixURI("matrix:roomid/7NdBVvkd4aLSbgKt9RXl:example.org/e/uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
- require.NoError(t, err)
- require.NotNil(t, parsed3)
+ require.NotNil(t, parsed)
- assert.Equal(t, roomAliasEventLink, *parsed1)
- assert.Equal(t, roomAliasEventLink, *parsed2)
- assert.Equal(t, roomIDEventLink, *parsed3)
+ assert.Equal(t, roomIDEventLink, *parsed)
}
func TestParseMatrixToURL_RoomAlias(t *testing.T) {
@@ -158,21 +151,13 @@ func TestParseMatrixToURL_UserID(t *testing.T) {
}
func TestParseMatrixToURL_EventID(t *testing.T) {
- parsed1, err := id.ParseMatrixToURL("https://matrix.to/#/#someroom:example.org/$uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
+ parsed, err := id.ParseMatrixToURL("https://matrix.to/#/!7NdBVvkd4aLSbgKt9RXl:example.org/$uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
require.NoError(t, err)
- require.NotNil(t, parsed1)
- parsed2, err := id.ParseMatrixToURL("https://matrix.to/#/!7NdBVvkd4aLSbgKt9RXl:example.org/$uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
+ require.NotNil(t, parsed)
+ parsedEncoded, err := id.ParseMatrixToURL("https://matrix.to/#/%217NdBVvkd4aLSbgKt9RXl:example.org/%24uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
require.NoError(t, err)
- require.NotNil(t, parsed2)
- parsed1Encoded, err := id.ParseMatrixToURL("https://matrix.to/#/%23someroom:example.org/%24uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
- require.NoError(t, err)
- require.NotNil(t, parsed1)
- parsed2Encoded, err := id.ParseMatrixToURL("https://matrix.to/#/%217NdBVvkd4aLSbgKt9RXl:example.org/%24uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
- require.NoError(t, err)
- require.NotNil(t, parsed2)
+ require.NotNil(t, parsedEncoded)
- assert.Equal(t, roomAliasEventLink, *parsed1)
- assert.Equal(t, roomAliasEventLink, *parsed1Encoded)
- assert.Equal(t, roomIDEventLink, *parsed2)
- assert.Equal(t, roomIDEventLink, *parsed2Encoded)
+ assert.Equal(t, roomIDEventLink, *parsed)
+ assert.Equal(t, roomIDEventLink, *parsedEncoded)
}
diff --git a/id/opaque.go b/id/opaque.go
index 1d9f0dcf..c1ad4988 100644
--- a/id/opaque.go
+++ b/id/opaque.go
@@ -32,6 +32,9 @@ type EventID string
// https://github.com/matrix-org/matrix-doc/pull/2716
type BatchID string
+// A DelayID is a string identifying a delayed event.
+type DelayID string
+
func (roomID RoomID) String() string {
return string(roomID)
}
diff --git a/id/roomversion.go b/id/roomversion.go
new file mode 100644
index 00000000..578c10bd
--- /dev/null
+++ b/id/roomversion.go
@@ -0,0 +1,265 @@
+// Copyright (c) 2025 Tulir Asokan
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package id
+
+import (
+ "errors"
+ "fmt"
+ "slices"
+)
+
+type RoomVersion string
+
+const (
+ RoomV0 RoomVersion = "" // No room version, used for rooms created before room versions were introduced, equivalent to v1
+ RoomV1 RoomVersion = "1"
+ RoomV2 RoomVersion = "2"
+ RoomV3 RoomVersion = "3"
+ RoomV4 RoomVersion = "4"
+ RoomV5 RoomVersion = "5"
+ RoomV6 RoomVersion = "6"
+ RoomV7 RoomVersion = "7"
+ RoomV8 RoomVersion = "8"
+ RoomV9 RoomVersion = "9"
+ RoomV10 RoomVersion = "10"
+ RoomV11 RoomVersion = "11"
+ RoomV12 RoomVersion = "12"
+)
+
+func (rv RoomVersion) Equals(versions ...RoomVersion) bool {
+ return slices.Contains(versions, rv)
+}
+
+func (rv RoomVersion) NotEquals(versions ...RoomVersion) bool {
+ return !rv.Equals(versions...)
+}
+
+var ErrUnknownRoomVersion = errors.New("unknown room version")
+
+func (rv RoomVersion) unknownVersionError() error {
+ return fmt.Errorf("%w %s", ErrUnknownRoomVersion, rv)
+}
+
+func (rv RoomVersion) IsKnown() bool {
+ switch rv {
+ case RoomV0, RoomV1, RoomV2, RoomV3, RoomV4, RoomV5, RoomV6, RoomV7, RoomV8, RoomV9, RoomV10, RoomV11, RoomV12:
+ return true
+ default:
+ return false
+ }
+}
+
+type StateResVersion int
+
+const (
+ // StateResV1 is the original state resolution algorithm.
+ StateResV1 StateResVersion = 0
+ // StateResV2 is state resolution v2 introduced by https://github.com/matrix-org/matrix-spec-proposals/pull/1759
+ StateResV2 StateResVersion = 1
+ // StateResV2_1 is state resolution v2.1 introduced by https://github.com/matrix-org/matrix-spec-proposals/pull/4297
+ StateResV2_1 StateResVersion = 2
+)
+
+// StateResVersion returns the version of the state resolution algorithm used by this room version.
+func (rv RoomVersion) StateResVersion() StateResVersion {
+ switch rv {
+ case RoomV0, RoomV1:
+ return StateResV1
+ case RoomV2, RoomV3, RoomV4, RoomV5, RoomV6, RoomV7, RoomV8, RoomV9, RoomV10, RoomV11:
+ return StateResV2
+ case RoomV12:
+ return StateResV2_1
+ default:
+ panic(rv.unknownVersionError())
+ }
+}
+
+type EventIDFormat int
+
+const (
+ // EventIDFormatCustom is the original format used by room v1 and v2.
+ // Event IDs in this format are an arbitrary string followed by a colon and the server name.
+ EventIDFormatCustom EventIDFormat = 0
+ // EventIDFormatBase64 is the format used by room v3 introduced by https://github.com/matrix-org/matrix-spec-proposals/pull/1659.
+ // Event IDs in this format are the standard unpadded base64-encoded SHA256 reference hash of the event.
+ EventIDFormatBase64 EventIDFormat = 1
+ // EventIDFormatURLSafeBase64 is the format used by room v4 and later introduced by https://github.com/matrix-org/matrix-spec-proposals/pull/2002.
+ // Event IDs in this format are the url-safe unpadded base64-encoded SHA256 reference hash of the event.
+ EventIDFormatURLSafeBase64 EventIDFormat = 2
+)
+
+// EventIDFormat returns the format of event IDs used by this room version.
+func (rv RoomVersion) EventIDFormat() EventIDFormat {
+ switch rv {
+ case RoomV0, RoomV1, RoomV2:
+ return EventIDFormatCustom
+ case RoomV3:
+ return EventIDFormatBase64
+ default:
+ return EventIDFormatURLSafeBase64
+ }
+}
+
+/////////////////////
+// Room v5 changes //
+/////////////////////
+// https://github.com/matrix-org/matrix-spec-proposals/pull/2077
+
+// EnforceSigningKeyValidity returns true if the `valid_until_ts` field of federation signing keys
+// must be enforced on received events.
+//
+// See https://github.com/matrix-org/matrix-spec-proposals/pull/2076
+func (rv RoomVersion) EnforceSigningKeyValidity() bool {
+ return rv.NotEquals(RoomV0, RoomV1, RoomV2, RoomV3, RoomV4)
+}
+
+/////////////////////
+// Room v6 changes //
+/////////////////////
+// https://github.com/matrix-org/matrix-spec-proposals/pull/2240
+
+// SpecialCasedAliasesAuth returns true if the `m.room.aliases` event authorization is special cased
+// to only always allow servers to modify the state event with their own server name as state key.
+// This also implies that the `aliases` field is protected from redactions.
+//
+// See https://github.com/matrix-org/matrix-spec-proposals/pull/2432
+func (rv RoomVersion) SpecialCasedAliasesAuth() bool {
+ return rv.Equals(RoomV0, RoomV1, RoomV2, RoomV3, RoomV4, RoomV5)
+}
+
+// ForbidFloatsAndBigInts returns true if floats and integers greater than 2^53-1 or lower than -2^53+1 are forbidden everywhere.
+//
+// See https://github.com/matrix-org/matrix-spec-proposals/pull/2540
+func (rv RoomVersion) ForbidFloatsAndBigInts() bool {
+ return rv.NotEquals(RoomV0, RoomV1, RoomV2, RoomV3, RoomV4, RoomV5)
+}
+
+// NotificationsPowerLevels returns true if the `notifications` field in `m.room.power_levels` is validated in event auth.
+// However, the field is not protected from redactions.
+//
+// See https://github.com/matrix-org/matrix-spec-proposals/pull/2209
+func (rv RoomVersion) NotificationsPowerLevels() bool {
+ return rv.NotEquals(RoomV0, RoomV1, RoomV2, RoomV3, RoomV4, RoomV5)
+}
+
+/////////////////////
+// Room v7 changes //
+/////////////////////
+// https://github.com/matrix-org/matrix-spec-proposals/pull/2998
+
+// Knocks returns true if the `knock` join rule is supported.
+//
+// See https://github.com/matrix-org/matrix-spec-proposals/pull/2403
+func (rv RoomVersion) Knocks() bool {
+ return rv.NotEquals(RoomV0, RoomV1, RoomV2, RoomV3, RoomV4, RoomV5, RoomV6)
+}
+
+/////////////////////
+// Room v8 changes //
+/////////////////////
+// https://github.com/matrix-org/matrix-spec-proposals/pull/3289
+
+// RestrictedJoins returns true if the `restricted` join rule is supported.
+// This also implies that the `allow` field in the `m.room.join_rules` event is supported and protected from redactions.
+//
+// See https://github.com/matrix-org/matrix-spec-proposals/pull/3083
+func (rv RoomVersion) RestrictedJoins() bool {
+ return rv.NotEquals(RoomV0, RoomV1, RoomV2, RoomV3, RoomV4, RoomV5, RoomV6, RoomV7)
+}
+
+/////////////////////
+// Room v9 changes //
+/////////////////////
+// https://github.com/matrix-org/matrix-spec-proposals/pull/3375
+
+// RestrictedJoinsFix returns true if the `join_authorised_via_users_server` field in `m.room.member` events is protected from redactions.
+//
+// See https://github.com/matrix-org/matrix-spec-proposals/pull/3375
+func (rv RoomVersion) RestrictedJoinsFix() bool {
+ return rv.RestrictedJoins() && rv != RoomV8
+}
+
+//////////////////////
+// Room v10 changes //
+//////////////////////
+// https://github.com/matrix-org/matrix-spec-proposals/pull/3604
+
+// ValidatePowerLevelInts returns true if the known values in `m.room.power_levels` must be integers (and not strings).
+//
+// See https://github.com/matrix-org/matrix-spec-proposals/pull/3667
+func (rv RoomVersion) ValidatePowerLevelInts() bool {
+ return rv.NotEquals(RoomV0, RoomV1, RoomV2, RoomV3, RoomV4, RoomV5, RoomV6, RoomV7, RoomV8, RoomV9)
+}
+
+// KnockRestricted returns true if the `knock_restricted` join rule is supported.
+//
+// See https://github.com/matrix-org/matrix-spec-proposals/pull/3787
+func (rv RoomVersion) KnockRestricted() bool {
+ return rv.NotEquals(RoomV0, RoomV1, RoomV2, RoomV3, RoomV4, RoomV5, RoomV6, RoomV7, RoomV8, RoomV9)
+}
+
+//////////////////////
+// Room v11 changes //
+//////////////////////
+// https://github.com/matrix-org/matrix-spec-proposals/pull/3820
+
+// CreatorInContent returns true if the `m.room.create` event has a `creator` field in content.
+//
+// See https://github.com/matrix-org/matrix-spec-proposals/pull/2175
+func (rv RoomVersion) CreatorInContent() bool {
+ return rv.Equals(RoomV0, RoomV1, RoomV2, RoomV3, RoomV4, RoomV5, RoomV6, RoomV7, RoomV8, RoomV9, RoomV10)
+}
+
+// RedactsInContent returns true if the `m.room.redaction` event has the `redacts` field in content instead of at the top level.
+// The redaction protection is also moved from the top level to the content field.
+//
+// See https://github.com/matrix-org/matrix-spec-proposals/pull/2174
+// (and https://github.com/matrix-org/matrix-spec-proposals/pull/2176 for the redaction protection).
+func (rv RoomVersion) RedactsInContent() bool {
+ return rv.NotEquals(RoomV0, RoomV1, RoomV2, RoomV3, RoomV4, RoomV5, RoomV6, RoomV7, RoomV8, RoomV9, RoomV10)
+}
+
+// UpdatedRedactionRules returns true if various updates to the redaction algorithm are applied.
+//
+// Specifically:
+//
+// * the `membership`, `origin`, and `prev_state` fields at the top level of all events are no longer protected.
+// * the entire content of `m.room.create` is protected.
+// * the `redacts` field in `m.room.redaction` content is protected instead of the top-level field.
+// * the `m.room.power_levels` event protects the `invite` field in content.
+// * the `signed` field inside the `third_party_invite` field in content of `m.room.member` events is protected.
+//
+// See https://github.com/matrix-org/matrix-spec-proposals/pull/2176,
+// https://github.com/matrix-org/matrix-spec-proposals/pull/3821, and
+// https://github.com/matrix-org/matrix-spec-proposals/pull/3989
+func (rv RoomVersion) UpdatedRedactionRules() bool {
+ return rv.NotEquals(RoomV0, RoomV1, RoomV2, RoomV3, RoomV4, RoomV5, RoomV6, RoomV7, RoomV8, RoomV9, RoomV10)
+}
+
+//////////////////////
+// Room v12 changes //
+//////////////////////
+// https://github.com/matrix-org/matrix-spec-proposals/pull/4304
+
+// Return value of StateResVersion was changed to StateResV2_1
+
+// PrivilegedRoomCreators returns true if the creator(s) of a room always have infinite power level.
+// This also implies that the `m.room.create` event has an `additional_creators` field,
+// and that the creators can't be present in the `m.room.power_levels` event.
+//
+// See https://github.com/matrix-org/matrix-spec-proposals/pull/4289
+func (rv RoomVersion) PrivilegedRoomCreators() bool {
+ return rv.NotEquals(RoomV0, RoomV1, RoomV2, RoomV3, RoomV4, RoomV5, RoomV6, RoomV7, RoomV8, RoomV9, RoomV10, RoomV11)
+}
+
+// RoomIDIsCreateEventID returns true if the ID of rooms is the same as the ID of the `m.room.create` event.
+// This also implies that `m.room.create` events do not have a `room_id` field.
+//
+// See https://github.com/matrix-org/matrix-spec-proposals/pull/4291
+func (rv RoomVersion) RoomIDIsCreateEventID() bool {
+ return rv.NotEquals(RoomV0, RoomV1, RoomV2, RoomV3, RoomV4, RoomV5, RoomV6, RoomV7, RoomV8, RoomV9, RoomV10, RoomV11)
+}
diff --git a/id/servername.go b/id/servername.go
new file mode 100644
index 00000000..923705b6
--- /dev/null
+++ b/id/servername.go
@@ -0,0 +1,58 @@
+// Copyright (c) 2025 Tulir Asokan
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package id
+
+import (
+ "regexp"
+ "strconv"
+)
+
+type ParsedServerNameType int
+
+const (
+ ServerNameDNS ParsedServerNameType = iota
+ ServerNameIPv4
+ ServerNameIPv6
+)
+
+type ParsedServerName struct {
+ Type ParsedServerNameType
+ Host string
+ Port int
+}
+
+var ServerNameRegex = regexp.MustCompile(`^(?:\[([0-9A-Fa-f:.]{2,45})]|(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})|([0-9A-Za-z.-]{1,255}))(?::(\d{1,5}))?$`)
+
+func ValidateServerName(serverName string) bool {
+ return len(serverName) <= 255 && len(serverName) > 0 && ServerNameRegex.MatchString(serverName)
+}
+
+func ParseServerName(serverName string) *ParsedServerName {
+ if len(serverName) > 255 || len(serverName) < 1 {
+ return nil
+ }
+ match := ServerNameRegex.FindStringSubmatch(serverName)
+ if len(match) != 5 {
+ return nil
+ }
+ port, _ := strconv.Atoi(match[4])
+ parsed := &ParsedServerName{
+ Port: port,
+ }
+ switch {
+ case match[1] != "":
+ parsed.Type = ServerNameIPv6
+ parsed.Host = match[1]
+ case match[2] != "":
+ parsed.Type = ServerNameIPv4
+ parsed.Host = match[2]
+ case match[3] != "":
+ parsed.Type = ServerNameDNS
+ parsed.Host = match[3]
+ }
+ return parsed
+}
diff --git a/id/trust.go b/id/trust.go
index 04f6e36b..6255093e 100644
--- a/id/trust.go
+++ b/id/trust.go
@@ -16,6 +16,7 @@ type TrustState int
const (
TrustStateBlacklisted TrustState = -100
+ TrustStateDeviceKeyMismatch TrustState = -5
TrustStateUnset TrustState = 0
TrustStateUnknownDevice TrustState = 10
TrustStateForwarded TrustState = 20
@@ -23,7 +24,7 @@ const (
TrustStateCrossSignedTOFU TrustState = 100
TrustStateCrossSignedVerified TrustState = 200
TrustStateVerified TrustState = 300
- TrustStateInvalid TrustState = (1 << 31) - 1
+ TrustStateInvalid TrustState = -2147483647
)
func (ts *TrustState) UnmarshalText(data []byte) error {
@@ -44,6 +45,8 @@ func ParseTrustState(val string) TrustState {
switch strings.ToLower(val) {
case "blacklisted":
return TrustStateBlacklisted
+ case "device-key-mismatch":
+ return TrustStateDeviceKeyMismatch
case "unverified":
return TrustStateUnset
case "cross-signed-untrusted":
@@ -67,6 +70,8 @@ func (ts TrustState) String() string {
switch ts {
case TrustStateBlacklisted:
return "blacklisted"
+ case TrustStateDeviceKeyMismatch:
+ return "device-key-mismatch"
case TrustStateUnset:
return "unverified"
case TrustStateCrossSignedUntrusted:
diff --git a/id/userid.go b/id/userid.go
index 1e1f3b29..726a0d58 100644
--- a/id/userid.go
+++ b/id/userid.go
@@ -30,10 +30,11 @@ func NewEncodedUserID(localpart, homeserver string) UserID {
}
var (
- ErrInvalidUserID = errors.New("is not a valid user ID")
- ErrNoncompliantLocalpart = errors.New("contains characters that are not allowed")
- ErrUserIDTooLong = errors.New("the given user ID is longer than 255 characters")
- ErrEmptyLocalpart = errors.New("empty localparts are not allowed")
+ ErrInvalidUserID = errors.New("is not a valid user ID")
+ ErrNoncompliantLocalpart = errors.New("contains characters that are not allowed")
+ ErrUserIDTooLong = errors.New("the given user ID is longer than 255 characters")
+ ErrEmptyLocalpart = errors.New("empty localparts are not allowed")
+ ErrNoncompliantServerPart = errors.New("is not a valid server name")
)
// ParseCommonIdentifier parses a common identifier according to https://spec.matrix.org/v1.9/appendices/#common-identifier-format
@@ -43,10 +44,10 @@ func ParseCommonIdentifier[Stringish ~string](identifier Stringish) (sigil byte,
}
sigil = identifier[0]
strIdentifier := string(identifier)
- if strings.ContainsRune(strIdentifier, ':') {
- parts := strings.SplitN(strIdentifier, ":", 2)
- localpart = parts[0][1:]
- homeserver = parts[1]
+ colonIdx := strings.IndexByte(strIdentifier, ':')
+ if colonIdx > 0 {
+ localpart = strIdentifier[1:colonIdx]
+ homeserver = strIdentifier[colonIdx+1:]
} else {
localpart = strIdentifier[1:]
}
@@ -103,21 +104,32 @@ func ValidateUserLocalpart(localpart string) error {
return nil
}
-// ParseAndValidate parses the user ID into the localpart and server name like Parse,
-// and also validates that the localpart is allowed according to the user identifiers spec.
-func (userID UserID) ParseAndValidate() (localpart, homeserver string, err error) {
- localpart, homeserver, err = userID.Parse()
+// ParseAndValidateStrict is a stricter version of ParseAndValidateRelaxed that checks the localpart to only allow non-historical localparts.
+// This should be used with care: there are real users still using historical localparts.
+func (userID UserID) ParseAndValidateStrict() (localpart, homeserver string, err error) {
+ localpart, homeserver, err = userID.ParseAndValidateRelaxed()
if err == nil {
err = ValidateUserLocalpart(localpart)
}
- if err == nil && len(userID) > UserIDMaxLength {
+ return
+}
+
+// ParseAndValidateRelaxed parses the user ID into the localpart and server name like Parse,
+// and also validates that the user ID is not too long and that the server name is valid.
+func (userID UserID) ParseAndValidateRelaxed() (localpart, homeserver string, err error) {
+ if len(userID) > UserIDMaxLength {
err = ErrUserIDTooLong
+ return
+ }
+ localpart, homeserver, err = userID.Parse()
+ if err == nil && !ValidateServerName(homeserver) {
+ err = fmt.Errorf("%q %q", homeserver, ErrNoncompliantServerPart)
}
return
}
func (userID UserID) ParseAndDecode() (localpart, homeserver string, err error) {
- localpart, homeserver, err = userID.ParseAndValidate()
+ localpart, homeserver, err = userID.ParseAndValidateStrict()
if err == nil {
localpart, err = DecodeUserLocalpart(localpart)
}
@@ -207,15 +219,15 @@ func DecodeUserLocalpart(str string) (string, error) {
for i := 0; i < len(strBytes); i++ {
b := strBytes[i]
if !isValidByte(b) {
- return "", fmt.Errorf("Byte pos %d: Invalid byte", i)
+ return "", fmt.Errorf("invalid encoded byte at position %d: %c", i, b)
}
if b == '_' { // next byte is a-z and should be upper-case or is another _ and should be a literal _
if i+1 >= len(strBytes) {
- return "", fmt.Errorf("Byte pos %d: expected _[a-z_] encoding but ran out of string", i)
+ return "", fmt.Errorf("unexpected end of string after underscore at %d", i)
}
if !isValidEscapedChar(strBytes[i+1]) { // invalid escaping
- return "", fmt.Errorf("Byte pos %d: expected _[a-z_] encoding", i)
+ return "", fmt.Errorf("unexpected byte %c after underscore at %d", strBytes[i+1], i)
}
if strBytes[i+1] == '_' {
outputBuffer.WriteByte('_')
@@ -225,7 +237,7 @@ func DecodeUserLocalpart(str string) (string, error) {
i++ // skip next byte since we just handled it
} else if b == '=' { // next 2 bytes are hex and should be buffered ready to be read as utf8
if i+2 >= len(strBytes) {
- return "", fmt.Errorf("Byte pos: %d: expected quote-printable encoding but ran out of string", i)
+ return "", fmt.Errorf("unexpected end of string after equals sign at %d", i)
}
dst := make([]byte, 1)
_, err := hex.Decode(dst, strBytes[i+1:i+3])
diff --git a/id/userid_test.go b/id/userid_test.go
index 359bc687..57a88066 100644
--- a/id/userid_test.go
+++ b/id/userid_test.go
@@ -38,30 +38,30 @@ func TestUserID_Parse_Invalid(t *testing.T) {
assert.True(t, errors.Is(err, id.ErrInvalidUserID))
}
-func TestUserID_ParseAndValidate_Invalid(t *testing.T) {
+func TestUserID_ParseAndValidateStrict_Invalid(t *testing.T) {
const inputUserID = "@s p a c e:maunium.net"
- _, _, err := id.UserID(inputUserID).ParseAndValidate()
+ _, _, err := id.UserID(inputUserID).ParseAndValidateStrict()
assert.Error(t, err)
assert.True(t, errors.Is(err, id.ErrNoncompliantLocalpart))
}
-func TestUserID_ParseAndValidate_Empty(t *testing.T) {
+func TestUserID_ParseAndValidateStrict_Empty(t *testing.T) {
const inputUserID = "@:ponies.im"
- _, _, err := id.UserID(inputUserID).ParseAndValidate()
+ _, _, err := id.UserID(inputUserID).ParseAndValidateStrict()
assert.Error(t, err)
assert.True(t, errors.Is(err, id.ErrEmptyLocalpart))
}
-func TestUserID_ParseAndValidate_Long(t *testing.T) {
+func TestUserID_ParseAndValidateStrict_Long(t *testing.T) {
const inputUserID = "@aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa:example.com"
- _, _, err := id.UserID(inputUserID).ParseAndValidate()
+ _, _, err := id.UserID(inputUserID).ParseAndValidateStrict()
assert.Error(t, err)
assert.True(t, errors.Is(err, id.ErrUserIDTooLong))
}
-func TestUserID_ParseAndValidate_NotLong(t *testing.T) {
+func TestUserID_ParseAndValidateStrict_NotLong(t *testing.T) {
const inputUserID = "@aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa:example.com"
- _, _, err := id.UserID(inputUserID).ParseAndValidate()
+ _, _, err := id.UserID(inputUserID).ParseAndValidateStrict()
assert.NoError(t, err)
}
@@ -70,7 +70,7 @@ func TestUserIDEncoding(t *testing.T) {
const encodedLocalpart = "_this=20local+part=20contains=20_il_le_ga_l=20ch=c3=a4racters=20=f0=9f=9a=a8"
const inputServerName = "example.com"
userID := id.NewEncodedUserID(inputLocalpart, inputServerName)
- parsedLocalpart, parsedServerName, err := userID.ParseAndValidate()
+ parsedLocalpart, parsedServerName, err := userID.ParseAndValidateStrict()
assert.NoError(t, err)
assert.Equal(t, encodedLocalpart, parsedLocalpart)
assert.Equal(t, inputServerName, parsedServerName)
diff --git a/mediaproxy/mediaproxy.go b/mediaproxy/mediaproxy.go
index f2591428..4d2bc7cf 100644
--- a/mediaproxy/mediaproxy.go
+++ b/mediaproxy/mediaproxy.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2024 Tulir Asokan
+// Copyright (c) 2025 Tulir Asokan
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -8,51 +8,107 @@ package mediaproxy
import (
"context"
- "encoding/json"
"errors"
"fmt"
"io"
"mime"
"mime/multipart"
- "net"
"net/http"
"net/textproto"
+ "net/url"
+ "os"
"strconv"
"strings"
"time"
- "github.com/gorilla/mux"
"github.com/rs/zerolog"
+ "github.com/rs/zerolog/hlog"
+ "go.mau.fi/util/exerrors"
+ "go.mau.fi/util/exhttp"
+ "go.mau.fi/util/ptr"
+ "go.mau.fi/util/requestlog"
"maunium.net/go/mautrix"
"maunium.net/go/mautrix/federation"
+ "maunium.net/go/mautrix/id"
)
type GetMediaResponse interface {
isGetMediaResponse()
}
-func (*GetMediaResponseURL) isGetMediaResponse() {}
-func (*GetMediaResponseData) isGetMediaResponse() {}
+func (*GetMediaResponseURL) isGetMediaResponse() {}
+func (*GetMediaResponseData) isGetMediaResponse() {}
+func (*GetMediaResponseCallback) isGetMediaResponse() {}
+func (*GetMediaResponseFile) isGetMediaResponse() {}
type GetMediaResponseURL struct {
URL string
ExpiresAt time.Time
}
+type GetMediaResponseWriter interface {
+ GetMediaResponse
+ io.WriterTo
+ GetContentType() string
+ GetContentLength() int64
+}
+
+var (
+ _ GetMediaResponseWriter = (*GetMediaResponseCallback)(nil)
+ _ GetMediaResponseWriter = (*GetMediaResponseData)(nil)
+)
+
type GetMediaResponseData struct {
Reader io.ReadCloser
ContentType string
ContentLength int64
}
-type GetMediaFunc = func(ctx context.Context, mediaID string) (response GetMediaResponse, err error)
+func (d *GetMediaResponseData) WriteTo(w io.Writer) (int64, error) {
+ return io.Copy(w, d.Reader)
+}
+
+func (d *GetMediaResponseData) GetContentType() string {
+ return d.ContentType
+}
+
+func (d *GetMediaResponseData) GetContentLength() int64 {
+ return d.ContentLength
+}
+
+type GetMediaResponseCallback struct {
+ Callback func(w io.Writer) (int64, error)
+ ContentType string
+ ContentLength int64
+}
+
+func (d *GetMediaResponseCallback) WriteTo(w io.Writer) (int64, error) {
+ return d.Callback(w)
+}
+
+func (d *GetMediaResponseCallback) GetContentLength() int64 {
+ return d.ContentLength
+}
+
+func (d *GetMediaResponseCallback) GetContentType() string {
+ return d.ContentType
+}
+
+type FileMeta struct {
+ ContentType string
+ ReplacementFile string
+}
+
+type GetMediaResponseFile struct {
+ Callback func(w *os.File) (*FileMeta, error)
+}
+
+type GetMediaFunc = func(ctx context.Context, mediaID string, params map[string]string) (response GetMediaResponse, err error)
type MediaProxy struct {
- KeyServer *federation.KeyServer
- ProxyClient *http.Client
-
- ForceProxyLegacyFederation bool
+ KeyServer *federation.KeyServer
+ ServerAuth *federation.ServerAuth
GetMedia GetMediaFunc
PrepareProxyRequest func(*http.Request)
@@ -60,9 +116,8 @@ type MediaProxy struct {
serverName string
serverKey *federation.SigningKey
- FederationRouter *mux.Router
- LegacyMediaRouter *mux.Router
- ClientMediaRouter *mux.Router
+ FederationRouter *http.ServeMux
+ ClientMediaRouter *http.ServeMux
}
func New(serverName string, serverKey string, getMedia GetMediaFunc) (*MediaProxy, error) {
@@ -70,18 +125,10 @@ func New(serverName string, serverKey string, getMedia GetMediaFunc) (*MediaProx
if err != nil {
return nil, err
}
- return &MediaProxy{
+ mp := &MediaProxy{
serverName: serverName,
serverKey: parsed,
GetMedia: getMedia,
- ProxyClient: &http.Client{
- Transport: &http.Transport{
- DialContext: (&net.Dialer{Timeout: 10 * time.Second}).DialContext,
- TLSHandshakeTimeout: 10 * time.Second,
- ForceAttemptHTTP2: false,
- },
- Timeout: 60 * time.Second,
- },
KeyServer: &federation.KeyServer{
KeyProvider: &federation.StaticServerKey{
ServerName: serverName,
@@ -93,13 +140,27 @@ func New(serverName string, serverKey string, getMedia GetMediaFunc) (*MediaProx
Version: strings.TrimPrefix(mautrix.VersionWithCommit, "v"),
},
},
- }, nil
+ }
+ mp.FederationRouter = http.NewServeMux()
+ mp.FederationRouter.HandleFunc("GET /v1/media/download/{mediaID}", mp.DownloadMediaFederation)
+ mp.FederationRouter.HandleFunc("GET /v1/media/thumbnail/{mediaID}", mp.DownloadMediaFederation)
+ mp.FederationRouter.HandleFunc("GET /v1/version", mp.KeyServer.GetServerVersion)
+ mp.ClientMediaRouter = http.NewServeMux()
+ mp.ClientMediaRouter.HandleFunc("GET /download/{serverName}/{mediaID}", mp.DownloadMedia)
+ mp.ClientMediaRouter.HandleFunc("GET /download/{serverName}/{mediaID}/{fileName}", mp.DownloadMedia)
+ mp.ClientMediaRouter.HandleFunc("GET /thumbnail/{serverName}/{mediaID}", mp.DownloadMedia)
+ mp.ClientMediaRouter.HandleFunc("PUT /upload/{serverName}/{mediaID}", mp.UploadNotSupported)
+ mp.ClientMediaRouter.HandleFunc("POST /upload", mp.UploadNotSupported)
+ mp.ClientMediaRouter.HandleFunc("POST /create", mp.UploadNotSupported)
+ mp.ClientMediaRouter.HandleFunc("GET /config", mp.UploadNotSupported)
+ mp.ClientMediaRouter.HandleFunc("GET /preview_url", mp.PreviewURLNotSupported)
+ return mp, nil
}
type BasicConfig struct {
ServerName string `yaml:"server_name" json:"server_name"`
ServerKey string `yaml:"server_key" json:"server_key"`
- AllowProxy bool `yaml:"allow_proxy" json:"allow_proxy"`
+ FederationAuth bool `yaml:"federation_auth" json:"federation_auth"`
WellKnownResponse string `yaml:"well_known_response" json:"well_known_response"`
}
@@ -108,12 +169,12 @@ func NewFromConfig(cfg BasicConfig, getMedia GetMediaFunc) (*MediaProxy, error)
if err != nil {
return nil, err
}
- if !cfg.AllowProxy {
- mp.DisallowProxying()
- }
if cfg.WellKnownResponse != "" {
mp.KeyServer.WellKnownTarget = cfg.WellKnownResponse
}
+ if cfg.FederationAuth {
+ mp.EnableServerAuth(nil, nil)
+ }
return mp, nil
}
@@ -123,8 +184,8 @@ type ServerConfig struct {
}
func (mp *MediaProxy) Listen(cfg ServerConfig) error {
- router := mux.NewRouter()
- mp.RegisterRoutes(router)
+ router := http.NewServeMux()
+ mp.RegisterRoutes(router, zerolog.Nop())
return http.ListenAndServe(fmt.Sprintf("%s:%d", cfg.Hostname, cfg.Port), router)
}
@@ -136,99 +197,183 @@ func (mp *MediaProxy) GetServerKey() *federation.SigningKey {
return mp.serverKey
}
-func (mp *MediaProxy) DisallowProxying() {
- mp.ProxyClient = nil
+func (mp *MediaProxy) EnableServerAuth(client *federation.Client, keyCache federation.KeyCache) {
+ if keyCache == nil {
+ keyCache = federation.NewInMemoryCache()
+ }
+ if client == nil {
+ resCache, _ := keyCache.(federation.ResolutionCache)
+ client = federation.NewClient(mp.serverName, mp.serverKey, resCache)
+ }
+ mp.ServerAuth = federation.NewServerAuth(client, keyCache, func(auth federation.XMatrixAuth) string {
+ return mp.GetServerName()
+ })
}
-func (mp *MediaProxy) RegisterRoutes(router *mux.Router) {
- if mp.FederationRouter == nil {
- mp.FederationRouter = router.PathPrefix("/_matrix/federation").Subrouter()
+func (mp *MediaProxy) RegisterRoutes(router *http.ServeMux, log zerolog.Logger) {
+ errorBodies := exhttp.ErrorBodies{
+ NotFound: exerrors.Must(ptr.Ptr(mautrix.MUnrecognized.WithMessage("Unrecognized endpoint")).MarshalJSON()),
+ MethodNotAllowed: exerrors.Must(ptr.Ptr(mautrix.MUnrecognized.WithMessage("Invalid method for endpoint")).MarshalJSON()),
}
- if mp.LegacyMediaRouter == nil {
- mp.LegacyMediaRouter = router.PathPrefix("/_matrix/media").Subrouter()
- }
- if mp.ClientMediaRouter == nil {
- mp.ClientMediaRouter = router.PathPrefix("/_matrix/client/v1/media").Subrouter()
- }
-
- mp.FederationRouter.HandleFunc("/v1/media/download/{mediaID}", mp.DownloadMediaFederation).Methods(http.MethodGet)
- mp.FederationRouter.HandleFunc("/v1/version", mp.KeyServer.GetServerVersion).Methods(http.MethodGet)
- addClientRoutes := func(router *mux.Router, prefix string) {
- router.HandleFunc(prefix+"/download/{serverName}/{mediaID}", mp.DownloadMedia).Methods(http.MethodGet)
- router.HandleFunc(prefix+"/download/{serverName}/{mediaID}/{fileName}", mp.DownloadMedia).Methods(http.MethodGet)
- router.HandleFunc(prefix+"/thumbnail/{serverName}/{mediaID}", mp.DownloadMedia).Methods(http.MethodGet)
- router.HandleFunc(prefix+"/upload/{serverName}/{mediaID}", mp.UploadNotSupported).Methods(http.MethodPut)
- router.HandleFunc(prefix+"/upload", mp.UploadNotSupported).Methods(http.MethodPost)
- router.HandleFunc(prefix+"/create", mp.UploadNotSupported).Methods(http.MethodPost)
- router.HandleFunc(prefix+"/config", mp.UploadNotSupported).Methods(http.MethodGet)
- router.HandleFunc(prefix+"/preview_url", mp.PreviewURLNotSupported).Methods(http.MethodGet)
- }
- addClientRoutes(mp.LegacyMediaRouter, "/v3")
- addClientRoutes(mp.LegacyMediaRouter, "/r0")
- addClientRoutes(mp.LegacyMediaRouter, "/v1")
- addClientRoutes(mp.ClientMediaRouter, "")
- mp.LegacyMediaRouter.NotFoundHandler = http.HandlerFunc(mp.UnknownEndpoint)
- mp.LegacyMediaRouter.MethodNotAllowedHandler = http.HandlerFunc(mp.UnsupportedMethod)
- mp.FederationRouter.NotFoundHandler = http.HandlerFunc(mp.UnknownEndpoint)
- mp.FederationRouter.MethodNotAllowedHandler = http.HandlerFunc(mp.UnsupportedMethod)
- mp.ClientMediaRouter.NotFoundHandler = http.HandlerFunc(mp.UnknownEndpoint)
- mp.ClientMediaRouter.MethodNotAllowedHandler = http.HandlerFunc(mp.UnsupportedMethod)
- corsMiddleware := func(next http.Handler) http.Handler {
- return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- w.Header().Set("Access-Control-Allow-Origin", "*")
- w.Header().Set("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS")
- w.Header().Set("Access-Control-Allow-Headers", "X-Requested-With, Content-Type, Authorization")
- w.Header().Set("Content-Security-Policy", "sandbox; default-src 'none'; script-src 'none'; plugin-types application/pdf; style-src 'unsafe-inline'; object-src 'self';")
- next.ServeHTTP(w, r)
- })
- }
- mp.LegacyMediaRouter.Use(corsMiddleware)
- mp.ClientMediaRouter.Use(corsMiddleware)
- mp.KeyServer.Register(router)
+ router.Handle("/_matrix/federation/", exhttp.ApplyMiddleware(
+ mp.FederationRouter,
+ exhttp.StripPrefix("/_matrix/federation"),
+ hlog.NewHandler(log),
+ hlog.RequestIDHandler("request_id", "Request-Id"),
+ requestlog.AccessLogger(requestlog.Options{TrustXForwardedFor: true}),
+ exhttp.HandleErrors(errorBodies),
+ ))
+ router.Handle("/_matrix/client/v1/media/", exhttp.ApplyMiddleware(
+ mp.ClientMediaRouter,
+ exhttp.StripPrefix("/_matrix/client/v1/media"),
+ hlog.NewHandler(log),
+ hlog.RequestIDHandler("request_id", "Request-Id"),
+ exhttp.CORSMiddleware,
+ requestlog.AccessLogger(requestlog.Options{TrustXForwardedFor: true}),
+ exhttp.HandleErrors(errorBodies),
+ ))
+ mp.KeyServer.Register(router, log)
}
-func (mp *MediaProxy) proxyDownload(ctx context.Context, w http.ResponseWriter, url, fileName string) {
- log := zerolog.Ctx(ctx)
- req, err := http.NewRequest(http.MethodGet, url, nil)
+var ErrInvalidMediaIDSyntax = errors.New("invalid media ID syntax")
+
+func queryToMap(vals url.Values) map[string]string {
+ m := make(map[string]string, len(vals))
+ for k, v := range vals {
+ m[k] = v[0]
+ }
+ return m
+}
+
+func (mp *MediaProxy) getMedia(w http.ResponseWriter, r *http.Request) GetMediaResponse {
+ mediaID := r.PathValue("mediaID")
+ if !id.IsValidMediaID(mediaID) {
+ mautrix.MNotFound.WithMessage("Media ID %q is not valid", mediaID).Write(w)
+ return nil
+ }
+ resp, err := mp.GetMedia(r.Context(), mediaID, queryToMap(r.URL.Query()))
if err != nil {
- log.Err(err).Str("url", url).Msg("Failed to create proxy request")
- jsonResponse(w, http.StatusInternalServerError, &mautrix.RespError{
- ErrCode: "M_UNKNOWN",
- Err: "Failed to create proxy request",
- })
- return
- }
- req.Header.Set("User-Agent", mautrix.DefaultUserAgent+" (media proxy)")
- if mp.PrepareProxyRequest != nil {
- mp.PrepareProxyRequest(req)
- }
- resp, err := mp.ProxyClient.Do(req)
- defer func() {
- if resp != nil && resp.Body != nil {
- _ = resp.Body.Close()
+ var mautrixRespError mautrix.RespError
+ if errors.Is(err, ErrInvalidMediaIDSyntax) {
+ mautrix.MNotFound.WithMessage("This is a media proxy at %q, other media downloads are not available here", mp.serverName).Write(w)
+ } else if errors.As(err, &mautrixRespError) {
+ mautrixRespError.Write(w)
+ } else {
+ zerolog.Ctx(r.Context()).Err(err).Str("media_id", mediaID).Msg("Failed to get media URL")
+ mautrix.MNotFound.WithMessage("Media not found").Write(w)
}
- }()
+ return nil
+ }
+ return resp
+}
+
+func startMultipart(ctx context.Context, w http.ResponseWriter) *multipart.Writer {
+ mpw := multipart.NewWriter(w)
+ w.Header().Set("Content-Type", strings.Replace(mpw.FormDataContentType(), "form-data", "mixed", 1))
+ w.WriteHeader(http.StatusOK)
+ metaPart, err := mpw.CreatePart(textproto.MIMEHeader{
+ "Content-Type": {"application/json"},
+ })
if err != nil {
- log.Err(err).Str("url", url).Msg("Failed to proxy download")
- jsonResponse(w, http.StatusServiceUnavailable, &mautrix.RespError{
- ErrCode: "M_UNKNOWN",
- Err: "Failed to proxy download",
- })
- return
- } else if resp.StatusCode != http.StatusOK {
- log.Warn().Str("url", url).Int("status", resp.StatusCode).Msg("Unexpected status code proxying download")
- jsonResponse(w, resp.StatusCode, &mautrix.RespError{
- ErrCode: "M_UNKNOWN",
- Err: "Unexpected status code proxying download",
- })
+ zerolog.Ctx(ctx).Err(err).Msg("Failed to create multipart metadata field")
+ return nil
+ }
+ _, err = metaPart.Write([]byte(`{}`))
+ if err != nil {
+ zerolog.Ctx(ctx).Err(err).Msg("Failed to write multipart metadata field")
+ return nil
+ }
+ return mpw
+}
+
+func (mp *MediaProxy) DownloadMediaFederation(w http.ResponseWriter, r *http.Request) {
+ if mp.ServerAuth != nil {
+ var err *mautrix.RespError
+ r, err = mp.ServerAuth.Authenticate(r)
+ if err != nil {
+ err.Write(w)
+ return
+ }
+ }
+ ctx := r.Context()
+ log := zerolog.Ctx(ctx)
+
+ resp := mp.getMedia(w, r)
+ if resp == nil {
return
}
- w.Header()["Content-Type"] = resp.Header["Content-Type"]
- w.Header()["Content-Length"] = resp.Header["Content-Length"]
- w.Header()["Last-Modified"] = resp.Header["Last-Modified"]
- w.Header()["Cache-Control"] = resp.Header["Cache-Control"]
+
+ var mpw *multipart.Writer
+ if urlResp, ok := resp.(*GetMediaResponseURL); ok {
+ mpw = startMultipart(ctx, w)
+ if mpw == nil {
+ return
+ }
+ _, err := mpw.CreatePart(textproto.MIMEHeader{
+ "Location": {urlResp.URL},
+ })
+ if err != nil {
+ log.Err(err).Msg("Failed to create multipart redirect field")
+ return
+ }
+ } else if fileResp, ok := resp.(*GetMediaResponseFile); ok {
+ responseStarted, err := doTempFileDownload(fileResp, func(wt io.WriterTo, size int64, mimeType string) error {
+ mpw = startMultipart(ctx, w)
+ if mpw == nil {
+ return fmt.Errorf("failed to start multipart writer")
+ }
+ dataPart, err := mpw.CreatePart(textproto.MIMEHeader{
+ "Content-Type": {mimeType},
+ })
+ if err != nil {
+ return fmt.Errorf("failed to create multipart data field: %w", err)
+ }
+ _, err = wt.WriteTo(dataPart)
+ return err
+ })
+ if err != nil {
+ log.Err(err).Msg("Failed to do media proxy with temp file")
+ if !responseStarted {
+ var mautrixRespError mautrix.RespError
+ if errors.As(err, &mautrixRespError) {
+ mautrixRespError.Write(w)
+ } else {
+ mautrix.MUnknown.WithMessage("Internal error proxying media").Write(w)
+ }
+ }
+ return
+ }
+ } else if dataResp, ok := resp.(GetMediaResponseWriter); ok {
+ mpw = startMultipart(ctx, w)
+ if mpw == nil {
+ return
+ }
+ dataPart, err := mpw.CreatePart(textproto.MIMEHeader{
+ "Content-Type": {dataResp.GetContentType()},
+ })
+ if err != nil {
+ log.Err(err).Msg("Failed to create multipart data field")
+ return
+ }
+ _, err = dataResp.WriteTo(dataPart)
+ if err != nil {
+ log.Err(err).Msg("Failed to write multipart data field")
+ return
+ }
+ } else {
+ panic(fmt.Errorf("unknown GetMediaResponse type %T", resp))
+ }
+ err := mpw.Close()
+ if err != nil {
+ log.Err(err).Msg("Failed to close multipart writer")
+ return
+ }
+}
+
+func (mp *MediaProxy) addHeaders(w http.ResponseWriter, mimeType, fileName string) {
+ w.Header().Set("Cache-Control", "public, max-age=31536000, immutable")
contentDisposition := "attachment"
- switch resp.Header.Get("Content-Type") {
+ switch mimeType {
case "text/css", "text/plain", "text/csv", "application/json", "application/ld+json", "image/jpeg", "image/gif",
"image/png", "image/apng", "image/webp", "image/avif", "video/mp4", "video/webm", "video/ogg", "video/quicktime",
"audio/mp4", "audio/webm", "audio/aac", "audio/mpeg", "audio/ogg", "audio/wave", "audio/wav", "audio/x-wav",
@@ -241,113 +386,14 @@ func (mp *MediaProxy) proxyDownload(ctx context.Context, w http.ResponseWriter,
})
}
w.Header().Set("Content-Disposition", contentDisposition)
- w.WriteHeader(http.StatusOK)
- _, err = io.Copy(w, resp.Body)
- if err != nil {
- log.Debug().Err(err).Msg("Failed to write proxy response")
- }
-}
-
-type ResponseError struct {
- Status int
- Data any
-}
-
-func (err *ResponseError) Error() string {
- return fmt.Sprintf("HTTP %d: %v", err.Status, err.Data)
-}
-
-var ErrInvalidMediaIDSyntax = errors.New("invalid media ID syntax")
-
-func (mp *MediaProxy) getMedia(w http.ResponseWriter, r *http.Request) GetMediaResponse {
- mediaID := mux.Vars(r)["mediaID"]
- resp, err := mp.GetMedia(r.Context(), mediaID)
- if err != nil {
- var respError *ResponseError
- if errors.Is(err, ErrInvalidMediaIDSyntax) {
- jsonResponse(w, http.StatusNotFound, &mautrix.RespError{
- ErrCode: mautrix.MNotFound.ErrCode,
- Err: fmt.Sprintf("This is a media proxy at %q, other media downloads are not available here", mp.serverName),
- })
- } else if errors.As(err, &respError) {
- jsonResponse(w, respError.Status, respError.Data)
- } else {
- zerolog.Ctx(r.Context()).Err(err).Str("media_id", mediaID).Msg("Failed to get media URL")
- jsonResponse(w, http.StatusNotFound, &mautrix.RespError{
- ErrCode: mautrix.MNotFound.ErrCode,
- Err: "Media not found",
- })
- }
- return nil
- }
- return resp
-}
-
-func (mp *MediaProxy) DownloadMediaFederation(w http.ResponseWriter, r *http.Request) {
- ctx := r.Context()
- log := zerolog.Ctx(ctx)
- // TODO check destination header in X-Matrix auth
-
- resp := mp.getMedia(w, r)
- if resp == nil {
- return
- }
-
- mpw := multipart.NewWriter(w)
- w.Header().Set("Content-Type", strings.Replace(mpw.FormDataContentType(), "form-data", "mixed", 1))
- w.WriteHeader(http.StatusOK)
- metaPart, err := mpw.CreatePart(textproto.MIMEHeader{
- "Content-Type": {"application/json"},
- })
- if err != nil {
- log.Err(err).Msg("Failed to create multipart metadata field")
- return
- }
- _, err = metaPart.Write([]byte(`{}`))
- if err != nil {
- log.Err(err).Msg("Failed to write multipart metadata field")
- return
- }
- if urlResp, ok := resp.(*GetMediaResponseURL); ok {
- _, err = mpw.CreatePart(textproto.MIMEHeader{
- "Location": {urlResp.URL},
- })
- if err != nil {
- log.Err(err).Msg("Failed to create multipart redirect field")
- return
- }
- } else if dataResp, ok := resp.(*GetMediaResponseData); ok {
- dataPart, err := mpw.CreatePart(textproto.MIMEHeader{
- "Content-Type": {dataResp.ContentType},
- })
- if err != nil {
- log.Err(err).Msg("Failed to create multipart data field")
- return
- }
- _, err = io.Copy(dataPart, dataResp.Reader)
- if err != nil {
- log.Err(err).Msg("Failed to write multipart data field")
- return
- }
- } else {
- panic("unknown GetMediaResponse type")
- }
- err = mpw.Close()
- if err != nil {
- log.Err(err).Msg("Failed to close multipart writer")
- return
- }
+ w.Header().Set("Content-Type", mimeType)
}
func (mp *MediaProxy) DownloadMedia(w http.ResponseWriter, r *http.Request) {
ctx := r.Context()
log := zerolog.Ctx(ctx)
- vars := mux.Vars(r)
- if vars["serverName"] != mp.serverName {
- jsonResponse(w, http.StatusNotFound, &mautrix.RespError{
- ErrCode: mautrix.MNotFound.ErrCode,
- Err: fmt.Sprintf("This is a media proxy at %q, other media downloads are not available here", mp.serverName),
- })
+ if r.PathValue("serverName") != mp.serverName {
+ mautrix.MNotFound.WithMessage("This is a media proxy at %q, other media downloads are not available here", mp.serverName).Write(w)
return
}
resp := mp.getMedia(w, r)
@@ -356,13 +402,6 @@ func (mp *MediaProxy) DownloadMedia(w http.ResponseWriter, r *http.Request) {
}
if urlResp, ok := resp.(*GetMediaResponseURL); ok {
- // Proxy if the config allows proxying and the request doesn't allow redirects.
- // In any other case, redirect to the URL.
- isFederated := strings.HasPrefix(r.Header.Get("Authorization"), "X-Matrix")
- if mp.ProxyClient != nil && (r.URL.Query().Get("allow_redirect") != "true" || (mp.ForceProxyLegacyFederation && isFederated)) {
- mp.proxyDownload(ctx, w, urlResp.URL, vars["fileName"])
- return
- }
w.Header().Set("Location", urlResp.URL)
expirySeconds := (time.Until(urlResp.ExpiresAt) - 5*time.Minute).Seconds()
if urlResp.ExpiresAt.IsZero() {
@@ -374,51 +413,113 @@ func (mp *MediaProxy) DownloadMedia(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Cache-Control", "no-store")
}
w.WriteHeader(http.StatusTemporaryRedirect)
- } else if dataResp, ok := resp.(*GetMediaResponseData); ok {
- w.Header().Set("Content-Type", dataResp.ContentType)
- if dataResp.ContentLength != 0 {
- w.Header().Set("Content-Length", strconv.FormatInt(dataResp.ContentLength, 10))
+ } else if fileResp, ok := resp.(*GetMediaResponseFile); ok {
+ responseStarted, err := doTempFileDownload(fileResp, func(wt io.WriterTo, size int64, mimeType string) error {
+ mp.addHeaders(w, mimeType, r.PathValue("fileName"))
+ w.Header().Set("Content-Length", strconv.FormatInt(size, 10))
+ w.WriteHeader(http.StatusOK)
+ _, err := wt.WriteTo(w)
+ return err
+ })
+ if err != nil {
+ log.Err(err).Msg("Failed to do media proxy with temp file")
+ if !responseStarted {
+ var mautrixRespError mautrix.RespError
+ if errors.As(err, &mautrixRespError) {
+ mautrixRespError.Write(w)
+ } else {
+ mautrix.MUnknown.WithMessage("Internal error proxying media").Write(w)
+ }
+ }
+ }
+ } else if writerResp, ok := resp.(GetMediaResponseWriter); ok {
+ if dataResp, ok := writerResp.(*GetMediaResponseData); ok {
+ defer dataResp.Reader.Close()
+ }
+ mp.addHeaders(w, writerResp.GetContentType(), r.PathValue("fileName"))
+ if writerResp.GetContentLength() != 0 {
+ w.Header().Set("Content-Length", strconv.FormatInt(writerResp.GetContentLength(), 10))
}
w.WriteHeader(http.StatusOK)
- _, err := io.Copy(w, dataResp.Reader)
+ _, err := writerResp.WriteTo(w)
if err != nil {
log.Err(err).Msg("Failed to write media data")
}
} else {
- panic("unknown GetMediaResponse type")
+ panic(fmt.Errorf("unknown GetMediaResponse type %T", resp))
}
}
-func jsonResponse(w http.ResponseWriter, status int, response interface{}) {
- w.Header().Add("Content-Type", "application/json")
- w.WriteHeader(status)
- _ = json.NewEncoder(w).Encode(response)
+func doTempFileDownload(
+ data *GetMediaResponseFile,
+ respond func(w io.WriterTo, size int64, mimeType string) error,
+) (bool, error) {
+ tempFile, err := os.CreateTemp("", "mautrix-mediaproxy-*")
+ if err != nil {
+ return false, fmt.Errorf("failed to create temp file: %w", err)
+ }
+ origTempFile := tempFile
+ defer func() {
+ _ = origTempFile.Close()
+ _ = os.Remove(origTempFile.Name())
+ }()
+ meta, err := data.Callback(tempFile)
+ if err != nil {
+ return false, err
+ }
+ if meta.ReplacementFile != "" {
+ tempFile, err = os.Open(meta.ReplacementFile)
+ if err != nil {
+ return false, fmt.Errorf("failed to open replacement file: %w", err)
+ }
+ defer func() {
+ _ = tempFile.Close()
+ _ = os.Remove(origTempFile.Name())
+ }()
+ } else {
+ _, err = tempFile.Seek(0, io.SeekStart)
+ if err != nil {
+ return false, fmt.Errorf("failed to seek to start of temp file: %w", err)
+ }
+ }
+ fileInfo, err := tempFile.Stat()
+ if err != nil {
+ return false, fmt.Errorf("failed to stat temp file: %w", err)
+ }
+ mimeType := meta.ContentType
+ if mimeType == "" {
+ buf := make([]byte, 512)
+ n, err := tempFile.Read(buf)
+ if err != nil {
+ return false, fmt.Errorf("failed to read temp file to detect mime: %w", err)
+ }
+ buf = buf[:n]
+ _, err = tempFile.Seek(0, io.SeekStart)
+ if err != nil {
+ return false, fmt.Errorf("failed to seek to start of temp file: %w", err)
+ }
+ mimeType = http.DetectContentType(buf)
+ }
+ err = respond(tempFile, fileInfo.Size(), mimeType)
+ if err != nil {
+ return true, err
+ }
+ return true, nil
}
+var (
+ ErrUploadNotSupported = mautrix.MUnrecognized.
+ WithMessage("This is a media proxy and does not support media uploads.").
+ WithStatus(http.StatusNotImplemented)
+ ErrPreviewURLNotSupported = mautrix.MUnrecognized.
+ WithMessage("This is a media proxy and does not support URL previews.").
+ WithStatus(http.StatusNotImplemented)
+)
+
func (mp *MediaProxy) UploadNotSupported(w http.ResponseWriter, r *http.Request) {
- jsonResponse(w, http.StatusNotImplemented, &mautrix.RespError{
- ErrCode: mautrix.MUnrecognized.ErrCode,
- Err: "This is a media proxy and does not support media uploads.",
- })
+ ErrUploadNotSupported.Write(w)
}
func (mp *MediaProxy) PreviewURLNotSupported(w http.ResponseWriter, r *http.Request) {
- jsonResponse(w, http.StatusNotImplemented, &mautrix.RespError{
- ErrCode: mautrix.MUnrecognized.ErrCode,
- Err: "This is a media proxy and does not support URL previews.",
- })
-}
-
-func (mp *MediaProxy) UnknownEndpoint(w http.ResponseWriter, r *http.Request) {
- jsonResponse(w, http.StatusNotFound, &mautrix.RespError{
- ErrCode: mautrix.MUnrecognized.ErrCode,
- Err: "Unrecognized endpoint",
- })
-}
-
-func (mp *MediaProxy) UnsupportedMethod(w http.ResponseWriter, r *http.Request) {
- jsonResponse(w, http.StatusMethodNotAllowed, &mautrix.RespError{
- ErrCode: mautrix.MUnrecognized.ErrCode,
- Err: "Invalid method for endpoint",
- })
+ ErrPreviewURLNotSupported.Write(w)
}
diff --git a/mockserver/mockserver.go b/mockserver/mockserver.go
new file mode 100644
index 00000000..507c24a5
--- /dev/null
+++ b/mockserver/mockserver.go
@@ -0,0 +1,307 @@
+// Copyright (c) 2025 Tulir Asokan
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package mockserver
+
+import (
+ "context"
+ "encoding/json"
+ "fmt"
+ "io"
+ "maps"
+ "net/http"
+ "net/http/httptest"
+ "strings"
+ "testing"
+
+ globallog "github.com/rs/zerolog/log" // zerolog-allow-global-log
+ "github.com/stretchr/testify/require"
+ "go.mau.fi/util/dbutil"
+ "go.mau.fi/util/exerrors"
+ "go.mau.fi/util/exhttp"
+ "go.mau.fi/util/random"
+
+ "maunium.net/go/mautrix"
+ "maunium.net/go/mautrix/crypto"
+ "maunium.net/go/mautrix/crypto/cryptohelper"
+ "maunium.net/go/mautrix/event"
+ "maunium.net/go/mautrix/id"
+)
+
+func mustDecode(r *http.Request, data any) {
+ exerrors.PanicIfNotNil(json.NewDecoder(r.Body).Decode(data))
+}
+
+type userAndDeviceID struct {
+ UserID id.UserID
+ DeviceID id.DeviceID
+}
+
+type MockServer struct {
+ Router *http.ServeMux
+ Server *httptest.Server
+
+ AccessTokenToUserID map[string]userAndDeviceID
+ DeviceInbox map[id.UserID]map[id.DeviceID][]event.Event
+ AccountData map[id.UserID]map[event.Type]json.RawMessage
+ DeviceKeys map[id.UserID]map[id.DeviceID]mautrix.DeviceKeys
+ OneTimeKeys map[id.UserID]map[id.DeviceID]map[id.KeyID]mautrix.OneTimeKey
+ MasterKeys map[id.UserID]mautrix.CrossSigningKeys
+ SelfSigningKeys map[id.UserID]mautrix.CrossSigningKeys
+ UserSigningKeys map[id.UserID]mautrix.CrossSigningKeys
+
+ PopOTKs bool
+ MemoryStore bool
+}
+
+func Create(t testing.TB) *MockServer {
+ t.Helper()
+
+ server := MockServer{
+ AccessTokenToUserID: map[string]userAndDeviceID{},
+ DeviceInbox: map[id.UserID]map[id.DeviceID][]event.Event{},
+ AccountData: map[id.UserID]map[event.Type]json.RawMessage{},
+ DeviceKeys: map[id.UserID]map[id.DeviceID]mautrix.DeviceKeys{},
+ OneTimeKeys: map[id.UserID]map[id.DeviceID]map[id.KeyID]mautrix.OneTimeKey{},
+ MasterKeys: map[id.UserID]mautrix.CrossSigningKeys{},
+ SelfSigningKeys: map[id.UserID]mautrix.CrossSigningKeys{},
+ UserSigningKeys: map[id.UserID]mautrix.CrossSigningKeys{},
+ PopOTKs: true,
+ MemoryStore: true,
+ }
+
+ router := http.NewServeMux()
+ router.HandleFunc("POST /_matrix/client/v3/login", server.postLogin)
+ router.HandleFunc("POST /_matrix/client/v3/keys/query", server.postKeysQuery)
+ router.HandleFunc("POST /_matrix/client/v3/keys/claim", server.postKeysClaim)
+ router.HandleFunc("PUT /_matrix/client/v3/sendToDevice/{type}/{txn}", server.putSendToDevice)
+ router.HandleFunc("PUT /_matrix/client/v3/user/{userID}/account_data/{type}", server.putAccountData)
+ router.HandleFunc("POST /_matrix/client/v3/keys/device_signing/upload", server.postDeviceSigningUpload)
+ router.HandleFunc("POST /_matrix/client/v3/keys/signatures/upload", server.emptyResp)
+ router.HandleFunc("POST /_matrix/client/v3/keys/upload", server.postKeysUpload)
+ server.Router = router
+ server.Server = httptest.NewServer(router)
+ t.Cleanup(server.Server.Close)
+ return &server
+}
+
+func (ms *MockServer) getUserID(r *http.Request) userAndDeviceID {
+ authHeader := r.Header.Get("Authorization")
+ authHeader = strings.TrimPrefix(authHeader, "Bearer ")
+ userID, ok := ms.AccessTokenToUserID[authHeader]
+ if !ok {
+ panic("no user ID found for access token " + authHeader)
+ }
+ return userID
+}
+
+func (ms *MockServer) emptyResp(w http.ResponseWriter, _ *http.Request) {
+ exhttp.WriteEmptyJSONResponse(w, http.StatusOK)
+}
+
+func (ms *MockServer) postLogin(w http.ResponseWriter, r *http.Request) {
+ var loginReq mautrix.ReqLogin
+ mustDecode(r, &loginReq)
+
+ deviceID := loginReq.DeviceID
+ if deviceID == "" {
+ deviceID = id.DeviceID(random.String(10))
+ }
+
+ accessToken := random.String(30)
+ userID := id.UserID(loginReq.Identifier.User)
+ ms.AccessTokenToUserID[accessToken] = userAndDeviceID{
+ UserID: userID,
+ DeviceID: deviceID,
+ }
+
+ exhttp.WriteJSONResponse(w, http.StatusOK, &mautrix.RespLogin{
+ AccessToken: accessToken,
+ DeviceID: deviceID,
+ UserID: userID,
+ })
+}
+
+func (ms *MockServer) putSendToDevice(w http.ResponseWriter, r *http.Request) {
+ var req mautrix.ReqSendToDevice
+ mustDecode(r, &req)
+ evtType := event.Type{Type: r.PathValue("type"), Class: event.ToDeviceEventType}
+
+ for user, devices := range req.Messages {
+ for device, content := range devices {
+ if _, ok := ms.DeviceInbox[user]; !ok {
+ ms.DeviceInbox[user] = map[id.DeviceID][]event.Event{}
+ }
+ content.ParseRaw(evtType)
+ ms.DeviceInbox[user][device] = append(ms.DeviceInbox[user][device], event.Event{
+ Sender: ms.getUserID(r).UserID,
+ Type: evtType,
+ Content: *content,
+ })
+ }
+ }
+ ms.emptyResp(w, r)
+}
+
+func (ms *MockServer) putAccountData(w http.ResponseWriter, r *http.Request) {
+ userID := id.UserID(r.PathValue("userID"))
+ eventType := event.Type{Type: r.PathValue("type"), Class: event.AccountDataEventType}
+
+ jsonData, _ := io.ReadAll(r.Body)
+ if _, ok := ms.AccountData[userID]; !ok {
+ ms.AccountData[userID] = map[event.Type]json.RawMessage{}
+ }
+ ms.AccountData[userID][eventType] = json.RawMessage(jsonData)
+ ms.emptyResp(w, r)
+}
+
+func (ms *MockServer) postKeysQuery(w http.ResponseWriter, r *http.Request) {
+ var req mautrix.ReqQueryKeys
+ mustDecode(r, &req)
+ resp := mautrix.RespQueryKeys{
+ MasterKeys: map[id.UserID]mautrix.CrossSigningKeys{},
+ UserSigningKeys: map[id.UserID]mautrix.CrossSigningKeys{},
+ SelfSigningKeys: map[id.UserID]mautrix.CrossSigningKeys{},
+ DeviceKeys: map[id.UserID]map[id.DeviceID]mautrix.DeviceKeys{},
+ }
+ for user := range req.DeviceKeys {
+ resp.MasterKeys[user] = ms.MasterKeys[user]
+ resp.UserSigningKeys[user] = ms.UserSigningKeys[user]
+ resp.SelfSigningKeys[user] = ms.SelfSigningKeys[user]
+ resp.DeviceKeys[user] = ms.DeviceKeys[user]
+ }
+ exhttp.WriteJSONResponse(w, http.StatusOK, &resp)
+}
+
+func (ms *MockServer) postKeysClaim(w http.ResponseWriter, r *http.Request) {
+ var req mautrix.ReqClaimKeys
+ mustDecode(r, &req)
+ resp := mautrix.RespClaimKeys{
+ OneTimeKeys: map[id.UserID]map[id.DeviceID]map[id.KeyID]mautrix.OneTimeKey{},
+ }
+ for user, devices := range req.OneTimeKeys {
+ resp.OneTimeKeys[user] = map[id.DeviceID]map[id.KeyID]mautrix.OneTimeKey{}
+ for device := range devices {
+ keys := ms.OneTimeKeys[user][device]
+ for keyID, key := range keys {
+ if ms.PopOTKs {
+ delete(keys, keyID)
+ }
+ resp.OneTimeKeys[user][device] = map[id.KeyID]mautrix.OneTimeKey{
+ keyID: key,
+ }
+ break
+ }
+ }
+ }
+ exhttp.WriteJSONResponse(w, http.StatusOK, &resp)
+}
+
+func (ms *MockServer) postKeysUpload(w http.ResponseWriter, r *http.Request) {
+ var req mautrix.ReqUploadKeys
+ mustDecode(r, &req)
+
+ uid := ms.getUserID(r)
+ userID := uid.UserID
+ if _, ok := ms.DeviceKeys[userID]; !ok {
+ ms.DeviceKeys[userID] = map[id.DeviceID]mautrix.DeviceKeys{}
+ }
+ if _, ok := ms.OneTimeKeys[userID]; !ok {
+ ms.OneTimeKeys[userID] = map[id.DeviceID]map[id.KeyID]mautrix.OneTimeKey{}
+ }
+
+ if req.DeviceKeys != nil {
+ ms.DeviceKeys[userID][uid.DeviceID] = *req.DeviceKeys
+ }
+ otks, ok := ms.OneTimeKeys[userID][uid.DeviceID]
+ if !ok {
+ otks = map[id.KeyID]mautrix.OneTimeKey{}
+ ms.OneTimeKeys[userID][uid.DeviceID] = otks
+ }
+ if req.OneTimeKeys != nil {
+ maps.Copy(otks, req.OneTimeKeys)
+ }
+
+ exhttp.WriteJSONResponse(w, http.StatusOK, &mautrix.RespUploadKeys{
+ OneTimeKeyCounts: mautrix.OTKCount{SignedCurve25519: len(otks)},
+ })
+}
+
+func (ms *MockServer) postDeviceSigningUpload(w http.ResponseWriter, r *http.Request) {
+ var req mautrix.UploadCrossSigningKeysReq[any]
+ mustDecode(r, &req)
+
+ userID := ms.getUserID(r).UserID
+ ms.MasterKeys[userID] = req.Master
+ ms.SelfSigningKeys[userID] = req.SelfSigning
+ ms.UserSigningKeys[userID] = req.UserSigning
+
+ ms.emptyResp(w, r)
+}
+
+func (ms *MockServer) Login(t testing.TB, ctx context.Context, userID id.UserID, deviceID id.DeviceID) (*mautrix.Client, crypto.Store) {
+ t.Helper()
+ if ctx == nil {
+ ctx = context.TODO()
+ }
+ client, err := mautrix.NewClient(ms.Server.URL, "", "")
+ require.NoError(t, err)
+ client.Client = ms.Server.Client()
+
+ _, err = client.Login(ctx, &mautrix.ReqLogin{
+ Type: mautrix.AuthTypePassword,
+ Identifier: mautrix.UserIdentifier{
+ Type: mautrix.IdentifierTypeUser,
+ User: userID.String(),
+ },
+ DeviceID: deviceID,
+ Password: "password",
+ StoreCredentials: true,
+ })
+ require.NoError(t, err)
+
+ var store any
+ if ms.MemoryStore {
+ store = crypto.NewMemoryStore(nil)
+ client.StateStore = mautrix.NewMemoryStateStore()
+ } else {
+ store, err = dbutil.NewFromConfig("", dbutil.Config{
+ PoolConfig: dbutil.PoolConfig{
+ Type: "sqlite3-fk-wal",
+ URI: fmt.Sprintf("file:%s?mode=memory&cache=shared&_txlock=immediate", random.String(10)),
+ MaxOpenConns: 5,
+ MaxIdleConns: 1,
+ },
+ }, nil)
+ require.NoError(t, err)
+ }
+ cryptoHelper, err := cryptohelper.NewCryptoHelper(client, []byte("test"), store)
+ require.NoError(t, err)
+ client.Crypto = cryptoHelper
+
+ err = cryptoHelper.Init(ctx)
+ require.NoError(t, err)
+
+ machineLog := globallog.Logger.With().
+ Stringer("my_user_id", userID).
+ Stringer("my_device_id", deviceID).
+ Logger()
+ cryptoHelper.Machine().Log = &machineLog
+
+ err = cryptoHelper.Machine().ShareKeys(ctx, 50)
+ require.NoError(t, err)
+
+ return client, cryptoHelper.Machine().CryptoStore
+}
+
+func (ms *MockServer) DispatchToDevice(t testing.TB, ctx context.Context, client *mautrix.Client) {
+ t.Helper()
+
+ for _, evt := range ms.DeviceInbox[client.UserID][client.DeviceID] {
+ client.Syncer.(*mautrix.DefaultSyncer).Dispatch(ctx, &evt)
+ ms.DeviceInbox[client.UserID][client.DeviceID] = ms.DeviceInbox[client.UserID][client.DeviceID][1:]
+ }
+}
diff --git a/pushrules/action.go b/pushrules/action.go
index 9838e88b..b5a884b2 100644
--- a/pushrules/action.go
+++ b/pushrules/action.go
@@ -105,7 +105,7 @@ func (action *PushAction) UnmarshalJSON(raw []byte) error {
if ok {
action.Action = ActionSetTweak
action.Tweak = PushActionTweak(tweak)
- action.Value, _ = val["value"]
+ action.Value = val["value"]
}
}
return nil
diff --git a/pushrules/action_test.go b/pushrules/action_test.go
index a8f68415..3c0aa168 100644
--- a/pushrules/action_test.go
+++ b/pushrules/action_test.go
@@ -139,9 +139,9 @@ func TestPushAction_UnmarshalJSON_InvalidTypeDoesNothing(t *testing.T) {
}
err := pa.UnmarshalJSON([]byte(`{"foo": "bar"}`))
- assert.Nil(t, err)
+ assert.NoError(t, err)
err = pa.UnmarshalJSON([]byte(`9001`))
- assert.Nil(t, err)
+ assert.NoError(t, err)
assert.Equal(t, pushrules.PushActionType("unchanged"), pa.Action)
assert.Equal(t, pushrules.PushActionTweak("unchanged"), pa.Tweak)
@@ -156,7 +156,7 @@ func TestPushAction_UnmarshalJSON_StringChangesActionType(t *testing.T) {
}
err := pa.UnmarshalJSON([]byte(`"foo"`))
- assert.Nil(t, err)
+ assert.NoError(t, err)
assert.Equal(t, pushrules.PushActionType("foo"), pa.Action)
assert.Equal(t, pushrules.PushActionTweak("unchanged"), pa.Tweak)
@@ -171,7 +171,7 @@ func TestPushAction_UnmarshalJSON_SetTweakChangesTweak(t *testing.T) {
}
err := pa.UnmarshalJSON([]byte(`{"set_tweak": "foo", "value": 123.0}`))
- assert.Nil(t, err)
+ assert.NoError(t, err)
assert.Equal(t, pushrules.ActionSetTweak, pa.Action)
assert.Equal(t, pushrules.PushActionTweak("foo"), pa.Tweak)
@@ -185,7 +185,7 @@ func TestPushAction_MarshalJSON_TweakOutputWorks(t *testing.T) {
Value: "bar",
}
data, err := pa.MarshalJSON()
- assert.Nil(t, err)
+ assert.NoError(t, err)
assert.Equal(t, []byte(`{"set_tweak":"foo","value":"bar"}`), data)
}
@@ -196,6 +196,6 @@ func TestPushAction_MarshalJSON_OtherOutputWorks(t *testing.T) {
Value: "bar",
}
data, err := pa.MarshalJSON()
- assert.Nil(t, err)
+ assert.NoError(t, err)
assert.Equal(t, []byte(`"something else"`), data)
}
diff --git a/pushrules/condition.go b/pushrules/condition.go
index dbe83a61..caa717de 100644
--- a/pushrules/condition.go
+++ b/pushrules/condition.go
@@ -27,6 +27,11 @@ type Room interface {
GetMemberCount() int
}
+type PowerLevelfulRoom interface {
+ Room
+ GetPowerLevels() *event.PowerLevelsEventContent
+}
+
// EventfulRoom is an extension of Room to support MSC3664.
type EventfulRoom interface {
Room
@@ -38,11 +43,12 @@ type PushCondKind string
// The allowed push condition kinds as specified in https://spec.matrix.org/v1.2/client-server-api/#conditions-1
const (
- KindEventMatch PushCondKind = "event_match"
- KindContainsDisplayName PushCondKind = "contains_display_name"
- KindRoomMemberCount PushCondKind = "room_member_count"
- KindEventPropertyIs PushCondKind = "event_property_is"
- KindEventPropertyContains PushCondKind = "event_property_contains"
+ KindEventMatch PushCondKind = "event_match"
+ KindContainsDisplayName PushCondKind = "contains_display_name"
+ KindRoomMemberCount PushCondKind = "room_member_count"
+ KindEventPropertyIs PushCondKind = "event_property_is"
+ KindEventPropertyContains PushCondKind = "event_property_contains"
+ KindSenderNotificationPermission PushCondKind = "sender_notification_permission"
// MSC3664: https://github.com/matrix-org/matrix-spec-proposals/pull/3664
@@ -82,6 +88,8 @@ func (cond *PushCondition) Match(room Room, evt *event.Event) bool {
return cond.matchDisplayName(room, evt)
case KindRoomMemberCount:
return cond.matchMemberCount(room)
+ case KindSenderNotificationPermission:
+ return cond.matchSenderNotificationPermission(room, evt.Sender, cond.Key)
default:
return false
}
@@ -334,3 +342,18 @@ func (cond *PushCondition) matchMemberCount(room Room) bool {
return false
}
}
+
+func (cond *PushCondition) matchSenderNotificationPermission(room Room, sender id.UserID, key string) bool {
+ if key != "room" {
+ return false
+ }
+ plRoom, ok := room.(PowerLevelfulRoom)
+ if !ok {
+ return false
+ }
+ pls := plRoom.GetPowerLevels()
+ if pls == nil {
+ return false
+ }
+ return pls.GetUserLevel(sender) >= pls.Notifications.Room()
+}
diff --git a/pushrules/condition_test.go b/pushrules/condition_test.go
index 0d3eaf7a..37af3e34 100644
--- a/pushrules/condition_test.go
+++ b/pushrules/condition_test.go
@@ -102,14 +102,6 @@ func newEventPropertyIsPushCondition(key string, value any) *pushrules.PushCondi
}
}
-func newEventPropertyContainsPushCondition(key string, value any) *pushrules.PushCondition {
- return &pushrules.PushCondition{
- Kind: pushrules.KindEventPropertyContains,
- Key: key,
- Value: value,
- }
-}
-
func TestPushCondition_Match_InvalidKind(t *testing.T) {
condition := &pushrules.PushCondition{
Kind: pushrules.PushCondKind("invalid"),
diff --git a/pushrules/pushrules_test.go b/pushrules/pushrules_test.go
index a531ca28..a5a0f5e7 100644
--- a/pushrules/pushrules_test.go
+++ b/pushrules/pushrules_test.go
@@ -25,7 +25,7 @@ func TestEventToPushRules(t *testing.T) {
},
}
pushRuleset, err := pushrules.EventToPushRules(evt)
- assert.Nil(t, err)
+ assert.NoError(t, err)
assert.NotNil(t, pushRuleset)
assert.IsType(t, pushRuleset.Override, pushrules.PushRuleArray{})
diff --git a/pushrules/rule.go b/pushrules/rule.go
index ee6d33c4..cf659695 100644
--- a/pushrules/rule.go
+++ b/pushrules/rule.go
@@ -8,7 +8,10 @@ package pushrules
import (
"encoding/gob"
+ "regexp"
+ "strings"
+ "go.mau.fi/util/exerrors"
"go.mau.fi/util/glob"
"maunium.net/go/mautrix/event"
@@ -165,13 +168,20 @@ func (rule *PushRule) matchConditions(room Room, evt *event.Event) bool {
}
func (rule *PushRule) matchPattern(room Room, evt *event.Event) bool {
- pattern := glob.CompileWithImplicitContains(rule.Pattern)
- if pattern == nil {
- return false
- }
msg, ok := evt.Content.Raw["body"].(string)
if !ok {
return false
}
- return pattern.Match(msg)
+ var buf strings.Builder
+ // As per https://spec.matrix.org/unstable/client-server-api/#push-rules, content rules are case-insensitive
+ // and must match whole words, so wrap the converted glob in (?i) and \b.
+ buf.WriteString(`(?i)\b`)
+ // strings.Builder will never return errors
+ exerrors.PanicIfNotNil(glob.ToRegexPattern(rule.Pattern, &buf))
+ buf.WriteString(`\b`)
+ pattern, err := regexp.Compile(buf.String())
+ if err != nil {
+ return false
+ }
+ return pattern.MatchString(msg)
}
diff --git a/pushrules/rule_test.go b/pushrules/rule_test.go
index 803c721e..7ff839a7 100644
--- a/pushrules/rule_test.go
+++ b/pushrules/rule_test.go
@@ -186,6 +186,34 @@ func TestPushRule_Match_Content(t *testing.T) {
assert.True(t, rule.Match(blankTestRoom, evt))
}
+func TestPushRule_Match_WordBoundary(t *testing.T) {
+ rule := &pushrules.PushRule{
+ Type: pushrules.ContentRule,
+ Enabled: true,
+ Pattern: "test",
+ }
+
+ evt := newFakeEvent(event.EventMessage, &event.MessageEventContent{
+ MsgType: event.MsgEmote,
+ Body: "is testing pushrules",
+ })
+ assert.False(t, rule.Match(blankTestRoom, evt))
+}
+
+func TestPushRule_Match_CaseInsensitive(t *testing.T) {
+ rule := &pushrules.PushRule{
+ Type: pushrules.ContentRule,
+ Enabled: true,
+ Pattern: "test",
+ }
+
+ evt := newFakeEvent(event.EventMessage, &event.MessageEventContent{
+ MsgType: event.MsgEmote,
+ Body: "is TeSt-InG pushrules",
+ })
+ assert.True(t, rule.Match(blankTestRoom, evt))
+}
+
func TestPushRule_Match_Content_Fail(t *testing.T) {
rule := &pushrules.PushRule{
Type: pushrules.ContentRule,
diff --git a/pushrules/ruleset.go b/pushrules/ruleset.go
index 609997b4..c42d4799 100644
--- a/pushrules/ruleset.go
+++ b/pushrules/ruleset.go
@@ -68,6 +68,9 @@ func (rs *PushRuleset) MarshalJSON() ([]byte, error) {
var DefaultPushActions = PushActionArray{&PushAction{Action: ActionDontNotify}}
func (rs *PushRuleset) GetMatchingRule(room Room, evt *event.Event) (rule *PushRule) {
+ if rs == nil {
+ return nil
+ }
// Add push rule collections to array in priority order
arrays := []PushRuleCollection{rs.Override, rs.Content, rs.Room, rs.Sender, rs.Underride}
// Loop until one of the push rule collections matches the room/event combo.
diff --git a/requests.go b/requests.go
index a6b0ea8b..cc8b7266 100644
--- a/requests.go
+++ b/requests.go
@@ -2,7 +2,9 @@ package mautrix
import (
"encoding/json"
+ "fmt"
"strconv"
+ "time"
"maunium.net/go/mautrix/crypto/signatures"
"maunium.net/go/mautrix/event"
@@ -38,20 +40,40 @@ const (
type Direction rune
+func (d Direction) MarshalJSON() ([]byte, error) {
+ return json.Marshal(string(d))
+}
+
+func (d *Direction) UnmarshalJSON(data []byte) error {
+ var str string
+ if err := json.Unmarshal(data, &str); err != nil {
+ return err
+ }
+ switch str {
+ case "f":
+ *d = DirectionForward
+ case "b":
+ *d = DirectionBackward
+ default:
+ return fmt.Errorf("invalid direction %q, must be 'f' or 'b'", str)
+ }
+ return nil
+}
+
const (
DirectionForward Direction = 'f'
DirectionBackward Direction = 'b'
)
// ReqRegister is the JSON request for https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3register
-type ReqRegister struct {
+type ReqRegister[UIAType any] struct {
Username string `json:"username,omitempty"`
Password string `json:"password,omitempty"`
DeviceID id.DeviceID `json:"device_id,omitempty"`
InitialDeviceDisplayName string `json:"initial_device_display_name,omitempty"`
InhibitLogin bool `json:"inhibit_login,omitempty"`
RefreshToken bool `json:"refresh_token,omitempty"`
- Auth interface{} `json:"auth,omitempty"`
+ Auth UIAType `json:"auth,omitempty"`
// Type for registration, only used for appservice user registrations
// https://spec.matrix.org/v1.2/application-service-api/#server-admin-style-permissions
@@ -91,6 +113,10 @@ type ReqLogin struct {
StoreHomeserverURL bool `json:"-"`
}
+type ReqPutDevice struct {
+ DisplayName string `json:"display_name,omitempty"`
+}
+
type ReqUIAuthFallback struct {
Session string `json:"session"`
User string `json:"user"`
@@ -115,14 +141,17 @@ type ReqCreateRoom struct {
InitialState []*event.Event `json:"initial_state,omitempty"`
Preset string `json:"preset,omitempty"`
IsDirect bool `json:"is_direct,omitempty"`
- RoomVersion string `json:"room_version,omitempty"`
+ RoomVersion id.RoomVersion `json:"room_version,omitempty"`
PowerLevelOverride *event.PowerLevelsEventContent `json:"power_level_content_override,omitempty"`
MeowRoomID id.RoomID `json:"fi.mau.room_id,omitempty"`
+ MeowCreateTS int64 `json:"fi.mau.origin_server_ts,omitempty"`
BeeperInitialMembers []id.UserID `json:"com.beeper.initial_members,omitempty"`
BeeperAutoJoinInvites bool `json:"com.beeper.auto_join_invites,omitempty"`
BeeperLocalRoomID id.RoomID `json:"com.beeper.local_room_id,omitempty"`
+ BeeperBridgeName string `json:"com.beeper.bridge_name,omitempty"`
+ BeeperBridgeAccountID string `json:"com.beeper.bridge_account_id,omitempty"`
}
// ReqRedact is the JSON request for https://spec.matrix.org/v1.2/client-server-api/#put_matrixclientv3roomsroomidredacteventidtxnid
@@ -132,12 +161,37 @@ type ReqRedact struct {
Extra map[string]interface{}
}
+type ReqRedactUser struct {
+ Reason string `json:"reason"`
+ Limit int `json:"-"`
+}
+
type ReqMembers struct {
At string `json:"at"`
Membership event.Membership `json:"membership,omitempty"`
NotMembership event.Membership `json:"not_membership,omitempty"`
}
+type ReqJoinRoom struct {
+ Via []string `json:"-"`
+ Reason string `json:"reason,omitempty"`
+ ThirdPartySigned any `json:"third_party_signed,omitempty"`
+}
+
+type ReqKnockRoom struct {
+ Via []string `json:"-"`
+ Reason string `json:"reason,omitempty"`
+}
+
+type ReqSearchUserDirectory struct {
+ SearchTerm string `json:"search_term"`
+ Limit int `json:"limit,omitempty"`
+}
+
+type ReqMutualRooms struct {
+ From string `json:"-"`
+}
+
// ReqInvite3PID is the JSON request for https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3roomsroomidinvite-1
// It is also a JSON object used in https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3createroom
type ReqInvite3PID struct {
@@ -166,6 +220,8 @@ type ReqKickUser struct {
type ReqBanUser struct {
Reason string `json:"reason,omitempty"`
UserID id.UserID `json:"user_id"`
+
+ MSC4293RedactEvents bool `json:"org.matrix.msc4293.redact_events,omitempty"`
}
// ReqUnbanUser is the JSON request for https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3roomsroomidunban
@@ -181,7 +237,8 @@ type ReqTyping struct {
}
type ReqPresence struct {
- Presence event.Presence `json:"presence"`
+ Presence event.Presence `json:"presence"`
+ StatusMsg string `json:"status_msg,omitempty"`
}
type ReqAliasCreate struct {
@@ -263,11 +320,11 @@ func (csk *CrossSigningKeys) FirstKey() id.Ed25519 {
return ""
}
-type UploadCrossSigningKeysReq struct {
+type UploadCrossSigningKeysReq[UIAType any] struct {
Master CrossSigningKeys `json:"master_key"`
SelfSigning CrossSigningKeys `json:"self_signing_key"`
UserSigning CrossSigningKeys `json:"user_signing_key"`
- Auth interface{} `json:"auth,omitempty"`
+ Auth UIAType `json:"auth,omitempty"`
}
type KeyMap map[id.DeviceKeyID]string
@@ -309,20 +366,40 @@ type ReqSendToDevice struct {
Messages map[id.UserID]map[id.DeviceID]*event.Content `json:"messages"`
}
+type ReqSendEvent struct {
+ Timestamp int64
+ TransactionID string
+ UnstableDelay time.Duration
+ UnstableStickyDuration time.Duration
+ DontEncrypt bool
+ MeowEventID id.EventID
+}
+
+type ReqDelayedEvents struct {
+ DelayID id.DelayID `json:"-"`
+ Status event.DelayStatus `json:"-"`
+ NextBatch string `json:"-"`
+}
+
+type ReqUpdateDelayedEvent struct {
+ DelayID id.DelayID `json:"-"`
+ Action event.DelayAction `json:"action"`
+}
+
// ReqDeviceInfo is the JSON request for https://spec.matrix.org/v1.2/client-server-api/#put_matrixclientv3devicesdeviceid
type ReqDeviceInfo struct {
DisplayName string `json:"display_name,omitempty"`
}
// ReqDeleteDevice is the JSON request for https://spec.matrix.org/v1.2/client-server-api/#delete_matrixclientv3devicesdeviceid
-type ReqDeleteDevice struct {
- Auth interface{} `json:"auth,omitempty"`
+type ReqDeleteDevice[UIAType any] struct {
+ Auth UIAType `json:"auth,omitempty"`
}
// ReqDeleteDevices is the JSON request for https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3delete_devices
-type ReqDeleteDevices struct {
+type ReqDeleteDevices[UIAType any] struct {
Devices []id.DeviceID `json:"devices"`
- Auth interface{} `json:"auth,omitempty"`
+ Auth UIAType `json:"auth,omitempty"`
}
type ReqPutPushRule struct {
@@ -334,18 +411,6 @@ type ReqPutPushRule struct {
Pattern string `json:"pattern"`
}
-// Deprecated: MSC2716 was abandoned
-type ReqBatchSend struct {
- PrevEventID id.EventID `json:"-"`
- BatchID id.BatchID `json:"-"`
-
- BeeperNewMessages bool `json:"-"`
- BeeperMarkReadBy id.UserID `json:"-"`
-
- StateEventsAtStart []*event.Event `json:"state_events_at_start"`
- Events []*event.Event `json:"events"`
-}
-
type ReqBeeperBatchSend struct {
// ForwardIfNoMessages should be set to true if the batch should be forward
// backfilled if there are no messages currently in the room.
@@ -381,6 +446,33 @@ type ReqSendReceipt struct {
ThreadID string `json:"thread_id,omitempty"`
}
+type ReqPublicRooms struct {
+ IncludeAllNetworks bool
+ Limit int
+ Since string
+ ThirdPartyInstanceID string
+}
+
+func (req *ReqPublicRooms) Query() map[string]string {
+ query := map[string]string{}
+ if req == nil {
+ return query
+ }
+ if req.IncludeAllNetworks {
+ query["include_all_networks"] = "true"
+ }
+ if req.Limit > 0 {
+ query["limit"] = strconv.Itoa(req.Limit)
+ }
+ if req.Since != "" {
+ query["since"] = req.Since
+ }
+ if req.ThirdPartyInstanceID != "" {
+ query["third_party_instance_id"] = req.ThirdPartyInstanceID
+ }
+ return query
+}
+
// ReqHierarchy contains the parameters for https://spec.matrix.org/v1.4/client-server-api/#get_matrixclientv1roomsroomidhierarchy
//
// As it's a GET method, there is no JSON body, so this is only query parameters.
@@ -473,3 +565,54 @@ type ReqReport struct {
Reason string `json:"reason,omitempty"`
Score int `json:"score,omitempty"`
}
+
+type ReqGetRelations struct {
+ RelationType event.RelationType
+ EventType event.Type
+
+ Dir Direction
+ From string
+ To string
+ Limit int
+ Recurse bool
+}
+
+func (rgr *ReqGetRelations) PathSuffix() ClientURLPath {
+ if rgr.RelationType != "" {
+ if rgr.EventType.Type != "" {
+ return ClientURLPath{rgr.RelationType, rgr.EventType.Type}
+ }
+ return ClientURLPath{rgr.RelationType}
+ }
+ return ClientURLPath{}
+}
+
+func (rgr *ReqGetRelations) Query() map[string]string {
+ query := map[string]string{}
+ if rgr.Dir != 0 {
+ query["dir"] = string(rgr.Dir)
+ }
+ if rgr.From != "" {
+ query["from"] = rgr.From
+ }
+ if rgr.To != "" {
+ query["to"] = rgr.To
+ }
+ if rgr.Limit > 0 {
+ query["limit"] = strconv.Itoa(rgr.Limit)
+ }
+ if rgr.Recurse {
+ query["recurse"] = "true"
+ }
+ return query
+}
+
+// ReqSuspend is the request body for https://github.com/matrix-org/matrix-spec-proposals/pull/4323
+type ReqSuspend struct {
+ Suspended bool `json:"suspended"`
+}
+
+// ReqLocked is the request body for https://github.com/matrix-org/matrix-spec-proposals/pull/4323
+type ReqLocked struct {
+ Locked bool `json:"locked"`
+}
diff --git a/responses.go b/responses.go
index 26aaac77..4fbe1fbc 100644
--- a/responses.go
+++ b/responses.go
@@ -4,13 +4,16 @@ import (
"bytes"
"encoding/json"
"fmt"
+ "maps"
"reflect"
+ "slices"
"strconv"
"strings"
"github.com/tidwall/gjson"
"github.com/tidwall/sjson"
"go.mau.fi/util/jsontime"
+ "go.mau.fi/util/ptr"
"maunium.net/go/mautrix/event"
"maunium.net/go/mautrix/id"
@@ -32,6 +35,11 @@ type RespJoinRoom struct {
RoomID id.RoomID `json:"room_id"`
}
+// RespKnockRoom is the JSON response for https://spec.matrix.org/v1.13/client-server-api/#post_matrixclientv3knockroomidoralias
+type RespKnockRoom struct {
+ RoomID id.RoomID `json:"room_id"`
+}
+
// RespLeaveRoom is the JSON response for https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3roomsroomidleave
type RespLeaveRoom struct{}
@@ -97,6 +105,29 @@ type RespContext struct {
// RespSendEvent is the JSON response for https://spec.matrix.org/v1.2/client-server-api/#put_matrixclientv3roomsroomidsendeventtypetxnid
type RespSendEvent struct {
EventID id.EventID `json:"event_id"`
+
+ UnstableDelayID id.DelayID `json:"delay_id,omitempty"`
+}
+
+type RespUpdateDelayedEvent struct{}
+
+type RespDelayedEvents struct {
+ Scheduled []*event.ScheduledDelayedEvent `json:"scheduled,omitempty"`
+ Finalised []*event.FinalisedDelayedEvent `json:"finalised,omitempty"`
+ NextBatch string `json:"next_batch,omitempty"`
+
+ // Deprecated: Synapse implementation still returns this
+ DelayedEvents []*event.ScheduledDelayedEvent `json:"delayed_events,omitempty"`
+ // Deprecated: Synapse implementation still returns this
+ FinalisedEvents []*event.FinalisedDelayedEvent `json:"finalised_events,omitempty"`
+}
+
+type RespRedactUserEvents struct {
+ IsMoreEvents bool `json:"is_more_events"`
+ RedactedEvents struct {
+ Total int `json:"total"`
+ SoftFailed int `json:"soft_failed"`
+ } `json:"redacted_events"`
}
// RespMediaConfig is the JSON response for https://spec.matrix.org/v1.4/client-server-api/#get_matrixmediav3config
@@ -155,8 +186,89 @@ type RespUserDisplayName struct {
}
type RespUserProfile struct {
- DisplayName string `json:"displayname"`
- AvatarURL id.ContentURI `json:"avatar_url"`
+ DisplayName string `json:"displayname,omitempty"`
+ AvatarURL id.ContentURI `json:"avatar_url,omitempty"`
+ Extra map[string]any `json:"-"`
+}
+
+type marshalableUserProfile RespUserProfile
+
+func (r *RespUserProfile) UnmarshalJSON(data []byte) error {
+ err := json.Unmarshal(data, &r.Extra)
+ if err != nil {
+ return err
+ }
+ r.DisplayName, _ = r.Extra["displayname"].(string)
+ avatarURL, _ := r.Extra["avatar_url"].(string)
+ if avatarURL != "" {
+ r.AvatarURL, _ = id.ParseContentURI(avatarURL)
+ }
+ delete(r.Extra, "displayname")
+ delete(r.Extra, "avatar_url")
+ return nil
+}
+
+func (r *RespUserProfile) MarshalJSON() ([]byte, error) {
+ if len(r.Extra) == 0 {
+ return json.Marshal((*marshalableUserProfile)(r))
+ }
+ marshalMap := maps.Clone(r.Extra)
+ if r.DisplayName != "" {
+ marshalMap["displayname"] = r.DisplayName
+ } else {
+ delete(marshalMap, "displayname")
+ }
+ if !r.AvatarURL.IsEmpty() {
+ marshalMap["avatar_url"] = r.AvatarURL.String()
+ } else {
+ delete(marshalMap, "avatar_url")
+ }
+ return json.Marshal(marshalMap)
+}
+
+type RespSearchUserDirectory struct {
+ Limited bool `json:"limited"`
+ Results []*UserDirectoryEntry `json:"results"`
+}
+
+type UserDirectoryEntry struct {
+ RespUserProfile
+ UserID id.UserID `json:"user_id"`
+}
+
+func (r *UserDirectoryEntry) UnmarshalJSON(data []byte) error {
+ err := r.RespUserProfile.UnmarshalJSON(data)
+ if err != nil {
+ return err
+ }
+ userIDStr, _ := r.Extra["user_id"].(string)
+ r.UserID = id.UserID(userIDStr)
+ delete(r.Extra, "user_id")
+ return nil
+}
+
+func (r *UserDirectoryEntry) MarshalJSON() ([]byte, error) {
+ if r.Extra == nil {
+ r.Extra = make(map[string]any)
+ }
+ r.Extra["user_id"] = r.UserID.String()
+ return r.RespUserProfile.MarshalJSON()
+}
+
+type RespMutualRooms struct {
+ Joined []id.RoomID `json:"joined"`
+ NextBatch string `json:"next_batch,omitempty"`
+ Count int `json:"count,omitempty"`
+}
+
+type RespRoomSummary struct {
+ PublicRoomInfo
+
+ Membership event.Membership `json:"membership,omitempty"`
+
+ UnstableRoomVersion id.RoomVersion `json:"im.nheko.summary.room_version,omitempty"`
+ UnstableRoomVersionOld id.RoomVersion `json:"im.nheko.summary.version,omitempty"`
+ UnstableEncryption id.Algorithm `json:"im.nheko.summary.encryption,omitempty"`
}
// RespRegisterAvailable is the JSON response for https://spec.matrix.org/v1.4/client-server-api/#get_matrixclientv3registeravailable
@@ -207,6 +319,9 @@ type RespLogin struct {
DeviceID id.DeviceID `json:"device_id"`
UserID id.UserID `json:"user_id"`
WellKnown *ClientWellKnown `json:"well_known,omitempty"`
+
+ RefreshToken string `json:"refresh_token,omitempty"`
+ ExpiresInMS int64 `json:"expires_in_ms,omitempty"`
}
// RespLogout is the JSON response for https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3logout
@@ -227,6 +342,24 @@ type LazyLoadSummary struct {
InvitedMemberCount *int `json:"m.invited_member_count,omitempty"`
}
+func (lls *LazyLoadSummary) MemberCount() int {
+ if lls == nil {
+ return 0
+ }
+ return ptr.Val(lls.JoinedMemberCount) + ptr.Val(lls.InvitedMemberCount)
+}
+
+func (lls *LazyLoadSummary) Equal(other *LazyLoadSummary) bool {
+ if lls == other {
+ return true
+ } else if lls == nil || other == nil {
+ return false
+ }
+ return ptr.Val(lls.JoinedMemberCount) == ptr.Val(other.JoinedMemberCount) &&
+ ptr.Val(lls.InvitedMemberCount) == ptr.Val(other.InvitedMemberCount) &&
+ slices.Equal(lls.Heroes, other.Heroes)
+}
+
type SyncEventsList struct {
Events []*event.Event `json:"events,omitempty"`
}
@@ -322,6 +455,7 @@ type BeeperInboxPreviewEvent struct {
type SyncJoinedRoom struct {
Summary LazyLoadSummary `json:"summary"`
State SyncEventsList `json:"state"`
+ StateAfter *SyncEventsList `json:"state_after,omitempty"`
Timeline SyncTimeline `json:"timeline"`
Ephemeral SyncEventsList `json:"ephemeral"`
AccountData SyncEventsList `json:"account_data"`
@@ -347,16 +481,7 @@ func (sjr SyncJoinedRoom) MarshalJSON() ([]byte, error) {
}
type SyncInvitedRoom struct {
- Summary LazyLoadSummary `json:"summary"`
- State SyncEventsList `json:"invite_state"`
-}
-
-type marshalableSyncInvitedRoom SyncInvitedRoom
-
-var syncInvitedRoomPathsToDelete = []string{"summary"}
-
-func (sir SyncInvitedRoom) MarshalJSON() ([]byte, error) {
- return marshalAndDeleteEmpty((marshalableSyncInvitedRoom)(sir), syncInvitedRoomPathsToDelete)
+ State SyncEventsList `json:"invite_state"`
}
type SyncKnockedRoom struct {
@@ -421,29 +546,19 @@ type RespDeviceInfo struct {
LastSeenTS int64 `json:"last_seen_ts"`
}
-// Deprecated: MSC2716 was abandoned
-type RespBatchSend struct {
- StateEventIDs []id.EventID `json:"state_event_ids"`
- EventIDs []id.EventID `json:"event_ids"`
-
- InsertionEventID id.EventID `json:"insertion_event_id"`
- BatchEventID id.EventID `json:"batch_event_id"`
- BaseInsertionEventID id.EventID `json:"base_insertion_event_id"`
-
- NextBatchID id.BatchID `json:"next_batch_id"`
-}
-
type RespBeeperBatchSend struct {
EventIDs []id.EventID `json:"event_ids"`
}
// RespCapabilities is the JSON response for https://spec.matrix.org/v1.3/client-server-api/#get_matrixclientv3capabilities
type RespCapabilities struct {
- RoomVersions *CapRoomVersions `json:"m.room_versions,omitempty"`
- ChangePassword *CapBooleanTrue `json:"m.change_password,omitempty"`
- SetDisplayname *CapBooleanTrue `json:"m.set_displayname,omitempty"`
- SetAvatarURL *CapBooleanTrue `json:"m.set_avatar_url,omitempty"`
- ThreePIDChanges *CapBooleanTrue `json:"m.3pid_changes,omitempty"`
+ RoomVersions *CapRoomVersions `json:"m.room_versions,omitempty"`
+ ChangePassword *CapBooleanTrue `json:"m.change_password,omitempty"`
+ SetDisplayname *CapBooleanTrue `json:"m.set_displayname,omitempty"`
+ SetAvatarURL *CapBooleanTrue `json:"m.set_avatar_url,omitempty"`
+ ThreePIDChanges *CapBooleanTrue `json:"m.3pid_changes,omitempty"`
+ GetLoginToken *CapBooleanTrue `json:"m.get_login_token,omitempty"`
+ UnstableAccountModeration *CapUnstableAccountModeration `json:"uk.timedout.msc4323,omitempty"`
Custom map[string]interface{} `json:"-"`
}
@@ -552,29 +667,44 @@ func (vers *CapRoomVersions) IsAvailable(version string) bool {
return available
}
+type CapUnstableAccountModeration struct {
+ Suspend bool `json:"suspend"`
+ Lock bool `json:"lock"`
+}
+
+type RespPublicRooms struct {
+ Chunk []*PublicRoomInfo `json:"chunk"`
+ NextBatch string `json:"next_batch,omitempty"`
+ PrevBatch string `json:"prev_batch,omitempty"`
+ TotalRoomCountEstimate int `json:"total_room_count_estimate"`
+}
+
+type PublicRoomInfo struct {
+ RoomID id.RoomID `json:"room_id"`
+ AvatarURL id.ContentURIString `json:"avatar_url,omitempty"`
+ CanonicalAlias id.RoomAlias `json:"canonical_alias,omitempty"`
+ GuestCanJoin bool `json:"guest_can_join"`
+ JoinRule event.JoinRule `json:"join_rule,omitempty"`
+ Name string `json:"name,omitempty"`
+ NumJoinedMembers int `json:"num_joined_members"`
+ RoomType event.RoomType `json:"room_type"`
+ Topic string `json:"topic,omitempty"`
+ WorldReadable bool `json:"world_readable"`
+
+ RoomVersion id.RoomVersion `json:"room_version,omitempty"`
+ Encryption id.Algorithm `json:"encryption,omitempty"`
+ AllowedRoomIDs []id.RoomID `json:"allowed_room_ids,omitempty"`
+}
+
// RespHierarchy is the JSON response for https://spec.matrix.org/v1.4/client-server-api/#get_matrixclientv1roomsroomidhierarchy
type RespHierarchy struct {
- NextBatch string `json:"next_batch,omitempty"`
- Rooms []ChildRoomsChunk `json:"rooms"`
+ NextBatch string `json:"next_batch,omitempty"`
+ Rooms []*ChildRoomsChunk `json:"rooms"`
}
type ChildRoomsChunk struct {
- AvatarURL id.ContentURI `json:"avatar_url,omitempty"`
- CanonicalAlias id.RoomAlias `json:"canonical_alias,omitempty"`
- ChildrenState []StrippedStateWithTime `json:"children_state"`
- GuestCanJoin bool `json:"guest_can_join"`
- JoinRule event.JoinRule `json:"join_rule,omitempty"`
- Name string `json:"name,omitempty"`
- NumJoinedMembers int `json:"num_joined_members"`
- RoomID id.RoomID `json:"room_id"`
- RoomType event.RoomType `json:"room_type"`
- Topic string `json:"topic,omitempty"`
- WorldReadble bool `json:"world_readable"`
-}
-
-type StrippedStateWithTime struct {
- event.StrippedState
- Timestamp jsontime.UnixMilli `json:"origin_server_ts"`
+ PublicRoomInfo
+ ChildrenState []*event.Event `json:"children_state"`
}
type RespAppservicePing struct {
@@ -623,3 +753,47 @@ type RespRoomKeysUpdate struct {
Count int `json:"count"`
ETag string `json:"etag"`
}
+
+type RespOpenIDToken struct {
+ AccessToken string `json:"access_token"`
+ ExpiresIn int `json:"expires_in"`
+ MatrixServerName string `json:"matrix_server_name"`
+ TokenType string `json:"token_type"` // Always "Bearer"
+}
+
+type RespGetRelations struct {
+ Chunk []*event.Event `json:"chunk"`
+ NextBatch string `json:"next_batch,omitempty"`
+ PrevBatch string `json:"prev_batch,omitempty"`
+ RecursionDepth int `json:"recursion_depth,omitempty"`
+}
+
+// RespSuspended is the response body for https://github.com/matrix-org/matrix-spec-proposals/pull/4323
+type RespSuspended struct {
+ Suspended bool `json:"suspended"`
+}
+
+// RespLocked is the response body for https://github.com/matrix-org/matrix-spec-proposals/pull/4323
+type RespLocked struct {
+ Locked bool `json:"locked"`
+}
+
+type ConnectionInfo struct {
+ IP string `json:"ip,omitempty"`
+ LastSeen jsontime.UnixMilli `json:"last_seen,omitempty"`
+ UserAgent string `json:"user_agent,omitempty"`
+}
+
+type SessionInfo struct {
+ Connections []ConnectionInfo `json:"connections,omitempty"`
+}
+
+type DeviceInfo struct {
+ Sessions []SessionInfo `json:"sessions,omitempty"`
+}
+
+// RespWhoIs is the response body for https://spec.matrix.org/v1.15/client-server-api/#get_matrixclientv3adminwhoisuserid
+type RespWhoIs struct {
+ UserID id.UserID `json:"user_id,omitempty"`
+ Devices map[id.DeviceID]DeviceInfo `json:"devices,omitempty"`
+}
diff --git a/responses_test.go b/responses_test.go
index b23d85ad..73d82635 100644
--- a/responses_test.go
+++ b/responses_test.go
@@ -8,7 +8,6 @@ package mautrix_test
import (
"encoding/json"
- "fmt"
"testing"
"github.com/stretchr/testify/assert"
@@ -86,7 +85,6 @@ func TestRespCapabilities_UnmarshalJSON(t *testing.T) {
var caps mautrix.RespCapabilities
err := json.Unmarshal([]byte(sampleData), &caps)
require.NoError(t, err)
- fmt.Println(caps)
require.NotNil(t, caps.RoomVersions)
assert.Equal(t, "9", caps.RoomVersions.Default)
diff --git a/room.go b/room.go
index c3ddb7e6..4292bff5 100644
--- a/room.go
+++ b/room.go
@@ -5,8 +5,6 @@ import (
"maunium.net/go/mautrix/id"
)
-type RoomStateMap = map[event.Type]map[string]*event.Event
-
// Room represents a single Matrix room.
type Room struct {
ID id.RoomID
@@ -25,8 +23,8 @@ func (room Room) UpdateState(evt *event.Event) {
// GetStateEvent returns the state event for the given type/state_key combo, or nil.
func (room Room) GetStateEvent(eventType event.Type, stateKey string) *event.Event {
- stateEventMap, _ := room.State[eventType]
- evt, _ := stateEventMap[stateKey]
+ stateEventMap := room.State[eventType]
+ evt := stateEventMap[stateKey]
return evt
}
diff --git a/sqlstatestore/statestore.go b/sqlstatestore/statestore.go
index d594c307..11957dfa 100644
--- a/sqlstatestore/statestore.go
+++ b/sqlstatestore/statestore.go
@@ -62,6 +62,9 @@ func (store *SQLStateStore) IsRegistered(ctx context.Context, userID id.UserID)
}
func (store *SQLStateStore) MarkRegistered(ctx context.Context, userID id.UserID) error {
+ if userID == "" {
+ return fmt.Errorf("user ID is empty")
+ }
_, err := store.Exec(ctx, "INSERT INTO mx_registrations (user_id) VALUES ($1) ON CONFLICT (user_id) DO NOTHING", userID)
return err
}
@@ -85,14 +88,11 @@ func (store *SQLStateStore) GetRoomMembers(ctx context.Context, roomID id.RoomID
query = fmt.Sprintf("%s AND membership IN (%s)", query, strings.Join(placeholders, ","))
}
rows, err := store.Query(ctx, query, args...)
- if err != nil {
- return nil, err
- }
members := make(map[id.UserID]*event.MemberEventContent)
- return members, dbutil.NewRowIter(rows, func(row dbutil.Scannable) (ret Member, err error) {
+ return members, dbutil.NewRowIterWithError(rows, func(row dbutil.Scannable) (ret Member, err error) {
err = row.Scan(&ret.UserID, &ret.Membership, &ret.Displayname, &ret.AvatarURL)
return
- }).Iter(func(m Member) (bool, error) {
+ }, err).Iter(func(m Member) (bool, error) {
members[m.UserID] = &m.MemberEventContent
return true, nil
})
@@ -159,10 +159,7 @@ func (store *SQLStateStore) FindSharedRooms(ctx context.Context, userID id.UserI
`
}
rows, err := store.Query(ctx, query, userID)
- if err != nil {
- return nil, err
- }
- return dbutil.NewRowIter(rows, dbutil.ScanSingleColumn[id.RoomID]).AsList()
+ return dbutil.NewRowIterWithError(rows, dbutil.ScanSingleColumn[id.RoomID], err).AsList()
}
func (store *SQLStateStore) IsInRoom(ctx context.Context, roomID id.RoomID, userID id.UserID) bool {
@@ -188,6 +185,11 @@ func (store *SQLStateStore) IsMembership(ctx context.Context, roomID id.RoomID,
}
func (store *SQLStateStore) SetMembership(ctx context.Context, roomID id.RoomID, userID id.UserID, membership event.Membership) error {
+ if roomID == "" {
+ return fmt.Errorf("room ID is empty")
+ } else if userID == "" {
+ return fmt.Errorf("user ID is empty")
+ }
_, err := store.Exec(ctx, `
INSERT INTO mx_user_profile (room_id, user_id, membership, displayname, avatar_url) VALUES ($1, $2, $3, '', '')
ON CONFLICT (room_id, user_id) DO UPDATE SET membership=excluded.membership
@@ -220,6 +222,11 @@ func (u *userProfileRow) GetMassInsertValues() [5]any {
var userProfileMassInserter = dbutil.NewMassInsertBuilder[*userProfileRow, [1]any](insertUserProfileQuery, "($1, $%d, $%d, $%d, $%d, $%d)")
func (store *SQLStateStore) SetMember(ctx context.Context, roomID id.RoomID, userID id.UserID, member *event.MemberEventContent) error {
+ if roomID == "" {
+ return fmt.Errorf("room ID is empty")
+ } else if userID == "" {
+ return fmt.Errorf("user ID is empty")
+ }
var nameSkeleton []byte
if !store.DisableNameDisambiguation && len(member.Displayname) > 0 {
nameSkeletonArr := confusable.SkeletonHash(member.Displayname)
@@ -241,6 +248,9 @@ func (store *SQLStateStore) IsConfusableName(ctx context.Context, roomID id.Room
const userProfileMassInsertBatchSize = 500
func (store *SQLStateStore) ReplaceCachedMembers(ctx context.Context, roomID id.RoomID, evts []*event.Event, onlyMemberships ...event.Membership) error {
+ if roomID == "" {
+ return fmt.Errorf("room ID is empty")
+ }
return store.DoTxn(ctx, nil, func(ctx context.Context) error {
err := store.ClearCachedMembers(ctx, roomID, onlyMemberships...)
if err != nil {
@@ -303,7 +313,7 @@ func (store *SQLStateStore) ClearCachedMembers(ctx context.Context, roomID id.Ro
}
func (store *SQLStateStore) HasFetchedMembers(ctx context.Context, roomID id.RoomID) (fetched bool, err error) {
- err = store.QueryRow(ctx, "SELECT members_fetched FROM mx_room_state WHERE room_id=$1", roomID).Scan(&fetched)
+ err = store.QueryRow(ctx, "SELECT COALESCE(members_fetched, false) FROM mx_room_state WHERE room_id=$1", roomID).Scan(&fetched)
if errors.Is(err, sql.ErrNoRows) {
err = nil
}
@@ -311,6 +321,9 @@ func (store *SQLStateStore) HasFetchedMembers(ctx context.Context, roomID id.Roo
}
func (store *SQLStateStore) MarkMembersFetched(ctx context.Context, roomID id.RoomID) error {
+ if roomID == "" {
+ return fmt.Errorf("room ID is empty")
+ }
_, err := store.Exec(ctx, `
INSERT INTO mx_room_state (room_id, members_fetched) VALUES ($1, true)
ON CONFLICT (room_id) DO UPDATE SET members_fetched=true
@@ -340,6 +353,9 @@ func (store *SQLStateStore) GetAllMembers(ctx context.Context, roomID id.RoomID)
}
func (store *SQLStateStore) SetEncryptionEvent(ctx context.Context, roomID id.RoomID, content *event.EncryptionEventContent) error {
+ if roomID == "" {
+ return fmt.Errorf("room ID is empty")
+ }
contentBytes, err := json.Marshal(content)
if err != nil {
return fmt.Errorf("failed to marshal content JSON: %w", err)
@@ -354,7 +370,7 @@ func (store *SQLStateStore) SetEncryptionEvent(ctx context.Context, roomID id.Ro
func (store *SQLStateStore) GetEncryptionEvent(ctx context.Context, roomID id.RoomID) (*event.EncryptionEventContent, error) {
var data []byte
err := store.
- QueryRow(ctx, "SELECT encryption FROM mx_room_state WHERE room_id=$1", roomID).
+ QueryRow(ctx, "SELECT encryption FROM mx_room_state WHERE room_id=$1 AND encryption IS NOT NULL", roomID).
Scan(&data)
if errors.Is(err, sql.ErrNoRows) {
return nil, nil
@@ -377,6 +393,9 @@ func (store *SQLStateStore) IsEncrypted(ctx context.Context, roomID id.RoomID) (
}
func (store *SQLStateStore) SetPowerLevels(ctx context.Context, roomID id.RoomID, levels *event.PowerLevelsEventContent) error {
+ if roomID == "" {
+ return fmt.Errorf("room ID is empty")
+ }
_, err := store.Exec(ctx, `
INSERT INTO mx_room_state (room_id, power_levels) VALUES ($1, $2)
ON CONFLICT (room_id) DO UPDATE SET power_levels=excluded.power_levels
@@ -385,89 +404,92 @@ func (store *SQLStateStore) SetPowerLevels(ctx context.Context, roomID id.RoomID
}
func (store *SQLStateStore) GetPowerLevels(ctx context.Context, roomID id.RoomID) (levels *event.PowerLevelsEventContent, err error) {
+ levels = &event.PowerLevelsEventContent{}
err = store.
- QueryRow(ctx, "SELECT power_levels FROM mx_room_state WHERE room_id=$1", roomID).
- Scan(&dbutil.JSON{Data: &levels})
+ QueryRow(ctx, "SELECT power_levels, create_event FROM mx_room_state WHERE room_id=$1 AND power_levels IS NOT NULL", roomID).
+ Scan(&dbutil.JSON{Data: &levels}, &dbutil.JSON{Data: &levels.CreateEvent})
if errors.Is(err, sql.ErrNoRows) {
- err = nil
+ return nil, nil
+ } else if err != nil {
+ return nil, err
+ }
+ if levels.CreateEvent != nil {
+ err = levels.CreateEvent.Content.ParseRaw(event.StateCreate)
}
return
}
func (store *SQLStateStore) GetPowerLevel(ctx context.Context, roomID id.RoomID, userID id.UserID) (int, error) {
- if store.Dialect == dbutil.Postgres {
- var powerLevel int
- err := store.
- QueryRow(ctx, `
- SELECT COALESCE((power_levels->'users'->$2)::int, (power_levels->'users_default')::int, 0)
- FROM mx_room_state WHERE room_id=$1
- `, roomID, userID).
- Scan(&powerLevel)
- return powerLevel, err
- } else {
- levels, err := store.GetPowerLevels(ctx, roomID)
- if err != nil {
- return 0, err
- }
- return levels.GetUserLevel(userID), nil
+ levels, err := store.GetPowerLevels(ctx, roomID)
+ if err != nil {
+ return 0, err
}
+ return levels.GetUserLevel(userID), nil
}
func (store *SQLStateStore) GetPowerLevelRequirement(ctx context.Context, roomID id.RoomID, eventType event.Type) (int, error) {
- if store.Dialect == dbutil.Postgres {
- defaultType := "events_default"
- defaultValue := 0
- if eventType.IsState() {
- defaultType = "state_default"
- defaultValue = 50
- }
- var powerLevel int
- err := store.
- QueryRow(ctx, `
- SELECT COALESCE((power_levels->'events'->$2)::int, (power_levels->'$3')::int, $4)
- FROM mx_room_state WHERE room_id=$1
- `, roomID, eventType.Type, defaultType, defaultValue).
- Scan(&powerLevel)
- if errors.Is(err, sql.ErrNoRows) {
- err = nil
- powerLevel = defaultValue
- }
- return powerLevel, err
- } else {
- levels, err := store.GetPowerLevels(ctx, roomID)
- if err != nil {
- return 0, err
- }
- return levels.GetEventLevel(eventType), nil
+ levels, err := store.GetPowerLevels(ctx, roomID)
+ if err != nil {
+ return 0, err
}
+ return levels.GetEventLevel(eventType), nil
}
func (store *SQLStateStore) HasPowerLevel(ctx context.Context, roomID id.RoomID, userID id.UserID, eventType event.Type) (bool, error) {
- if store.Dialect == dbutil.Postgres {
- defaultType := "events_default"
- defaultValue := 0
- if eventType.IsState() {
- defaultType = "state_default"
- defaultValue = 50
- }
- var hasPower bool
- err := store.
- QueryRow(ctx, `SELECT
- COALESCE((power_levels->'users'->$2)::int, (power_levels->'users_default')::int, 0)
- >=
- COALESCE((power_levels->'events'->$3)::int, (power_levels->'$4')::int, $5)
- FROM mx_room_state WHERE room_id=$1`, roomID, userID, eventType.Type, defaultType, defaultValue).
- Scan(&hasPower)
- if errors.Is(err, sql.ErrNoRows) {
- err = nil
- hasPower = defaultValue == 0
- }
- return hasPower, err
- } else {
- levels, err := store.GetPowerLevels(ctx, roomID)
- if err != nil {
- return false, err
- }
- return levels.GetUserLevel(userID) >= levels.GetEventLevel(eventType), nil
+ levels, err := store.GetPowerLevels(ctx, roomID)
+ if err != nil {
+ return false, err
}
+ return levels.GetUserLevel(userID) >= levels.GetEventLevel(eventType), nil
+}
+
+func (store *SQLStateStore) SetCreate(ctx context.Context, evt *event.Event) error {
+ if evt.Type != event.StateCreate {
+ return fmt.Errorf("invalid event type for create event: %s", evt.Type)
+ } else if evt.RoomID == "" {
+ return fmt.Errorf("room ID is empty")
+ }
+ _, err := store.Exec(ctx, `
+ INSERT INTO mx_room_state (room_id, create_event) VALUES ($1, $2)
+ ON CONFLICT (room_id) DO UPDATE SET create_event=excluded.create_event
+ `, evt.RoomID, dbutil.JSON{Data: evt})
+ return err
+}
+
+func (store *SQLStateStore) GetCreate(ctx context.Context, roomID id.RoomID) (evt *event.Event, err error) {
+ err = store.
+ QueryRow(ctx, "SELECT create_event FROM mx_room_state WHERE room_id=$1 AND create_event IS NOT NULL", roomID).
+ Scan(&dbutil.JSON{Data: &evt})
+ if errors.Is(err, sql.ErrNoRows) {
+ return nil, nil
+ } else if err != nil {
+ return nil, err
+ }
+ if evt != nil {
+ err = evt.Content.ParseRaw(event.StateCreate)
+ }
+ return
+}
+
+func (store *SQLStateStore) SetJoinRules(ctx context.Context, roomID id.RoomID, rules *event.JoinRulesEventContent) error {
+ if roomID == "" {
+ return fmt.Errorf("room ID is empty")
+ }
+ _, err := store.Exec(ctx, `
+ INSERT INTO mx_room_state (room_id, join_rules) VALUES ($1, $2)
+ ON CONFLICT (room_id) DO UPDATE SET join_rules=excluded.join_rules
+ `, roomID, dbutil.JSON{Data: rules})
+ return err
+}
+
+func (store *SQLStateStore) GetJoinRules(ctx context.Context, roomID id.RoomID) (levels *event.JoinRulesEventContent, err error) {
+ levels = &event.JoinRulesEventContent{}
+ err = store.
+ QueryRow(ctx, "SELECT join_rules FROM mx_room_state WHERE room_id=$1 AND join_rules IS NOT NULL", roomID).
+ Scan(&dbutil.JSON{Data: &levels})
+ if errors.Is(err, sql.ErrNoRows) {
+ levels = nil
+ err = nil
+ }
+ return
}
diff --git a/sqlstatestore/v00-latest-revision.sql b/sqlstatestore/v00-latest-revision.sql
index a58cc56a..4679f1c6 100644
--- a/sqlstatestore/v00-latest-revision.sql
+++ b/sqlstatestore/v00-latest-revision.sql
@@ -1,4 +1,4 @@
--- v0 -> v7 (compatible with v3+): Latest revision
+-- v0 -> v10 (compatible with v3+): Latest revision
CREATE TABLE mx_registrations (
user_id TEXT PRIMARY KEY
@@ -26,5 +26,7 @@ CREATE TABLE mx_room_state (
room_id TEXT PRIMARY KEY,
power_levels jsonb,
encryption jsonb,
+ create_event jsonb,
+ join_rules jsonb,
members_fetched BOOLEAN NOT NULL DEFAULT false
);
diff --git a/sqlstatestore/v08-create-event.sql b/sqlstatestore/v08-create-event.sql
new file mode 100644
index 00000000..9f1b55c9
--- /dev/null
+++ b/sqlstatestore/v08-create-event.sql
@@ -0,0 +1,2 @@
+-- v8 (compatible with v3+): Add create event to room state table
+ALTER TABLE mx_room_state ADD COLUMN create_event jsonb;
diff --git a/sqlstatestore/v09-clear-empty-room-ids.sql b/sqlstatestore/v09-clear-empty-room-ids.sql
new file mode 100644
index 00000000..ca951068
--- /dev/null
+++ b/sqlstatestore/v09-clear-empty-room-ids.sql
@@ -0,0 +1,3 @@
+-- v9 (compatible with v3+): Clear invalid rows
+DELETE FROM mx_room_state WHERE room_id='';
+DELETE FROM mx_user_profile WHERE room_id='' OR user_id='';
diff --git a/sqlstatestore/v10-join-rules.sql b/sqlstatestore/v10-join-rules.sql
new file mode 100644
index 00000000..3074c46a
--- /dev/null
+++ b/sqlstatestore/v10-join-rules.sql
@@ -0,0 +1,2 @@
+-- v10 (compatible with v3+): Add join rules to room state table
+ALTER TABLE mx_room_state ADD COLUMN join_rules jsonb;
diff --git a/statestore.go b/statestore.go
index e728b885..2bd498dd 100644
--- a/statestore.go
+++ b/statestore.go
@@ -34,6 +34,12 @@ type StateStore interface {
SetPowerLevels(ctx context.Context, roomID id.RoomID, levels *event.PowerLevelsEventContent) error
GetPowerLevels(ctx context.Context, roomID id.RoomID) (*event.PowerLevelsEventContent, error)
+ SetCreate(ctx context.Context, evt *event.Event) error
+ GetCreate(ctx context.Context, roomID id.RoomID) (*event.Event, error)
+
+ GetJoinRules(ctx context.Context, roomID id.RoomID) (*event.JoinRulesEventContent, error)
+ SetJoinRules(ctx context.Context, roomID id.RoomID, content *event.JoinRulesEventContent) error
+
HasFetchedMembers(ctx context.Context, roomID id.RoomID) (bool, error)
MarkMembersFetched(ctx context.Context, roomID id.RoomID) error
GetAllMembers(ctx context.Context, roomID id.RoomID) (map[id.UserID]*event.MemberEventContent, error)
@@ -68,9 +74,13 @@ func UpdateStateStore(ctx context.Context, store StateStore, evt *event.Event) {
err = store.SetPowerLevels(ctx, evt.RoomID, content)
case *event.EncryptionEventContent:
err = store.SetEncryptionEvent(ctx, evt.RoomID, content)
+ case *event.CreateEventContent:
+ err = store.SetCreate(ctx, evt)
+ case *event.JoinRulesEventContent:
+ err = store.SetJoinRules(ctx, evt.RoomID, content)
default:
switch evt.Type {
- case event.StateMember, event.StatePowerLevels, event.StateEncryption:
+ case event.StateMember, event.StatePowerLevels, event.StateEncryption, event.StateCreate:
zerolog.Ctx(ctx).Warn().
Stringer("event_id", evt.ID).
Str("event_type", evt.Type.Type).
@@ -101,11 +111,14 @@ type MemoryStateStore struct {
MembersFetched map[id.RoomID]bool `json:"members_fetched"`
PowerLevels map[id.RoomID]*event.PowerLevelsEventContent `json:"power_levels"`
Encryption map[id.RoomID]*event.EncryptionEventContent `json:"encryption"`
+ Create map[id.RoomID]*event.Event `json:"create"`
+ JoinRules map[id.RoomID]*event.JoinRulesEventContent `json:"join_rules"`
registrationsLock sync.RWMutex
membersLock sync.RWMutex
powerLevelsLock sync.RWMutex
encryptionLock sync.RWMutex
+ joinRulesLock sync.RWMutex
}
func NewMemoryStateStore() StateStore {
@@ -115,6 +128,8 @@ func NewMemoryStateStore() StateStore {
MembersFetched: make(map[id.RoomID]bool),
PowerLevels: make(map[id.RoomID]*event.PowerLevelsEventContent),
Encryption: make(map[id.RoomID]*event.EncryptionEventContent),
+ Create: make(map[id.RoomID]*event.Event),
+ JoinRules: make(map[id.RoomID]*event.JoinRulesEventContent),
}
}
@@ -298,6 +313,9 @@ func (store *MemoryStateStore) SetPowerLevels(_ context.Context, roomID id.RoomI
func (store *MemoryStateStore) GetPowerLevels(_ context.Context, roomID id.RoomID) (levels *event.PowerLevelsEventContent, err error) {
store.powerLevelsLock.RLock()
levels = store.PowerLevels[roomID]
+ if levels != nil && levels.CreateEvent == nil {
+ levels.CreateEvent = store.Create[roomID]
+ }
store.powerLevelsLock.RUnlock()
return
}
@@ -314,6 +332,23 @@ func (store *MemoryStateStore) HasPowerLevel(ctx context.Context, roomID id.Room
return exerrors.Must(store.GetPowerLevel(ctx, roomID, userID)) >= exerrors.Must(store.GetPowerLevelRequirement(ctx, roomID, eventType)), nil
}
+func (store *MemoryStateStore) SetCreate(ctx context.Context, evt *event.Event) error {
+ store.powerLevelsLock.Lock()
+ store.Create[evt.RoomID] = evt
+ if pls, ok := store.PowerLevels[evt.RoomID]; ok && pls.CreateEvent == nil {
+ pls.CreateEvent = evt
+ }
+ store.powerLevelsLock.Unlock()
+ return nil
+}
+
+func (store *MemoryStateStore) GetCreate(ctx context.Context, roomID id.RoomID) (*event.Event, error) {
+ store.powerLevelsLock.RLock()
+ evt := store.Create[roomID]
+ store.powerLevelsLock.RUnlock()
+ return evt, nil
+}
+
func (store *MemoryStateStore) SetEncryptionEvent(_ context.Context, roomID id.RoomID, content *event.EncryptionEventContent) error {
store.encryptionLock.Lock()
store.Encryption[roomID] = content
@@ -327,6 +362,19 @@ func (store *MemoryStateStore) GetEncryptionEvent(_ context.Context, roomID id.R
return store.Encryption[roomID], nil
}
+func (store *MemoryStateStore) SetJoinRules(ctx context.Context, roomID id.RoomID, content *event.JoinRulesEventContent) error {
+ store.joinRulesLock.Lock()
+ store.JoinRules[roomID] = content
+ store.joinRulesLock.Unlock()
+ return nil
+}
+
+func (store *MemoryStateStore) GetJoinRules(ctx context.Context, roomID id.RoomID) (*event.JoinRulesEventContent, error) {
+ store.joinRulesLock.RLock()
+ defer store.joinRulesLock.RUnlock()
+ return store.JoinRules[roomID], nil
+}
+
func (store *MemoryStateStore) IsEncrypted(ctx context.Context, roomID id.RoomID) (bool, error) {
cfg, err := store.GetEncryptionEvent(ctx, roomID)
return cfg != nil && cfg.Algorithm == id.AlgorithmMegolmV1, err
diff --git a/synapseadmin/client.go b/synapseadmin/client.go
index 775b4b13..6925ca7d 100644
--- a/synapseadmin/client.go
+++ b/synapseadmin/client.go
@@ -14,9 +14,9 @@ import (
//
// https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/index.html
type Client struct {
- *mautrix.Client
+ Client *mautrix.Client
}
func (cli *Client) BuildAdminURL(path ...any) string {
- return cli.BuildURL(mautrix.SynapseAdminURLPath(path))
+ return cli.Client.BuildURL(mautrix.SynapseAdminURLPath(path))
}
diff --git a/synapseadmin/register.go b/synapseadmin/register.go
index 641f9b56..05e0729a 100644
--- a/synapseadmin/register.go
+++ b/synapseadmin/register.go
@@ -73,7 +73,7 @@ func (req *ReqSharedSecretRegister) Sign(secret string) string {
// This does not need to be called manually as SharedSecretRegister will automatically call this if no nonce is provided.
func (cli *Client) GetRegisterNonce(ctx context.Context) (string, error) {
var resp respGetRegisterNonce
- _, err := cli.MakeRequest(ctx, http.MethodGet, cli.BuildURL(mautrix.SynapseAdminURLPath{"v1", "register"}), nil, &resp)
+ _, err := cli.Client.MakeRequest(ctx, http.MethodGet, cli.BuildAdminURL("v1", "register"), nil, &resp)
if err != nil {
return "", err
}
@@ -93,7 +93,7 @@ func (cli *Client) SharedSecretRegister(ctx context.Context, sharedSecret string
}
req.SHA1Checksum = req.Sign(sharedSecret)
var resp mautrix.RespRegister
- _, err = cli.MakeRequest(ctx, http.MethodPost, cli.BuildURL(mautrix.SynapseAdminURLPath{"v1", "register"}), &req, &resp)
+ _, err = cli.Client.MakeRequest(ctx, http.MethodPost, cli.BuildAdminURL("v1", "register"), &req, &resp)
if err != nil {
return nil, err
}
diff --git a/synapseadmin/roomapi.go b/synapseadmin/roomapi.go
index 6c072e23..0925b748 100644
--- a/synapseadmin/roomapi.go
+++ b/synapseadmin/roomapi.go
@@ -75,12 +75,17 @@ type RespListRooms struct {
// https://matrix-org.github.io/synapse/latest/admin_api/rooms.html#list-room-api
func (cli *Client) ListRooms(ctx context.Context, req ReqListRoom) (RespListRooms, error) {
var resp RespListRooms
- var reqURL string
- reqURL = cli.BuildURLWithQuery(mautrix.SynapseAdminURLPath{"v1", "rooms"}, req.BuildQuery())
- _, err := cli.MakeRequest(ctx, http.MethodGet, reqURL, nil, &resp)
+ reqURL := cli.Client.BuildURLWithQuery(mautrix.SynapseAdminURLPath{"v1", "rooms"}, req.BuildQuery())
+ _, err := cli.Client.MakeRequest(ctx, http.MethodGet, reqURL, nil, &resp)
return resp, err
}
+func (cli *Client) RoomInfo(ctx context.Context, roomID id.RoomID) (resp *RoomInfo, err error) {
+ reqURL := cli.BuildAdminURL("v1", "rooms", roomID)
+ _, err = cli.Client.MakeRequest(ctx, http.MethodGet, reqURL, nil, &resp)
+ return
+}
+
type RespRoomMessages = mautrix.RespMessages
// RoomMessages returns a list of messages in a room.
@@ -104,13 +109,14 @@ func (cli *Client) RoomMessages(ctx context.Context, roomID id.RoomID, from, to
if limit != 0 {
query["limit"] = strconv.Itoa(limit)
}
- urlPath := cli.BuildURLWithQuery(mautrix.SynapseAdminURLPath{"v1", "rooms", roomID, "messages"}, query)
- _, err = cli.MakeRequest(ctx, http.MethodGet, urlPath, nil, &resp)
+ urlPath := cli.Client.BuildURLWithQuery(mautrix.SynapseAdminURLPath{"v1", "rooms", roomID, "messages"}, query)
+ _, err = cli.Client.MakeRequest(ctx, http.MethodGet, urlPath, nil, &resp)
return resp, err
}
type ReqDeleteRoom struct {
Purge bool `json:"purge,omitempty"`
+ ForcePurge bool `json:"force_purge,omitempty"`
Block bool `json:"block,omitempty"`
Message string `json:"message,omitempty"`
RoomName string `json:"room_name,omitempty"`
@@ -121,6 +127,19 @@ type RespDeleteRoom struct {
DeleteID string `json:"delete_id"`
}
+type RespDeleteRoomResult struct {
+ KickedUsers []id.UserID `json:"kicked_users,omitempty"`
+ FailedToKickUsers []id.UserID `json:"failed_to_kick_users,omitempty"`
+ LocalAliases []id.RoomAlias `json:"local_aliases,omitempty"`
+ NewRoomID id.RoomID `json:"new_room_id,omitempty"`
+}
+
+type RespDeleteRoomStatus struct {
+ Status string `json:"status,omitempty"`
+ Error string `json:"error,omitempty"`
+ ShutdownRoom RespDeleteRoomResult `json:"shutdown_room,omitempty"`
+}
+
// DeleteRoom deletes a room from the server, optionally blocking it and/or purging all data from the database.
//
// This calls the async version of the endpoint, which will return immediately and delete the room in the background.
@@ -129,10 +148,37 @@ type RespDeleteRoom struct {
func (cli *Client) DeleteRoom(ctx context.Context, roomID id.RoomID, req ReqDeleteRoom) (RespDeleteRoom, error) {
reqURL := cli.BuildAdminURL("v2", "rooms", roomID)
var resp RespDeleteRoom
- _, err := cli.MakeRequest(ctx, http.MethodDelete, reqURL, &req, &resp)
+ _, err := cli.Client.MakeRequest(ctx, http.MethodDelete, reqURL, &req, &resp)
return resp, err
}
+func (cli *Client) DeleteRoomStatus(ctx context.Context, deleteID string) (resp RespDeleteRoomStatus, err error) {
+ reqURL := cli.BuildAdminURL("v2", "rooms", "delete_status", deleteID)
+ _, err = cli.Client.MakeRequest(ctx, http.MethodGet, reqURL, nil, &resp)
+ return
+}
+
+// DeleteRoomSync deletes a room from the server, optionally blocking it and/or purging all data from the database.
+//
+// This calls the synchronous version of the endpoint, which will block until the room is deleted.
+//
+// https://element-hq.github.io/synapse/latest/admin_api/rooms.html#version-1-old-version
+func (cli *Client) DeleteRoomSync(ctx context.Context, roomID id.RoomID, req ReqDeleteRoom) (resp RespDeleteRoomResult, err error) {
+ reqURL := cli.BuildAdminURL("v1", "rooms", roomID)
+ httpClient := &http.Client{}
+ _, err = cli.Client.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodDelete,
+ URL: reqURL,
+ RequestJSON: &req,
+ ResponseJSON: &resp,
+ MaxAttempts: 1,
+ // Use a fresh HTTP client without timeouts
+ Client: httpClient,
+ })
+ httpClient.CloseIdleConnections()
+ return
+}
+
type RespRoomsMembers struct {
Members []id.UserID `json:"members"`
Total int `json:"total"`
@@ -144,7 +190,7 @@ type RespRoomsMembers struct {
func (cli *Client) RoomMembers(ctx context.Context, roomID id.RoomID) (RespRoomsMembers, error) {
reqURL := cli.BuildAdminURL("v1", "rooms", roomID, "members")
var resp RespRoomsMembers
- _, err := cli.MakeRequest(ctx, http.MethodGet, reqURL, nil, &resp)
+ _, err := cli.Client.MakeRequest(ctx, http.MethodGet, reqURL, nil, &resp)
return resp, err
}
@@ -157,7 +203,7 @@ type ReqMakeRoomAdmin struct {
// https://matrix-org.github.io/synapse/latest/admin_api/rooms.html#make-room-admin-api
func (cli *Client) MakeRoomAdmin(ctx context.Context, roomIDOrAlias string, req ReqMakeRoomAdmin) error {
reqURL := cli.BuildAdminURL("v1", "rooms", roomIDOrAlias, "make_room_admin")
- _, err := cli.MakeRequest(ctx, http.MethodPost, reqURL, &req, nil)
+ _, err := cli.Client.MakeRequest(ctx, http.MethodPost, reqURL, &req, nil)
return err
}
@@ -170,7 +216,7 @@ type ReqJoinUserToRoom struct {
// https://matrix-org.github.io/synapse/latest/admin_api/room_membership.html
func (cli *Client) JoinUserToRoom(ctx context.Context, roomID id.RoomID, req ReqJoinUserToRoom) error {
reqURL := cli.BuildAdminURL("v1", "join", roomID)
- _, err := cli.MakeRequest(ctx, http.MethodPost, reqURL, &req, nil)
+ _, err := cli.Client.MakeRequest(ctx, http.MethodPost, reqURL, &req, nil)
return err
}
@@ -183,7 +229,7 @@ type ReqBlockRoom struct {
// https://matrix-org.github.io/synapse/latest/admin_api/rooms.html#block-room-api
func (cli *Client) BlockRoom(ctx context.Context, roomID id.RoomID, req ReqBlockRoom) error {
reqURL := cli.BuildAdminURL("v1", "rooms", roomID, "block")
- _, err := cli.MakeRequest(ctx, http.MethodPut, reqURL, &req, nil)
+ _, err := cli.Client.MakeRequest(ctx, http.MethodPut, reqURL, &req, nil)
return err
}
@@ -199,6 +245,6 @@ type RoomsBlockResponse struct {
func (cli *Client) GetRoomBlockStatus(ctx context.Context, roomID id.RoomID) (RoomsBlockResponse, error) {
var resp RoomsBlockResponse
reqURL := cli.BuildAdminURL("v1", "rooms", roomID, "block")
- _, err := cli.MakeRequest(ctx, http.MethodGet, reqURL, nil, &resp)
+ _, err := cli.Client.MakeRequest(ctx, http.MethodGet, reqURL, nil, &resp)
return resp, err
}
diff --git a/synapseadmin/userapi.go b/synapseadmin/userapi.go
index 9cbb17e4..b1de55b6 100644
--- a/synapseadmin/userapi.go
+++ b/synapseadmin/userapi.go
@@ -32,7 +32,7 @@ type ReqResetPassword struct {
// https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#reset-password
func (cli *Client) ResetPassword(ctx context.Context, req ReqResetPassword) error {
reqURL := cli.BuildAdminURL("v1", "reset_password", req.UserID)
- _, err := cli.MakeRequest(ctx, http.MethodPost, reqURL, &req, nil)
+ _, err := cli.Client.MakeRequest(ctx, http.MethodPost, reqURL, &req, nil)
return err
}
@@ -43,8 +43,8 @@ func (cli *Client) ResetPassword(ctx context.Context, req ReqResetPassword) erro
//
// https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#check-username-availability
func (cli *Client) UsernameAvailable(ctx context.Context, username string) (resp *mautrix.RespRegisterAvailable, err error) {
- u := cli.BuildURLWithQuery(mautrix.SynapseAdminURLPath{"v1", "username_available"}, map[string]string{"username": username})
- _, err = cli.MakeRequest(ctx, http.MethodGet, u, nil, &resp)
+ u := cli.Client.BuildURLWithQuery(mautrix.SynapseAdminURLPath{"v1", "username_available"}, map[string]string{"username": username})
+ _, err = cli.Client.MakeRequest(ctx, http.MethodGet, u, nil, &resp)
if err == nil && !resp.Available {
err = fmt.Errorf(`request returned OK status without "available": true`)
}
@@ -65,7 +65,7 @@ type RespListDevices struct {
//
// https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#list-all-devices
func (cli *Client) ListDevices(ctx context.Context, userID id.UserID) (resp *RespListDevices, err error) {
- _, err = cli.MakeRequest(ctx, http.MethodGet, cli.BuildAdminURL("v2", "users", userID, "devices"), nil, &resp)
+ _, err = cli.Client.MakeRequest(ctx, http.MethodGet, cli.BuildAdminURL("v2", "users", userID, "devices"), nil, &resp)
return
}
@@ -89,7 +89,7 @@ type RespUserInfo struct {
//
// https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#query-user-account
func (cli *Client) GetUserInfo(ctx context.Context, userID id.UserID) (resp *RespUserInfo, err error) {
- _, err = cli.MakeRequest(ctx, http.MethodGet, cli.BuildAdminURL("v2", "users", userID), nil, &resp)
+ _, err = cli.Client.MakeRequest(ctx, http.MethodGet, cli.BuildAdminURL("v2", "users", userID), nil, &resp)
return
}
@@ -102,7 +102,20 @@ type ReqDeleteUser struct {
// https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#deactivate-account
func (cli *Client) DeactivateAccount(ctx context.Context, userID id.UserID, req ReqDeleteUser) error {
reqURL := cli.BuildAdminURL("v1", "deactivate", userID)
- _, err := cli.MakeRequest(ctx, http.MethodPost, reqURL, &req, nil)
+ _, err := cli.Client.MakeRequest(ctx, http.MethodPost, reqURL, &req, nil)
+ return err
+}
+
+type ReqSuspendUser struct {
+ Suspend bool `json:"suspend"`
+}
+
+// SuspendAccount suspends or unsuspends a specific local user account.
+//
+// https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#suspendunsuspend-account
+func (cli *Client) SuspendAccount(ctx context.Context, userID id.UserID, req ReqSuspendUser) error {
+ reqURL := cli.BuildAdminURL("v1", "suspend", userID)
+ _, err := cli.Client.MakeRequest(ctx, http.MethodPut, reqURL, &req, nil)
return err
}
@@ -124,7 +137,7 @@ type ReqCreateOrModifyAccount struct {
// https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#create-or-modify-account
func (cli *Client) CreateOrModifyAccount(ctx context.Context, userID id.UserID, req ReqCreateOrModifyAccount) error {
reqURL := cli.BuildAdminURL("v2", "users", userID)
- _, err := cli.MakeRequest(ctx, http.MethodPut, reqURL, &req, nil)
+ _, err := cli.Client.MakeRequest(ctx, http.MethodPut, reqURL, &req, nil)
return err
}
@@ -140,7 +153,7 @@ type ReqSetRatelimit = RatelimitOverride
// https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#set-ratelimit
func (cli *Client) SetUserRatelimit(ctx context.Context, userID id.UserID, req ReqSetRatelimit) error {
reqURL := cli.BuildAdminURL("v1", "users", userID, "override_ratelimit")
- _, err := cli.MakeRequest(ctx, http.MethodPost, reqURL, &req, nil)
+ _, err := cli.Client.MakeRequest(ctx, http.MethodPost, reqURL, &req, nil)
return err
}
@@ -150,7 +163,7 @@ type RespUserRatelimit = RatelimitOverride
//
// https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#get-status-of-ratelimit
func (cli *Client) GetUserRatelimit(ctx context.Context, userID id.UserID) (resp RespUserRatelimit, err error) {
- _, err = cli.MakeRequest(ctx, http.MethodGet, cli.BuildAdminURL("v1", "users", userID, "override_ratelimit"), nil, &resp)
+ _, err = cli.Client.MakeRequest(ctx, http.MethodGet, cli.BuildAdminURL("v1", "users", userID, "override_ratelimit"), nil, &resp)
return
}
@@ -158,6 +171,6 @@ func (cli *Client) GetUserRatelimit(ctx context.Context, userID id.UserID) (resp
//
// https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#delete-ratelimit
func (cli *Client) DeleteUserRatelimit(ctx context.Context, userID id.UserID) (err error) {
- _, err = cli.MakeRequest(ctx, http.MethodDelete, cli.BuildAdminURL("v1", "users", userID, "override_ratelimit"), nil, nil)
+ _, err = cli.Client.MakeRequest(ctx, http.MethodDelete, cli.BuildAdminURL("v1", "users", userID, "override_ratelimit"), nil, nil)
return
}
diff --git a/sync.go b/sync.go
index d4208404..598df8e0 100644
--- a/sync.go
+++ b/sync.go
@@ -90,6 +90,7 @@ func (s *DefaultSyncer) ProcessResponse(ctx context.Context, res *RespSync, sinc
err = fmt.Errorf("ProcessResponse panicked! since=%s panic=%s\n%s", since, r, debug.Stack())
}
}()
+ ctx = context.WithValue(ctx, SyncTokenContextKey, since)
for _, listener := range s.syncListeners {
if !listener(ctx, res, since) {
@@ -97,33 +98,38 @@ func (s *DefaultSyncer) ProcessResponse(ctx context.Context, res *RespSync, sinc
}
}
- s.processSyncEvents(ctx, "", res.ToDevice.Events, event.SourceToDevice)
- s.processSyncEvents(ctx, "", res.Presence.Events, event.SourcePresence)
- s.processSyncEvents(ctx, "", res.AccountData.Events, event.SourceAccountData)
+ s.processSyncEvents(ctx, "", res.ToDevice.Events, event.SourceToDevice, false)
+ s.processSyncEvents(ctx, "", res.Presence.Events, event.SourcePresence, false)
+ s.processSyncEvents(ctx, "", res.AccountData.Events, event.SourceAccountData, false)
for roomID, roomData := range res.Rooms.Join {
- s.processSyncEvents(ctx, roomID, roomData.State.Events, event.SourceJoin|event.SourceState)
- s.processSyncEvents(ctx, roomID, roomData.Timeline.Events, event.SourceJoin|event.SourceTimeline)
- s.processSyncEvents(ctx, roomID, roomData.Ephemeral.Events, event.SourceJoin|event.SourceEphemeral)
- s.processSyncEvents(ctx, roomID, roomData.AccountData.Events, event.SourceJoin|event.SourceAccountData)
+ if roomData.StateAfter == nil {
+ s.processSyncEvents(ctx, roomID, roomData.State.Events, event.SourceJoin|event.SourceState, false)
+ s.processSyncEvents(ctx, roomID, roomData.Timeline.Events, event.SourceJoin|event.SourceTimeline, false)
+ } else {
+ s.processSyncEvents(ctx, roomID, roomData.Timeline.Events, event.SourceJoin|event.SourceTimeline, true)
+ s.processSyncEvents(ctx, roomID, roomData.StateAfter.Events, event.SourceJoin|event.SourceState, false)
+ }
+ s.processSyncEvents(ctx, roomID, roomData.Ephemeral.Events, event.SourceJoin|event.SourceEphemeral, false)
+ s.processSyncEvents(ctx, roomID, roomData.AccountData.Events, event.SourceJoin|event.SourceAccountData, false)
}
for roomID, roomData := range res.Rooms.Invite {
- s.processSyncEvents(ctx, roomID, roomData.State.Events, event.SourceInvite|event.SourceState)
+ s.processSyncEvents(ctx, roomID, roomData.State.Events, event.SourceInvite|event.SourceState, false)
}
for roomID, roomData := range res.Rooms.Leave {
- s.processSyncEvents(ctx, roomID, roomData.State.Events, event.SourceLeave|event.SourceState)
- s.processSyncEvents(ctx, roomID, roomData.Timeline.Events, event.SourceLeave|event.SourceTimeline)
+ s.processSyncEvents(ctx, roomID, roomData.State.Events, event.SourceLeave|event.SourceState, false)
+ s.processSyncEvents(ctx, roomID, roomData.Timeline.Events, event.SourceLeave|event.SourceTimeline, false)
}
return
}
-func (s *DefaultSyncer) processSyncEvents(ctx context.Context, roomID id.RoomID, events []*event.Event, source event.Source) {
+func (s *DefaultSyncer) processSyncEvents(ctx context.Context, roomID id.RoomID, events []*event.Event, source event.Source, ignoreState bool) {
for _, evt := range events {
- s.processSyncEvent(ctx, roomID, evt, source)
+ s.processSyncEvent(ctx, roomID, evt, source, ignoreState)
}
}
-func (s *DefaultSyncer) processSyncEvent(ctx context.Context, roomID id.RoomID, evt *event.Event, source event.Source) {
+func (s *DefaultSyncer) processSyncEvent(ctx context.Context, roomID id.RoomID, evt *event.Event, source event.Source, ignoreState bool) {
evt.RoomID = roomID
// Ensure the type class is correct. It's safe to mutate the class since the event type is not a pointer.
@@ -149,6 +155,7 @@ func (s *DefaultSyncer) processSyncEvent(ctx context.Context, roomID id.RoomID,
}
evt.Mautrix.EventSource = source
+ evt.Mautrix.IgnoreState = ignoreState
s.Dispatch(ctx, evt)
}
@@ -191,8 +198,8 @@ func (s *DefaultSyncer) OnFailedSync(res *RespSync, err error) (time.Duration, e
}
var defaultFilter = Filter{
- Room: RoomFilter{
- Timeline: FilterPart{
+ Room: &RoomFilter{
+ Timeline: &FilterPart{
Limit: 50,
},
},
@@ -257,7 +264,7 @@ func dontProcessOldEvents(userID id.UserID, resp *RespSync, since string) bool {
// cli.Syncer.(mautrix.ExtensibleSyncer).OnSync(cli.MoveInviteState)
func (cli *Client) MoveInviteState(ctx context.Context, resp *RespSync, _ string) bool {
for _, meta := range resp.Rooms.Invite {
- var inviteState []event.StrippedState
+ var inviteState []*event.Event
var inviteEvt *event.Event
for _, evt := range meta.State.Events {
if evt.Type == event.StateMember && evt.GetStateKey() == cli.UserID.String() {
@@ -265,12 +272,7 @@ func (cli *Client) MoveInviteState(ctx context.Context, resp *RespSync, _ string
} else {
evt.Type.Class = event.StateEventType
_ = evt.Content.ParseRaw(evt.Type)
- inviteState = append(inviteState, event.StrippedState{
- Content: evt.Content,
- Type: evt.Type,
- StateKey: evt.GetStateKey(),
- Sender: evt.Sender,
- })
+ inviteState = append(inviteState, evt)
}
}
if inviteEvt != nil {
diff --git a/url.go b/url.go
index f35ae5e2..91b3d49d 100644
--- a/url.go
+++ b/url.go
@@ -57,13 +57,13 @@ func BuildURL(baseURL *url.URL, path ...any) *url.URL {
// BuildURL builds a URL with the Client's homeserver and appservice user ID set already.
func (cli *Client) BuildURL(urlPath PrefixableURLPath) string {
- return cli.BuildURLWithQuery(urlPath, nil)
+ return cli.BuildURLWithFullQuery(urlPath, nil)
}
// BuildClientURL builds a URL with the Client's homeserver and appservice user ID set already.
// This method also automatically prepends the client API prefix (/_matrix/client).
func (cli *Client) BuildClientURL(urlPath ...any) string {
- return cli.BuildURLWithQuery(ClientURLPath(urlPath), nil)
+ return cli.BuildURLWithFullQuery(ClientURLPath(urlPath), nil)
}
type PrefixableURLPath interface {
@@ -97,6 +97,19 @@ func (saup SynapseAdminURLPath) FullPath() []any {
// BuildURLWithQuery builds a URL with query parameters in addition to the Client's homeserver
// and appservice user ID set already.
func (cli *Client) BuildURLWithQuery(urlPath PrefixableURLPath, urlQuery map[string]string) string {
+ return cli.BuildURLWithFullQuery(urlPath, func(q url.Values) {
+ for k, v := range urlQuery {
+ q.Set(k, v)
+ }
+ })
+}
+
+// BuildURLWithQuery builds a URL with query parameters in addition to the Client's homeserver
+// and appservice user ID set already.
+func (cli *Client) BuildURLWithFullQuery(urlPath PrefixableURLPath, fn func(q url.Values)) string {
+ if cli == nil {
+ return "client is nil"
+ }
hsURL := *BuildURL(cli.HomeserverURL, urlPath.FullPath()...)
query := hsURL.Query()
if cli.SetAppServiceUserID {
@@ -106,10 +119,8 @@ func (cli *Client) BuildURLWithQuery(urlPath PrefixableURLPath, urlQuery map[str
query.Set("device_id", string(cli.DeviceID))
query.Set("org.matrix.msc3202.device_id", string(cli.DeviceID))
}
- if urlQuery != nil {
- for k, v := range urlQuery {
- query.Set(k, v)
- }
+ if fn != nil {
+ fn(query)
}
hsURL.RawQuery = query.Encode()
return hsURL.String()
diff --git a/version.go b/version.go
index 29368573..f00bbf39 100644
--- a/version.go
+++ b/version.go
@@ -4,10 +4,11 @@ import (
"fmt"
"regexp"
"runtime"
+ "runtime/debug"
"strings"
)
-const Version = "v0.21.1"
+const Version = "v0.26.3"
var GoModVersion = ""
var Commit = ""
@@ -15,11 +16,20 @@ var VersionWithCommit = Version
var DefaultUserAgent = "mautrix-go/" + Version + " go/" + strings.TrimPrefix(runtime.Version(), "go")
-var goModVersionRegex = regexp.MustCompile(`v.+\d{14}-([0-9a-f]{12})`)
-
func init() {
+ if GoModVersion == "" {
+ info, _ := debug.ReadBuildInfo()
+ if info != nil {
+ for _, mod := range info.Deps {
+ if mod.Path == "maunium.net/go/mautrix" {
+ GoModVersion = mod.Version
+ break
+ }
+ }
+ }
+ }
if GoModVersion != "" {
- match := goModVersionRegex.FindStringSubmatch(GoModVersion)
+ match := regexp.MustCompile(`v.+\d{14}-([0-9a-f]{12})`).FindStringSubmatch(GoModVersion)
if match != nil {
Commit = match[1]
}
diff --git a/versions.go b/versions.go
index 672018ff..61b2e4ea 100644
--- a/versions.go
+++ b/versions.go
@@ -60,17 +60,28 @@ type UnstableFeature struct {
}
var (
- FeatureAsyncUploads = UnstableFeature{UnstableFlag: "fi.mau.msc2246.stable", SpecVersion: SpecV17}
- FeatureAppservicePing = UnstableFeature{UnstableFlag: "fi.mau.msc2659.stable", SpecVersion: SpecV17}
- FeatureAuthenticatedMedia = UnstableFeature{UnstableFlag: "org.matrix.msc3916.stable", SpecVersion: SpecV111}
+ FeatureAsyncUploads = UnstableFeature{UnstableFlag: "fi.mau.msc2246.stable", SpecVersion: SpecV17}
+ FeatureAppservicePing = UnstableFeature{UnstableFlag: "fi.mau.msc2659.stable", SpecVersion: SpecV17}
+ FeatureAuthenticatedMedia = UnstableFeature{UnstableFlag: "org.matrix.msc3916.stable", SpecVersion: SpecV111}
+ FeatureUnstableMutualRooms = UnstableFeature{UnstableFlag: "uk.half-shot.msc2666.query_mutual_rooms"}
+ FeatureStableMutualRooms = UnstableFeature{UnstableFlag: "uk.half-shot.msc2666.query_mutual_rooms.stable" /*, SpecVersion: SpecV118*/}
+ FeatureUserRedaction = UnstableFeature{UnstableFlag: "org.matrix.msc4194"}
+ FeatureViewRedactedContent = UnstableFeature{UnstableFlag: "fi.mau.msc2815"}
+ FeatureUnstableAccountModeration = UnstableFeature{UnstableFlag: "uk.timedout.msc4323"}
+ FeatureStableAccountModeration = UnstableFeature{UnstableFlag: "uk.timedout.msc4323.stable" /*, SpecVersion: SpecV118*/}
+ FeatureUnstableProfileFields = UnstableFeature{UnstableFlag: "uk.tcpip.msc4133"}
+ FeatureArbitraryProfileFields = UnstableFeature{UnstableFlag: "uk.tcpip.msc4133.stable", SpecVersion: SpecV116}
+ FeatureRedactSendAsEvent = UnstableFeature{UnstableFlag: "com.beeper.msc4169"}
- BeeperFeatureHungry = UnstableFeature{UnstableFlag: "com.beeper.hungry"}
- BeeperFeatureBatchSending = UnstableFeature{UnstableFlag: "com.beeper.batch_sending"}
- BeeperFeatureRoomYeeting = UnstableFeature{UnstableFlag: "com.beeper.room_yeeting"}
- BeeperFeatureAutojoinInvites = UnstableFeature{UnstableFlag: "com.beeper.room_create_autojoin_invites"}
- BeeperFeatureArbitraryProfileMeta = UnstableFeature{UnstableFlag: "com.beeper.arbitrary_profile_meta"}
- BeeperFeatureAccountDataMute = UnstableFeature{UnstableFlag: "com.beeper.account_data_mute"}
- BeeperFeatureInboxState = UnstableFeature{UnstableFlag: "com.beeper.inbox_state"}
+ BeeperFeatureHungry = UnstableFeature{UnstableFlag: "com.beeper.hungry"}
+ BeeperFeatureBatchSending = UnstableFeature{UnstableFlag: "com.beeper.batch_sending"}
+ BeeperFeatureRoomYeeting = UnstableFeature{UnstableFlag: "com.beeper.room_yeeting"}
+ BeeperFeatureAutojoinInvites = UnstableFeature{UnstableFlag: "com.beeper.room_create_autojoin_invites"}
+ BeeperFeatureArbitraryProfileMeta = UnstableFeature{UnstableFlag: "com.beeper.arbitrary_profile_meta"}
+ BeeperFeatureAccountDataMute = UnstableFeature{UnstableFlag: "com.beeper.account_data_mute"}
+ BeeperFeatureInboxState = UnstableFeature{UnstableFlag: "com.beeper.inbox_state"}
+ BeeperFeatureArbitraryMemberChange = UnstableFeature{UnstableFlag: "com.beeper.arbitrary_member_change"}
+ BeeperFeatureEphemeralEvents = UnstableFeature{UnstableFlag: "com.beeper.ephemeral"}
)
func (versions *RespVersions) Supports(feature UnstableFeature) bool {
@@ -110,6 +121,12 @@ var (
SpecV19 = MustParseSpecVersion("v1.9")
SpecV110 = MustParseSpecVersion("v1.10")
SpecV111 = MustParseSpecVersion("v1.11")
+ SpecV112 = MustParseSpecVersion("v1.12")
+ SpecV113 = MustParseSpecVersion("v1.13")
+ SpecV114 = MustParseSpecVersion("v1.14")
+ SpecV115 = MustParseSpecVersion("v1.15")
+ SpecV116 = MustParseSpecVersion("v1.16")
+ SpecV117 = MustParseSpecVersion("v1.17")
)
func (svf SpecVersionFormat) String() string {